Package com.commercetools.ml.client

Class ByProjectKeyRecommendationsGeneralCategoriesGet

java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyRecommendationsGeneralCategoriesGet,GeneralCategoryRecommendationPagedQueryResponse>
com.commercetools.ml.client.ByProjectKeyRecommendationsGeneralCategoriesGet
All Implemented Interfaces:
ClientRequestCommand<GeneralCategoryRecommendationPagedQueryResponse>, CreateHttpRequestCommand, HttpRequestCommand<GeneralCategoryRecommendationPagedQueryResponse>, RequestCommand<GeneralCategoryRecommendationPagedQueryResponse>
public class ByProjectKeyRecommendationsGeneralCategoriesGet extends TypeApiMethod<ByProjectKeyRecommendationsGeneralCategoriesGet,GeneralCategoryRecommendationPagedQueryResponse>

This endpoint takes arbitrary product names or image URLs and generates recommendations from a general set of categories, which cover a broad range of industries. The full list of supported categories can be found here. These are independent of the categories that are actually defined in your project. The main purpose of this API is to provide a quick way to test the behavior of the category recommendations engine for different names and images. In contrast to the project-specific endpoint, this endpoint does not have activation criteria and is enabled for all projects.


   CompletableFuture<ApiHttpResponse<com.commercetools.ml.models.general_category_recommendations.GeneralCategoryRecommendationPagedQueryResponse>> result = apiRoot
            .withProjectKey("{projectKey}")
            .recommendations()
            .generalCategories()
            .get()
            .withProductName(productName)
            .execute()