com.commercetools.ml.models.similar_products

Interface SimilarProductSearchRequest

All Known Implementing Classes:

SimilarProductSearchRequestImpl

public interface SimilarProductSearchRequest

SimilarProductSearchRequest Example to create an instance using the builder pattern

     SimilarProductSearchRequest similarProductSearchRequest = SimilarProductSearchRequest.builder()
             .build()
 

Method Summary

Modifier and Type	Method and Description
static SimilarProductSearchRequestBuilder	builder()
static SimilarProductSearchRequestBuilder	builder(SimilarProductSearchRequest template)
Double	getConfidenceMax()
Double	getConfidenceMin()
String	getCurrencyCode() The three-digit currency code to compare prices in.
String	getLanguage() language tag used to prioritize language for text comparisons.
Long	getLimit() Number of results requested.
Long	getOffset() Number of elements skipped.
@Valid List<ProductSetSelector>	getProductSetSelectors() Array of length 2 of ProductSetSelector
@Valid SimilarityMeasures	getSimilarityMeasures() similarityMeasures defines the attributes taken into account to measure product similarity.
static SimilarProductSearchRequest	of()
static SimilarProductSearchRequest	of(SimilarProductSearchRequest template)
void	setConfidenceMax(Double confidenceMax)
void	setConfidenceMin(Double confidenceMin)
void	setCurrencyCode(String currencyCode)
void	setLanguage(String language)
void	setLimit(Long limit)
void	setOffset(Long offset)
void	setProductSetSelectors(List<ProductSetSelector> productSetSelectors)
void	setProductSetSelectors(ProductSetSelector... productSetSelectors)
void	setSimilarityMeasures(SimilarityMeasures similarityMeasures)
static com.fasterxml.jackson.core.type.TypeReference<SimilarProductSearchRequest>	typeReference()
default <T> T	withSimilarProductSearchRequest(Function<SimilarProductSearchRequest,T> helper)

Method Detail

getLimit

Long getLimit()

Number of results requested.

getOffset

Long getOffset()

Number of elements skipped.

getLanguage

String getLanguage()

language tag used to prioritize language for text comparisons.

getCurrencyCode

String getCurrencyCode()

The three-digit currency code to compare prices in. When a product has multiple prices, all prices for the product are converted to the currency provided by the currency attribute and the median price is calculated for comparison. Currencies are converted using the ECB currency exchange rates at the time the request is made. Of the currency codes, only currencies with currency exchange rates provided by the ECB are supported.

getSimilarityMeasures

@Valid
@Valid SimilarityMeasures getSimilarityMeasures()

similarityMeasures defines the attributes taken into account to measure product similarity.

getProductSetSelectors

@Valid
@Valid List<ProductSetSelector> getProductSetSelectors()

Array of length 2 of ProductSetSelector

getConfidenceMin

Double getConfidenceMin()

getConfidenceMax

Double getConfidenceMax()

setLimit

void setLimit(Long limit)

setOffset

void setOffset(Long offset)

setLanguage

void setLanguage(String language)

setCurrencyCode

void setCurrencyCode(String currencyCode)

setSimilarityMeasures

void setSimilarityMeasures(SimilarityMeasures similarityMeasures)

setProductSetSelectors

void setProductSetSelectors(ProductSetSelector... productSetSelectors)

setProductSetSelectors

void setProductSetSelectors(List<ProductSetSelector> productSetSelectors)

setConfidenceMin

void setConfidenceMin(Double confidenceMin)

setConfidenceMax

void setConfidenceMax(Double confidenceMax)

of

static SimilarProductSearchRequest of()

of

static SimilarProductSearchRequest of(SimilarProductSearchRequest template)

builder

static SimilarProductSearchRequestBuilder builder()

builder

static SimilarProductSearchRequestBuilder builder(SimilarProductSearchRequest template)

withSimilarProductSearchRequest

default <T> T withSimilarProductSearchRequest(Function<SimilarProductSearchRequest,T> helper)

typeReference

static com.fasterxml.jackson.core.type.TypeReference<SimilarProductSearchRequest> typeReference()