Serialized Form

Package com.amazonaws.services.personalizeruntime.model

Class com.amazonaws.services.personalizeruntime.model.AmazonPersonalizeRuntimeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.personalizeruntime.model.GetActionRecommendationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

campaignArn

String campaignArn

The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations. This campaign must deploy a solution version trained with a PERSONALIZED_ACTIONS recipe.

userId

String userId

The user ID of the user to provide action recommendations for.

numResults

Integer numResults

The number of results to return. The default is 5. The maximum is 100.

filterArn

String filterArn

The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.

When using this parameter, be sure the filter resource is ACTIVE.

filterValues

Map<K,V> filterValues

The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

For filter expressions that use an INCLUDE element to include actions, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude actions, you can omit the filter-values. In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.

For more information, see Filtering recommendations and user segments.

Class com.amazonaws.services.personalizeruntime.model.GetActionRecommendationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

actionList

List<E> actionList

A list of action recommendations sorted in descending order by prediction score. There can be a maximum of 100 actions in the list. For information about action scores, see How action recommendation scoring works.

recommendationId

String recommendationId

The ID of the recommendation.

Class com.amazonaws.services.personalizeruntime.model.GetPersonalizedRankingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

campaignArn

String campaignArn

The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.

inputList

List<E> inputList

A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

userId

String userId

The user for which you want the campaign to provide a personalized ranking.

context

Map<K,V> context

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

filterArn

String filterArn

The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user. For more information, see Filtering Recommendations.

filterValues

Map<K,V> filterValues

The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.

For more information, see Filtering Recommendations.

metadataColumns

Map<K,V> metadataColumns

If you enabled metadata in recommendations when you created or updated the campaign, specify metadata columns from your Items dataset to include in the personalized ranking. The map key is ITEMS and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.

For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.

Class com.amazonaws.services.personalizeruntime.model.GetPersonalizedRankingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

personalizedRanking

List<E> personalizedRanking

A list of items in order of most likely interest to the user. The maximum is 500.

recommendationId

String recommendationId

The ID of the recommendation.

Class com.amazonaws.services.personalizeruntime.model.GetRecommendationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

campaignArn

String campaignArn

The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

itemId

String itemId

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

userId

String userId

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

numResults

Integer numResults

The number of results to return. The default is 25. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

context

Map<K,V> context

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

filterArn

String filterArn

The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.

When using this parameter, be sure the filter resource is ACTIVE.

filterValues

Map<K,V> filterValues

The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.

For more information, see Filtering recommendations and user segments.

recommenderArn

String recommenderArn

The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.

promotions

List<E> promotions

The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.

metadataColumns

Map<K,V> metadataColumns

If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations. The map key is ITEMS and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.

For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a recommender.

Class com.amazonaws.services.personalizeruntime.model.GetRecommendationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

itemList

List<E> itemList

A list of recommendations sorted in descending order by prediction score. There can be a maximum of 500 items in the list.

recommendationId

String recommendationId

The ID of the recommendation.

Class com.amazonaws.services.personalizeruntime.model.InvalidInputException extends AmazonPersonalizeRuntimeException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.personalizeruntime.model.PredictedAction extends Object implements Serializable

Serialized Fields

actionId

String actionId

The ID of the recommended action.

score

Double score

The score of the recommended action. For information about action scores, see How action recommendation scoring works.

Class com.amazonaws.services.personalizeruntime.model.PredictedItem extends Object implements Serializable

Serialized Fields

itemId

String itemId

The recommended item ID.

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.

promotionName

String promotionName

The name of the promotion that included the predicted item.

metadata

Map<K,V> metadata

Metadata about the item from your Items dataset.

reason

List<E> 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.

Class com.amazonaws.services.personalizeruntime.model.Promotion extends Object implements Serializable

Serialized Fields

name

String name

The name of the promotion.

percentPromotedItems

Integer percentPromotedItems

The percentage of recommended items to apply the promotion to.

filterArn

String filterArn

The Amazon Resource Name (ARN) of the filter used by the promotion. This filter defines the criteria for promoted items. For more information, see Promotion filters.

filterValues

Map<K,V> filterValues

The values to use when promoting items. For each placeholder parameter in your promotion's filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values. In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.

For more information on creating filters, see Filtering recommendations and user segments.

Class com.amazonaws.services.personalizeruntime.model.ResourceNotFoundException extends AmazonPersonalizeRuntimeException implements Serializable

serialVersionUID:

1L