Skip to content

StartBotAnalyzerResponse

Source code in docs_src/capo_lex_models_v2/types/start_bot_analyzer_response.py
class StartBotAnalyzerResponse(TypedDict, closed=True):
    bot_id: NotRequired["capo_lex_models_v2.types.id.Id"]
    """<p>The unique identifier of the bot being analyzed.</p>"""
    bot_version: NotRequired[
        "capo_lex_models_v2.types.draft_bot_version.DraftBotVersion"
    ]
    """<p>The version of the bot being analyzed.</p>"""
    locale_id: NotRequired["capo_lex_models_v2.types.locale_id.LocaleId"]
    """<p>The locale identifier of the bot locale being analyzed.</p>"""
    bot_analyzer_status: NotRequired[
        "capo_lex_models_v2.types.bot_analyzer_status.BotAnalyzerStatus"
    ]
    """<p>The current status of the analysis. The initial status is <code>Processing</code>.</p> <p>Valid Values: <code>Processing | Available | Failed | Stopping | Stopped</code> </p>"""
    bot_analyzer_request_id: NotRequired["capo_lex_models_v2.types.uuid.UUID"]
    """<p>A unique identifier for this analysis request. Use this identifier to check the status and retrieve results.</p>"""
    creation_date_time: NotRequired["capo_lex_models_v2.types.timestamp.Timestamp"]
    """<p>The date and time when the analysis was initiated.</p>"""

bot_analyzer_request_id instance-attribute

bot_analyzer_request_id: NotRequired[UUID]

A unique identifier for this analysis request. Use this identifier to check the status and retrieve results.

bot_analyzer_status instance-attribute

bot_analyzer_status: NotRequired[BotAnalyzerStatus]

The current status of the analysis. The initial status is Processing.

Valid Values: Processing | Available | Failed | Stopping | Stopped

bot_id instance-attribute

bot_id: NotRequired[Id]

The unique identifier of the bot being analyzed.

bot_version instance-attribute

bot_version: NotRequired[DraftBotVersion]

The version of the bot being analyzed.

creation_date_time instance-attribute

creation_date_time: NotRequired[Timestamp]

The date and time when the analysis was initiated.

locale_id instance-attribute

locale_id: NotRequired[LocaleId]

The locale identifier of the bot locale being analyzed.