Amazon Personalize Runtime

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 - itemId required, userId not used

• USER_PERSONALIZATION - itemId optional, userId required

See also: AWS API Documentation

Request Syntax

client.get_recommendations(
    campaignArn='string',
    itemId='string',
    userId='string',
    numResults=123
)

type campaignArn:

string

param campaignArn:

[REQUIRED]

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

type itemId:

string

param itemId:

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

type userId:

string

param userId:

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

type numResults:

integer

param numResults:

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

rtype:

dict

returns:

Response Syntax

{
    'itemList': [
        {
            'itemId': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • itemList (list) --

    A list of recommendations.

    • (dict) --

      An object that identifies an item.

      The and APIs return a list of ``PredictedItem``s.

      • itemId (string) --

        The recommended item ID.

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.

See also: AWS API Documentation

Request Syntax

client.get_personalized_ranking(
    campaignArn='string',
    inputList=[
        'string',
    ],
    userId='string'
)

type campaignArn:

string

param campaignArn:

[REQUIRED]

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

type inputList:

list

param inputList:

[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.

• (string) --

type userId:

string

param userId:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'personalizedRanking': [
        {
            'itemId': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • personalizedRanking (list) --

    A list of items in order of most likely interest to the user.

    • (dict) --

      An object that identifies an item.

      The and APIs return a list of ``PredictedItem``s.

      • itemId (string) --

        The recommended item ID.