Interface InputSearchKeywords

interface InputSearchKeywords {
    boost?: InputSearchBoost[];
    emptyQueryMatchesAll?: boolean;
    filter?: InputSearchTopLevelFilter[];
    from?: number;
    highlight?: InputSearchHighlight;
    size?: number;
    sort?: InputSearchSort[];
}

Properties

boost? emptyQueryMatchesAll? filter? from? highlight? size? sort?

Properties

Optionalboost

boost?: InputSearchBoost[]

List of custom boosts

OptionalemptyQueryMatchesAll

emptyQueryMatchesAll?: boolean

Matches all objects if query is not provided or empty. Defaults to false.

Optionalfilter

filter?: InputSearchTopLevelFilter[]

List of filters. Values are joined with AND operator

Optionalfrom

from?: number

Offset of returned keyword list. Used for pagination, use together with size parameter

Optionalhighlight

highlight?: InputSearchHighlight

Highlight tag

Optionalsize

size?: number

How many keywords will be returned

Optionalsort

sort?: InputSearchSort[]

Sets how results should be sorted. After sorting by all the options provided in sort param, or in case sort param is not set, results will be sorted by relevance.

Settings

Member Visibility

On This Page

Properties