Skip to content

StartBotAnalyzerRequest

Source code in docs_src/capo_lex_models_v2/types/start_bot_analyzer_request.py 
16
17
18
19
20
21
22
23
24
25
26
class StartBotAnalyzerRequest(TypedDict, closed=True):
    bot_id: "capo_lex_models_v2.types.id.Id"
    """<p>The unique identifier of the bot to analyze.</p>"""
    analysis_scope: "capo_lex_models_v2.types.analysis_scope.AnalysisScope"
    """<p>The scope of analysis to perform. Currently only <code>BotLocale</code> scope is supported.</p> <p>Valid Values: <code>BotLocale</code> </p>"""
    locale_id: NotRequired["capo_lex_models_v2.types.locale_id.LocaleId"]
    """<p>The locale identifier for the bot locale to analyze. Required when <code>analysisScope</code> is <code>BotLocale</code>.</p>"""
    bot_version: NotRequired[
        "capo_lex_models_v2.types.draft_bot_version.DraftBotVersion"
    ]
    """<p>The version of the bot to analyze. Defaults to <code>DRAFT</code> if not specified.</p>"""

analysis_scope instance-attribute 

analysis_scope: AnalysisScope

The scope of analysis to perform. Currently only BotLocale scope is supported.

Valid Values: BotLocale

bot_id instance-attribute 

bot_id: Id

The unique identifier of the bot to analyze.

bot_version instance-attribute 

bot_version: NotRequired[DraftBotVersion]

The version of the bot to analyze. Defaults to DRAFT if not specified.

locale_id instance-attribute 

locale_id: NotRequired[LocaleId]

The locale identifier for the bot locale to analyze. Required when analysisScope is BotLocale.