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

Inherits:

Struct

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

Includes:

Structure

Defined in:

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
        content: "ContentString", # required
      },
    ],
    max_attempts: 1, # required
    response_card: "ResponseCard",
  },
  priority: 1,
  sample_utterances: ["Utterance"],
  response_card: "ResponseCard",
}

Identifies the version of a specific slot.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #description ⇒ String

  A description of the slot.

• #name ⇒ String

  The name of the slot.

• #priority ⇒ Integer

  Directs 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

#description ⇒ String

A description of the slot.

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

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

#name ⇒ String

The name of the slot.

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

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

#priority ⇒ Integer

Directs 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 Lex first elicits a value for the slot with priority 1.

If multiple slots share the same priority, the order in which Lex elicits values is arbitrary.

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

class Slot < Struct.new(
  :name,
  :description,
  :slot_constraint,
  :slot_type,
  :slot_type_version,
  :value_elicitation_prompt,
  :priority,
  :sample_utterances,
  :response_card)
  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.

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

class Slot < Struct.new(
  :name,
  :description,
  :slot_constraint,
  :slot_type,
  :slot_type_version,
  :value_elicitation_prompt,
  :priority,
  :sample_utterances,
  :response_card)
  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.

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

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

#slot_constraint ⇒ String

Specifies whether the slot is required or optional.

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

class Slot < Struct.new(
  :name,
  :description,
  :slot_constraint,
  :slot_type,
  :slot_type_version,
  :value_elicitation_prompt,
  :priority,
  :sample_utterances,
  :response_card)
  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.

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

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

#slot_type_version ⇒ String

The version of the slot type.

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

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

#value_elicitation_prompt ⇒ Types::Prompt

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

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

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