

# PredictedItem
<a name="API_RS_PredictedItem"></a>

An object that identifies an item.

The [GetRecommendations](API_RS_GetRecommendations.md) and [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) APIs return a list of `PredictedItem`s.

## Contents
<a name="API_RS_PredictedItem_Contents"></a>

 ** itemId **   <a name="personalize-Type-RS_PredictedItem-itemId"></a>
The recommended item ID.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** metadata **   <a name="personalize-Type-RS_PredictedItem-metadata"></a>
Metadata about the item from your Items dataset.  
Type: String to string map  
Key Length Constraints: Maximum length of 150.  
Value Length Constraints: Maximum length of 20000.  
Required: No

 ** promotionName **   <a name="personalize-Type-RS_PredictedItem-promotionName"></a>
The name of the promotion that included the predicted item.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
Required: No

 ** reason **   <a name="personalize-Type-RS_PredictedItem-reason"></a>
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](https://docs.amazonaws.cn/personalize/latest/dg/use-case-recipe-features.html#about-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. 
Type: Array of strings  
Length Constraints: Maximum length of 256.  
Required: No

 ** score **   <a name="personalize-Type-RS_PredictedItem-score"></a>
A numeric representation of the model's certainty that the item will be the next user selection. For more information on scoring logic, see [Recommendation scores](getting-recommendations.md#how-scores-work).  
Type: Double  
Required: No

## See Also
<a name="API_RS_PredictedItem_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-runtime-2018-05-22/PredictedItem) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-runtime-2018-05-22/PredictedItem) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-runtime-2018-05-22/PredictedItem) 