Package software.amazon.awssdk.services.personalizeruntime.model

Class PredictedItem

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

An object that identifies an item.

The and APIs return a list of PredictedItems.

See Also:

  • Method Details

    • itemId

      public final String itemId()

      The recommended item ID.

      Returns:
      The recommended item ID.

    • score

      public final Double score()

      A numeric representation of the model's certainty that the item will be the next user selection. For more information on scoring logic, see how-scores-work.

      Returns:
      A numeric representation of the model's certainty that the item will be the next user selection. For more information on scoring logic, see how-scores-work.

    • promotionName

      public final String promotionName()

      The name of the promotion that included the predicted item.

      Returns:
      The name of the promotion that included the predicted item.

    • hasMetadata

      public final boolean hasMetadata()
      For responses, this returns true if the service returned a value for the Metadata 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.

    • metadata

      public final Map<String,String> metadata()

      Metadata about the item from your Items dataset.

      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 hasMetadata() method.

      Returns:
      Metadata about the item from your Items dataset.

    • hasReason

      public final boolean hasReason()
      For responses, this returns true if the service returned a value for the Reason 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.

    • reason

      public final List<String> reason()

      If you use User-Personalization-v2, a list of reasons for why the item was included in recommendations. Possible reasons include the following:

      • Promoted item - Indicates the item was included as part of a promotion that you applied in your recommendation request.

      • Exploration - Indicates the item was included with exploration. With exploration, recommendations include items with less interactions data or relevance for the user. For more information about exploration, see Exploration.

      • Popular item - Indicates the item was included as a placeholder popular item. If you use a filter, depending on how many recommendations the filter removes, Amazon Personalize might add placeholder items to meet the numResults for your recommendation request. These items are popular items, based on interactions data, that satisfy your filter criteria. They don't have a relevance score for the user.

      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 hasReason() method.

      Returns:
      If you use User-Personalization-v2, a list of reasons for why the item was included in recommendations. Possible reasons include the following:

      • Promoted item - Indicates the item was included as part of a promotion that you applied in your recommendation request.

      • Exploration - Indicates the item was included with exploration. With exploration, recommendations include items with less interactions data or relevance for the user. For more information about exploration, see Exploration.

      • Popular item - Indicates the item was included as a placeholder popular item. If you use a filter, depending on how many recommendations the filter removes, Amazon Personalize might add placeholder items to meet the numResults for your recommendation request. These items are popular items, based on interactions data, that satisfy your filter criteria. They don't have a relevance score for the user.

    • toBuilder

      public PredictedItem.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<PredictedItem.Builder,PredictedItem>
      Returns:
      a builder for type T

    • builder

      public static PredictedItem.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PredictedItem.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.