Class: Aws::LexModelsV2::Types::IntentConfirmationSetting

Inherits:

Struct

• Object
• Struct
• Aws::LexModelsV2::Types::IntentConfirmationSetting

Defined in:

gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #active ⇒ Boolean

  Specifies whether the intent's confirmation is sent to the user.

• #code_hook ⇒ Types::DialogCodeHookInvocationSetting

  The DialogCodeHookInvocationSetting object associated with intent's confirmation step.

• #confirmation_conditional ⇒ Types::ConditionalSpecification

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

• #confirmation_next_step ⇒ Types::DialogState

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

• #confirmation_response ⇒ Types::ResponseSpecification

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

• #declination_conditional ⇒ Types::ConditionalSpecification

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

• #declination_next_step ⇒ Types::DialogState

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

• #declination_response ⇒ Types::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.

• #elicitation_code_hook ⇒ Types::ElicitationCodeHookInvocationSetting

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

• #failure_conditional ⇒ Types::ConditionalSpecification

  Provides a list of conditional branches.

• #failure_next_step ⇒ Types::DialogState

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

• #failure_response ⇒ Types::ResponseSpecification

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

• #prompt_specification ⇒ Types::PromptSpecification

  Prompts the user to confirm the intent.

Instance Attribute Details

#active ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 8317

class IntentConfirmationSetting < Struct.new(
  :prompt_specification,
  :declination_response,
  :active,
  :confirmation_response,
  :confirmation_next_step,
  :confirmation_conditional,
  :declination_next_step,
  :declination_conditional,
  :failure_response,
  :failure_next_step,
  :failure_conditional,
  :code_hook,
  :elicitation_code_hook)
  SENSITIVE = []
  include Aws::Structure
end

#code_hook ⇒ Types::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.

Returns:

• (Types::DialogCodeHookInvocationSetting)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 8317

class IntentConfirmationSetting < Struct.new(
  :prompt_specification,
  :declination_response,
  :active,
  :confirmation_response,
  :confirmation_next_step,
  :confirmation_conditional,
  :declination_next_step,
  :declination_conditional,
  :failure_response,
  :failure_next_step,
  :failure_conditional,
  :code_hook,
  :elicitation_code_hook)
  SENSITIVE = []
  include Aws::Structure
end

#confirmation_conditional ⇒ Types::ConditionalSpecification

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

Returns:

• (Types::ConditionalSpecification)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 8317

class IntentConfirmationSetting < Struct.new(
  :prompt_specification,
  :declination_response,
  :active,
  :confirmation_response,
  :confirmation_next_step,
  :confirmation_conditional,
  :declination_next_step,
  :declination_conditional,
  :failure_response,
  :failure_next_step,
  :failure_conditional,
  :code_hook,
  :elicitation_code_hook)
  SENSITIVE = []
  include Aws::Structure
end

#confirmation_next_step ⇒ Types::DialogState

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

Returns:

• (Types::DialogState)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 8317

class IntentConfirmationSetting < Struct.new(
  :prompt_specification,
  :declination_response,
  :active,
  :confirmation_response,
  :confirmation_next_step,
  :confirmation_conditional,
  :declination_next_step,
  :declination_conditional,
  :failure_response,
  :failure_next_step,
  :failure_conditional,
  :code_hook,
  :elicitation_code_hook)
  SENSITIVE = []
  include Aws::Structure
end

#confirmation_response ⇒ Types::ResponseSpecification

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

Returns:

• (Types::ResponseSpecification)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 8317

class IntentConfirmationSetting < Struct.new(
  :prompt_specification,
  :declination_response,
  :active,
  :confirmation_response,
  :confirmation_next_step,
  :confirmation_conditional,
  :declination_next_step,
  :declination_conditional,
  :failure_response,
  :failure_next_step,
  :failure_conditional,
  :code_hook,
  :elicitation_code_hook)
  SENSITIVE = []
  include Aws::Structure
end

#declination_conditional ⇒ Types::ConditionalSpecification

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

Returns:

• (Types::ConditionalSpecification)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 8317

class IntentConfirmationSetting < Struct.new(
  :prompt_specification,
  :declination_response,
  :active,
  :confirmation_response,
  :confirmation_next_step,
  :confirmation_conditional,
  :declination_next_step,
  :declination_conditional,
  :failure_response,
  :failure_next_step,
  :failure_conditional,
  :code_hook,
  :elicitation_code_hook)
  SENSITIVE = []
  include Aws::Structure
end

#declination_next_step ⇒ Types::DialogState

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

Returns:

• (Types::DialogState)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 8317

class IntentConfirmationSetting < Struct.new(
  :prompt_specification,
  :declination_response,
  :active,
  :confirmation_response,
  :confirmation_next_step,
  :confirmation_conditional,
  :declination_next_step,
  :declination_conditional,
  :failure_response,
  :failure_next_step,
  :failure_conditional,
  :code_hook,
  :elicitation_code_hook)
  SENSITIVE = []
  include Aws::Structure
end

#declination_response ⇒ Types::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.

Returns:

• (Types::ResponseSpecification)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 8317

class IntentConfirmationSetting < Struct.new(
  :prompt_specification,
  :declination_response,
  :active,
  :confirmation_response,
  :confirmation_next_step,
  :confirmation_conditional,
  :declination_next_step,
  :declination_conditional,
  :failure_response,
  :failure_next_step,
  :failure_conditional,
  :code_hook,
  :elicitation_code_hook)
  SENSITIVE = []
  include Aws::Structure
end

#elicitation_code_hook ⇒ Types::ElicitationCodeHookInvocationSetting

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

Returns:

• (Types::ElicitationCodeHookInvocationSetting)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 8317

class IntentConfirmationSetting < Struct.new(
  :prompt_specification,
  :declination_response,
  :active,
  :confirmation_response,
  :confirmation_next_step,
  :confirmation_conditional,
  :declination_next_step,
  :declination_conditional,
  :failure_response,
  :failure_next_step,
  :failure_conditional,
  :code_hook,
  :elicitation_code_hook)
  SENSITIVE = []
  include Aws::Structure
end

#failure_conditional ⇒ Types::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.

Returns:

• (Types::ConditionalSpecification)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 8317

class IntentConfirmationSetting < Struct.new(
  :prompt_specification,
  :declination_response,
  :active,
  :confirmation_response,
  :confirmation_next_step,
  :confirmation_conditional,
  :declination_next_step,
  :declination_conditional,
  :failure_response,
  :failure_next_step,
  :failure_conditional,
  :code_hook,
  :elicitation_code_hook)
  SENSITIVE = []
  include Aws::Structure
end

#failure_next_step ⇒ Types::DialogState

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

Returns:

• (Types::DialogState)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 8317

class IntentConfirmationSetting < Struct.new(
  :prompt_specification,
  :declination_response,
  :active,
  :confirmation_response,
  :confirmation_next_step,
  :confirmation_conditional,
  :declination_next_step,
  :declination_conditional,
  :failure_response,
  :failure_next_step,
  :failure_conditional,
  :code_hook,
  :elicitation_code_hook)
  SENSITIVE = []
  include Aws::Structure
end

#failure_response ⇒ Types::ResponseSpecification

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

Returns:

• (Types::ResponseSpecification)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 8317

class IntentConfirmationSetting < Struct.new(
  :prompt_specification,
  :declination_response,
  :active,
  :confirmation_response,
  :confirmation_next_step,
  :confirmation_conditional,
  :declination_next_step,
  :declination_conditional,
  :failure_response,
  :failure_next_step,
  :failure_conditional,
  :code_hook,
  :elicitation_code_hook)
  SENSITIVE = []
  include Aws::Structure
end

#prompt_specification ⇒ Types::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.

Returns:

• (Types::PromptSpecification)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 8317

class IntentConfirmationSetting < Struct.new(
  :prompt_specification,
  :declination_response,
  :active,
  :confirmation_response,
  :confirmation_next_step,
  :confirmation_conditional,
  :declination_next_step,
  :declination_conditional,
  :failure_response,
  :failure_next_step,
  :failure_conditional,
  :code_hook,
  :elicitation_code_hook)
  SENSITIVE = []
  include Aws::Structure
end