Class: Aws::LexModelBuildingService::Types::Slot
- Inherits:
-
Struct
- Object
- Struct
- Aws::LexModelBuildingService::Types::Slot
- Defined in:
- gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb
Overview
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
},
],
},
}
Identifies the version of a specific slot.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#default_value_spec ⇒ Types::SlotDefaultValueSpec
A list of default values for the slot.
-
#description ⇒ String
A description of the slot.
-
#name ⇒ String
The name of the slot.
-
#obfuscation_setting ⇒ String
Determines whether a slot is obfuscated in conversation logs and stored utterances.
-
#priority ⇒ Integer
Directs Amazon Lex the order in which to elicit this slot value from the user.
-
#response_card ⇒ String
A set of possible responses for the slot type used by text-based clients.
-
#sample_utterances ⇒ Array<String>
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.
-
#slot_constraint ⇒ String
Specifies whether the slot is required or optional.
-
#slot_type ⇒ String
The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
-
#slot_type_version ⇒ String
The version of the slot type.
-
#value_elicitation_prompt ⇒ Types::Prompt
The prompt that Amazon Lex uses to elicit the slot value from the user.
Instance Attribute Details
#default_value_spec ⇒ Types::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.
4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4752 class Slot < Struct.new( :name, :description, :slot_constraint, :slot_type, :slot_type_version, :value_elicitation_prompt, :priority, :sample_utterances, :response_card, :obfuscation_setting, :default_value_spec) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A description of the slot.
4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4752 class Slot < Struct.new( :name, :description, :slot_constraint, :slot_type, :slot_type_version, :value_elicitation_prompt, :priority, :sample_utterances, :response_card, :obfuscation_setting, :default_value_spec) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the slot.
4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4752 class Slot < Struct.new( :name, :description, :slot_constraint, :slot_type, :slot_type_version, :value_elicitation_prompt, :priority, :sample_utterances, :response_card, :obfuscation_setting, :default_value_spec) SENSITIVE = [] include Aws::Structure end |
#obfuscation_setting ⇒ String
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 .
4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4752 class Slot < Struct.new( :name, :description, :slot_constraint, :slot_type, :slot_type_version, :value_elicitation_prompt, :priority, :sample_utterances, :response_card, :obfuscation_setting, :default_value_spec) SENSITIVE = [] include Aws::Structure end |
#priority ⇒ Integer
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.
4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4752 class Slot < Struct.new( :name, :description, :slot_constraint, :slot_type, :slot_type_version, :value_elicitation_prompt, :priority, :sample_utterances, :response_card, :obfuscation_setting, :default_value_spec) SENSITIVE = [] include Aws::Structure end |
#response_card ⇒ String
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.
4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4752 class Slot < Struct.new( :name, :description, :slot_constraint, :slot_type, :slot_type_version, :value_elicitation_prompt, :priority, :sample_utterances, :response_card, :obfuscation_setting, :default_value_spec) SENSITIVE = [] include Aws::Structure end |
#sample_utterances ⇒ Array<String>
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.
4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4752 class Slot < Struct.new( :name, :description, :slot_constraint, :slot_type, :slot_type_version, :value_elicitation_prompt, :priority, :sample_utterances, :response_card, :obfuscation_setting, :default_value_spec) SENSITIVE = [] include Aws::Structure end |
#slot_constraint ⇒ String
Specifies whether the slot is required or optional.
4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4752 class Slot < Struct.new( :name, :description, :slot_constraint, :slot_type, :slot_type_version, :value_elicitation_prompt, :priority, :sample_utterances, :response_card, :obfuscation_setting, :default_value_spec) SENSITIVE = [] include Aws::Structure end |
#slot_type ⇒ String
The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4752 class Slot < Struct.new( :name, :description, :slot_constraint, :slot_type, :slot_type_version, :value_elicitation_prompt, :priority, :sample_utterances, :response_card, :obfuscation_setting, :default_value_spec) SENSITIVE = [] include Aws::Structure end |
#slot_type_version ⇒ String
The version of the slot type.
4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4752 class Slot < Struct.new( :name, :description, :slot_constraint, :slot_type, :slot_type_version, :value_elicitation_prompt, :priority, :sample_utterances, :response_card, :obfuscation_setting, :default_value_spec) SENSITIVE = [] include Aws::Structure end |
#value_elicitation_prompt ⇒ Types::Prompt
The prompt that Amazon Lex uses to elicit the slot value from the user.
4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 |
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4752 class Slot < Struct.new( :name, :description, :slot_constraint, :slot_type, :slot_type_version, :value_elicitation_prompt, :priority, :sample_utterances, :response_card, :obfuscation_setting, :default_value_spec) SENSITIVE = [] include Aws::Structure end |