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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-lexmodelbuildingservice/types.rb

Overview

Note:

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

{
  messages: [ # required
    {
      content_type: "PlainText", # required, accepts PlainText, SSML
      content: "ContentString", # required
    },
  ],
  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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#max_attempts ⇒ Integer

The number of times to prompt the user for information.

Returns:

  • (Integer) 


2208
2209
2210
2211
2212
2213
 
# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2208

class Prompt < Struct.new(
  :messages,
  :max_attempts,
  :response_card)
  include Aws::Structure
end

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



2208
2209
2210
2211
2212
2213
 
# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2208

class Prompt < Struct.new(
  :messages,
  :max_attempts,
  :response_card)
  include Aws::Structure
end

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


2208
2209
2210
2211
2212
2213
 
# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2208

class Prompt < Struct.new(
  :messages,
  :max_attempts,
  :response_card)
  include Aws::Structure
end