Class: Aws::LexModelsV2::Types::CreateSlotTypeRequest

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

Overview

Note:

When making an API call, you may pass CreateSlotTypeRequest data as a hash:

{
  slot_type_name: "Name", # required
  description: "Description",
  slot_type_values: [
    {
      sample_value: {
        value: "Value", # required
      },
      synonyms: [
        {
          value: "Value", # required
        },
      ],
    },
  ],
  value_selection_setting: { # required
    resolution_strategy: "OriginalValue", # required, accepts OriginalValue, TopResolution
    regex_filter: {
      pattern: "RegexPattern", # required
    },
  },
  parent_slot_type_signature: "SlotTypeSignature",
  bot_id: "Id", # required
  bot_version: "DraftBotVersion", # required
  locale_id: "LocaleId", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bot_idString

The identifier of the bot associated with this slot type.

Returns:

  • (String)


3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 3154

class CreateSlotTypeRequest < Struct.new(
  :slot_type_name,
  :description,
  :slot_type_values,
  :value_selection_setting,
  :parent_slot_type_signature,
  :bot_id,
  :bot_version,
  :locale_id)
  SENSITIVE = []
  include Aws::Structure
end

#bot_versionString

The identifier of the bot version associated with this slot type.

Returns:

  • (String)


3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 3154

class CreateSlotTypeRequest < Struct.new(
  :slot_type_name,
  :description,
  :slot_type_values,
  :value_selection_setting,
  :parent_slot_type_signature,
  :bot_id,
  :bot_version,
  :locale_id)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the slot type. Use the description to help identify the slot type in lists.

Returns:

  • (String)


3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 3154

class CreateSlotTypeRequest < Struct.new(
  :slot_type_name,
  :description,
  :slot_type_values,
  :value_selection_setting,
  :parent_slot_type_signature,
  :bot_id,
  :bot_version,
  :locale_id)
  SENSITIVE = []
  include Aws::Structure
end

#locale_idString

The identifier of the language and locale that the slot type will be used in. The string must match one of the supported locales. All of the bots, intents, and slots used by the slot type must have the same locale. For more information, see Supported languages.

Returns:

  • (String)


3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 3154

class CreateSlotTypeRequest < Struct.new(
  :slot_type_name,
  :description,
  :slot_type_values,
  :value_selection_setting,
  :parent_slot_type_signature,
  :bot_id,
  :bot_version,
  :locale_id)
  SENSITIVE = []
  include Aws::Structure
end

#parent_slot_type_signatureString

The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type.

Only AMAZON.AlphaNumeric is supported.

Returns:

  • (String)


3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 3154

class CreateSlotTypeRequest < Struct.new(
  :slot_type_name,
  :description,
  :slot_type_values,
  :value_selection_setting,
  :parent_slot_type_signature,
  :bot_id,
  :bot_version,
  :locale_id)
  SENSITIVE = []
  include Aws::Structure
end

#slot_type_nameString

The name for the slot. A slot type name must be unique within the account.

Returns:

  • (String)


3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 3154

class CreateSlotTypeRequest < Struct.new(
  :slot_type_name,
  :description,
  :slot_type_values,
  :value_selection_setting,
  :parent_slot_type_signature,
  :bot_id,
  :bot_version,
  :locale_id)
  SENSITIVE = []
  include Aws::Structure
end

#slot_type_valuesArray<Types::SlotTypeValue>

A list of SlotTypeValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot.

Returns:



3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 3154

class CreateSlotTypeRequest < Struct.new(
  :slot_type_name,
  :description,
  :slot_type_values,
  :value_selection_setting,
  :parent_slot_type_signature,
  :bot_id,
  :bot_version,
  :locale_id)
  SENSITIVE = []
  include Aws::Structure
end

#value_selection_settingTypes::SlotValueSelectionSetting

Determines the strategy that Amazon Lex uses to select a value from the list of possible values. The field can be set to one of the following values:

  • OriginalValue - Returns the value entered by the user, if the user value is similar to the slot value.

  • TopResolution - If there is a resolution list for the slot, return the first value in the resolution list. If there is no resolution list, return null.

If you don't specify the valueSelectionSetting parameter, the default is OriginalValue.



3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 3154

class CreateSlotTypeRequest < Struct.new(
  :slot_type_name,
  :description,
  :slot_type_values,
  :value_selection_setting,
  :parent_slot_type_signature,
  :bot_id,
  :bot_version,
  :locale_id)
  SENSITIVE = []
  include Aws::Structure
end