CustomerProfiles / Client / get_recommender

get_recommender¶

CustomerProfiles.Client.get_recommender(**kwargs)¶

Retrieves a recommender.

Request Syntax

response = client.get_recommender(
    DomainName='string',
    RecommenderName='string',
    TrainingMetricsCount=123
)

Parameters:

DomainName (string) –
[REQUIRED]

The unique name of the domain.
RecommenderName (string) –
[REQUIRED]

The name of the recommender.
TrainingMetricsCount (integer) – The number of training metrics to retrieve for the recommender.

Return type:

dict

Returns:

Response Syntax

{
    'RecommenderName': 'string',
    'RecommenderRecipeName': 'recommended-for-you'|'similar-items'|'frequently-paired-items'|'popular-items'|'trending-now'|'personalized-ranking',
    'RecommenderSchemaName': 'string',
    'RecommenderConfig': {
        'EventsConfig': {
            'EventParametersList': [
                {
                    'EventType': 'string',
                    'EventValueThreshold': 123.0,
                    'EventWeight': 123.0
                },
            ]
        },
        'TrainingFrequency': 123,
        'InferenceConfig': {
            'MinProvisionedTPS': 123
        },
        'IncludedColumns': {
            'string': [
                'string',
            ]
        }
    },
    'Description': 'string',
    'Status': 'PENDING'|'IN_PROGRESS'|'ACTIVE'|'FAILED'|'STOPPING'|'INACTIVE'|'STARTING'|'DELETING',
    'LastUpdatedAt': datetime(2015, 1, 1),
    'CreatedAt': datetime(2015, 1, 1),
    'FailureReason': 'string',
    'LatestRecommenderUpdate': {
        'RecommenderConfig': {
            'EventsConfig': {
                'EventParametersList': [
                    {
                        'EventType': 'string',
                        'EventValueThreshold': 123.0,
                        'EventWeight': 123.0
                    },
                ]
            },
            'TrainingFrequency': 123,
            'InferenceConfig': {
                'MinProvisionedTPS': 123
            },
            'IncludedColumns': {
                'string': [
                    'string',
                ]
            }
        },
        'Status': 'PENDING'|'IN_PROGRESS'|'ACTIVE'|'FAILED'|'STOPPING'|'INACTIVE'|'STARTING'|'DELETING',
        'CreatedAt': datetime(2015, 1, 1),
        'LastUpdatedAt': datetime(2015, 1, 1),
        'FailureReason': 'string'
    },
    'TrainingMetrics': [
        {
            'Time': datetime(2015, 1, 1),
            'Metrics': {
                'string': 123.0
            }
        },
    ],
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –
- RecommenderName (string) –
  
  The name of the recommender.
- RecommenderRecipeName (string) –
  
  The name of the recipe used by the recommender to generate recommendations.
- RecommenderSchemaName (string) –
  
  The name of the recommender schema associated with this recommender.
- RecommenderConfig (dict) –
  
  The configuration settings for the recommender, including parameters and settings that define its behavior.
  - EventsConfig (dict) –
    
    Configuration settings for how the recommender processes and uses events.
    - EventParametersList (list) –
      
      A list of event parameters configurations that specify how different event types should be handled.
      - (dict) –
        
        Configuration parameters for events in the personalization system.
        
        EventType (string) –
        
        The type of event being tracked (e.g., ‘click’, ‘purchase’, ‘view’).
        
        EventValueThreshold (float) –
        
        The minimum value threshold that an event must meet to be considered valid.
        
        EventWeight (float) –
        
        The weight of the event type. A higher weight means higher importance of the event type for the created solution.
  - TrainingFrequency (integer) –
    
    How often the recommender should retrain its model with new data.
  - InferenceConfig (dict) –
    
    Configuration settings for how the recommender handles inference requests.
    - MinProvisionedTPS (integer) –
      
      The minimum provisioned transactions per second (TPS) that the recommender supports. The default value is 1. A high MinProvisionedTPS will increase your cost.
  - IncludedColumns (dict) –
    
    A map of dataset type to a list of column names to train on. The column names must be a subset of the columns defined in the recommender schema. If not specified, all columns in the schema are used for training. The following columns are always included and do not need to be specified: Item.Id, ItemList[].Id, EventTimestamp, EventType, and EventValue.
    - (string) –
      - (list) –
        
        (string) –
- Description (string) –
  
  A detailed description of the recommender providing information about its purpose and functionality.
- Status (string) –
  
  The current status of the recommender, indicating whether it is active, creating, updating, or in another state.
- LastUpdatedAt (datetime) –
  
  The timestamp of when the recommender was edited.
- CreatedAt (datetime) –
  
  The timestamp of when the recommender was created.
- FailureReason (string) –
  
  If the recommender fails, provides the reason for the failure.
- LatestRecommenderUpdate (dict) –
  
  Information about the most recent update performed on the recommender, including status and timestamp.
  - RecommenderConfig (dict) –
    
    The updated configuration settings applied to the recommender during this update.
    - EventsConfig (dict) –
      
      Configuration settings for how the recommender processes and uses events.
      - EventParametersList (list) –
        
        A list of event parameters configurations that specify how different event types should be handled.
        
        (dict) –
        
        Configuration parameters for events in the personalization system.
        
        EventType (string) –
        
        The type of event being tracked (e.g., ‘click’, ‘purchase’, ‘view’).
        
        EventValueThreshold (float) –
        
        The minimum value threshold that an event must meet to be considered valid.
        
        EventWeight (float) –
        
        The weight of the event type. A higher weight means higher importance of the event type for the created solution.
    - TrainingFrequency (integer) –
      
      How often the recommender should retrain its model with new data.
    - InferenceConfig (dict) –
      
      Configuration settings for how the recommender handles inference requests.
      - MinProvisionedTPS (integer) –
        
        The minimum provisioned transactions per second (TPS) that the recommender supports. The default value is 1. A high MinProvisionedTPS will increase your cost.
    - IncludedColumns (dict) –
      
      A map of dataset type to a list of column names to train on. The column names must be a subset of the columns defined in the recommender schema. If not specified, all columns in the schema are used for training. The following columns are always included and do not need to be specified: Item.Id, ItemList[].Id, EventTimestamp, EventType, and EventValue.
      - (string) –
        
        (list) –
        
        (string) –
  - Status (string) –
    
    The current status of the recommender update operation.
  - CreatedAt (datetime) –
    
    The timestamp when this recommender update was initiated.
  - LastUpdatedAt (datetime) –
    
    The timestamp of when the recommender was edited.
  - FailureReason (string) –
    
    If the update operation failed, provides the reason for the failure.
- TrainingMetrics (list) –
  
  A set of metrics that provide information about the recommender’s training performance and accuracy.
  - (dict) –
    
    Contains metrics and performance indicators from the training of a recommender model.
    - Time (datetime) –
      
      The timestamp when these training metrics were recorded.
    - Metrics (dict) –
      
      A collection of performance metrics and statistics from the training process.
      - (string) –
        
        (float) –
- Tags (dict) –
  
  The tags used to organize, track, or control access for this resource.
  - (string) –
    - (string) –

get_recommender¶

Request Syntax

Response Syntax

Response Structure

Exceptions