Class: Aws::LexModelsV2::Types::ResponseSpecification

Inherits:

Struct

• Object
• Struct
• Aws::LexModelsV2::Types::ResponseSpecification

Defined in:

gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb

Overview

Note:

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

{
  message_groups: [ # required
    {
      message: { # required
        plain_text_message: {
          value: "PlainTextMessageValue", # required
        },
        custom_payload: {
          value: "CustomPayloadValue", # required
        },
        ssml_message: {
          value: "SSMLMessageValue", # required
        },
        image_response_card: {
          title: "AttachmentTitle", # required
          subtitle: "AttachmentTitle",
          image_url: "AttachmentUrl",
          buttons: [
            {
              text: "ButtonText", # required
              value: "ButtonValue", # required
            },
          ],
        },
      },
      variations: [
        {
          plain_text_message: {
            value: "PlainTextMessageValue", # required
          },
          custom_payload: {
            value: "CustomPayloadValue", # required
          },
          ssml_message: {
            value: "SSMLMessageValue", # required
          },
          image_response_card: {
            title: "AttachmentTitle", # required
            subtitle: "AttachmentTitle",
            image_url: "AttachmentUrl",
            buttons: [
              {
                text: "ButtonText", # required
                value: "ButtonValue", # required
              },
            ],
          },
        },
      ],
    },
  ],
  allow_interrupt: false,
}

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allow_interrupt ⇒ Boolean

  Indicates whether the user can interrupt a speech response from Amazon Lex.

• #message_groups ⇒ Array<Types::MessageGroup>

  A collection of responses that Amazon Lex can send to the user.

Instance Attribute Details

#allow_interrupt ⇒ Boolean

Indicates whether the user can interrupt a speech response from Amazon Lex.

Returns:

• (Boolean)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6844

class ResponseSpecification < Struct.new(
  :message_groups,
  :allow_interrupt)
  SENSITIVE = []
  include Aws::Structure
end

#message_groups ⇒ Array<Types::MessageGroup>

A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

Returns:

• (Array<Types::MessageGroup>)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6844

class ResponseSpecification < Struct.new(
  :message_groups,
  :allow_interrupt)
  SENSITIVE = []
  include Aws::Structure
end