ProductRecommendationsActions (Deprecated)

This is for:

Developer
Warning

Headless v1 has been deprecated. We recommend using the latest version of the Coveo Headless library.

The product recommendations action creators.

Loader Function

loadProductRecommendationsActions

Loads the productRecommendations reducer and returns possible action creators.

Parameters

  • engine: ProductRecommendationEngine

    The headless engine.

Returns ProductRecommendationsActionCreators: The product recommendations action creators.

ProductRecommendationsActionCreators

getProductRecommendations

Refreshes the product recommendations.

Returns AsyncThunkAction<GetProductRecommendationsThunkReturn, void, AsyncThunkSearchOptions<StateNeededByGetProductRecommendations>>: A dispatchable action.

setProductRecommendationsAdditionalFields

Updates the additional requested result fields.

Parameters

Returns PayloadAction<SetProductRecommendationsAdditionalFieldsActionCreatorPayload>: A dispatchable action.

setProductRecommendationsBrandFilter

Updates the brand used to filter recommendations.

Parameters

Returns PayloadAction<SetProductRecommendationsBrandFilterActionCreatorPayload>: A dispatchable action.

setProductRecommendationsCategoryFilter

Updates the category used to filter recommendations.

Parameters

Returns PayloadAction<SetProductRecommendationsCategoryFilterActionCreatorPayload>: A dispatchable action.

setProductRecommendationsMaxNumberOfRecommendations

Updates the maximum number of recommendations to return.

Parameters

Returns PayloadAction<SetProductRecommendationsMaxNumberOfRecommendationsActionCreatorPayload>: A dispatchable action.

setProductRecommendationsRecommenderId

Updates the recommender id, used to determine the machine-learning model that should fulfill the request.

Parameters

Returns PayloadAction<SetProductRecommendationsRecommenderIdActionCreatorPayload>: A dispatchable action.

setProductRecommendationsSkus

Updates the skus for which to retrieve recommendations.

Parameters

Returns PayloadAction<SetProductRecommendationsSkusActionCreatorPayload>: A dispatchable action.

SetProductRecommendationsAdditionalFieldsActionCreatorPayload

Properties

  • additionalFields: string[]

    The additional result fields to request.

SetProductRecommendationsBrandFilterActionCreatorPayload

Properties

  • brand: string

    The brand to filter recommendations by.

SetProductRecommendationsCategoryFilterActionCreatorPayload

Properties

  • category: string

    The category to filter recommendations by.

SetProductRecommendationsMaxNumberOfRecommendationsActionCreatorPayload

Properties

  • number: number

    The maximum number of recommendations to return.

SetProductRecommendationsRecommenderIdActionCreatorPayload

Properties

  • id: string

    The recommender id, used to determine the machine-learning model that should fulfill the request.

SetProductRecommendationsSkusActionCreatorPayload

Properties

  • skus: string[]

    The skus to retrieve recommendations for.