AutocompleteOptions Class

Definition

Namespace:

Azure.Search.Documents

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v11.6.0

Source:

AutocompleteOptions.cs

Parameters for fuzzy matching, and other autocomplete query behaviors.

public class AutocompleteOptions

type AutocompleteOptions = class

Public Class AutocompleteOptions

Inheritance

Object

AutocompleteOptions

Constructors

AutocompleteOptions()

Initializes new instance of AutocompleteOptions

Properties

Filter	An OData expression that filters the documents used to produce completed terms for the Autocomplete result. 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 is disabled.
HighlightPreTag	A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled.
MinimumCoverage	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.
Mode	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.
SearchFields	The list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester.
Size	The number of auto-completed terms 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 autocomplete query. Default is false. When set to true, the query will autocomplete 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.