Amazonka.LexV2Models.Types.SlotValueElicitationSetting

Documentation

data SlotValueElicitationSetting

Specifies the elicitation setting details for constituent sub slots of a composite slot.

See: newSlotValueElicitationSetting smart constructor.

Constructors

SlotValueElicitationSetting'

Fields

• defaultValueSpecification :: Maybe SlotDefaultValueSpecification

  A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.

• promptSpecification :: Maybe PromptSpecification

  The prompt that Amazon Lex uses to elicit the slot value from the user.

• sampleUtterances :: Maybe [SampleUtterance]

  If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

• slotCaptureSetting :: Maybe SlotCaptureSetting

  Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.

• waitAndContinueSpecification :: Maybe WaitAndContinueSpecification
• slotConstraint :: SlotConstraint

  Specifies whether the slot is required or optional.

Instances

FromJSON SlotValueElicitationSetting

Defined in Amazonka.LexV2Models.Types.SlotValueElicitationSetting

Methods

parseJSON :: Value -> Parser SlotValueElicitationSetting

parseJSONList :: Value -> Parser [SlotValueElicitationSetting]

ToJSON SlotValueElicitationSetting

Defined in Amazonka.LexV2Models.Types.SlotValueElicitationSetting

Methods

toJSON :: SlotValueElicitationSetting -> Value

toEncoding :: SlotValueElicitationSetting -> Encoding

toJSONList :: [SlotValueElicitationSetting] -> Value

toEncodingList :: [SlotValueElicitationSetting] -> Encoding

Generic SlotValueElicitationSetting

Defined in Amazonka.LexV2Models.Types.SlotValueElicitationSetting

Associated Types

type Rep SlotValueElicitationSetting :: Type -> Type

Methods

from :: SlotValueElicitationSetting -> Rep SlotValueElicitationSetting x

to :: Rep SlotValueElicitationSetting x -> SlotValueElicitationSetting

Read SlotValueElicitationSetting

Defined in Amazonka.LexV2Models.Types.SlotValueElicitationSetting

Methods

readsPrec :: Int -> ReadS SlotValueElicitationSetting

readList :: ReadS [SlotValueElicitationSetting]

readPrec :: ReadPrec SlotValueElicitationSetting

readListPrec :: ReadPrec [SlotValueElicitationSetting]

Show SlotValueElicitationSetting

Defined in Amazonka.LexV2Models.Types.SlotValueElicitationSetting

Methods

showsPrec :: Int -> SlotValueElicitationSetting -> ShowS

show :: SlotValueElicitationSetting -> String

showList :: [SlotValueElicitationSetting] -> ShowS

NFData SlotValueElicitationSetting

Defined in Amazonka.LexV2Models.Types.SlotValueElicitationSetting

Methods

rnf :: SlotValueElicitationSetting -> ()

Eq SlotValueElicitationSetting

Defined in Amazonka.LexV2Models.Types.SlotValueElicitationSetting

Methods

(==) :: SlotValueElicitationSetting -> SlotValueElicitationSetting -> Bool

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

Hashable SlotValueElicitationSetting

Defined in Amazonka.LexV2Models.Types.SlotValueElicitationSetting

Methods

hashWithSalt :: Int -> SlotValueElicitationSetting -> Int

hash :: SlotValueElicitationSetting -> Int

type Rep SlotValueElicitationSetting

Defined in Amazonka.LexV2Models.Types.SlotValueElicitationSetting

type Rep SlotValueElicitationSetting = D1 ('MetaData "SlotValueElicitationSetting" "Amazonka.LexV2Models.Types.SlotValueElicitationSetting" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "SlotValueElicitationSetting'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "defaultValueSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SlotDefaultValueSpecification)) :*: (S1 ('MetaSel ('Just "promptSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PromptSpecification)) :*: S1 ('MetaSel ('Just "sampleUtterances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SampleUtterance])))) :*: (S1 ('MetaSel ('Just "slotCaptureSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SlotCaptureSetting)) :*: (S1 ('MetaSel ('Just "waitAndContinueSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WaitAndContinueSpecification)) :*: S1 ('MetaSel ('Just "slotConstraint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SlotConstraint)))))

newSlotValueElicitationSetting

Arguments

:: SlotConstraint

$sel:slotConstraint:SlotValueElicitationSetting'

-> SlotValueElicitationSetting

Create a value of SlotValueElicitationSetting 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:defaultValueSpecification:SlotValueElicitationSetting', slotValueElicitationSetting_defaultValueSpecification - A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.

$sel:promptSpecification:SlotValueElicitationSetting', slotValueElicitationSetting_promptSpecification - The prompt that Amazon Lex uses to elicit the slot value from the user.

$sel:sampleUtterances:SlotValueElicitationSetting', slotValueElicitationSetting_sampleUtterances - If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

$sel:slotCaptureSetting:SlotValueElicitationSetting', slotValueElicitationSetting_slotCaptureSetting - Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.

$sel:waitAndContinueSpecification:SlotValueElicitationSetting', slotValueElicitationSetting_waitAndContinueSpecification - Undocumented member.

$sel:slotConstraint:SlotValueElicitationSetting', slotValueElicitationSetting_slotConstraint - Specifies whether the slot is required or optional.

slotValueElicitationSetting_defaultValueSpecification :: Lens' SlotValueElicitationSetting (Maybe SlotDefaultValueSpecification)

A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.

slotValueElicitationSetting_promptSpecification :: Lens' SlotValueElicitationSetting (Maybe PromptSpecification)

The prompt that Amazon Lex uses to elicit the slot value from the user.

slotValueElicitationSetting_sampleUtterances :: Lens' SlotValueElicitationSetting (Maybe [SampleUtterance])

If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

slotValueElicitationSetting_slotCaptureSetting :: Lens' SlotValueElicitationSetting (Maybe SlotCaptureSetting)

Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.

slotValueElicitationSetting_waitAndContinueSpecification :: Lens' SlotValueElicitationSetting (Maybe WaitAndContinueSpecification)

Undocumented member.

slotValueElicitationSetting_slotConstraint :: Lens' SlotValueElicitationSetting SlotConstraint

Specifies whether the slot is required or optional.