Skip to content

GetRecommenderResponse

Source code in docs_src/capo_customer_profiles/types/get_recommender_response.py
class GetRecommenderResponse(TypedDict, closed=True):
    recommender_name: "capo_customer_profiles.types.name.name"
    """<p>The name of the recommender.</p>"""
    recommender_recipe_name: (
        "capo_customer_profiles.types.recommender_recipe_name.RecommenderRecipeName"
    )
    """<p>The name of the recipe used by the recommender to generate recommendations.</p>"""
    recommender_schema_name: NotRequired["capo_customer_profiles.types.name.name"]
    """<p>The name of the recommender schema associated with this recommender.</p>"""
    recommender_config: NotRequired[
        "capo_customer_profiles.types.recommender_config.RecommenderConfig"
    ]
    """<p>The configuration settings for the recommender, including parameters and settings that define its behavior.</p>"""
    description: NotRequired[
        "capo_customer_profiles.types.sensitive_text.sensitiveText"
    ]
    """<p>A detailed description of the recommender providing information about its purpose and functionality.</p>"""
    status: NotRequired[
        "capo_customer_profiles.types.recommender_status.RecommenderStatus"
    ]
    """<p>The current status of the recommender, indicating whether it is active, creating, updating, or in another state.</p>"""
    last_updated_at: NotRequired["capo_customer_profiles.types.timestamp.timestamp"]
    """<p>The timestamp of when the recommender was edited.</p>"""
    created_at: NotRequired["capo_customer_profiles.types.timestamp.timestamp"]
    """<p>The timestamp of when the recommender was created.</p>"""
    failure_reason: NotRequired["str"]
    """<p>If the recommender fails, provides the reason for the failure.</p>"""
    latest_recommender_update: NotRequired[
        "capo_customer_profiles.types.recommender_update.RecommenderUpdate"
    ]
    """<p>Information about the most recent update performed on the recommender, including status and timestamp.</p>"""
    active_recommender_version_name: NotRequired[
        "capo_customer_profiles.types.recommender_version_name.RecommenderVersionName"
    ]
    """<p>The name of the recommender version currently serving recommendations. Omitted when no active recommender version is set.</p>"""
    training_metrics: NotRequired[
        "capo_customer_profiles.types.training_metrics_list.TrainingMetricsList"
    ]
    """<p>A set of metrics that provide information about the recommender's training performance and accuracy.</p>"""
    tags: NotRequired["capo_customer_profiles.types.tag_map.TagMap"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""

active_recommender_version_name instance-attribute

active_recommender_version_name: NotRequired[RecommenderVersionName]

The name of the recommender version currently serving recommendations. Omitted when no active recommender version is set.

created_at instance-attribute

created_at: NotRequired[timestamp]

The timestamp of when the recommender was created.

description instance-attribute

description: NotRequired[sensitiveText]

A detailed description of the recommender providing information about its purpose and functionality.

failure_reason instance-attribute

failure_reason: NotRequired[str]

If the recommender fails, provides the reason for the failure.

last_updated_at instance-attribute

last_updated_at: NotRequired[timestamp]

The timestamp of when the recommender was edited.

latest_recommender_update instance-attribute

latest_recommender_update: NotRequired[RecommenderUpdate]

Information about the most recent update performed on the recommender, including status and timestamp.

recommender_config instance-attribute

recommender_config: NotRequired[RecommenderConfig]

The configuration settings for the recommender, including parameters and settings that define its behavior.

recommender_name instance-attribute

recommender_name: name

The name of the recommender.

recommender_recipe_name instance-attribute

recommender_recipe_name: RecommenderRecipeName

The name of the recipe used by the recommender to generate recommendations.

recommender_schema_name instance-attribute

recommender_schema_name: NotRequired[name]

The name of the recommender schema associated with this recommender.

status instance-attribute

status: NotRequired[RecommenderStatus]

The current status of the recommender, indicating whether it is active, creating, updating, or in another state.

tags instance-attribute

tags: NotRequired[TagMap]

The tags used to organize, track, or control access for this resource.

training_metrics instance-attribute

training_metrics: NotRequired[TrainingMetricsList]

A set of metrics that provide information about the recommender's training performance and accuracy.