class Aws::LexModelBuildingService::Types::Slot
Identifies the version of a specific slot.
@note When making an API call, you may pass Slot
data as a hash: { name: "SlotName", # required description: "Description", slot_constraint: "Required", # required, accepts Required, Optional slot_type: "CustomOrBuiltinSlotTypeName", slot_type_version: "Version", value_elicitation_prompt: { messages: [ # required { content_type: "PlainText", # required, accepts PlainText, SSML, CustomPayload content: "ContentString", # required group_number: 1, }, ], max_attempts: 1, # required response_card: "ResponseCard", }, priority: 1, sample_utterances: ["Utterance"], response_card: "ResponseCard", obfuscation_setting: "NONE", # accepts NONE, DEFAULT_OBFUSCATION default_value_spec: { default_value_list: [ # required { default_value: "SlotDefaultValueString", # required }, ], }, }
@!attribute [rw] name
The name of the slot. @return [String]
@!attribute [rw] description
A description of the slot. @return [String]
@!attribute [rw] slot_constraint
Specifies whether the slot is required or optional. @return [String]
@!attribute [rw] slot_type
The type of the slot, either a custom slot type that you defined or one of the built-in slot types. @return [String]
@!attribute [rw] slot_type_version
The version of the slot type. @return [String]
@!attribute [rw] value_elicitation_prompt
The prompt that Amazon Lex uses to elicit the slot value from the user. @return [Types::Prompt]
@!attribute [rw] 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. @return [Integer]
@!attribute [rw] sample_utterances
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. @return [Array<String>]
@!attribute [rw] response_card
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. @return [String]
@!attribute [rw] obfuscation_setting
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 ][1]. [1]: https://docs.aws.amazon.com/lex/latest/dg/how-obfuscate.html @return [String]
@!attribute [rw] default_value_spec
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. @return [Types::SlotDefaultValueSpec]
@see docs.aws.amazon.com/goto/WebAPI/lex-models-2017-04-19/Slot AWS API Documentation
Constants
- SENSITIVE