Package software.amazon.awssdk.services.personalize.model

Class RecommenderConfig

java.lang.Object
software.amazon.awssdk.services.personalize.model.RecommenderConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RecommenderConfig.Builder,RecommenderConfig>
@Generated("software.amazon.awssdk:codegen") public final class RecommenderConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RecommenderConfig.Builder,RecommenderConfig>

The configuration details of the recommender.

See Also:

  • Method Details

    • hasItemExplorationConfig

      public final boolean hasItemExplorationConfig()
      For responses, this returns true if the service returned a value for the ItemExplorationConfig property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • itemExplorationConfig

      public final Map<String,String> itemExplorationConfig()

      Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasItemExplorationConfig() method.

      Returns:
      Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).

    • minRecommendationRequestsPerSecond

      public final Integer minRecommendationRequestsPerSecond()

      Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support. A high minRecommendationRequestsPerSecond will increase your bill. We recommend starting with 1 for minRecommendationRequestsPerSecond (the default). Track your usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond as necessary.

      Returns:
      Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support. A high minRecommendationRequestsPerSecond will increase your bill. We recommend starting with 1 for minRecommendationRequestsPerSecond (the default). Track your usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond as necessary.

    • trainingDataConfig

      public final TrainingDataConfig trainingDataConfig()

      Specifies the training data configuration to use when creating a domain recommender.

      Returns:
      Specifies the training data configuration to use when creating a domain recommender.

    • enableMetadataWithRecommendations

      public final Boolean enableMetadataWithRecommendations()

      Whether metadata with recommendations is enabled for the recommender. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.

      If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

      Returns:
      Whether metadata with recommendations is enabled for the recommender. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.

      If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

    • toBuilder

      public RecommenderConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RecommenderConfig.Builder,RecommenderConfig>
      Returns:
      a builder for type T

    • builder

      public static RecommenderConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RecommenderConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.