Package com.commercetools.ml.models.similar_products

Interface SimilarityMeasures

All Known Implementing Classes:
SimilarityMeasuresImpl
public interface SimilarityMeasures

Specify which ProductData attributes to use for estimating similarity and how to weigh them. An attribute's weight can be any whole positive integer, starting with 0. The larger the integer, the higher its weight.

Example to create an instance using the builder pattern 

     SimilarityMeasures similarityMeasures = SimilarityMeasures.builder()
             .build()

  • Method Details

    • getName

      Long getName()

      Importance of the name attribute in overall similarity.

      Returns:
      name

    • getDescription

      Long getDescription()

      Importance of the description attribute in overall similarity.

      Returns:
      description

    • getAttribute

      Long getAttribute()

      Importance of the description attribute in overall similarity.

      Returns:
      attribute

    • getVariantCount

      Long getVariantCount()

      Importance of the number of product variants in overall similarity.

      Returns:
      variantCount

    • getPrice

      Long getPrice()

      Importance of the price attribute in overall similarity.

      Returns:
      price

    • setName

      void setName(Long name)

      Importance of the name attribute in overall similarity.

      Parameters:
      name - value to be set

    • setDescription

      void setDescription(Long description)

      Importance of the description attribute in overall similarity.

      Parameters:
      description - value to be set

    • setAttribute

      void setAttribute(Long attribute)

      Importance of the description attribute in overall similarity.

      Parameters:
      attribute - value to be set

    • setVariantCount

      void setVariantCount(Long variantCount)

      Importance of the number of product variants in overall similarity.

      Parameters:
      variantCount - value to be set

    • setPrice

      void setPrice(Long price)

      Importance of the price attribute in overall similarity.

      Parameters:
      price - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static SimilarityMeasuresBuilder builder()
      builder factory method for SimilarityMeasures
      Returns:
      builder

    • builder

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

    • withSimilarityMeasures

      default <T> T withSimilarityMeasures(Function<SimilarityMeasures,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<SimilarityMeasures> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference