Skip to content

DialogAction

Source code in docs_src/capo_lex_runtime_v2/types/dialog_action.py
class DialogAction(TypedDict, closed=True):
    type: "capo_lex_runtime_v2.types.dialog_action_type.DialogActionType"
    """<p>The next action that the bot should take in its interaction with the user. The following values are possible:</p> <ul> <li> <p> <code>Close</code> – Indicates that there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.</p> </li> <li> <p> <code>ConfirmIntent</code> – The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"</p> </li> <li> <p> <code>Delegate</code> – The next action is determined by Amazon Lex V2.</p> </li> <li> <p> <code>ElicitIntent</code> – The next action is to elicit an intent from the user.</p> </li> <li> <p> <code>ElicitSlot</code> – The next action is to elicit a slot value from the user.</p> </li> </ul>"""
    slot_to_elicit: NotRequired[
        "capo_lex_runtime_v2.types.non_empty_string.NonEmptyString"
    ]
    """<p>The name of the slot that should be elicited from the user.</p>"""
    slot_elicitation_style: NotRequired[
        "capo_lex_runtime_v2.types.style_type.StyleType"
    ]
    """<p>Configures the slot to use spell-by-letter or spell-by-word style. When you use a style on a slot, users can spell out their input to make it clear to your bot.</p> <ul> <li> <p>Spell by letter - "b" "o" "b"</p> </li> <li> <p>Spell by word - "b as in boy" "o as in oscar" "b as in boy"</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/spelling-styles.html"> Using spelling to enter slot values </a>.</p>"""
    sub_slot_to_elicit: NotRequired[
        "capo_lex_runtime_v2.types.elicit_sub_slot.ElicitSubSlot"
    ]
    """<p>The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.</p>"""

slot_elicitation_style instance-attribute

slot_elicitation_style: NotRequired[StyleType]

Configures the slot to use spell-by-letter or spell-by-word style. When you use a style on a slot, users can spell out their input to make it clear to your bot.

  • Spell by letter - "b" "o" "b"

  • Spell by word - "b as in boy" "o as in oscar" "b as in boy"

For more information, see Using spelling to enter slot values .

slot_to_elicit instance-attribute

slot_to_elicit: NotRequired[NonEmptyString]

The name of the slot that should be elicited from the user.

sub_slot_to_elicit instance-attribute

sub_slot_to_elicit: NotRequired[ElicitSubSlot]

The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.

type instance-attribute

The next action that the bot should take in its interaction with the user. The following values are possible:

  • Close – Indicates that there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

  • ConfirmIntent – The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

  • Delegate – The next action is determined by Amazon Lex V2.

  • ElicitIntent – The next action is to elicit an intent from the user.

  • ElicitSlot – The next action is to elicit a slot value from the user.