Updates the settings that a bot has for a specific locale¶

Description¶

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

Usage¶

lexmodelsv2_update_bot_locale(botId, botVersion, localeId, description,
  nluIntentConfidenceThreshold, voiceSettings, unifiedSpeechSettings,
  audioFillerSettings, speechRecognitionSettings, generativeAISettings,
  speechDetectionSensitivity, speakerDiarizationSettings)

Arguments¶

botId

[required] The unique identifier of the bot that contains the locale.
botVersion

[required] The version of the bot that contains the locale to be updated. The version can only be the DRAFT version.
localeId

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

The new description of the locale.
nluIntentConfidenceThreshold

[required] The new confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.
voiceSettings

The new Amazon Polly voice Amazon Lex should use for voice interaction with the user.
unifiedSpeechSettings

Updated unified speech settings to apply to the bot locale.
audioFillerSettings

Updated audio filler settings to apply to the bot locale. When enabled, requires unifiedSpeechSettings (speech-to-speech) to be configured on the bot locale.
speechRecognitionSettings

Updated speech-to-text settings to apply to the bot locale.
generativeAISettings

Contains settings for generative AI features powered by Amazon Bedrock for your bot locale. Use this object to turn generative AI features on and off. Pricing may differ if you turn a feature on. For more information, see LINK.
speechDetectionSensitivity

The new sensitivity level for voice activity detection (VAD) in the bot locale. This setting helps optimize speech recognition accuracy by adjusting how the system responds to background noise during voice interactions.
speakerDiarizationSettings

The updated speaker diarization settings to apply to the bot locale. If you omit this field, Amazon Lex keeps the setting currently stored on the bot locale. To turn speaker diarization off, set enabled to false explicitly.

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"|"Advanced",
    speechModelConfig = list(
      deepgramConfig = list(
        apiTokenSecretArn = "string",
        modelId = "string"
      )
    )
  ),
  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"
  ),
  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",
  speakerDiarizationSettings = list(
    enabled = TRUE|FALSE
  )
)

Request syntax¶

svc$update_bot_locale(
  botId = "string",
  botVersion = "string",
  localeId = "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"|"Advanced",
    speechModelConfig = list(
      deepgramConfig = list(
        apiTokenSecretArn = "string",
        modelId = "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",
  speakerDiarizationSettings = list(
    enabled = TRUE|FALSE
  )
)