Class: Aws::LexRuntimeV2::Types::DialogAction

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb

Overview

Note:

When making an API call, you may pass DialogAction data as a hash:

{
  type: "Close", # required, accepts Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot, None
  slot_to_elicit: "NonEmptyString",
  slot_elicitation_style: "Default", # accepts Default, SpellByLetter, SpellByWord
}

The next action that Amazon Lex V2 should take.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#slot_elicitation_styleString

Configures the slot to use spell-by-letter or spell-by-word style. When you use a style on a slot, users can spell out their input to make it clear to your bot.

  • Spell by letter - "b" "o" "b"

  • Spell by word - "b as in boy" "o as in oscar" "b as in boy"

For more information, see Using spelling to enter slot values .

Returns:

  • (String)


599
600
601
602
603
604
605
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 599

class DialogAction < Struct.new(
  :type,
  :slot_to_elicit,
  :slot_elicitation_style)
  SENSITIVE = []
  include Aws::Structure
end

#slot_to_elicitString

The name of the slot that should be elicited from the user.

Returns:

  • (String)


599
600
601
602
603
604
605
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 599

class DialogAction < Struct.new(
  :type,
  :slot_to_elicit,
  :slot_elicitation_style)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The next action that the bot should take in its interaction with the user. The possible values are:

  • Close - Indicates that there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

  • 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?"

  • Delegate - The next action is determined by Amazon Lex V2.

  • ElicitSlot - The next action is to elicit a slot value from the user.

Returns:

  • (String)


599
600
601
602
603
604
605
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 599

class DialogAction < Struct.new(
  :type,
  :slot_to_elicit,
  :slot_elicitation_style)
  SENSITIVE = []
  include Aws::Structure
end