Class: module:api/AiApi

module:api/AiApi(apiClient)

new module:api/AiApi(apiClient)

Constructs a new AiApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use, default to module:ApiClient#instance if unspecified.
Source:

Methods

getAiProductRecommendationsByID(recommenderName, opts) → {Promise}

This is a beta feature that has been canceled. A future release will include the ability to obtain product recommendations by making direct calls to the Commerce Cloud Einstein API. Returns product recommendations based on the given product or category IDs.

Parameters:
Name Type Description
recommenderName String

The recommender name.
opts Object

Optional parameters

Properties
Name Type Description
products Array.<String>
categories Array.<String>
uuid String
expand Array.<String>
inventoryIds Array.<String>
currency String
allImages Boolean
Source:
Returns:

a Promise, with data of type module:models/ProductRecommendationsResult

Type
Promise

getAiProductRecommendationsByIDWithHttpInfo(recommenderName, opts) → {Promise}

This is a beta feature that has been canceled. A future release will include the ability to obtain product recommendations by making direct calls to the Commerce Cloud Einstein API. Returns product recommendations based on the given product or category IDs.

Parameters:
Name Type Description
recommenderName String

The recommender name.
opts Object

Optional parameters

Properties
Name Type Description
products Array.<String>
categories Array.<String>
uuid String
expand Array.<String>
inventoryIds Array.<String>
currency String
allImages Boolean
Source:
Returns:

a Promise, with an object containing data of type module:models/ProductRecommendationsResult and HTTP response

Type
Promise