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::PutSlotTypeRequest

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

Overview

Note:

When passing PutSlotTypeRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "SlotTypeName", # required
  description: "Description",
  enumeration_values: [
    {
      value: "Value", # required
      synonyms: ["Value"],
    },
  ],
  checksum: "String",
  value_selection_strategy: "ORIGINAL_VALUE", # accepts ORIGINAL_VALUE, TOP_RESOLUTION
  create_version: false,
  parent_slot_type_signature: "CustomOrBuiltinSlotTypeName",
  slot_type_configurations: [
    {
      regex_configuration: {
        pattern: "RegexPattern", # required
      },
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#checksumString

Identifies a specific revision of the $LATEST version.

When you create a new slot type, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a slot type, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don\'t specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.

Returns:

  • (String)

    Identifies a specific revision of the $LATEST version.

#create_versionBoolean

When set to true a new numbered version of the slot type is created. This is the same as calling the CreateSlotTypeVersion operation. If you do not specify createVersion, the default is false.

Returns:

  • (Boolean)

    When set to true a new numbered version of the slot type is created.

#descriptionString

A description of the slot type.

Returns:

  • (String)

    A description of the slot type.

#enumeration_valuesArray<Types::EnumerationValue>

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

A regular expression slot type doesn\'t require enumeration values. All other slot types require a list of enumeration values.

When Amazon Lex resolves a slot value, it generates a resolution list that contains up to five possible values for the slot. If you are using a Lambda function, this resolution list is passed to the function. If you are not using a Lambda function you can choose to return the value that the user entered or the first value in the resolution list as the slot value. The valueSelectionStrategy field indicates the option to use.

Returns:

  • (Array<Types::EnumerationValue>)

    A list of EnumerationValue objects that defines the values that the slot type can take.

#nameString

The name of the slot type. The name is not case sensitive.

The name can\'t match a built-in slot type name, or a built-in slot type name with \"AMAZON.\" removed. For example, because there is a built-in slot type called AMAZON.DATE, you can\'t create a custom slot type called DATE.

For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.

Returns:

  • (String)

    The name of the slot type.

#parent_slot_type_signatureString

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

Only AMAZON.AlphaNumeric is supported.

Returns:

  • (String)

    The built-in slot type used as the parent of the slot type.

#slot_type_configurationsArray<Types::SlotTypeConfiguration>

Configuration information that extends the parent built-in slot type. The configuration is added to the settings for the parent slot type.

Returns:

#value_selection_strategyString

Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:

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

  • TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.

If you don\'t specify the valueSelectionStrategy, the default is ORIGINAL_VALUE.

Possible values:

  • ORIGINAL_VALUE
  • TOP_RESOLUTION

Returns:

  • (String)

    Determines the slot resolution strategy that Amazon Lex uses to return slot type values.