@nosto/nosto-js
    Preparing search index...

    Interface SearchQuery

    interface SearchQuery {
        abTests?: InputSearchABTest[];
        accountId?: string;
        categories?: InputSearchCategories & { fields?: string[] };
        customRules?: InputSearchRule[];
        explain?: boolean;
        keywords?: InputSearchKeywords & { facets: string[]; fields: string[] };
        name?: string;
        popularSearches?: InputSearchPopularSearches & { fields?: string[] };
        products?: InputSearchProducts & { facets?: string[]; fields?: string[] };
        query?: string;
        redirect?: string;
        rules?: string[];
        segments?: string[];
        sessionParams?: InputSearchQuery;
        time?: number;
    }
    Index

    Properties

    abTests? accountId? categories? customRules? explain? keywords? name? popularSearches? products? query? redirect? rules? segments? sessionParams? time?

    Properties

    abTests?: InputSearchABTest[]
    accountId?: string

    Your account ID

    categories?: InputSearchCategories & { fields?: string[] }

    Category specific parameters

    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

    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

    keywords?: InputSearchKeywords & { facets: string[]; fields: string[] }
    name?: string
    popularSearches?: InputSearchPopularSearches & { fields?: string[] }

    Popular searches specific parameters

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

    Search text (raw user input)

    redirect?: string
    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

    segments?: string[]

    Segment ID's user belongs to

    sessionParams?: InputSearchQuery
    time?: number

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

    Settings

    Member Visibility

    On This Page

    Properties