Describe Bot Locale

lexmodelsv2_describe_bot_locale

R Documentation

Describes the settings that a bot has for a specific locale

Description

Describes the settings that a bot has for a specific locale.

Usage

lexmodelsv2_describe_bot_locale(botId, botVersion, localeId)

Arguments

botId	[required] The identifier of the bot associated with the locale.
botVersion	[required] The version of the bot associated with the locale.
localeId	[required] The unique identifier of the locale 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(
  botId = "string",
  botVersion = "string",
  localeId = "string",
  localeName = "string",
  description = "string",
  nluIntentConfidenceThreshold = 123.0,
  voiceSettings = list(
    engine = "standard"|"neural"|"long-form"|"generative",
    voiceId = "string"
  ),
  unifiedSpeechSettings = list(
    speechFoundationModel = list(
      modelArn = "string",
      voiceId = "string"
    )
  ),
  audioFillerSettings = list(
    enabled = TRUE|FALSE,
    audioType = "MELODY_CHIPPER_CHIME"|"MELODY_CURIOUS_CRAWL"|"MELODY_RISING_RIPPLE"|"MELODY_PATIENT_PING"|"MELODY_PONDERING_PONG"|"TYPING_KINETIC_KEYS"|"TYPING_QUIET_QWERTY",
    startDelayInMilliseconds = 123,
    minimumPlayDurationInMilliseconds = 123,
    responseDeliveryDelayInMilliseconds = 123
  ),
  speechRecognitionSettings = list(
    speechModelPreference = "Standard"|"Neural"|"Deepgram",
    speechModelConfig = list(
      deepgramConfig = list(
        apiTokenSecretArn = "string",
        modelId = "string"
      )
    )
  ),
  intentsCount = 123,
  slotTypesCount = 123,
  botLocaleStatus = "Creating"|"Building"|"Built"|"ReadyExpressTesting"|"Failed"|"Deleting"|"NotBuilt"|"Importing"|"Processing",
  failureReasons = list(
    "string"
  ),
  creationDateTime = as.POSIXct(
    "2015-01-01"
  ),
  lastUpdatedDateTime = as.POSIXct(
    "2015-01-01"
  ),
  lastBuildSubmittedDateTime = as.POSIXct(
    "2015-01-01"
  ),
  botLocaleHistoryEvents = list(
    list(
      event = "string",
      eventDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  recommendedActions = list(
    "string"
  ),
  generativeAISettings = list(
    runtimeSettings = list(
      slotResolutionImprovement = list(
        enabled = TRUE|FALSE,
        bedrockModelSpecification = list(
          modelArn = "string",
          guardrail = list(
            identifier = "string",
            version = "string"
          ),
          traceStatus = "ENABLED"|"DISABLED",
          customPrompt = "string"
        )
      ),
      nluImprovement = list(
        enabled = TRUE|FALSE,
        assistedNluMode = "Primary"|"Fallback",
        intentDisambiguationSettings = list(
          enabled = TRUE|FALSE,
          maxDisambiguationIntents = 123,
          customDisambiguationMessage = "string"
        )
      )
    ),
    buildtimeSettings = list(
      descriptiveBotBuilder = list(
        enabled = TRUE|FALSE,
        bedrockModelSpecification = list(
          modelArn = "string",
          guardrail = list(
            identifier = "string",
            version = "string"
          ),
          traceStatus = "ENABLED"|"DISABLED",
          customPrompt = "string"
        )
      ),
      sampleUtteranceGeneration = list(
        enabled = TRUE|FALSE,
        bedrockModelSpecification = list(
          modelArn = "string",
          guardrail = list(
            identifier = "string",
            version = "string"
          ),
          traceStatus = "ENABLED"|"DISABLED",
          customPrompt = "string"
        )
      )
    )
  ),
  speechDetectionSensitivity = "Default"|"HighNoiseTolerance"|"MaximumNoiseTolerance"
)

Request syntax

svc$describe_bot_locale(
  botId = "string",
  botVersion = "string",
  localeId = "string"
)