Amazonka.LexModels.Types.Prompt

Documentation

data Prompt

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: newPrompt smart constructor.

Constructors

Prompt'

Fields

• responseCard :: Maybe Text

  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.

• messages :: NonEmpty 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).

• maxAttempts :: Natural

  The number of times to prompt the user for information.

Instances

FromJSON Prompt

Defined in Amazonka.LexModels.Types.Prompt

Methods

parseJSON :: Value -> Parser Prompt

parseJSONList :: Value -> Parser [Prompt]

ToJSON Prompt

Defined in Amazonka.LexModels.Types.Prompt

Methods

toJSON :: Prompt -> Value

toEncoding :: Prompt -> Encoding

toJSONList :: [Prompt] -> Value

toEncodingList :: [Prompt] -> Encoding

Generic Prompt

Defined in Amazonka.LexModels.Types.Prompt

Associated Types

type Rep Prompt :: Type -> Type

Methods

from :: Prompt -> Rep Prompt x

to :: Rep Prompt x -> Prompt

Read Prompt

Defined in Amazonka.LexModels.Types.Prompt

Methods

readsPrec :: Int -> ReadS Prompt

readList :: ReadS [Prompt]

readPrec :: ReadPrec Prompt

readListPrec :: ReadPrec [Prompt]

Show Prompt

Defined in Amazonka.LexModels.Types.Prompt

Methods

showsPrec :: Int -> Prompt -> ShowS

show :: Prompt -> String

showList :: [Prompt] -> ShowS

NFData Prompt

Defined in Amazonka.LexModels.Types.Prompt

Methods

rnf :: Prompt -> ()

Eq Prompt

Defined in Amazonka.LexModels.Types.Prompt

Methods

(==) :: Prompt -> Prompt -> Bool

(/=) :: Prompt -> Prompt -> Bool

Hashable Prompt

Defined in Amazonka.LexModels.Types.Prompt

Methods

hashWithSalt :: Int -> Prompt -> Int

hash :: Prompt -> Int

type Rep Prompt

Defined in Amazonka.LexModels.Types.Prompt

type Rep Prompt = D1 ('MetaData "Prompt" "Amazonka.LexModels.Types.Prompt" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "Prompt'" 'PrefixI 'True) (S1 ('MetaSel ('Just "responseCard") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "messages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Message)) :*: S1 ('MetaSel ('Just "maxAttempts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))

newPrompt

Arguments

:: NonEmpty Message

$sel:messages:Prompt'

-> Natural

$sel:maxAttempts:Prompt'

-> Prompt

Create a value of Prompt with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:responseCard:Prompt', prompt_responseCard - 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.

$sel:messages:Prompt', prompt_messages - 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).

$sel:maxAttempts:Prompt', prompt_maxAttempts - The number of times to prompt the user for information.

prompt_responseCard :: Lens' Prompt (Maybe Text)

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.

prompt_messages :: Lens' Prompt (NonEmpty 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).

prompt_maxAttempts :: Lens' Prompt Natural

The number of times to prompt the user for information.