AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Slot as input to an Aws::Client method, you can use a vanilla 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.

Instance Attribute Summary collapse

Instance Attribute Details

#default_value_specTypes::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:

#descriptionString

A description of the slot.

Returns:

  • (String)

    A description of the slot.

#nameString

The name of the slot.

Returns:

  • (String)

    The name of the slot.

#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)

    Determines whether a slot is obfuscated in conversation logs and stored utterances.

#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)

    Directs Amazon Lex the order in which to elicit this slot value from the user.

#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)

    A set of possible responses for the slot type used by text-based clients.

#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>)

    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_constraintString

Specifies whether the slot is required or optional.

Possible values:

  • Required
  • Optional

Returns:

  • (String)

    Specifies whether the slot is required or optional.

#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)

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

#slot_type_versionString

The version of the slot type.

Returns:

  • (String)

    The version of the slot type.

#value_elicitation_promptTypes::Prompt

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

Returns:

  • (Types::Prompt)

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