SuggestParameters Class

Definition

Namespace:

Microsoft.Azure.Search.Models

Assembly:

Microsoft.Azure.Search.Data.dll

Package:

Microsoft.Azure.Search.Data v10.1.0

Source:

SuggestParameters.cs

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

public class SuggestParameters

type SuggestParameters = class

Public Class SuggestParameters

Inheritance

Object

SuggestParameters

Constructors

SuggestParameters()	Initializes a new instance of the SuggestParameters class.
SuggestParameters(String, Boolean, String, String, Nullable<Double>, IList<String>, IList<String>, IList<String>, Nullable<Int32>)	Initializes a new instance of the SuggestParameters class.

Properties

Filter	Gets or sets an OData expression that filters the documents considered for suggestions.
HighlightPostTag	Gets or sets a string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled.
HighlightPreTag	Gets or sets a string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled.
MinimumCoverage	Gets or sets a number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions 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	Gets or sets 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	Gets or sets the list of field names to search for the specified search text. Target fields must be included in the specified suggester.
Select	Gets or sets the list of fields to retrieve. If unspecified, only the key field will be included in the results.
Top	Gets or sets the number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5.
UseFuzzyMatching	Gets or sets a value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms 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 suggestions queries are slower and consume more resources.

Methods

EnsureSelect()

Returns this instance if it has a non-null Select property, or a new instance with Select set to "*" otherwise.