Package version:

Interface SuggestRequest<TModel, TFields>

Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors.

interface SuggestRequest<TModel, TFields> {
    filter?: string;
    highlightPostTag?: string;
    highlightPreTag?: string;
    minimumCoverage?: number;
    orderBy?: string[];
    searchFields?: SearchFieldArray<TModel>;
    select?: SelectArray<TFields>;
    top?: number;
    useFuzzyMatching?: boolean;
}

Type Parameters

Properties

filter? highlightPostTag? highlightPreTag? minimumCoverage? orderBy? searchFields? select? top? useFuzzyMatching?

Properties

Optionalfilter

filter?: string

An OData expression that filters the documents considered for suggestions.

OptionalhighlightPostTag

highlightPostTag?: string

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

OptionalhighlightPreTag

highlightPreTag?: string

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

OptionalminimumCoverage

minimumCoverage?: number

A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion 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.

OptionalorderBy

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.

OptionalsearchFields

searchFields?: SearchFieldArray<TModel>

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

Optionalselect

select?: SelectArray<TFields>

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

Optionaltop

top?: number

/**

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

OptionaluseFuzzyMatching

useFuzzyMatching?: boolean

A value indicating whether to use fuzzy matching for the suggestion query. Default is false. When set to true, the query will find suggestions 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 suggestion searches are slower and consume more resources.

Settings

Member Visibility