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

Inherits:

Struct

• Object
• Struct
• Aws::Lex::Types::DialogAction

Includes:

Structure

Defined in:

lib/aws-sdk-lex/types.rb

Overview

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:slots, :message]

Instance Attribute Summary

• #fulfillment_state ⇒ String

  The fulfillment state of the intent.

• #intent_name ⇒ String

  The name of the intent.

• #message ⇒ String

  The message that should be shown to the user.

• #message_format ⇒ String

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

• #slot_to_elicit ⇒ String

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

• #slots ⇒ Hash<String,String>

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

• #type ⇒ String

  The next action that the bot should take in its interaction with the user.

Instance Attribute Details

#fulfillment_state ⇒ String

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)

# File 'lib/aws-sdk-lex/types.rb', line 279

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

#intent_name ⇒ String

The name of the intent.

Returns:

• (String)

# File 'lib/aws-sdk-lex/types.rb', line 279

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

#message ⇒ String

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)

# File 'lib/aws-sdk-lex/types.rb', line 279

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

#message_format ⇒ String

• ‘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].

[1]: docs.aws.amazon.com/lex/latest/dg/howitworks-manage-prompts.html

Returns:

• (String)

# File 'lib/aws-sdk-lex/types.rb', line 279

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

#slot_to_elicit ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-lex/types.rb', line 279

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

#slots ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-lex/types.rb', line 279

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

#type ⇒ String

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)

# File 'lib/aws-sdk-lex/types.rb', line 279

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