Interface InputSearchQueryWithFields

Hierarchy

Properties

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

Properties

Optional accountId

accountId?: string

Your account ID

Optional customRules

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

Optional explain

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

Optional keywords

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

Keyword specific parameters

Type declaration

  • Optional fields?: string[]

    The fields to return in the response.

Optional products

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

Product specific parameters

Type declaration

  • Optional fields?: string[]

    The fields to return in the response.

Optional query

query?: string

Search text (raw user input)

Optional redirect

redirect?: string

Optional rules

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

Optional segments

segments?: string[]

Segment ID's user belongs to

Optional sessionParams

sessionParams?: InputSearchQuery

Optional time

time?: number

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc