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

Inherits:
Struct
  • Object
show all
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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#activeBoolean

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)


7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 7563

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_hookTypes::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.



7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 7563

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_conditionalTypes::ConditionalSpecification

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



7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 7563

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_stepTypes::DialogState

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

Returns:



7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 7563

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_responseTypes::ResponseSpecification

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



7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 7563

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_conditionalTypes::ConditionalSpecification

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



7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 7563

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_stepTypes::DialogState

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

Returns:



7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 7563

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_responseTypes::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.



7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 7563

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_hookTypes::ElicitationCodeHookInvocationSetting

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



7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 7563

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_conditionalTypes::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.



7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 7563

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_stepTypes::DialogState

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

Returns:



7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 7563

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_responseTypes::ResponseSpecification

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



7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 7563

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_specificationTypes::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.



7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 7563

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