@chelseaapps/recommender documentation

File

Description

Recommender module configuration options

Index

Properties

cache
cache: literal type
Type : literal type

databaseID
databaseID: string
Type : string
ID of the Recombee database to pull recommendations from

isGlobal
isGlobal: boolean
Type : boolean
Optional
Should the module be registered globally? Defaults to true

privateToken
privateToken: string
Type : string
Recombee private token for authentication

scenarios
scenarios: literal type
Type : literal type
Scenario names for various recommendation features

export interface RecommenderOptions {
    /**
     * ID of the Recombee database to pull recommendations from
     */
    databaseID: string;

    /**
     * Recombee private token for authentication
     */
    privateToken: string;

    /**
     * Should the module be registered globally? Defaults to `true`
     */
    isGlobal?: boolean;

    cache: {
        /**
         * Cache recommendations returned from the API to improve response times and reduce network calls
         */
        enabled: boolean;
        /**
         * How many milliseconds are recommendations stored in the cache for a user before being refetched?
         */
        ttl?: number;

        /**
         * Redis configuration options for the cache
         */
        redis: {
            /**
             * Redis host
             */
            host: string;
            /**
             * Redis port
             */
            port: number;
        };
    };

    /**
     * Scenario names for various recommendation features
     */
    scenarios: {
        /**
         * Main homepage recommendation scenario
         */
        main: string;
        /**
         * User search recommendations scenario
         */
        search: string;
        /**
         * User to users recommendation scenario
         */
        users: string;
        /**
         * Items to item recommendation scenario
         */
        items: string;
    };
}