Skip to content

DescribeBotLocaleResponse

Source code in docs_src/capo_lex_models_v2/types/describe_bot_locale_response.py
class DescribeBotLocaleResponse(TypedDict, closed=True):
    bot_id: NotRequired["capo_lex_models_v2.types.id.Id"]
    """<p>The identifier of the bot associated with the locale.</p>"""
    bot_version: NotRequired["capo_lex_models_v2.types.bot_version.BotVersion"]
    """<p>The version of the bot associated with the locale.</p>"""
    locale_id: NotRequired["capo_lex_models_v2.types.locale_id.LocaleId"]
    """<p>The unique identifier of the described locale.</p>"""
    locale_name: NotRequired["capo_lex_models_v2.types.locale_name.LocaleName"]
    """<p>The name of the locale.</p>"""
    description: NotRequired["capo_lex_models_v2.types.description.Description"]
    """<p>The description of the locale.</p>"""
    nlu_intent_confidence_threshold: NotRequired[
        "capo_lex_models_v2.types.confidence_threshold.ConfidenceThreshold"
    ]
    """<p>The confidence threshold where Amazon Lex inserts the <code>AMAZON.FallbackIntent</code> and <code>AMAZON.KendraSearchIntent</code> intents in the list of possible intents for an utterance.</p>"""
    voice_settings: NotRequired["capo_lex_models_v2.types.voice_settings.VoiceSettings"]
    """<p>The Amazon Polly voice Amazon Lex uses for voice interaction with the user.</p>"""
    unified_speech_settings: NotRequired[
        "capo_lex_models_v2.types.unified_speech_settings.UnifiedSpeechSettings"
    ]
    """<p>The unified speech settings configured for the bot locale.</p>"""
    audio_filler_settings: NotRequired[
        "capo_lex_models_v2.types.audio_filler_settings.AudioFillerSettings"
    ]
    """<p>The audio filler settings configured for the bot locale.</p>"""
    speech_recognition_settings: NotRequired[
        "capo_lex_models_v2.types.speech_recognition_settings.SpeechRecognitionSettings"
    ]
    """<p>The speech-to-text settings configured for the bot locale.</p>"""
    intents_count: NotRequired["capo_lex_models_v2.types.resource_count.ResourceCount"]
    """<p>The number of intents defined for the locale.</p>"""
    slot_types_count: NotRequired[
        "capo_lex_models_v2.types.resource_count.ResourceCount"
    ]
    """<p>The number of slot types defined for the locale.</p>"""
    bot_locale_status: NotRequired[
        "capo_lex_models_v2.types.bot_locale_status.BotLocaleStatus"
    ]
    """<p>The status of the bot. If the status is <code>Failed</code>, the reasons for the failure are listed in the <code>failureReasons</code> field.</p>"""
    failure_reasons: NotRequired[
        "capo_lex_models_v2.types.failure_reasons.FailureReasons"
    ]
    """<p>if <code>botLocaleStatus</code> is <code>Failed</code>, Amazon Lex explains why it failed to build the bot.</p>"""
    creation_date_time: NotRequired["capo_lex_models_v2.types.timestamp.Timestamp"]
    """<p>The date and time that the locale was created.</p>"""
    last_updated_date_time: NotRequired["capo_lex_models_v2.types.timestamp.Timestamp"]
    """<p>The date and time that the locale was last updated.</p>"""
    last_build_submitted_date_time: NotRequired[
        "capo_lex_models_v2.types.timestamp.Timestamp"
    ]
    """<p>The date and time that the locale was last submitted for building.</p>"""
    bot_locale_history_events: NotRequired[
        "capo_lex_models_v2.types.bot_locale_history_events_list.BotLocaleHistoryEventsList"
    ]
    """<p>History of changes, such as when a locale is used in an alias, that have taken place for the locale.</p>"""
    recommended_actions: NotRequired[
        "capo_lex_models_v2.types.recommended_actions.RecommendedActions"
    ]
    """<p>Recommended actions to take to resolve an error in the <code>failureReasons</code> field.</p>"""
    generative_ai_settings: NotRequired[
        "capo_lex_models_v2.types.generative_ai_settings.GenerativeAISettings"
    ]
    """<p>Contains settings for Amazon Bedrock's generative AI features for your bot locale.</p>"""
    speech_detection_sensitivity: NotRequired[
        "capo_lex_models_v2.types.speech_detection_sensitivity.SpeechDetectionSensitivity"
    ]
    """<p>The sensitivity level for voice activity detection (VAD) configured for the bot locale.</p>"""
    speaker_diarization_settings: NotRequired[
        "capo_lex_models_v2.types.speaker_diarization_settings.SpeakerDiarizationSettings"
    ]
    """<p>The speaker diarization settings configured for the bot locale.</p>"""

