---
schema_version: "1"
id: 3f26f963cfe8e8ad29fdc419e602c7cc2dcf25c33488b9115218d6515c52f29f
title: SuggestionOption Class
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_class_Search_SuggestionOption.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Search_SuggestionOption.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: ee245a78d31036d7b38d3303850345f7abd51c67b0aaa8a3b9d71c88efea6819
description: Options that narrow record and article suggestion results returned from a call to System.Search.suggest(String, String, Search.SuggestionOption).Set filters that narrow Salesforce Knowledge article results in a call to System.Search.suggest(String, String, Search.SuggestionOption). The maximum number of record or article suggestions to retrieve.
---
# SuggestionOption Class

Options that narrow record and article suggestion results returned from a call to System.Search.suggest(String, String, Search.SuggestionOption).

## Namespace

[Search](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_namespace_Search.htm#apex_namespace_Search "The Search namespace provides classes for getting search results and suggestion results.")

## SuggestionOption Methods

The following are methods for SuggestionOption.

- **[setFilter(knowledgeSuggestionFilter)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Search_SuggestionOption.htm#apex_Search_SuggestionOption_setFilter)**  
    Set filters that narrow Salesforce Knowledge article results in a call to System.Search.suggest(String, String, Search.SuggestionOption).
- **[setLimit(limit)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Search_SuggestionOption.htm#apex_Search_SuggestionOption_setLimit)**  
    The maximum number of record or article suggestions to retrieve.

### setFilter(knowledgeSuggestionFilter)

Set filters that narrow Salesforce Knowledge article results in a call to System.Search.suggest(String, String, Search.SuggestionOption).

#### Signature

public void setFilter(Search.KnowledegeSuggestionFilter knowledgeSuggestionFilter)

#### Parameters

- **knowledgeSuggestionFilter**: Type: [KnowledgeSuggestionFilter](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_Search_KnowledgeSuggestionFilter.htm#apex_class_Search_KnowledgeSuggestionFilter "Filter settings that narrow the results from a call to System.Search.suggest(searchQuery, sObjectType, options) when the SOSL search query contains a KnowledgeArticleVersion object.") An object containing filters that narrow the search results.

#### Return Value

Type: void

#### Usage

Search.KnowledgeSuggestionFilter filters = new Search.KnowledgeSuggestionFilter(); 
filters.setLanguage('en\_US'); 
filters.setPublishStatus('Online'); 
filters.setChannel('app'); 

Search.SuggestionOption options = new Search.SuggestionOption(); 
options.setFilter(filters); 

Search.SuggestionResults suggestionResults = Search.suggest('all', 'KnowledgeArticleVersion', options); 

for (Search.SuggestionResult searchResult : suggestionResults.getSuggestionResults()) {     
  KnowledgeArticleVersion article = (KnowledgeArticleVersion)searchResult.getSObject();   
  System.debug(article.title); 
} 

### setLimit(limit)

The maximum number of record or article suggestions to retrieve.

#### Signature

public void setLimit(Integer limit)

#### Parameters

- **limit**: Type: [Integer](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_integer.htm#apex_methods_system_integer "Contains methods for the Integer primitive data type.") The maximum number of record or article suggestions to retrieve.

#### Return Value

Type: void

#### Usage

By default, the System.Search.suggest(String, String, Search.SuggestionOption) method returns the 5 most relevant results. However, if your query is broad, it could match more than 5 results. If Search.SuggestionResults.hasMoreResults() returns true, there are more than 5 results. To retrieve them, call setLimit(Integer) to increase the number of suggestions results.

Search.SuggestionOption option = new Search.SuggestionOption();
option.setLimit(10);
Search.suggest('my query', 'mySObjectType', option);