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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DialogAction as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

See Also:

Instance Attribute Summary collapse

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.

    Possible values:

    • Fulfilled
    • Failed
    • ReadyForFulfillment

Returns:

  • (String) —

    The fulfillment state of the intent.

#intent_name ⇒ String

The name of the intent.

Returns:

  • (String) —

    The name of the intent.

#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) —

    The message that should be shown to the user.

#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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (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. 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.

    Possible values:

    • ElicitIntent
    • ConfirmIntent
    • ElicitSlot
    • Close
    • Delegate

Returns:

  • (String) —

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