audio_filler_settings instance-attribute

audio_filler_settings: NotRequired[AudioFillerSettings]

The audio filler settings configured for the bot locale.

bot_id instance-attribute

bot_id: NotRequired[Id]

The identifier of the bot associated with the locale.

bot_locale_history_events instance-attribute

bot_locale_history_events: NotRequired[BotLocaleHistoryEventsList]

History of changes, such as when a locale is used in an alias, that have taken place for the locale.

bot_locale_status instance-attribute

bot_locale_status: NotRequired[BotLocaleStatus]

The status of the bot. If the status is Failed, the reasons for the failure are listed in the failureReasons field.

bot_version instance-attribute

bot_version: NotRequired[BotVersion]

The version of the bot associated with the locale.

creation_date_time instance-attribute

creation_date_time: NotRequired[Timestamp]

The date and time that the locale was created.

description instance-attribute

description: NotRequired[Description]

The description of the locale.

failure_reasons instance-attribute

failure_reasons: NotRequired[FailureReasons]

if botLocaleStatus is Failed, Amazon Lex explains why it failed to build the bot.

generative_ai_settings instance-attribute

generative_ai_settings: NotRequired[GenerativeAISettings]

Contains settings for Amazon Bedrock's generative AI features for your bot locale.

intents_count instance-attribute

intents_count: NotRequired[ResourceCount]

The number of intents defined for the locale.

last_build_submitted_date_time instance-attribute

last_build_submitted_date_time: NotRequired[Timestamp]

The date and time that the locale was last submitted for building.

last_updated_date_time instance-attribute

last_updated_date_time: NotRequired[Timestamp]

The date and time that the locale was last updated.

locale_id instance-attribute

locale_id: NotRequired[LocaleId]

The unique identifier of the described locale.

locale_name instance-attribute

locale_name: NotRequired[LocaleName]

The name of the locale.

nlu_intent_confidence_threshold instance-attribute

nlu_intent_confidence_threshold: NotRequired[ConfidenceThreshold]

The confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

recommended_actions instance-attribute

recommended_actions: NotRequired[RecommendedActions]

Recommended actions to take to resolve an error in the failureReasons field.

slot_types_count instance-attribute

slot_types_count: NotRequired[ResourceCount]

The number of slot types defined for the locale.

speaker_diarization_settings instance-attribute

speaker_diarization_settings: NotRequired[SpeakerDiarizationSettings]

The speaker diarization settings configured for the bot locale.

speech_detection_sensitivity instance-attribute

speech_detection_sensitivity: NotRequired[SpeechDetectionSensitivity]

The sensitivity level for voice activity detection (VAD) configured for the bot locale.

speech_recognition_settings instance-attribute

speech_recognition_settings: NotRequired[SpeechRecognitionSettings]

The speech-to-text settings configured for the bot locale.

unified_speech_settings instance-attribute

unified_speech_settings: NotRequired[UnifiedSpeechSettings]

The unified speech settings configured for the bot locale.

voice_settings instance-attribute

voice_settings: NotRequired[VoiceSettings]

The Amazon Polly voice Amazon Lex uses for voice interaction with the user.