Share via


SuggestOptions interface

The payload of suggest request.

Properties

filter

The filter for the search.

keywords

The keywords applied to all fields that support suggest operation. It must be at least 1 character, and no more than 100 characters. In the index schema we defined a default suggester which lists all the supported fields and specifies a search mode.

limit

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

Property Details

filter

The filter for the search.

filter?: unknown

Property Value

unknown

keywords

The keywords applied to all fields that support suggest operation. It must be at least 1 character, and no more than 100 characters. In the index schema we defined a default suggester which lists all the supported fields and specifies a search mode.

keywords?: string

Property Value

string

limit

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

limit?: number

Property Value

number