Skip to content

SolutionUpdateSummary

Source code in docs_src/capo_personalize/types/solution_update_summary.py
class SolutionUpdateSummary(TypedDict, closed=True):
    solution_update_config: NotRequired[
        "capo_personalize.types.solution_update_config.SolutionUpdateConfig"
    ]
    """<p>The configuration details of the solution.</p>"""
    status: NotRequired["capo_personalize.types.status.Status"]
    """<p>The status of the solution update. A solution update can be in one of the following states:</p> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>"""
    perform_auto_training: NotRequired[
        "capo_personalize.types.perform_auto_training.PerformAutoTraining"
    ]
    """<p>Whether the solution automatically creates solution versions.</p>"""
    perform_incremental_update: NotRequired[
        "capo_personalize.types.perform_incremental_update.PerformIncrementalUpdate"
    ]
    """<p>A Boolean value that indicates whether incremental training updates are performed on the model. When enabled, this allows the model to learn from new data more frequently without requiring full retraining, which enables near real-time personalization. This parameter is supported only for solutions that use the semantic-similarity recipe.</p>"""
    creation_date_time: NotRequired["capo_personalize.types.date.Date"]
    """<p>The date and time (in Unix format) that the solution update was created.</p>"""
    last_updated_date_time: NotRequired["capo_personalize.types.date.Date"]
    """<p>The date and time (in Unix time) that the solution update was last updated.</p>"""
    failure_reason: NotRequired["capo_personalize.types.failure_reason.FailureReason"]
    """<p>If a solution update fails, the reason behind the failure.</p>"""

creation_date_time instance-attribute

creation_date_time: NotRequired[Date]

The date and time (in Unix format) that the solution update was created.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

If a solution update fails, the reason behind the failure.

last_updated_date_time instance-attribute

last_updated_date_time: NotRequired[Date]

The date and time (in Unix time) that the solution update was last updated.

perform_auto_training instance-attribute

perform_auto_training: NotRequired[PerformAutoTraining]

Whether the solution automatically creates solution versions.

perform_incremental_update instance-attribute

perform_incremental_update: NotRequired[PerformIncrementalUpdate]

A Boolean value that indicates whether incremental training updates are performed on the model. When enabled, this allows the model to learn from new data more frequently without requiring full retraining, which enables near real-time personalization. This parameter is supported only for solutions that use the semantic-similarity recipe.

solution_update_config instance-attribute

solution_update_config: NotRequired[SolutionUpdateConfig]

The configuration details of the solution.

status instance-attribute

status: NotRequired[Status]

The status of the solution update. A solution update can be in one of the following states:

CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED