Autocompletes incomplete query terms based on input text and matching terms in the Azure Search index.
Supports noop? false
Parameters
suggestername(Optional[String[1]])
— The name of the suggester as specified in the suggesters collection that's part of the index definition.
top(Optional[String[1]])
— The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5.
fuzzy(Optional[String[1]])
— 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.
client_request_id(Optional[String[1]])
— The tracking ID sent with the request to help with debugging.
highlightpretag(Optional[String[1]])
— A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled.
filter(Optional[String[1]])
— An OData expression that filters the documents used to produce completed terms for the Autocomplete result.
search(Optional[String[1]])
— The search text on which to base autocomplete results.
autocompletemode(Optional[String[1]])
— 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.
highlightposttag(Optional[String[1]])
— A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled.
searchfields(Optional[String[1]])
— The comma-separated list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester.
minimumcoverage(Optional[String[1]])
— 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.
api_version(Optional[String[1]])
— Client Api Version.
autocomplete_request(Optional[String[1]])
— The definition of the Autocomplete request.