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.ClientRequestCommand<GeneralCategoryRecommendationPagedQueryResponse>, 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.

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

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
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	addConfidenceMax(Collection<TValue> confidenceMax) add additional confidenceMax query parameters
ByProjectKeyRecommendationsGeneralCategoriesGet	addConfidenceMax(Function<StringBuilder,StringBuilder> op) add additional confidenceMax query parameter
ByProjectKeyRecommendationsGeneralCategoriesGet	addConfidenceMax(Supplier<Double> supplier) add additional confidenceMax query parameter
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	addConfidenceMax(TValue confidenceMax) add additional confidenceMax query parameter
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	addConfidenceMin(Collection<TValue> confidenceMin) add additional confidenceMin query parameters
ByProjectKeyRecommendationsGeneralCategoriesGet	addConfidenceMin(Function<StringBuilder,StringBuilder> op) add additional confidenceMin query parameter
ByProjectKeyRecommendationsGeneralCategoriesGet	addConfidenceMin(Supplier<Double> supplier) add additional confidenceMin query parameter
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	addConfidenceMin(TValue confidenceMin) add additional confidenceMin query parameter
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	addLimit(Collection<TValue> limit) add additional limit query parameters
ByProjectKeyRecommendationsGeneralCategoriesGet	addLimit(Function<StringBuilder,StringBuilder> op) add additional limit query parameter
ByProjectKeyRecommendationsGeneralCategoriesGet	addLimit(Supplier<Integer> supplier) add additional limit query parameter
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	addLimit(TValue limit) add additional limit query parameter
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	addOffset(Collection<TValue> offset) add additional offset query parameters
ByProjectKeyRecommendationsGeneralCategoriesGet	addOffset(Function<StringBuilder,StringBuilder> op) add additional offset query parameter
ByProjectKeyRecommendationsGeneralCategoriesGet	addOffset(Supplier<Integer> supplier) add additional offset query parameter
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	addOffset(TValue offset) add additional offset query parameter
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	addProductImageUrl(Collection<TValue> productImageUrl) add additional productImageUrl query parameters
ByProjectKeyRecommendationsGeneralCategoriesGet	addProductImageUrl(Function<StringBuilder,StringBuilder> op) add additional productImageUrl query parameter
ByProjectKeyRecommendationsGeneralCategoriesGet	addProductImageUrl(Supplier<String> supplier) add additional productImageUrl query parameter
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	addProductImageUrl(TValue productImageUrl) add additional productImageUrl query parameter
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	addProductName(Collection<TValue> productName) add additional productName query parameters
ByProjectKeyRecommendationsGeneralCategoriesGet	addProductName(Function<StringBuilder,StringBuilder> op) add additional productName query parameter
ByProjectKeyRecommendationsGeneralCategoriesGet	addProductName(Supplier<String> supplier) add additional productName query parameter
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	addProductName(TValue productName) add additional productName query parameter
boolean	equals(Object o)
CompletableFuture<io.vrap.rmf.base.client.ApiHttpResponse<GeneralCategoryRecommendationPagedQueryResponse>>	execute(io.vrap.rmf.base.client.ApiHttpClient client)
io.vrap.rmf.base.client.ApiHttpResponse<GeneralCategoryRecommendationPagedQueryResponse>	executeBlocking(io.vrap.rmf.base.client.ApiHttpClient client, Duration timeout)
List<String>	getConfidenceMax()
List<String>	getConfidenceMin()
List<String>	getLimit()
List<String>	getOffset()
List<String>	getProductImageUrl()
List<String>	getProductName()
String	getProjectKey()
int	hashCode()
void	setProjectKey(String projectKey)
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	withConfidenceMax(Collection<TValue> confidenceMax) set confidenceMax with the specified values
ByProjectKeyRecommendationsGeneralCategoriesGet	withConfidenceMax(Function<StringBuilder,StringBuilder> op) set confidenceMax with the specified value
ByProjectKeyRecommendationsGeneralCategoriesGet	withConfidenceMax(Supplier<Double> supplier) set confidenceMax with the specified value
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	withConfidenceMax(TValue confidenceMax) set confidenceMax with the specified value
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	withConfidenceMin(Collection<TValue> confidenceMin) set confidenceMin with the specified values
ByProjectKeyRecommendationsGeneralCategoriesGet	withConfidenceMin(Function<StringBuilder,StringBuilder> op) set confidenceMin with the specified value
ByProjectKeyRecommendationsGeneralCategoriesGet	withConfidenceMin(Supplier<Double> supplier) set confidenceMin with the specified value
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	withConfidenceMin(TValue confidenceMin) set confidenceMin with the specified value
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	withLimit(Collection<TValue> limit) set limit with the specified values
ByProjectKeyRecommendationsGeneralCategoriesGet	withLimit(Function<StringBuilder,StringBuilder> op) set limit with the specified value
ByProjectKeyRecommendationsGeneralCategoriesGet	withLimit(Supplier<Integer> supplier) set limit with the specified value
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	withLimit(TValue limit) set limit with the specified value
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	withOffset(Collection<TValue> offset) set offset with the specified values
ByProjectKeyRecommendationsGeneralCategoriesGet	withOffset(Function<StringBuilder,StringBuilder> op) set offset with the specified value
ByProjectKeyRecommendationsGeneralCategoriesGet	withOffset(Supplier<Integer> supplier) set offset with the specified value
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	withOffset(TValue offset) set offset with the specified value
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	withProductImageUrl(Collection<TValue> productImageUrl) set productImageUrl with the specified values
ByProjectKeyRecommendationsGeneralCategoriesGet	withProductImageUrl(Function<StringBuilder,StringBuilder> op) set productImageUrl with the specified value
ByProjectKeyRecommendationsGeneralCategoriesGet	withProductImageUrl(Supplier<String> supplier) set productImageUrl with the specified value
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	withProductImageUrl(TValue productImageUrl) set productImageUrl with the specified value
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	withProductName(Collection<TValue> productName) set productName with the specified values
ByProjectKeyRecommendationsGeneralCategoriesGet	withProductName(Function<StringBuilder,StringBuilder> op) set productName with the specified value
ByProjectKeyRecommendationsGeneralCategoriesGet	withProductName(Supplier<String> supplier) set productName with the specified value
<TValue> ByProjectKeyRecommendationsGeneralCategoriesGet	withProductName(TValue productName) set productName with the specified value

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

