Package com.commercetools.ml.models.category_recommendations

Interface ProjectCategoryRecommendation

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 Details

    • getCategory

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

      A category that is recommended for a product.

      Returns:
      category

    • getConfidence

      @NotNull @NotNull Double getConfidence()

      Probability score for the category recommendation.

      Returns:
      confidence

    • 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.

      Returns:
      path

    • setCategory

      void setCategory(CategoryReference category)

      A category that is recommended for a product.

      Parameters:
      category - value to be set

    • setConfidence

      void setConfidence(Double confidence)

      Probability score for the category recommendation.

      Parameters:
      confidence - value to be set

    • setPath

      void setPath(String path)

      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.

      Parameters:
      path - value to be set

    • of

      static ProjectCategoryRecommendation of()
      factory method
      Returns:
      instance of ProjectCategoryRecommendation

    • of

      static ProjectCategoryRecommendation of(ProjectCategoryRecommendation template)
      factory method to create a shallow copy ProjectCategoryRecommendation
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static ProjectCategoryRecommendation deepCopy(@Nullable ProjectCategoryRecommendation template)
      factory method to create a deep copy of ProjectCategoryRecommendation
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static ProjectCategoryRecommendationBuilder builder()
      builder factory method for ProjectCategoryRecommendation
      Returns:
      builder

    • builder

      static ProjectCategoryRecommendationBuilder builder(ProjectCategoryRecommendation template)
      create builder for ProjectCategoryRecommendation instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withProjectCategoryRecommendation

      default <T> T withProjectCategoryRecommendation(Function<ProjectCategoryRecommendation,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<ProjectCategoryRecommendation> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference