Struct aws_sdk_lexmodelsv2::types::IntentConfirmationSetting

#[non_exhaustive]
pub struct IntentConfirmationSetting {

    pub prompt_specification: Option<PromptSpecification>,
    pub declination_response: Option<ResponseSpecification>,
    pub active: Option<bool>,
    pub confirmation_response: Option<ResponseSpecification>,
    pub confirmation_next_step: Option<DialogState>,
    pub confirmation_conditional: Option<ConditionalSpecification>,
    pub declination_next_step: Option<DialogState>,
    pub declination_conditional: Option<ConditionalSpecification>,
    pub failure_response: Option<ResponseSpecification>,
    pub failure_next_step: Option<DialogState>,
    pub failure_conditional: Option<ConditionalSpecification>,
    pub code_hook: Option<DialogCodeHookInvocationSetting>,
    pub elicitation_code_hook: Option<ElicitationCodeHookInvocationSetting>,
}

Provides a prompt for making sure that the user is ready for the intent to be fulfilled.

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.

prompt_specification: Option<PromptSpecification>

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

declination_response: Option<ResponseSpecification>

When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.

active: Option<bool>

Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.

confirmation_response: Option<ResponseSpecification>

Specifies a list of message groups that Amazon Lex uses to respond the user input.

confirmation_next_step: Option<DialogState>

Specifies the next step that the bot executes when the customer confirms the intent.

confirmation_conditional: Option<ConditionalSpecification>

A list of conditional branches to evaluate after the intent is closed.

declination_next_step: Option<DialogState>

Specifies the next step that the bot executes when the customer declines the intent.

declination_conditional: Option<ConditionalSpecification>

A list of conditional branches to evaluate after the intent is declined.

failure_response: Option<ResponseSpecification>

Specifies a list of message groups that Amazon Lex uses to respond the user input.

failure_next_step: Option<DialogState>

The next step to take in the conversation if the confirmation step fails.

failure_conditional: Option<ConditionalSpecification>

Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.

code_hook: Option<DialogCodeHookInvocationSetting>

The DialogCodeHookInvocationSetting object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is InvokeDialogCodeHook.

elicitation_code_hook: Option<ElicitationCodeHookInvocationSetting>

The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries.

Implementations

impl IntentConfirmationSetting

pub fn prompt_specification(&self) -> Option<&PromptSpecification>

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

pub fn declination_response(&self) -> Option<&ResponseSpecification>

When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.

pub fn active(&self) -> Option<bool>

Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.

pub fn confirmation_response(&self) -> Option<&ResponseSpecification>

Specifies a list of message groups that Amazon Lex uses to respond the user input.

pub fn confirmation_next_step(&self) -> Option<&DialogState>

Specifies the next step that the bot executes when the customer confirms the intent.

pub fn confirmation_conditional(&self) -> Option<&ConditionalSpecification>

A list of conditional branches to evaluate after the intent is closed.

pub fn declination_next_step(&self) -> Option<&DialogState>

Specifies the next step that the bot executes when the customer declines the intent.

pub fn declination_conditional(&self) -> Option<&ConditionalSpecification>

A list of conditional branches to evaluate after the intent is declined.

pub fn failure_response(&self) -> Option<&ResponseSpecification>

Specifies a list of message groups that Amazon Lex uses to respond the user input.

pub fn failure_next_step(&self) -> Option<&DialogState>

The next step to take in the conversation if the confirmation step fails.

pub fn failure_conditional(&self) -> Option<&ConditionalSpecification>

Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.

pub fn code_hook(&self) -> Option<&DialogCodeHookInvocationSetting>

The DialogCodeHookInvocationSetting object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is InvokeDialogCodeHook.

pub fn elicitation_code_hook( &self ) -> Option<&ElicitationCodeHookInvocationSetting>

The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries.

impl IntentConfirmationSetting

pub fn builder() -> IntentConfirmationSettingBuilder

Creates a new builder-style object to manufacture IntentConfirmationSetting.

Trait Implementations

impl Clone for IntentConfirmationSetting

fn clone(&self) -> IntentConfirmationSetting

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IntentConfirmationSetting

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

Formats the value using the given formatter.

impl PartialEq for IntentConfirmationSetting

fn eq(&self, other: &IntentConfirmationSetting) -> 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 IntentConfirmationSetting