IntentConfirmationSetting - Amazon Lex API Reference

IntentConfirmationSetting

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

Contents

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.

Type: PromptSpecification object

Required: Yes

active

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.

Type: Boolean

Required: No

codeHook

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.

Type: DialogCodeHookInvocationSetting object

Required: No

confirmationConditional

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

Type: ConditionalSpecification object

Required: No

confirmationNextStep

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

Type: DialogState object

Required: No

confirmationResponse

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

Type: ResponseSpecification object

Required: No

declinationConditional

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

Type: ConditionalSpecification object

Required: No

declinationNextStep

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

Type: DialogState object

Required: No

declinationResponse

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

Type: ResponseSpecification object

Required: No

elicitationCodeHook

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

Type: ElicitationCodeHookInvocationSetting object

Required: No

failureConditional

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.

Type: ConditionalSpecification object

Required: No

failureNextStep

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

Type: DialogState object

Required: No

failureResponse

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

Type: ResponseSpecification object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: