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

Inherits:

Struct

• Object
• Struct
• Aws::LexModelBuildingService::Types::Slot

Includes:

Structure

Defined in:

lib/aws-sdk-lexmodelbuildingservice/types.rb

Overview

Identifies the version of a specific slot.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

Returns:

• (Types::SlotDefaultValueSpec)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4065

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.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4065

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.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4065

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 ][1].

[1]: docs.aws.amazon.com/lex/latest/dg/how-obfuscate.html

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4065

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4065

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.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4065

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.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4065

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.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4065

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.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4065

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.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4065

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.

Returns:

• (Types::Prompt)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 4065

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