com.commercetools.ml.client

Class ByProjectKeyRecommendationsGeneralCategoriesGet

java.lang.Object

io.vrap.rmf.base.client.ApiMethod<ByProjectKeyRecommendationsGeneralCategoriesGet,GeneralCategoryRecommendationPagedQueryResponse>

com.commercetools.ml.client.ByProjectKeyRecommendationsGeneralCategoriesGet

All Implemented Interfaces:

io.vrap.rmf.base.client.RequestCommand<GeneralCategoryRecommendationPagedQueryResponse>

public class ByProjectKeyRecommendationsGeneralCategoriesGet
extends io.vrap.rmf.base.client.ApiMethod<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.

Nested Class Summary

Nested classes/interfaces inherited from class io.vrap.rmf.base.client.ApiMethod

io.vrap.rmf.base.client.ApiMethod.ParamEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
ByProjectKeyRecommendationsGeneralCategoriesGet(io.vrap.rmf.base.client.ApiHttpClient apiHttpClient, String projectKey)
ByProjectKeyRecommendationsGeneralCategoriesGet(ByProjectKeyRecommendationsGeneralCategoriesGet t)

Method Summary

Modifier and Type	Method and Description
ByProjectKeyRecommendationsGeneralCategoriesGet	addConfidenceMax(Double confidenceMax)
ByProjectKeyRecommendationsGeneralCategoriesGet	addConfidenceMin(Double confidenceMin)
ByProjectKeyRecommendationsGeneralCategoriesGet	addLimit(Integer limit)
ByProjectKeyRecommendationsGeneralCategoriesGet	addOffset(Integer offset)
ByProjectKeyRecommendationsGeneralCategoriesGet	addProductImageUrl(String productImageUrl)
ByProjectKeyRecommendationsGeneralCategoriesGet	addProductName(String productName)
io.vrap.rmf.base.client.ApiHttpRequest	createHttpRequest()
CompletableFuture<io.vrap.rmf.base.client.ApiHttpResponse<GeneralCategoryRecommendationPagedQueryResponse>>	execute()
io.vrap.rmf.base.client.ApiHttpResponse<GeneralCategoryRecommendationPagedQueryResponse>	executeBlocking(Duration timeout)
List<String>	getConfidenceMax()
List<String>	getConfidenceMin()
List<String>	getLimit()
List<String>	getOffset()
List<String>	getProductImageUrl()
List<String>	getProductName()
String	getProjectKey()
void	setProjectKey(String projectKey)
ByProjectKeyRecommendationsGeneralCategoriesGet	withConfidenceMax(Double confidenceMax)
ByProjectKeyRecommendationsGeneralCategoriesGet	withConfidenceMin(Double confidenceMin)
ByProjectKeyRecommendationsGeneralCategoriesGet	withLimit(Integer limit)
ByProjectKeyRecommendationsGeneralCategoriesGet	withOffset(Integer offset)
ByProjectKeyRecommendationsGeneralCategoriesGet	withProductImageUrl(String productImageUrl)
ByProjectKeyRecommendationsGeneralCategoriesGet	withProductName(String productName)

Methods inherited from class io.vrap.rmf.base.client.ApiMethod

addHeader, addQueryParam, executeBlocking, getFirstQueryParam, getHeaders, getQueryParam, getQueryParams, getQueryParamUriStrings, send, sendBlocking, sendBlocking, withHeader, withHeaders, withoutHeader, withoutQueryParam, withQueryParam, withQueryParams

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ByProjectKeyRecommendationsGeneralCategoriesGet

public ByProjectKeyRecommendationsGeneralCategoriesGet(io.vrap.rmf.base.client.ApiHttpClient apiHttpClient,
                                                       String projectKey)

ByProjectKeyRecommendationsGeneralCategoriesGet

public ByProjectKeyRecommendationsGeneralCategoriesGet(ByProjectKeyRecommendationsGeneralCategoriesGet t)

Method Detail

createHttpRequest

public io.vrap.rmf.base.client.ApiHttpRequest createHttpRequest()

Specified by:

createHttpRequest in class io.vrap.rmf.base.client.ApiMethod<ByProjectKeyRecommendationsGeneralCategoriesGet,GeneralCategoryRecommendationPagedQueryResponse>

executeBlocking

public io.vrap.rmf.base.client.ApiHttpResponse<GeneralCategoryRecommendationPagedQueryResponse> executeBlocking(Duration timeout)

Specified by:

executeBlocking in interface io.vrap.rmf.base.client.RequestCommand<GeneralCategoryRecommendationPagedQueryResponse>

Specified by:

executeBlocking in class io.vrap.rmf.base.client.ApiMethod<ByProjectKeyRecommendationsGeneralCategoriesGet,GeneralCategoryRecommendationPagedQueryResponse>

execute

public CompletableFuture<io.vrap.rmf.base.client.ApiHttpResponse<GeneralCategoryRecommendationPagedQueryResponse>> execute()

Specified by:

execute in interface io.vrap.rmf.base.client.RequestCommand<GeneralCategoryRecommendationPagedQueryResponse>

Specified by:

execute in class io.vrap.rmf.base.client.ApiMethod<ByProjectKeyRecommendationsGeneralCategoriesGet,GeneralCategoryRecommendationPagedQueryResponse>

getProjectKey

public String getProjectKey()

getProductImageUrl

public List<String> getProductImageUrl()

getProductName

public List<String> getProductName()

getLimit

public List<String> getLimit()

getOffset

public List<String> getOffset()

getConfidenceMin

public List<String> getConfidenceMin()

getConfidenceMax

public List<String> getConfidenceMax()

setProjectKey

public void setProjectKey(String projectKey)

withProductImageUrl

public ByProjectKeyRecommendationsGeneralCategoriesGet withProductImageUrl(String productImageUrl)

addProductImageUrl

public ByProjectKeyRecommendationsGeneralCategoriesGet addProductImageUrl(String productImageUrl)

withProductName

public ByProjectKeyRecommendationsGeneralCategoriesGet withProductName(String productName)

addProductName

public ByProjectKeyRecommendationsGeneralCategoriesGet addProductName(String productName)

withLimit

public ByProjectKeyRecommendationsGeneralCategoriesGet withLimit(Integer limit)

addLimit

public ByProjectKeyRecommendationsGeneralCategoriesGet addLimit(Integer limit)

withOffset

public ByProjectKeyRecommendationsGeneralCategoriesGet withOffset(Integer offset)

addOffset

public ByProjectKeyRecommendationsGeneralCategoriesGet addOffset(Integer offset)

withConfidenceMin

public ByProjectKeyRecommendationsGeneralCategoriesGet withConfidenceMin(Double confidenceMin)

addConfidenceMin

public ByProjectKeyRecommendationsGeneralCategoriesGet addConfidenceMin(Double confidenceMin)

withConfidenceMax

public ByProjectKeyRecommendationsGeneralCategoriesGet withConfidenceMax(Double confidenceMax)

addConfidenceMax

public ByProjectKeyRecommendationsGeneralCategoriesGet addConfidenceMax(Double confidenceMax)