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>', ...],
'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. For more information, see Contextual Metadata.
- inputList
-
- Required: Yes
- Type: Array of strings
A list of items (itemId's) 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>',
],
// ...
],
]
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.
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. The required input depends on the recipe type used to create the solution backing the campaign, as follows:
-
RELATED_ITEMS -
itemIdrequired,userIdnot used -
USER_PERSONALIZATION -
itemIdoptional,userIdrequired
Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the API.
Parameter Syntax
$result = $client->getRecommendations([
'campaignArn' => '<string>', // REQUIRED
'context' => ['<string>', ...],
'itemId' => '<string>',
'numResults' => <integer>,
'userId' => '<string>',
]);
Parameter Details
Members
- campaignArn
-
- Required: Yes
- 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. For more information, see Contextual Metadata.
- 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.
- userId
-
- Type: string
The user ID to provide recommendations for.
Required for
USER_PERSONALIZATIONrecipe type.
Result Syntax
[
'itemList' => [
[
'itemId' => '<string>',
],
// ...
],
]
Result Details
Members
- itemList
-
- Type: Array of PredictedItem structures
A list of recommendations sorted in ascending order by prediction score. There can be a maximum of 500 items in the list.
Errors
-
Provide a valid value for the field or parameter.
-
The specified resource does not exist.
Shapes
InvalidInputException
PredictedItem
Description
An object that identifies an item.
The and APIs return a list of PredictedItems.
