Interface PredictedItem.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PredictedItem.Builder,PredictedItem>, SdkBuilder<PredictedItem.Builder,PredictedItem>, SdkPojo
Enclosing class:
PredictedItem
@Mutable @NotThreadSafe public static interface PredictedItem.Builder extends SdkPojo, CopyableBuilder<PredictedItem.Builder,PredictedItem>

  • Method Details

    • itemId

      PredictedItem.Builder itemId(String itemId)

      The recommended item ID.

      Parameters:
      itemId - The recommended item ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • score

      PredictedItem.Builder score(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • promotionName

      PredictedItem.Builder promotionName(String promotionName)

      The name of the promotion that included the predicted item.

      Parameters:
      promotionName - The name of the promotion that included the predicted item.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metadata

      PredictedItem.Builder metadata(Map<String,String> metadata)

      Metadata about the item from your Items dataset.

      Parameters:
      metadata - Metadata about the item from your Items dataset.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reason

      PredictedItem.Builder reason(Collection<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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reason

      PredictedItem.Builder reason(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.