addHeader, addQueryParam, addQueryParams, contentType, createHttpRequest, execute, execute, execute, execute, execute, execute, execute, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, getFirstQueryParam, getHeaders, getQueryParam, getQueryParams, getQueryParamUriString, getQueryParamUriStrings, send, sendBlocking, sendBlocking, with, with, withHeader, withHeaders, withHttpRequest, withoutHeader, withoutQueryParam, withQueryParam, withQueryParams

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ByProjectKeyRecommendationsGeneralCategoriesGet

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

ByProjectKeyRecommendationsGeneralCategoriesGet

public ByProjectKeyRecommendationsGeneralCategoriesGet(ByProjectKeyRecommendationsGeneralCategoriesGet t)

Method Detail

executeBlocking

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

Specified by:

executeBlocking in interface io.vrap.rmf.base.client.ClientRequestCommand<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(io.vrap.rmf.base.client.ApiHttpClient client)

Specified by:

execute in interface io.vrap.rmf.base.client.ClientRequestCommand<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 <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet withProductImageUrl(TValue productImageUrl)

set productImageUrl with the specified value

addProductImageUrl

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet addProductImageUrl(TValue productImageUrl)

add additional productImageUrl query parameter

withProductImageUrl

public ByProjectKeyRecommendationsGeneralCategoriesGet withProductImageUrl(Supplier<String> supplier)

set productImageUrl with the specified value

addProductImageUrl

public ByProjectKeyRecommendationsGeneralCategoriesGet addProductImageUrl(Supplier<String> supplier)

add additional productImageUrl query parameter

withProductImageUrl

public ByProjectKeyRecommendationsGeneralCategoriesGet withProductImageUrl(Function<StringBuilder,StringBuilder> op)

set productImageUrl with the specified value

addProductImageUrl

public ByProjectKeyRecommendationsGeneralCategoriesGet addProductImageUrl(Function<StringBuilder,StringBuilder> op)

add additional productImageUrl query parameter

withProductImageUrl

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet withProductImageUrl(Collection<TValue> productImageUrl)

set productImageUrl with the specified values

addProductImageUrl

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet addProductImageUrl(Collection<TValue> productImageUrl)

add additional productImageUrl query parameters

withProductName

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet withProductName(TValue productName)

set productName with the specified value

addProductName

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet addProductName(TValue productName)

add additional productName query parameter

withProductName

public ByProjectKeyRecommendationsGeneralCategoriesGet withProductName(Supplier<String> supplier)

set productName with the specified value

addProductName

public ByProjectKeyRecommendationsGeneralCategoriesGet addProductName(Supplier<String> supplier)

add additional productName query parameter

withProductName

public ByProjectKeyRecommendationsGeneralCategoriesGet withProductName(Function<StringBuilder,StringBuilder> op)

set productName with the specified value

addProductName

public ByProjectKeyRecommendationsGeneralCategoriesGet addProductName(Function<StringBuilder,StringBuilder> op)

