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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lexmodelbuildingservice/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.

Instance Attribute Summary collapse

Instance Attribute Details

#max_attemptsInteger

The number of times to prompt the user for information.

Returns:

  • (Integer)


2313
2314
2315
2316
2317
2318
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2313

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

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



2313
2314
2315
2316
2317
2318
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2313

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

#response_cardString

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)


2313
2314
2315
2316
2317
2318
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 2313

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