CustomerProfiles / Client / get_profile_recommendations

get_profile_recommendations

CustomerProfiles.Client.get_profile_recommendations(**kwargs)

Fetches the recommendations for a profile in the input Customer Profiles domain. Fetches all the profile recommendations

See also: AWS API Documentation

Request Syntax

response = client.get_profile_recommendations(
    DomainName='string',
    ProfileId='string',
    RecommenderName='string',
    Context={
        'string': 'string'
    },
    RecommenderFilters=[
        {
            'Name': 'string',
            'Values': {
                'string': 'string'
            }
        },
    ],
    RecommenderPromotionalFilters=[
        {
            'Name': 'string',
            'Values': {
                'string': 'string'
            },
            'PromotionName': 'string',
            'PercentPromotedItems': 123
        },
    ],
    CandidateIds=[
        'string',
    ],
    MaxResults=123,
    MetadataConfig={
        'MetadataColumns': [
            'string',
        ]
    }
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain.

  • ProfileId (string) –

    [REQUIRED]

    The unique identifier of the profile for which to retrieve recommendations.

  • RecommenderName (string) –

    [REQUIRED]

    The unique name of the recommender.

  • Context (dict) –

    The contextual metadata used to provide dynamic runtime information to tailor recommendations.

    • (string) –

      • (string) –

  • RecommenderFilters (list) –

    A list of filters to apply to the returned recommendations. Filters define criteria for including or excluding items from the recommendation results.

    • (dict) –

      A filter that specifies criteria for including or excluding items from recommendations.

      • Name (string) –

        The name of the recommender filter to apply.

      • Values (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.

        • (string) –

          • (string) –

  • RecommenderPromotionalFilters (list) –

    A list of promotional filters to apply to the recommendations. Promotional filters allow you to promote specific items within a configurable subset of recommendation results.

    • (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 recommender filter to use for the promotion.

      • Values (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.

        • (string) –

          • (string) –

      • PromotionName (string) –

        The name of the promotion.

      • PercentPromotedItems (integer) –

        The percentage of recommended items to apply the promotion to.

  • CandidateIds (list) –

    A list of item IDs to rank for the user. Use this when you want to re-rank a specific set of items rather than getting recommendations from the full item catalog. Required for personalized-ranking use cases.

    • (string) –

  • MaxResults (integer) – The maximum number of recommendations to return. The default value is 10.

  • MetadataConfig (dict) –

    Configuration for including item metadata in the recommendation response. Use this to specify which metadata columns to return alongside recommended items.

    • MetadataColumns (list) –

      A list of metadata column names from your Items dataset to include in the recommendation response.

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Recommendations': [
        {
            'CatalogItem': {
                'Id': 'string',
                'Name': 'string',
                'Code': 'string',
                'Type': 'string',
                'Category': 'string',
                'Description': 'string',
                'AdditionalInformation': 'string',
                'ImageLink': 'string',
                'Link': 'string',
                'CreatedAt': datetime(2015, 1, 1),
                'UpdatedAt': datetime(2015, 1, 1),
                'Price': 'string',
                'Attributes': {
                    'string': 'string'
                }
            },
            'Score': 123.0
        },
    ]
}

Response Structure

  • (dict) –

    • Recommendations (list) –

      List of recommendations generated by the recommender.

      • (dict) –

        Represents a single recommendation generated by the recommender system.

        • CatalogItem (dict) –

          The catalog item being recommended, including its complete details and attributes.

          • Id (string) –

            The unique identifier for the catalog item.

          • Name (string) –

            The display name of the catalog item.

          • Code (string) –

            The product code or SKU of the catalog item.

          • Type (string) –

            The type classification of the catalog item.

          • Category (string) –

            The category to which the catalog item belongs.

          • Description (string) –

            A detailed description of the catalog item.

          • AdditionalInformation (string) –

            Supplementary information about the catalog item beyond the basic description.

          • ImageLink (string) –

            The URL link to the item’s image.

          • Link (string) –

            The URL link to the item’s detailed page or external resource.

          • CreatedAt (datetime) –

            The timestamp when the catalog item was created.

          • UpdatedAt (datetime) –

            The timestamp when the catalog item was last updated.

          • Price (string) –

            The price of the catalog item.

          • Attributes (dict) –

            Additional attributes or properties associated with the catalog item stored as key-value pairs.

            • (string) –

              • (string) –

        • Score (float) –

          Recommendation Score between 0 and 1.

Exceptions