You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Lex::Types::DialogAction

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

Overview

Note:

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

{
  type: "ElicitIntent", # required, accepts ElicitIntent, ConfirmIntent, ElicitSlot, Close, Delegate
  intent_name: "IntentName",
  slots: {
    "String" => "String",
  },
  slot_to_elicit: "String",
  fulfillment_state: "Fulfilled", # accepts Fulfilled, Failed, ReadyForFulfillment
  message: "Text",
  message_format: "PlainText", # accepts PlainText, CustomPayload, SSML, Composite
}

Describes the next action that the bot should take in its interaction with the user and provides information about the context in which the action takes place. Use the DialogAction data type to set the interaction to a specific state, or to return the interaction to a previous state.

Instance Attribute Summary collapse

Instance Attribute Details

#fulfillment_stateString

The fulfillment state of the intent. The possible values are:

  • Failed - The Lambda function associated with the intent failed to fulfill the intent.

  • Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

  • ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

Returns:

  • (String)


242
243
244
245
246
247
248
249
250
251
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 242

class DialogAction < Struct.new(
  :type,
  :intent_name,
  :slots,
  :slot_to_elicit,
  :fulfillment_state,
  :message,
  :message_format)
  include Aws::Structure
end

#intent_nameString

The name of the intent.

Returns:

  • (String)


242
243
244
245
246
247
248
249
250
251
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 242

class DialogAction < Struct.new(
  :type,
  :intent_name,
  :slots,
  :slot_to_elicit,
  :fulfillment_state,
  :message,
  :message_format)
  include Aws::Structure
end

#messageString

The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.

Returns:

  • (String)


242
243
244
245
246
247
248
249
250
251
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 242

class DialogAction < Struct.new(
  :type,
  :intent_name,
  :slots,
  :slot_to_elicit,
  :fulfillment_state,
  :message,
  :message_format)
  include Aws::Structure
end

#message_formatString

  • PlainText - The message contains plain UTF-8 text.

  • CustomPayload - The message is a custom format for the client.

  • SSML - The message contains text formatted for voice output.

  • Composite - The message contains an escaped JSON object containing one or more messages. For more information, see Message Groups.

Returns:

  • (String)


242
243
244
245
246
247
248
249
250
251
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 242

class DialogAction < Struct.new(
  :type,
  :intent_name,
  :slots,
  :slot_to_elicit,
  :fulfillment_state,
  :message,
  :message_format)
  include Aws::Structure
end

#slot_to_elicitString

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

Returns:

  • (String)


242
243
244
245
246
247
248
249
250
251
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 242

class DialogAction < Struct.new(
  :type,
  :intent_name,
  :slots,
  :slot_to_elicit,
  :fulfillment_state,
  :message,
  :message_format)
  include Aws::Structure
end

#slotsHash<String,String>

Map of the slots that have been gathered and their values.

Returns:

  • (Hash<String,String>)


242
243
244
245
246
247
248
249
250
251
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 242

class DialogAction < Struct.new(
  :type,
  :intent_name,
  :slots,
  :slot_to_elicit,
  :fulfillment_state,
  :message,
  :message_format)
  include Aws::Structure
end

#typeString

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

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

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

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

  • ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

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

Returns:

  • (String)


242
243
244
245
246
247
248
249
250
251
# File 'gems/aws-sdk-lex/lib/aws-sdk-lex/types.rb', line 242

class DialogAction < Struct.new(
  :type,
  :intent_name,
  :slots,
  :slot_to_elicit,
  :fulfillment_state,
  :message,
  :message_format)
  include Aws::Structure
end