Struct DialogAction

#[non_exhaustive]
pub struct DialogAction {
    pub type: DialogActionType,
    pub intent_name: Option<String>,
    pub slots: Option<HashMap<String, String>>,
    pub slot_to_elicit: Option<String>,
    pub fulfillment_state: Option<FulfillmentState>,
    pub message: Option<String>,
    pub message_format: Option<MessageFormatType>,
}

Describes the next action that the bot should take in its interaction with the user and provides information about the context in which the action takes place. Use the DialogAction data type to set the interaction to a specific state, or to return the interaction to a previous state.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

type: DialogActionType

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

• 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?"

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

• Delegate - The next action is determined by Amazon Lex.

• ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

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

intent_name: Option<String>

The name of the intent.

slots: Option<HashMap<String, String>>

Map of the slots that have been gathered and their values.

slot_to_elicit: Option<String>

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

fulfillment_state: Option<FulfillmentState>

The fulfillment state of the intent. The possible values are:

• Failed - The Lambda function associated with the intent failed to fulfill the intent.

• Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

• ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

message: Option<String>

The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.

message_format: Option<MessageFormatType>

• PlainText - The message contains plain UTF-8 text.

• CustomPayload - The message is a custom format for the client.

• SSML - The message contains text formatted for voice output.

• Composite - The message contains an escaped JSON object containing one or more messages. For more information, see Message Groups.

Implementations

impl DialogAction

pub fn type(&self) -> &DialogActionType

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

• 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?"

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

• Delegate - The next action is determined by Amazon Lex.

• ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

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

pub fn intent_name(&self) -> Option<&str>

The name of the intent.

pub fn slots(&self) -> Option<&HashMap<String, String>>

Map of the slots that have been gathered and their values.

pub fn slot_to_elicit(&self) -> Option<&str>

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

pub fn fulfillment_state(&self) -> Option<&FulfillmentState>

The fulfillment state of the intent. The possible values are:

• Failed - The Lambda function associated with the intent failed to fulfill the intent.

• Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

• ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

pub fn message(&self) -> Option<&str>

The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.

pub fn message_format(&self) -> Option<&MessageFormatType>

• PlainText - The message contains plain UTF-8 text.

• CustomPayload - The message is a custom format for the client.

• SSML - The message contains text formatted for voice output.

• Composite - The message contains an escaped JSON object containing one or more messages. For more information, see Message Groups.

impl DialogAction

pub fn builder() -> DialogActionBuilder

Creates a new builder-style object to manufacture DialogAction.

Trait Implementations

impl Clone for DialogAction

fn clone(&self) -> DialogAction

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DialogAction

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DialogAction

fn eq(&self, other: &DialogAction) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DialogAction