add additional productName query parameter

withProductName

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet withProductName(Collection<TValue> productName)

set productName with the specified values

addProductName

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet addProductName(Collection<TValue> productName)

add additional productName query parameters

withLimit

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet withLimit(TValue limit)

set limit with the specified value

addLimit

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet addLimit(TValue limit)

add additional limit query parameter

withLimit

public ByProjectKeyRecommendationsGeneralCategoriesGet withLimit(Supplier<Integer> supplier)

set limit with the specified value

addLimit

public ByProjectKeyRecommendationsGeneralCategoriesGet addLimit(Supplier<Integer> supplier)

add additional limit query parameter

withLimit

public ByProjectKeyRecommendationsGeneralCategoriesGet withLimit(Function<StringBuilder,StringBuilder> op)

set limit with the specified value

addLimit

public ByProjectKeyRecommendationsGeneralCategoriesGet addLimit(Function<StringBuilder,StringBuilder> op)

add additional limit query parameter

withLimit

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet withLimit(Collection<TValue> limit)

set limit with the specified values

addLimit

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet addLimit(Collection<TValue> limit)

add additional limit query parameters

withOffset

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet withOffset(TValue offset)

set offset with the specified value

addOffset

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet addOffset(TValue offset)

add additional offset query parameter

withOffset

public ByProjectKeyRecommendationsGeneralCategoriesGet withOffset(Supplier<Integer> supplier)

set offset with the specified value

addOffset

public ByProjectKeyRecommendationsGeneralCategoriesGet addOffset(Supplier<Integer> supplier)

add additional offset query parameter

withOffset

public ByProjectKeyRecommendationsGeneralCategoriesGet withOffset(Function<StringBuilder,StringBuilder> op)

set offset with the specified value

addOffset

public ByProjectKeyRecommendationsGeneralCategoriesGet addOffset(Function<StringBuilder,StringBuilder> op)

add additional offset query parameter

withOffset

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet withOffset(Collection<TValue> offset)

set offset with the specified values

addOffset

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet addOffset(Collection<TValue> offset)

add additional offset query parameters

withConfidenceMin

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet withConfidenceMin(TValue confidenceMin)

set confidenceMin with the specified value

addConfidenceMin

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet addConfidenceMin(TValue confidenceMin)

add additional confidenceMin query parameter

withConfidenceMin

public ByProjectKeyRecommendationsGeneralCategoriesGet withConfidenceMin(Supplier<Double> supplier)

set confidenceMin with the specified value

addConfidenceMin

public ByProjectKeyRecommendationsGeneralCategoriesGet addConfidenceMin(Supplier<Double> supplier)

add additional confidenceMin query parameter

withConfidenceMin

public ByProjectKeyRecommendationsGeneralCategoriesGet withConfidenceMin(Function<StringBuilder,StringBuilder> op)

set confidenceMin with the specified value

addConfidenceMin

public ByProjectKeyRecommendationsGeneralCategoriesGet addConfidenceMin(Function<StringBuilder,StringBuilder> op)

add additional confidenceMin query parameter

withConfidenceMin

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet withConfidenceMin(Collection<TValue> confidenceMin)

set confidenceMin with the specified values

addConfidenceMin

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet addConfidenceMin(Collection<TValue> confidenceMin)

add additional confidenceMin query parameters

withConfidenceMax

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet withConfidenceMax(TValue confidenceMax)

set confidenceMax with the specified value

addConfidenceMax

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet addConfidenceMax(TValue confidenceMax)

add additional confidenceMax query parameter

withConfidenceMax

public ByProjectKeyRecommendationsGeneralCategoriesGet withConfidenceMax(Supplier<Double> supplier)

set confidenceMax with the specified value

addConfidenceMax

public ByProjectKeyRecommendationsGeneralCategoriesGet addConfidenceMax(Supplier<Double> supplier)

add additional confidenceMax query parameter

withConfidenceMax

public ByProjectKeyRecommendationsGeneralCategoriesGet withConfidenceMax(Function<StringBuilder,StringBuilder> op)

set confidenceMax with the specified value

addConfidenceMax

public ByProjectKeyRecommendationsGeneralCategoriesGet addConfidenceMax(Function<StringBuilder,StringBuilder> op)

add additional confidenceMax query parameter

withConfidenceMax

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet withConfidenceMax(Collection<TValue> confidenceMax)

set confidenceMax with the specified values

addConfidenceMax

public <TValue> ByProjectKeyRecommendationsGeneralCategoriesGet addConfidenceMax(Collection<TValue> confidenceMax)

add additional confidenceMax query parameters

equals

public boolean equals(Object o)

hashCode

public int hashCode()