Skip to content

IntentDisambiguationSettings

Source code in docs_src/capo_lex_models_v2/types/intent_disambiguation_settings.py
class IntentDisambiguationSettings(TypedDict, closed=True):
    enabled: "capo_lex_models_v2.types.enabled.Enabled"
    """<p>Determines whether the Intent Disambiguation feature is enabled. When set to <code>true</code>, Amazon Lex will present disambiguation options to users when multiple intents could match their input, with the default being <code>false</code>.</p>"""
    max_disambiguation_intents: NotRequired[
        "capo_lex_models_v2.types.max_disambiguation_intents.MaxDisambiguationIntents"
    ]
    """<p>Specifies the maximum number of intent options (2-5) to present to users when disambiguation is needed. This setting determines how many intent options will be shown to users when the system detects ambiguous input. The default value is 3.</p>"""
    custom_disambiguation_message: NotRequired[
        "capo_lex_models_v2.types.custom_disambiguation_message.CustomDisambiguationMessage"
    ]
    """<p>Provides a custom message that will be displayed before presenting the disambiguation options to users. This message helps set the context for users and can be customized to match your bot's tone and brand. If not specified, a default message will be used.</p>"""

custom_disambiguation_message instance-attribute

custom_disambiguation_message: NotRequired[CustomDisambiguationMessage]

Provides a custom message that will be displayed before presenting the disambiguation options to users. This message helps set the context for users and can be customized to match your bot's tone and brand. If not specified, a default message will be used.

enabled instance-attribute

enabled: Enabled

Determines whether the Intent Disambiguation feature is enabled. When set to true, Amazon Lex will present disambiguation options to users when multiple intents could match their input, with the default being false.

max_disambiguation_intents instance-attribute

max_disambiguation_intents: NotRequired[MaxDisambiguationIntents]

Specifies the maximum number of intent options (2-5) to present to users when disambiguation is needed. This setting determines how many intent options will be shown to users when the system detects ambiguous input. The default value is 3.