Table of Contents
A low-level client representing Amazon Personalize Runtime:
client = session.create_client('personalize-runtime')
These are the available methods:
Check if an operation can be paginated.
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
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.
Note
The solution backing the campaign must have been created using a recipe of type PERSONALIZED_RANKING.
See also: AWS API Documentation
Request Syntax
response = client.get_personalized_ranking(
campaignArn='string',
inputList=[
'string',
],
userId='string',
context={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.
[REQUIRED]
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.
[REQUIRED]
The user for which you want the campaign to provide a personalized ranking.
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.
dict
Response Syntax
{
'personalizedRanking': [
{
'itemId': 'string',
'score': 123.0
},
]
}
Response Structure
(dict) --
personalizedRanking (list) --
A list of items in order of most likely interest to the user. The maximum is 500.
(dict) --
An object that identifies an item.
The and APIs return a list of PredictedItem s.
itemId (string) --
The recommended item ID.
score (float) --
A numeric representation of the model's certainty in the item's suitability. For more information on scoring logic, see how-scores-work .
Exceptions
Returns a list of recommended items. The required input depends on the recipe type used to create the solution backing the campaign, as follows:
Note
Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the API.
See also: AWS API Documentation
Request Syntax
response = client.get_recommendations(
campaignArn='string',
itemId='string',
userId='string',
numResults=123,
context={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
The item ID to provide recommendations for.
Required for RELATED_ITEMS recipe type.
The user ID to provide recommendations for.
Required for USER_PERSONALIZATION recipe type.
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.
dict
Response Syntax
{
'itemList': [
{
'itemId': 'string',
'score': 123.0
},
]
}
Response Structure
(dict) --
itemList (list) --
A list of recommendations sorted in ascending order by prediction score. There can be a maximum of 500 items in the list.
(dict) --
An object that identifies an item.
The and APIs return a list of PredictedItem s.
itemId (string) --
The recommended item ID.
score (float) --
A numeric representation of the model's certainty in the item's suitability. For more information on scoring logic, see how-scores-work .
Exceptions
Returns an object that can wait for some condition.
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
Provide a valid value for the field or parameter.
Example
try:
...
except client.exceptions.InvalidInputException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
Provide a valid value for the field or parameter.
The specified resource does not exist.
Example
try:
...
except client.exceptions.ResourceNotFoundException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
The specified resource does not exist.
The available paginators are: