Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Synopsis
- data Slot = Slot' {
- slotType :: Maybe Text
- valueElicitationPrompt :: Maybe Prompt
- responseCard :: Maybe Text
- priority :: Maybe Natural
- obfuscationSetting :: Maybe ObfuscationSetting
- defaultValueSpec :: Maybe SlotDefaultValueSpec
- slotTypeVersion :: Maybe Text
- sampleUtterances :: Maybe [Text]
- description :: Maybe Text
- name :: Text
- slotConstraint :: SlotConstraint
- newSlot :: Text -> SlotConstraint -> Slot
- slot_slotType :: Lens' Slot (Maybe Text)
- slot_valueElicitationPrompt :: Lens' Slot (Maybe Prompt)
- slot_responseCard :: Lens' Slot (Maybe Text)
- slot_priority :: Lens' Slot (Maybe Natural)
- slot_obfuscationSetting :: Lens' Slot (Maybe ObfuscationSetting)
- slot_defaultValueSpec :: Lens' Slot (Maybe SlotDefaultValueSpec)
- slot_slotTypeVersion :: Lens' Slot (Maybe Text)
- slot_sampleUtterances :: Lens' Slot (Maybe [Text])
- slot_description :: Lens' Slot (Maybe Text)
- slot_name :: Lens' Slot Text
- slot_slotConstraint :: Lens' Slot SlotConstraint
Documentation
Identifies the version of a specific slot.
See: newSlot
smart constructor.
Slot' | |
|
Instances
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_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_slotConstraint :: Lens' Slot SlotConstraint Source #
Specifies whether the slot is required or optional.