Interface InputSearchQueryWithFields

interface InputSearchQueryWithFields {
    accountId?: string;
    customRules?: InputSearchRule[];
    explain?: boolean;
    keywords?: {
        fields?: string[];
    } & InputSearchKeywords;
    products?: {
        fields?: string[];
    } & InputSearchProducts;
    query?: string;
    redirect?: string;
    rules?: string[];
    segments?: string[];
    sessionParams?: InputSearchQuery;
    time?: number;
}

Hierarchy (view full)

Properties

accountId? customRules? explain? keywords? products? query? redirect? rules? segments? sessionParams? time?

Properties

OptionalaccountId

accountId?: string

Your account ID

OptionalcustomRules

customRules?: InputSearchRule[]

Any custom rules that should be added in this search request. These rules are appended to the rule list defined in nosto dashboard

Optionalexplain

explain?: boolean

(Private key only) Returns scoring information for each object if true. This should only be used for debugging as performance will suffer. If not needed, omit this parameter

Optionalkeywords

keywords?: {
    fields?: string[];
} & InputSearchKeywords

Keyword specific parameters

Type declaration

  • Optionalfields?: string[]

    The fields to return in the response.

Optionalproducts

products?: {
    fields?: string[];
} & InputSearchProducts

Product specific parameters

Type declaration

  • Optionalfields?: string[]

    The fields to return in the response.

Optionalquery

query?: string

Search text (raw user input)

Optionalredirect

redirect?: string

Optionalrules

rules?: string[]

List of rule ID's or ID matching patterns with wildcards. Patterns [ global-*, query-* ] should be used here to match all rules created in dashboard

Optionalsegments

segments?: string[]

Segment ID's user belongs to

OptionalsessionParams

sessionParams?: InputSearchQuery

Optionaltime

time?: number

(Private key only) Overwrites current time. Used to trigger scheduled rules ahead of schedule

Settings

Member Visibility

On This Page

Properties