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

Class: Aws::LexModelBuildingService::Types::Prompt

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

Overview

Note:

When passing Prompt as input to an Aws::Client method, you can use a vanilla Hash:

{
  messages: [ # required
    {
      content_type: "PlainText", # required, accepts PlainText, SSML, CustomPayload
      content: "ContentString", # required
      group_number: 1,
    },
  ],
  max_attempts: 1, # required
  response_card: "ResponseCard",
}

Obtains information from the user. To define a prompt, provide one or more messages and specify the number of attempts to get information from the user. If you provide more than one message, Amazon Lex chooses one of the messages to use to prompt the user. For more information, see how-it-works.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#max_attempts ⇒ Integer

The number of times to prompt the user for information.

Returns:

  • (Integer) —

    The number of times to prompt the user for information.

#messages ⇒ Array<Types::Message>

An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

Returns:

  • (Array<Types::Message>) —

    An array of objects, each of which provides a message string and its type.

#response_card ⇒ String

A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

Returns:

  • (String) —

    A response card.