AutocompleteParameters Class

Definition

Namespace:

Microsoft.Azure.Search.Models

Assembly:

Microsoft.Azure.Search.Data.dll

Package:

Microsoft.Azure.Search.Data v10.1.0

Source:

AutocompleteParameters.cs

Additional parameters for AutocompleteGet operation.

public class AutocompleteParameters

type AutocompleteParameters = class

Public Class AutocompleteParameters

Inheritance

Object

AutocompleteParameters

Constructors

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

Properties

AutocompleteMode	Gets or sets specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms. Possible values include: 'oneTerm', 'twoTerms', 'oneTermWithContext'
Filter	Gets or sets an OData expression that filters the documents used to produce completed terms for the Autocomplete result.
HighlightPostTag	Gets or sets a string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled.
HighlightPreTag	Gets or sets a string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled.
MinimumCoverage	Gets or sets a number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete 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.
SearchFields	Gets or sets the list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester.
Top	Gets or sets the number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5.
UseFuzzyMatching	Gets or sets a value indicating whether to use fuzzy matching for the autocomplete 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 autocomplete queries are slower and consume more resources.