Documentation

Identifies the version of a specific slot.

See: newSlot smart constructor.

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.

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

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

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.

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.

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 .

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.

The version of the slot type.

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.

A description of the slot.

The name of the slot.

Specifies whether the slot is required or optional.