amazonka-lexv2-models-2.0: Amazon Lex Model Building V2 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.LexV2Models.Types.PromptSpecification

Description

 
Synopsis

Documentation

data PromptSpecification Source #

Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.

See: newPromptSpecification smart constructor.

Constructors

PromptSpecification' 

Fields

Instances

Instances details
FromJSON PromptSpecification Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.PromptSpecification

Methods

parseJSON :: Value -> Parser PromptSpecification #

parseJSONList :: Value -> Parser [PromptSpecification] #

ToJSON PromptSpecification Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.PromptSpecification

Methods

toJSON :: PromptSpecification -> Value #

toEncoding :: PromptSpecification -> Encoding #

toJSONList :: [PromptSpecification] -> Value #

toEncodingList :: [PromptSpecification] -> Encoding #

Generic PromptSpecification Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.PromptSpecification

Associated Types

type Rep PromptSpecification :: Type -> Type #

Methods

from :: PromptSpecification -> Rep PromptSpecification x #

to :: Rep PromptSpecification x -> PromptSpecification #

Read PromptSpecification Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.PromptSpecification

Methods

readsPrec :: Int -> ReadS PromptSpecification #

readList :: ReadS [PromptSpecification] #

readPrec :: ReadPrec PromptSpecification #

readListPrec :: ReadPrec [PromptSpecification] #

Show PromptSpecification Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.PromptSpecification

Methods

showsPrec :: Int -> PromptSpecification -> ShowS #

show :: PromptSpecification -> String #

showList :: [PromptSpecification] -> ShowS #

NFData PromptSpecification Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.PromptSpecification

Methods

rnf :: PromptSpecification -> () #

Eq PromptSpecification Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.PromptSpecification

Methods

(==) :: PromptSpecification -> PromptSpecification -> Bool #

(/=) :: PromptSpecification -> PromptSpecification -> Bool #

Hashable PromptSpecification Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.PromptSpecification

Methods

hashWithSalt :: Int -> PromptSpecification -> Int #

hash :: PromptSpecification -> Int #

type Rep PromptSpecification Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.PromptSpecification

type Rep PromptSpecification = D1 ('MetaData "PromptSpecification" "Amazonka.LexV2Models.Types.PromptSpecification" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "PromptSpecification'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allowInterrupt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "messageSelectionStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageSelectionStrategy))) :*: (S1 ('MetaSel ('Just "promptAttemptsSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap PromptAttempt PromptAttemptSpecification))) :*: (S1 ('MetaSel ('Just "messageGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty MessageGroup)) :*: S1 ('MetaSel ('Just "maxRetries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))))

newPromptSpecification Source #

Arguments

:: NonEmpty MessageGroup

$sel:messageGroups:PromptSpecification'

-> Natural

$sel:maxRetries:PromptSpecification'

-> PromptSpecification 

Create a value of PromptSpecification 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:

PromptSpecification, promptSpecification_allowInterrupt - Indicates whether the user can interrupt a speech prompt from the bot.

$sel:messageSelectionStrategy:PromptSpecification', promptSpecification_messageSelectionStrategy - Indicates how a message is selected from a message group among retries.

$sel:promptAttemptsSpecification:PromptSpecification', promptSpecification_promptAttemptsSpecification - Specifies the advanced settings on each attempt of the prompt.

$sel:messageGroups:PromptSpecification', promptSpecification_messageGroups - A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

$sel:maxRetries:PromptSpecification', promptSpecification_maxRetries - The maximum number of times the bot tries to elicit a response from the user using this prompt.

promptSpecification_allowInterrupt :: Lens' PromptSpecification (Maybe Bool) Source #

Indicates whether the user can interrupt a speech prompt from the bot.

promptSpecification_messageSelectionStrategy :: Lens' PromptSpecification (Maybe MessageSelectionStrategy) Source #

Indicates how a message is selected from a message group among retries.

promptSpecification_promptAttemptsSpecification :: Lens' PromptSpecification (Maybe (HashMap PromptAttempt PromptAttemptSpecification)) Source #

Specifies the advanced settings on each attempt of the prompt.

promptSpecification_messageGroups :: Lens' PromptSpecification (NonEmpty MessageGroup) Source #

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

promptSpecification_maxRetries :: Lens' PromptSpecification Natural Source #

The maximum number of times the bot tries to elicit a response from the user using this prompt.