IntentConfirmationSetting ¶

class IntentConfirmationSetting(TypedDict, closed=True):
    prompt_specification: (
        "capo_lex_models_v2.types.prompt_specification.PromptSpecification"
    )
    """<p>Prompts the user to confirm the intent. This question should have a yes or no answer.</p> <p>Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the <code>OrderPizza</code> intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information. </p>"""
    declination_response: NotRequired[
        "capo_lex_models_v2.types.response_specification.ResponseSpecification"
    ]
    """<p>When the user answers "no" to the question defined in <code>promptSpecification</code>, Amazon Lex responds with this response to acknowledge that the intent was canceled. </p>"""
    active: NotRequired["capo_lex_models_v2.types.boxed_boolean.BoxedBoolean"]
    """<p>Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the <code>active</code> field isn't specified, the default is true.</p>"""
    confirmation_response: NotRequired[
        "capo_lex_models_v2.types.response_specification.ResponseSpecification"
    ]
    confirmation_next_step: NotRequired[
        "capo_lex_models_v2.types.dialog_state.DialogState"
    ]
    """<p>Specifies the next step that the bot executes when the customer confirms the intent.</p>"""
    confirmation_conditional: NotRequired[
        "capo_lex_models_v2.types.conditional_specification.ConditionalSpecification"
    ]
    """<p>A list of conditional branches to evaluate after the intent is closed.</p>"""
    declination_next_step: NotRequired[
        "capo_lex_models_v2.types.dialog_state.DialogState"
    ]
    """<p>Specifies the next step that the bot executes when the customer declines the intent.</p>"""
    declination_conditional: NotRequired[
        "capo_lex_models_v2.types.conditional_specification.ConditionalSpecification"
    ]
    """<p>A list of conditional branches to evaluate after the intent is declined.</p>"""
    failure_response: NotRequired[
        "capo_lex_models_v2.types.response_specification.ResponseSpecification"
    ]
    failure_next_step: NotRequired["capo_lex_models_v2.types.dialog_state.DialogState"]
    """<p>The next step to take in the conversation if the confirmation step fails.</p>"""
    failure_conditional: NotRequired[
        "capo_lex_models_v2.types.conditional_specification.ConditionalSpecification"
    ]
    code_hook: NotRequired[
        "capo_lex_models_v2.types.dialog_code_hook_invocation_setting.DialogCodeHookInvocationSetting"
    ]
    """<p>The <code>DialogCodeHookInvocationSetting</code> object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is <code>InvokeDialogCodeHook</code>. </p>"""
    elicitation_code_hook: NotRequired[
        "capo_lex_models_v2.types.elicitation_code_hook_invocation_setting.ElicitationCodeHookInvocationSetting"
    ]
    """<p>The <code>DialogCodeHookInvocationSetting</code> used when the code hook is invoked during confirmation prompt retries.</p>"""