Skip to content

Create Slot Type

lexmodelsv2_create_slot_type R Documentation

Creates a custom 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.

Usage

lexmodelsv2_create_slot_type(slotTypeName, description, slotTypeValues,
  valueSelectionSetting, parentSlotTypeSignature, botId, botVersion,
  localeId, externalSourceSetting, compositeSlotTypeSetting)

Arguments

slotTypeName

[required] The name for the slot. A slot type name must be unique within the intent.

description

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

slotTypeValues

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.

valueSelectionSetting

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:

  • 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. If there is no resolution list, return null.

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

parentSlotTypeSignature

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.

botId

[required] The identifier of the bot associated with this slot type.

botVersion

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

localeId

[required] 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.

externalSourceSetting

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

compositeSlotTypeSetting

Specifications for a composite slot type.

Value

A list with the following syntax: 

list(
  slotTypeId = "string",
  slotTypeName = "string",
  description = "string",
  slotTypeValues = list(
    list(
      sampleValue = list(
        value = "string"
      ),
      synonyms = list(
        list(
          value = "string"
        )
      )
    )
  ),
  valueSelectionSetting = list(
    resolutionStrategy = "OriginalValue"|"TopResolution"|"Concatenation",
    regexFilter = list(
      pattern = "string"
    ),
    advancedRecognitionSetting = list(
      audioRecognitionStrategy = "UseSlotValuesAsCustomVocabulary"
    )
  ),
  parentSlotTypeSignature = "string",
  botId = "string",
  botVersion = "string",
  localeId = "string",
  creationDateTime = as.POSIXct(
    "2015-01-01"
  ),
  externalSourceSetting = list(
    grammarSlotTypeSetting = list(
      source = list(
        s3BucketName = "string",
        s3ObjectKey = "string",
        kmsKeyArn = "string"
      )
    )
  ),
  compositeSlotTypeSetting = list(
    subSlots = list(
      list(
        name = "string",
        slotTypeId = "string"
      )
    )
  )
)

Request syntax

svc$create_slot_type(
  slotTypeName = "string",
  description = "string",
  slotTypeValues = list(
    list(
      sampleValue = list(
        value = "string"
      ),
      synonyms = list(
        list(
          value = "string"
        )
      )
    )
  ),
  valueSelectionSetting = list(
    resolutionStrategy = "OriginalValue"|"TopResolution"|"Concatenation",
    regexFilter = list(
      pattern = "string"
    ),
    advancedRecognitionSetting = list(
      audioRecognitionStrategy = "UseSlotValuesAsCustomVocabulary"
    )
  ),
  parentSlotTypeSignature = "string",
  botId = "string",
  botVersion = "string",
  localeId = "string",
  externalSourceSetting = list(
    grammarSlotTypeSetting = list(
      source = list(
        s3BucketName = "string",
        s3ObjectKey = "string",
        kmsKeyArn = "string"
      )
    )
  ),
  compositeSlotTypeSetting = list(
    subSlots = list(
      list(
        name = "string",
        slotTypeId = "string"
      )
    )
  )
)