libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.LexModels.Types.Slot

Description

 
Synopsis

Documentation

data Slot Source #

Identifies the version of a specific slot.

See: newSlot smart constructor.

Constructors

Slot' 

Fields

  • slotType :: Maybe Text

    The type of the slot, either a custom slot type that you defined or one of the built-in slot types.

  • valueElicitationPrompt :: Maybe Prompt

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

  • responseCard :: Maybe Text

    A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.

  • priority :: Maybe Natural

    Directs Amazon Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Amazon Lex first elicits a value for the slot with priority 1.

    If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.

  • obfuscationSetting :: Maybe ObfuscationSetting

    Determines whether a slot is obfuscated in conversation logs and stored utterances. When you obfuscate a slot, the value is replaced by the slot name in curly braces ({}). For example, if the slot name is "full_name", obfuscated values are replaced with "{full_name}". For more information, see Slot Obfuscation .

  • defaultValueSpec :: Maybe SlotDefaultValueSpec

    A list of default values for the 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.

  • slotTypeVersion :: Maybe Text

    The version of the slot type.

  • sampleUtterances :: Maybe [Text]

    If you know a specific pattern with which 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.

  • description :: Maybe Text

    A description of the slot.

  • name :: Text

    The name of the slot.

  • slotConstraint :: SlotConstraint

    Specifies whether the slot is required or optional.

Instances

Instances details
Eq Slot Source # 
Instance details

Defined in Amazonka.LexModels.Types.Slot

Methods

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

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

Read Slot Source # 
Instance details

Defined in Amazonka.LexModels.Types.Slot

Show Slot Source # 
Instance details

Defined in Amazonka.LexModels.Types.Slot

Methods

showsPrec :: Int -> Slot -> ShowS #

show :: Slot -> String #

showList :: [Slot] -> ShowS #

Generic Slot Source # 
Instance details

Defined in Amazonka.LexModels.Types.Slot

Associated Types

type Rep Slot :: Type -> Type #

Methods

from :: Slot -> Rep Slot x #

to :: Rep Slot x -> Slot #

NFData Slot Source # 
Instance details

Defined in Amazonka.LexModels.Types.Slot

Methods

rnf :: Slot -> () #

Hashable Slot Source # 
Instance details

Defined in Amazonka.LexModels.Types.Slot

Methods

hashWithSalt :: Int -> Slot -> Int #

hash :: Slot -> Int #

ToJSON Slot Source # 
Instance details

Defined in Amazonka.LexModels.Types.Slot

FromJSON Slot Source # 
Instance details

Defined in Amazonka.LexModels.Types.Slot

type Rep Slot Source # 
Instance details

Defined in Amazonka.LexModels.Types.Slot

type Rep Slot = D1 ('MetaData "Slot" "Amazonka.LexModels.Types.Slot" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "Slot'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "slotType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "valueElicitationPrompt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Prompt))) :*: (S1 ('MetaSel ('Just "responseCard") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "obfuscationSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObfuscationSetting))))) :*: ((S1 ('MetaSel ('Just "defaultValueSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SlotDefaultValueSpec)) :*: (S1 ('MetaSel ('Just "slotTypeVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sampleUtterances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "slotConstraint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SlotConstraint))))))

newSlot Source #

Create a value of Slot 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:slotType:Slot', slot_slotType - The type of the slot, either a custom slot type that you defined or one of the built-in slot types.

$sel:valueElicitationPrompt:Slot', slot_valueElicitationPrompt - The prompt that Amazon Lex uses to elicit the slot value from the user.

$sel:responseCard:Slot', slot_responseCard - A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.

$sel:priority:Slot', slot_priority - Directs Amazon Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Amazon Lex first elicits a value for the slot with priority 1.

If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.

$sel:obfuscationSetting:Slot', slot_obfuscationSetting - Determines whether a slot is obfuscated in conversation logs and stored utterances. When you obfuscate a slot, the value is replaced by the slot name in curly braces ({}). For example, if the slot name is "full_name", obfuscated values are replaced with "{full_name}". For more information, see Slot Obfuscation .

$sel:defaultValueSpec:Slot', slot_defaultValueSpec - A list of default values for the 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:slotTypeVersion:Slot', slot_slotTypeVersion - The version of the slot type.

$sel:sampleUtterances:Slot', slot_sampleUtterances - If you know a specific pattern with which 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:description:Slot', slot_description - A description of the slot.

$sel:name:Slot', slot_name - The name of the slot.

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

slot_slotType :: Lens' Slot (Maybe Text) Source #

The type of the slot, either a custom slot type that you defined or one of the built-in slot types.

slot_valueElicitationPrompt :: Lens' Slot (Maybe Prompt) Source #

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

slot_responseCard :: Lens' Slot (Maybe Text) Source #

A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.

slot_priority :: Lens' Slot (Maybe Natural) Source #

Directs Amazon Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Amazon Lex first elicits a value for the slot with priority 1.

If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.

slot_obfuscationSetting :: Lens' Slot (Maybe ObfuscationSetting) Source #

Determines whether a slot is obfuscated in conversation logs and stored utterances. When you obfuscate a slot, the value is replaced by the slot name in curly braces ({}). For example, if the slot name is "full_name", obfuscated values are replaced with "{full_name}". For more information, see Slot Obfuscation .

slot_defaultValueSpec :: Lens' Slot (Maybe SlotDefaultValueSpec) Source #

A list of default values for the 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.

slot_slotTypeVersion :: Lens' Slot (Maybe Text) Source #

The version of the slot type.

slot_sampleUtterances :: Lens' Slot (Maybe [Text]) Source #

If you know a specific pattern with which 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.

slot_description :: Lens' Slot (Maybe Text) Source #

A description of the slot.

slot_name :: Lens' Slot Text Source #

The name of the slot.

slot_slotConstraint :: Lens' Slot SlotConstraint Source #

Specifies whether the slot is required or optional.