PersonalizeRuntime

Client

class PersonalizeRuntime.Client

A low-level client representing Amazon Personalize Runtime

client = session.create_client('personalize-runtime')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_personalized_ranking(**kwargs)

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'
    },
    filterArn='string',
    filterValues={
        'string': 'string'
    }
)
Parameters
  • campaignArn (string) --

    [REQUIRED]

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

  • inputList (list) --

    [REQUIRED]

    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.

    • (string) --
  • userId (string) --

    [REQUIRED]

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

  • context (dict) --

    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.

    • (string) --
      • (string) --
  • filterArn (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 (dict) --

    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 .

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'personalizedRanking': [
        {
            'itemId': 'string',
            'score': 123.0,
            'promotionName': 'string'
        },
    ],
    'recommendationId': 'string'
}

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 that the item will be the next user selection. For more information on scoring logic, see how-scores-work .

        • promotionName (string) --

          The name of the promotion that included the predicted item.

    • recommendationId (string) --

      The ID of the recommendation.

Exceptions

get_recommendations(**kwargs)

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

Note

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 .

See also: AWS API Documentation

Request Syntax

response = client.get_recommendations(
    campaignArn='string',
    itemId='string',
    userId='string',
    numResults=123,
    context={
        'string': 'string'
    },
    filterArn='string',
    filterValues={
        'string': 'string'
    },
    recommenderArn='string',
    promotions=[
        {
            'name': 'string',
            'percentPromotedItems': 123,
            'filterArn': 'string',
            'filterValues': {
                'string': 'string'
            }
        },
    ]
)
Parameters
  • campaignArn (string) -- The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
  • itemId (string) --

    The item ID to provide recommendations for.

    Required for RELATED_ITEMS recipe type.

  • userId (string) --

    The user ID to provide recommendations for.

    Required for USER_PERSONALIZATION recipe type.

  • numResults (integer) -- The number of results to return. The default is 25. The maximum is 500.
  • context (dict) --

    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.

    • (string) --
      • (string) --
  • filterArn (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 (dict) --

    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 .

    • (string) --
      • (string) --
  • recommenderArn (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.
  • promotions (list) --

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

    • (dict) --

      Contains information on a promotion. A promotion defines additional business rules that apply to a configurable subset of recommended items.

      • name (string) --

        The name of the promotion.

      • percentPromotedItems (integer) --

        The percentage of recommended items to apply the promotion to.

      • filterArn (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 (dict) --

        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 .

        • (string) --
          • (string) --
Return type

dict

Returns

Response Syntax

{
    'itemList': [
        {
            'itemId': 'string',
            'score': 123.0,
            'promotionName': 'string'
        },
    ],
    'recommendationId': 'string'
}

Response Structure

  • (dict) --

    • itemList (list) --

      A list of recommendations sorted in descending 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 that the item will be the next user selection. For more information on scoring logic, see how-scores-work .

        • promotionName (string) --

          The name of the promotion that included the predicted item.

    • recommendationId (string) --

      The ID of the recommendation.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter

Client Exceptions

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:

class PersonalizeRuntime.Client.exceptions.InvalidInputException

Provide a valid value for the field or parameter.

Example

try:
  ...
except client.exceptions.InvalidInputException as e:
  print(e.response)
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.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class PersonalizeRuntime.Client.exceptions.ResourceNotFoundException

The specified resource does not exist.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
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.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: