com.commercetools.ml.models.category_recommendations

Interface ProjectCategoryRecommendation

All Known Implementing Classes:

ProjectCategoryRecommendationImpl

public interface ProjectCategoryRecommendation

ProjectCategoryRecommendation Example to create an instance using the builder pattern

     ProjectCategoryRecommendation projectCategoryRecommendation = ProjectCategoryRecommendation.builder()
             .category(categoryBuilder -> categoryBuilder)
             .confidence(0.3)
             .path("{path}")
             .build()
 

Method Summary

Modifier and Type	Method and Description
static ProjectCategoryRecommendationBuilder	builder()
static ProjectCategoryRecommendationBuilder	builder(ProjectCategoryRecommendation template)
@NotNull @Valid CategoryReference	getCategory() A category that is recommended for a product.
@NotNull Double	getConfidence() Probability score for the category recommendation.
@NotNull String	getPath() Breadcrumb path to the recommended category.
static ProjectCategoryRecommendation	of()
static ProjectCategoryRecommendation	of(ProjectCategoryRecommendation template)
void	setCategory(CategoryReference category)
void	setConfidence(Double confidence)
void	setPath(String path)
static com.fasterxml.jackson.core.type.TypeReference<ProjectCategoryRecommendation>	typeReference()
default <T> T	withProjectCategoryRecommendation(Function<ProjectCategoryRecommendation,T> helper)

Method Detail

getCategory

@NotNull
 @Valid
@NotNull @Valid CategoryReference getCategory()

A category that is recommended for a product.

getConfidence

@NotNull
@NotNull Double getConfidence()

Probability score for the category recommendation.

getPath

@NotNull
@NotNull String getPath()

Breadcrumb path to the recommended category. This only picks up one language, not all available languages for the category. English is prioritized, but if English data is not available, an arbitrary language is selected. Do not use this to identify a category,use the category ID from the category reference instead.

setCategory

void setCategory(CategoryReference category)

setConfidence

void setConfidence(Double confidence)

setPath

void setPath(String path)

of

static ProjectCategoryRecommendation of()

of

static ProjectCategoryRecommendation of(ProjectCategoryRecommendation template)

builder

static ProjectCategoryRecommendationBuilder builder()

builder

static ProjectCategoryRecommendationBuilder builder(ProjectCategoryRecommendation template)

withProjectCategoryRecommendation

default <T> T withProjectCategoryRecommendation(Function<ProjectCategoryRecommendation,T> helper)

typeReference

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