SearchModelFactory.AutocompleteOptions Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The AutocompleteOptions.
public static Azure.Search.Documents.AutocompleteOptions AutocompleteOptions(string searchText = default, Azure.Search.Documents.Models.AutocompleteMode? mode = default, string filter = default, bool? useFuzzyMatching = default, string highlightPostTag = default, string highlightPreTag = default, double? minimumCoverage = default, string searchFieldsRaw = default, string suggesterName = default, int? size = default);static member AutocompleteOptions : string * Nullable<Azure.Search.Documents.Models.AutocompleteMode> * string * Nullable<bool> * string * string * Nullable<double> * string * string * Nullable<int> -> Azure.Search.Documents.AutocompleteOptionsPublic Shared Function AutocompleteOptions (Optional searchText As String = Nothing, Optional mode As Nullable(Of AutocompleteMode) = Nothing, Optional filter As String = Nothing, Optional useFuzzyMatching As Nullable(Of Boolean) = Nothing, Optional highlightPostTag As String = Nothing, Optional highlightPreTag As String = Nothing, Optional minimumCoverage As Nullable(Of Double) = Nothing, Optional searchFieldsRaw As String = Nothing, Optional suggesterName As String = Nothing, Optional size As Nullable(Of Integer) = Nothing) As AutocompleteOptionsParameters
- searchText
- String
The search text on which to base autocomplete results.
- mode
- Nullable<AutocompleteMode>
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.
- filter
- String
An OData expression that filters the documents used to produce completed terms for the Autocomplete result.
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.
- highlightPostTag
- String
A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled.
- highlightPreTag
- String
A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled.
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.
- searchFieldsRaw
- String
The comma-separated list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester.
- suggesterName
- String
The name of the suggester as specified in the suggesters collection that's part of the index definition.
The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5.
Returns
A new AutocompleteOptions instance for mocking.
