Struct aws_sdk_lexruntime::types::IntentSummary

#[non_exhaustive]
pub struct IntentSummary {
    pub intent_name: Option<String>,
    pub checkpoint_label: Option<String>,
    pub slots: Option<HashMap<String, String>>,
    pub confirmation_status: Option<ConfirmationStatus>,
    pub dialog_action_type: DialogActionType,
    pub fulfillment_state: Option<FulfillmentState>,
    pub slot_to_elicit: Option<String>,
}

Provides information about the state of an intent. You can use this information to get the current state of an intent so that you can process the intent, or so that you can return the intent to its 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.

intent_name: Option<String>

The name of the intent.

checkpoint_label: Option<String>

A user-defined label that identifies a particular intent. You can use this label to return to a previous intent.

Use the checkpointLabelFilter parameter of the GetSessionRequest operation to filter the intents returned by the operation to those with only the specified label.

slots: Option<HashMap<String, String>>

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

confirmation_status: Option<ConfirmationStatus>

The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent, Amazon Lex sets this field to Confirmed. If the user denies the intent, Amazon Lex sets this value to Denied. The possible values are:

• Confirmed - The user has responded "Yes" to the confirmation prompt, confirming that the intent is complete and that it is ready to be fulfilled.

• Denied - The user has responded "No" to the confirmation prompt.

• None - The user has never been prompted for confirmation; or, the user was prompted but did not confirm or deny the prompt.

dialog_action_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.

• 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.

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.

slot_to_elicit: Option<String>

The next slot to elicit from the user. If there is not slot to elicit, the field is blank.

Implementations

impl IntentSummary

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

The name of the intent.

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

A user-defined label that identifies a particular intent. You can use this label to return to a previous intent.

Use the checkpointLabelFilter parameter of the GetSessionRequest operation to filter the intents returned by the operation to those with only the specified label.

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

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

pub fn confirmation_status(&self) -> Option<&ConfirmationStatus>

The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent, Amazon Lex sets this field to Confirmed. If the user denies the intent, Amazon Lex sets this value to Denied. The possible values are:

• Confirmed - The user has responded "Yes" to the confirmation prompt, confirming that the intent is complete and that it is ready to be fulfilled.

• Denied - The user has responded "No" to the confirmation prompt.

• None - The user has never been prompted for confirmation; or, the user was prompted but did not confirm or deny the prompt.

pub fn dialog_action_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.

• 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 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 slot_to_elicit(&self) -> Option<&str>

The next slot to elicit from the user. If there is not slot to elicit, the field is blank.

impl IntentSummary

pub fn builder() -> IntentSummaryBuilder

Creates a new builder-style object to manufacture IntentSummary.

Trait Implementations

impl Clone for IntentSummary

fn clone(&self) -> IntentSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IntentSummary

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

Formats the value using the given formatter.

impl PartialEq for IntentSummary

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for IntentSummary