Skip to content

IntentDict

Dictionary Type

IntentDict

Bases: TypedDict

Dictionary form of Intent.

Attributes

confirmation_state instance-attribute
confirmation_state: str | None

Indicates whether the intent has been Confirmed, Denied, or None if the confirmation stage has not yet been reached.

name instance-attribute
name: Required[str]

The name of the intent.

slots instance-attribute
slots: Mapping[str, Slot | SlotDict] | None

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.

state instance-attribute
state: str | None

Indicates the fulfillment state for the intent. The meanings of each value are as follows:

  • Failed -- The bot failed to fulfill the intent.

  • Fulfilled -- The bot has completed fulfillment of the intent.

  • FulfillmentInProgress -- The bot is in the middle of fulfilling the intent.

  • InProgress -- The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.

  • ReadyForFulfillment -- The bot has elicited all the slot values for the intent and is ready to fulfill the intent.

  • Waiting -- The bot is waiting for a response from the user (limited to streaming conversations).