Amazon Personalize Runtime 2018-05-22
- Client: Aws\PersonalizeRuntime\PersonalizeRuntimeClient
- Service ID: personalize-runtime
- Version: 2018-05-22
This page describes the parameters and results for the operations of the Amazon Personalize Runtime (2018-05-22), and shows how to use the Aws\PersonalizeRuntime\PersonalizeRuntimeClient object to call the described operations. This documentation is specific to the 2018-05-22 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- GetPersonalizedRanking ( array $params = [] )
Re-ranks a list of recommended items for the given user.
- GetRecommendations ( array $params = [] )
Returns a list of recommended items.
Operations
GetPersonalizedRanking
$result = $client->getPersonalizedRanking([/* ... */]); $promise = $client->getPersonalizedRankingAsync([/* ... */]);
Re-ranks a list of recommended items for the given user. The first item in the list is deemed the most likely item to be of interest to the user.
The solution backing the campaign must have been created using a recipe of type PERSONALIZED_RANKING.
Parameter Syntax
$result = $client->getPersonalizedRanking([
'campaignArn' => '<string>', // REQUIRED
'context' => ['<string>', ...],
'filterArn' => '<string>',
'filterValues' => ['<string>', ...],
'inputList' => ['<string>', ...], // REQUIRED
'userId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- campaignArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.
- context
-
- Type: Associative array of custom strings keys (AttributeName) to strings
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
-
- Type: string
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
-
- Type: Associative array of custom strings keys (FilterAttributeName) to strings
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
INCLUDEelement to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use anEXCLUDEelement to exclude items, you can omit thefilter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.For more information, see Filtering Recommendations.
- inputList
-
- Required: Yes
- Type: Array of strings
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. The maximum is 500. - userId
-
- Required: Yes
- Type: string
The user for which you want the campaign to provide a personalized ranking.
Result Syntax
[
'personalizedRanking' => [
[
'itemId' => '<string>',
'promotionName' => '<string>',
'score' => <float>,
],
// ...
],
'recommendationId' => '<string>',
]
Result Details
Members
- personalizedRanking
-
- Type: Array of PredictedItem structures
A list of items in order of most likely interest to the user. The maximum is 500.
- recommendationId
-
- Type: string
The ID of the recommendation.
Errors
-
Provide a valid value for the field or parameter.
-
The specified resource does not exist.
GetRecommendations
$result = $client->getRecommendations([/* ... */]); $promise = $client->getRecommendationsAsync([/* ... */]);
Returns a list of recommended items. For campaigns, the campaign's Amazon Resource Name (ARN) is required and the required user and item input depends on the recipe type used to create the solution backing the campaign as follows:
-
USER_PERSONALIZATION -
userIdrequired,itemIdnot used -
RELATED_ITEMS -
itemIdrequired,userIdnot used
Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the API.
For recommenders, the recommender's ARN is required and the required item and user input depends on the use case (domain-based recipe) backing the recommender. For information on use case requirements see Choosing recommender use cases.
Parameter Syntax
$result = $client->getRecommendations([
'campaignArn' => '<string>',
'context' => ['<string>', ...],
'filterArn' => '<string>',
'filterValues' => ['<string>', ...],
'itemId' => '<string>',
'numResults' => <integer>,
'promotions' => [
[
'filterArn' => '<string>',
'filterValues' => ['<string>', ...],
'name' => '<string>',
'percentPromotedItems' => <integer>,
],
// ...
],
'recommenderArn' => '<string>',
'userId' => '<string>',
]);
Parameter Details
Members
- campaignArn
-
- Type: string
The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
- context
-
- Type: Associative array of custom strings keys (AttributeName) to strings
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
-
- Type: string
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
-
- Type: Associative array of custom strings keys (FilterAttributeName) to strings
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
INCLUDEelement to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use anEXCLUDEelement to exclude items, you can omit thefilter-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.
- itemId
-
- Type: string
The item ID to provide recommendations for.
Required for
RELATED_ITEMSrecipe type. - numResults
-
- Type: int
The number of results to return. The default is 25. The maximum is 500.
- promotions
-
- Type: Array of Promotion structures
The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.
- recommenderArn
-
- Type: string
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.
- userId
-
- Type: string
The user ID to provide recommendations for.
Required for
USER_PERSONALIZATIONrecipe type.
Result Syntax
[
'itemList' => [
[
'itemId' => '<string>',
'promotionName' => '<string>',
'score' => <float>,
],
// ...
],
'recommendationId' => '<string>',
]
Result Details
Members
- itemList
-
- Type: Array of PredictedItem structures
A list of recommendations sorted in descending order by prediction score. There can be a maximum of 500 items in the list.
- recommendationId
-
- Type: string
The ID of the recommendation.
Errors
-
Provide a valid value for the field or parameter.
-
The specified resource does not exist.
Shapes
InvalidInputException
Description
Provide a valid value for the field or parameter.
Members
- message
-
- Type: string
PredictedItem
Description
An object that identifies an item.
The and APIs return a list of PredictedItems.
Members
- itemId
-
- Type: string
The recommended item ID.
- promotionName
-
- Type: string
The name of the promotion that included the predicted item.
- score
-
- Type: double
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.
Promotion
Description
Contains information on a promotion. A promotion defines additional business rules that apply to a configurable subset of recommended items.
Members
- filterArn
-
- Type: string
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
-
- Type: Associative array of custom strings keys (FilterAttributeName) to strings
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
INCLUDEelement to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use anEXCLUDEelement to exclude items, you can omit thefilter-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.
- name
-
- Type: string
The name of the promotion.
- percentPromotedItems
-
- Type: int
The percentage of recommended items to apply the promotion to.
ResourceNotFoundException
Description
The specified resource does not exist.
Members
- message
-
- Type: string