Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . lexv2-models ]

create-slot-type

Description

Creates a custom slot type

To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-slot-type
--slot-type-name <value>
[--description <value>]
[--slot-type-values <value>]
[--value-selection-setting <value>]
[--parent-slot-type-signature <value>]
--bot-id <value>
--bot-version <value>
--locale-id <value>
[--external-source-setting <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--slot-type-name (string)

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

--description (string)

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

--slot-type-values (list)

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.

(structure)

Each slot type can have a set of values. Each SlotTypeValue represents a value that the slot type can take.

sampleValue -> (structure)

The value of the slot type entry.

value -> (string)

The value that can be used for a slot type.

synonyms -> (list)

Additional values related to the slot type entry.

(structure)

Defines one of the values for a slot type.

value -> (string)

The value that can be used for a slot type.

Shorthand Syntax:

sampleValue={value=string},synonyms=[{value=string},{value=string}] ...

JSON Syntax:

[
  {
    "sampleValue": {
      "value": "string"
    },
    "synonyms": [
      {
        "value": "string"
      }
      ...
    ]
  }
  ...
]

--value-selection-setting (structure)

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 .

resolutionStrategy -> (string)

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:

  • 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 as the slot type value. If there is no resolution list, null is returned.

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

regexFilter -> (structure)

A regular expression used to validate the value of a slot.

pattern -> (string)

A regular expression used to validate the value of a slot.

Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:

  • A-Z, a-z
  • 0-9
  • Unicode characters ("u<Unicode>")

Represent Unicode characters with four digits, for example "u0041" or "u005A".

The following regular expression operators are not supported:

  • Infinite repeaters: *, +, or {x,} with no upper bound.
  • Wild card (.)

advancedRecognitionSetting -> (structure)

Provides settings that enable advanced recognition settings for slot values.

audioRecognitionStrategy -> (string)

Enables using the slot values as a custom vocabulary for recognizing user utterances.

Shorthand Syntax:

resolutionStrategy=string,regexFilter={pattern=string},advancedRecognitionSetting={audioRecognitionStrategy=string}

JSON Syntax:

{
  "resolutionStrategy": "OriginalValue"|"TopResolution",
  "regexFilter": {
    "pattern": "string"
  },
  "advancedRecognitionSetting": {
    "audioRecognitionStrategy": "UseSlotValuesAsCustomVocabulary"
  }
}

--parent-slot-type-signature (string)

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.

--bot-id (string)

The identifier of the bot associated with this slot type.

--bot-version (string)

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

--locale-id (string)

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 .

--external-source-setting (structure)

Sets the type of external information used to create the slot type.

grammarSlotTypeSetting -> (structure)

Settings required for a slot type based on a grammar that you provide.

source -> (structure)

The source of the grammar used to create the slot type.

s3BucketName -> (string)

The name of the S3 bucket that contains the grammar source.

s3ObjectKey -> (string)

The path to the grammar in the S3 bucket.

kmsKeyArn -> (string)

The Amazon KMS key required to decrypt the contents of the grammar, if any.

Shorthand Syntax:

grammarSlotTypeSetting={source={s3BucketName=string,s3ObjectKey=string,kmsKeyArn=string}}

JSON Syntax:

{
  "grammarSlotTypeSetting": {
    "source": {
      "s3BucketName": "string",
      "s3ObjectKey": "string",
      "kmsKeyArn": "string"
    }
  }
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

slotTypeId -> (string)

The unique identifier assigned to the slot type. Use this to identify the slot type in the UpdateSlotType and DeleteSlotType operations.

slotTypeName -> (string)

The name specified for the slot type.

description -> (string)

The description specified for the slot type.

slotTypeValues -> (list)

The list of values that the slot type can assume.

(structure)

Each slot type can have a set of values. Each SlotTypeValue represents a value that the slot type can take.

sampleValue -> (structure)

The value of the slot type entry.

value -> (string)

The value that can be used for a slot type.

synonyms -> (list)

Additional values related to the slot type entry.

(structure)

Defines one of the values for a slot type.

value -> (string)

The value that can be used for a slot type.

valueSelectionSetting -> (structure)

The strategy that Amazon Lex uses to select a value from the list of possible values.

resolutionStrategy -> (string)

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:

  • 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 as the slot type value. If there is no resolution list, null is returned.

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

regexFilter -> (structure)

A regular expression used to validate the value of a slot.

pattern -> (string)

A regular expression used to validate the value of a slot.

Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:

  • A-Z, a-z
  • 0-9
  • Unicode characters ("u<Unicode>")

Represent Unicode characters with four digits, for example "u0041" or "u005A".

The following regular expression operators are not supported:

  • Infinite repeaters: *, +, or {x,} with no upper bound.
  • Wild card (.)

advancedRecognitionSetting -> (structure)

Provides settings that enable advanced recognition settings for slot values.

audioRecognitionStrategy -> (string)

Enables using the slot values as a custom vocabulary for recognizing user utterances.

parentSlotTypeSignature -> (string)

The signature of the base slot type specified for the slot type.

botId -> (string)

The identifier for the bot associated with the slot type.

botVersion -> (string)

The version of the bot associated with the slot type.

localeId -> (string)

The specified language and local specified for the slot type.

creationDateTime -> (timestamp)

A timestamp of the date and time that the slot type was created.

externalSourceSetting -> (structure)

The type of external information used to create the slot type.

grammarSlotTypeSetting -> (structure)

Settings required for a slot type based on a grammar that you provide.

source -> (structure)

The source of the grammar used to create the slot type.

s3BucketName -> (string)

The name of the S3 bucket that contains the grammar source.

s3ObjectKey -> (string)

The path to the grammar in the S3 bucket.

kmsKeyArn -> (string)

The Amazon KMS key required to decrypt the contents of the grammar, if any.