SuggestOptions Class

Definition

Namespace:

Azure.Search.Documents

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v11.5.1

Source:

SuggestOptions.cs

Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors.

public class SuggestOptions

type SuggestOptions = class

Public Class SuggestOptions

Inheritance

Object

SuggestOptions

Constructors

SuggestOptions()

Initializes new instance of SuggestOptions

Properties

Filter	An OData expression that filters the documents considered for suggestions. You can use Create(FormattableString) to help construct the filter expression.
HighlightPostTag	A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled.
HighlightPreTag	A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled.
MinimumCoverage	A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.
OrderBy	The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.
SearchFields	The list of field names to search for the specified search text. Target fields must be included in the specified suggester.
Select	The list of fields to retrieve. If unspecified, only the key field will be included in the results.
Size	The number of suggestions to retrieve. This must be a value between 1 and 100. The default is 5.
UseFuzzyMatching	A value indicating whether to use fuzzy matching for the suggestion query. Default is false. When set to true, the query will find suggestions even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestion searches are slower and consume more resources.