Github Link

      Function getItemRecommendations

      • getItemRecommendations<T>(props): Promise<{
            evaluatedScenarios?: {
                default?: {
                    scenarioName?: string;
                    scenarioType?: NonNullable<NonNullable<"alias" | "ab_test" | "case" | "condition" | undefined>>;
                    to?: string;
                }[];
                genericDefault?: {
                    scenarioName?: string;
                    scenarioType?: NonNullable<NonNullable<"alias" | "ab_test" | "case" | "condition" | undefined>>;
                    to?: string;
                }[];
                genericRuntime?: {
                    scenarioName?: string;
                    scenarioType?: NonNullable<NonNullable<"alias" | "ab_test" | "case" | "condition" | undefined>>;
                    to?: string;
                }[];
                recommendationType?: NonNullable<"item_to_items" | "profile_to_items" | "session_to_items" | "profile_to_items_w_ctx_items" | "session_to_items_w_ctx_items" | "precomputed_item_to_items" | "precomputed_profile_to_items" | "item_properties_to_items" | "profile_to_item_properties" | "session_to_item_properties" | "profiles_group_to_items" | "chat_to_items" | "generic_input_to_items" | "llm_text_completion" | "llm_chat_completion" | undefined>;
                runtime?: {
                    scenarioName?: string;
                    scenarioType?: NonNullable<NonNullable<"alias" | "ab_test" | "case" | "condition" | undefined>>;
                    to?: string;
                }[];
            };
            itemIds: string[];
            metadata?: @crossingminds/utils;
            nextCursor?: string;
            warnings?: string[];
        }>
      • Beta

        Get item recommendations from a generic input.

        Type Parameters

        Parameters

        Returns Promise<{
            evaluatedScenarios?: {
                default?: {
                    scenarioName?: string;
                    scenarioType?: NonNullable<NonNullable<"alias" | "ab_test" | "case" | "condition" | undefined>>;
                    to?: string;
                }[];
                genericDefault?: {
                    scenarioName?: string;
                    scenarioType?: NonNullable<NonNullable<"alias" | "ab_test" | "case" | "condition" | undefined>>;
                    to?: string;
                }[];
                genericRuntime?: {
                    scenarioName?: string;
                    scenarioType?: NonNullable<NonNullable<"alias" | "ab_test" | "case" | "condition" | undefined>>;
                    to?: string;
                }[];
                recommendationType?: NonNullable<"item_to_items" | "profile_to_items" | "session_to_items" | "profile_to_items_w_ctx_items" | "session_to_items_w_ctx_items" | "precomputed_item_to_items" | "precomputed_profile_to_items" | "item_properties_to_items" | "profile_to_item_properties" | "session_to_item_properties" | "profiles_group_to_items" | "chat_to_items" | "generic_input_to_items" | "llm_text_completion" | "llm_chat_completion" | undefined>;
                runtime?: {
                    scenarioName?: string;
                    scenarioType?: NonNullable<NonNullable<"alias" | "ab_test" | "case" | "condition" | undefined>>;
                    to?: string;
                }[];
            };
            itemIds: string[];
            metadata?: @crossingminds/utils;
            nextCursor?: string;
            warnings?: string[];
        }>

        Throws

        Supported recommendation types: item_to_items, profile_to_items, session_to_items, profile_to_items_w_ctx_items, session_to_items_w_ctx_items, precomputed_item_to_items, precomputed_profile_to_items, item_properties_to_items Supported Generic Inputs: ItemToItems, UserToItems, SessionToItems, UserToItemsWithContext, SessionToItemsWithContext, PrecomputedItemToItems, PrecomputedUserToItems, ItemPropertiesToItems Authenticates: https://docs.api.crossingminds.com/endpoints/account.html#login-as-service-account Gets Item Recommendations from Generic Input: https://docs.api.crossingminds.com/endpoints/reco.html#get-items-recommendations-from-generic-input

      Settings

      Member Visibility

      Theme