Class: Aws::LexModelBuildingService::Types::Slot

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb

Overview

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
}

Identifies the version of a specific slot.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the slot.

Returns:

  • (String)


4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4183

class Slot < Struct.new(
  :name,
  :description,
  :slot_constraint,
  :slot_type,
  :slot_type_version,
  :value_elicitation_prompt,
  :priority,
  :sample_utterances,
  :response_card,
  :obfuscation_setting)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the slot.

Returns:

  • (String)


4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4183

class Slot < Struct.new(
  :name,
  :description,
  :slot_constraint,
  :slot_type,
  :slot_type_version,
  :value_elicitation_prompt,
  :priority,
  :sample_utterances,
  :response_card,
  :obfuscation_setting)
  SENSITIVE = []
  include Aws::Structure
end

#obfuscation_settingString

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 .

Returns:

  • (String)


4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4183

class Slot < Struct.new(
  :name,
  :description,
  :slot_constraint,
  :slot_type,
  :slot_type_version,
  :value_elicitation_prompt,
  :priority,
  :sample_utterances,
  :response_card,
  :obfuscation_setting)
  SENSITIVE = []
  include Aws::Structure
end

#priorityInteger

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.

Returns:

  • (Integer)


4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4183

class Slot < Struct.new(
  :name,
  :description,
  :slot_constraint,
  :slot_type,
  :slot_type_version,
  :value_elicitation_prompt,
  :priority,
  :sample_utterances,
  :response_card,
  :obfuscation_setting)
  SENSITIVE = []
  include Aws::Structure
end

#response_cardString

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.

Returns:

  • (String)


4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4183

class Slot < Struct.new(
  :name,
  :description,
  :slot_constraint,
  :slot_type,
  :slot_type_version,
  :value_elicitation_prompt,
  :priority,
  :sample_utterances,
  :response_card,
  :obfuscation_setting)
  SENSITIVE = []
  include Aws::Structure
end

#sample_utterancesArray<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.

Returns:

  • (Array<String>)


4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4183

class Slot < Struct.new(
  :name,
  :description,
  :slot_constraint,
  :slot_type,
  :slot_type_version,
  :value_elicitation_prompt,
  :priority,
  :sample_utterances,
  :response_card,
  :obfuscation_setting)
  SENSITIVE = []
  include Aws::Structure
end

#slot_constraintString

Specifies whether the slot is required or optional.

Returns:

  • (String)


4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4183

class Slot < Struct.new(
  :name,
  :description,
  :slot_constraint,
  :slot_type,
  :slot_type_version,
  :value_elicitation_prompt,
  :priority,
  :sample_utterances,
  :response_card,
  :obfuscation_setting)
  SENSITIVE = []
  include Aws::Structure
end

#slot_typeString

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

Returns:

  • (String)


4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4183

class Slot < Struct.new(
  :name,
  :description,
  :slot_constraint,
  :slot_type,
  :slot_type_version,
  :value_elicitation_prompt,
  :priority,
  :sample_utterances,
  :response_card,
  :obfuscation_setting)
  SENSITIVE = []
  include Aws::Structure
end

#slot_type_versionString

The version of the slot type.

Returns:

  • (String)


4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4183

class Slot < Struct.new(
  :name,
  :description,
  :slot_constraint,
  :slot_type,
  :slot_type_version,
  :value_elicitation_prompt,
  :priority,
  :sample_utterances,
  :response_card,
  :obfuscation_setting)
  SENSITIVE = []
  include Aws::Structure
end

#value_elicitation_promptTypes::Prompt

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

Returns:



4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4183

class Slot < Struct.new(
  :name,
  :description,
  :slot_constraint,
  :slot_type,
  :slot_type_version,
  :value_elicitation_prompt,
  :priority,
  :sample_utterances,
  :response_card,
  :obfuscation_setting)
  SENSITIVE = []
  include Aws::Structure
end