Describe Slot Type

lexmodelsv2_describe_slot_type

R Documentation

Gets metadata information about a slot type

Description

Gets metadata information about a slot type.

Usage

lexmodelsv2_describe_slot_type(slotTypeId, botId, botVersion, localeId)

Arguments

slotTypeId

[required] The identifier of the slot type.

botId

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

botVersion

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

localeId

[required] The identifier of the language and locale of the slot type to describe. The string must match one of the supported locales. For more information, see Supported languages.

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"
  ),
  lastUpdatedDateTime = 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$describe_slot_type(
  slotTypeId = "string",
  botId = "string",
  botVersion = "string",
  localeId = "string"
)