Intent ¶

class Intent(TypedDict, closed=True):
    name: "capo_lex_runtime_v2.types.non_empty_string.NonEmptyString"
    """<p>The name of the intent.</p>"""
    slots: NotRequired["capo_lex_runtime_v2.types.slots.Slots"]
    """<p>A map of all of the slots for the intent. The name of the slot maps to the value of the slot. If a slot has not been filled, the value is null.</p>"""
    state: NotRequired["capo_lex_runtime_v2.types.intent_state.IntentState"]
    """<p>Indicates the fulfillment state for the intent. The meanings of each value are as follows:</p> <ul> <li> <p> <code>Failed</code> – The bot failed to fulfill the intent.</p> </li> <li> <p> <code>Fulfilled</code> – The bot has completed fulfillment of the intent.</p> </li> <li> <p> <code>FulfillmentInProgress</code> – The bot is in the middle of fulfilling the intent.</p> </li> <li> <p> <code>InProgress</code> – The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.</p> </li> <li> <p> <code>ReadyForFulfillment</code> – The bot has elicited all the slot values for the intent and is ready to fulfill the intent.</p> </li> <li> <p> <code>Waiting</code> – The bot is waiting for a response from the user (limited to streaming conversations).</p> </li> </ul>"""
    confirmation_state: NotRequired[
        "capo_lex_runtime_v2.types.confirmation_state.ConfirmationState"
    ]
    """<p>Indicates whether the intent has been <code>Confirmed</code>, <code>Denied</code>, or <code>None</code> if the confirmation stage has not yet been reached.</p>"""