• Public
  • Public/Protected
  • All

Interface SuggestOptions<Fields>

Package version

Additional parameters for suggestGet operation. Options for retrieving suggestions based on the searchText.

Type parameters

  • Fields


  • SuggestOptions



Optional filter

filter: undefined | string

An OData expression that filters the documents considered for suggestions.

Optional highlightPostTag

highlightPostTag: undefined | string

A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled.

Optional highlightPreTag

highlightPreTag: undefined | string

A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled.

Optional minimumCoverage

minimumCoverage: undefined | number

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.

Optional orderBy

orderBy: string[]

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.

Optional searchFields

searchFields: string[]

The list of field names to search for the specified search text. Target fields must be included in the specified suggester.

Optional select

select: string[]

The list of fields to retrieve. If unspecified, only the key field will be included in the results.

Optional top

top: undefined | number

The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5.

Optional useFuzzyMatching

useFuzzyMatching: undefined | false | true

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.

Generated using TypeDoc