# update-bot-locale ## Description Updates the settings that a bot has for a specific locale. See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateBotLocale) ## Synopsis ``` update-bot-locale --bot-id --bot-version --locale-id [--description ] --nlu-intent-confidence-threshold [--voice-settings ] [--unified-speech-settings ] [--audio-filler-settings ] [--speech-recognition-settings ] [--generative-ai-settings ] [--speech-detection-sensitivity ] [--speaker-diarization-settings ] [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton ] [--debug] [--endpoint-url ] [--no-verify-ssl] [--no-paginate] [--output ] [--query ] [--profile ] [--region ] [--version ] [--color ] [--no-sign-request] [--ca-bundle ] [--cli-read-timeout ] [--cli-connect-timeout ] [--cli-binary-format ] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt] [--cli-error-format ] ``` ## Options `--bot-id` (string) [required] > The unique identifier of the bot that contains the locale. > Constraints: > * min: `10` > * max: `10` > * pattern: `^[0-9a-zA-Z]+$` `--bot-version` (string) [required] > The version of the bot that contains the locale to be updated. The version can only be the `DRAFT` version. > Constraints: > * min: `5` > * max: `5` > * pattern: `^DRAFT$` `--locale-id` (string) [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](https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) . `--description` (string) > The new description of the locale. > Constraints: > * min: `0` > * max: `2000` `--nlu-intent-confidence-threshold` (double) [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. > Constraints: > * min: `0` > * max: `1` `--voice-settings` (structure) > The new Amazon Polly voice Amazon Lex should use for voice interaction with the user. > engine -> (string) > > Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the \` `engine` parameter of the `SynthesizeSpeech` operation <[https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine](https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine)>\`_\_ in the *Amazon Polly developer guide* . > > If you do not specify a value, the default is `standard` . > > Possible values: > > * `standard` > > * `neural` > > * `long-form` > > * `generative` > voiceId -> (string) [required] > > The identifier of the Amazon Polly voice to use. Shorthand Syntax: ``` engine=string,voiceId=string ``` JSON Syntax: ```json { "engine": "standard"|"neural"|"long-form"|"generative", "voiceId": "string" } ``` `--unified-speech-settings` (structure) > Updated unified speech settings to apply to the bot locale. > speechFoundationModel -> (structure) [required] > > The foundation model configuration to use for unified speech processing capabilities. > > modelArn -> (string) [required] > > > The Amazon Resource Name (ARN) of the foundation model used for speech processing. > > > Constraints: > > > * pattern: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model\/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$` > > voiceId -> (string) > > > The identifier of the voice to use for speech synthesis with the foundation model. Shorthand Syntax: ``` speechFoundationModel={modelArn=string,voiceId=string} ``` JSON Syntax: ```json { "speechFoundationModel": { "modelArn": "string", "voiceId": "string" } } ``` `--audio-filler-settings` (structure) > Updated audio filler settings to apply to the bot locale. When enabled, requires `unifiedSpeechSettings` (speech-to-speech) to be configured on the bot locale. > enabled -> (boolean) > > Specifies whether audio filler playback is enabled for the bot locale. Set to `true` to play filler audio while Amazon Lex processes a user utterance. Set to `false` to disable filler audio. > audioType -> (string) > > The identifier of the audio filler to play while Amazon Lex processes the user’s input. This field is required when `enabled` is `true` . > > Possible values: > > * `MELODY_CHIPPER_CHIME` > > * `MELODY_CURIOUS_CRAWL` > > * `MELODY_RISING_RIPPLE` > > * `MELODY_PATIENT_PING` > > * `MELODY_PONDERING_PONG` > > * `TYPING_KINETIC_KEYS` > > * `TYPING_QUIET_QWERTY` > > Constraints: > > * min: `1` > > * max: `64` > startDelayInMilliseconds -> (integer) > > The time, in milliseconds, to wait after the end of the user’s utterance before starting audio filler playback. Valid range is `500` to `5000` milliseconds. If not specified, Amazon Lex uses a default of `2500` milliseconds. > minimumPlayDurationInMilliseconds -> (integer) > > The minimum time, in milliseconds, that audio filler plays once it has started, even if the bot response becomes ready sooner. Valid range is `1000` to `5000` milliseconds. If not specified, Amazon Lex uses a default of `3000` milliseconds. > responseDeliveryDelayInMilliseconds -> (integer) > > The silent delay, in milliseconds, inserted between the end of audio filler playback and the start of the bot’s response. Valid range is `200` to `1000` milliseconds. If not specified, Amazon Lex uses a default of `500` milliseconds. Shorthand Syntax: ``` enabled=boolean,audioType=string,startDelayInMilliseconds=integer,minimumPlayDurationInMilliseconds=integer,responseDeliveryDelayInMilliseconds=integer ``` JSON Syntax: ```json { "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": integer, "minimumPlayDurationInMilliseconds": integer, "responseDeliveryDelayInMilliseconds": integer } ``` `--speech-recognition-settings` (structure) > Updated speech-to-text settings to apply to the bot locale. > speechModelPreference -> (string) > > The speech-to-text model to use. > > Possible values: > > * `Standard` > > * `Neural` > > * `Deepgram` > > * `Advanced` > speechModelConfig -> (structure) > > Configuration settings for the selected speech-to-text model. > > deepgramConfig -> (structure) > > > Configuration settings for using Deepgram as the speech-to-text provider. > > > apiTokenSecretArn -> (string) [required] > > > > The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the Deepgram API token. > > > > Constraints: > > > > * min: `20` > > > > * max: `2048` > > > > * pattern: `^arn:aws[A-Za-z-]*:secretsmanager:[a-z0-9-]{1,20}:[0-9]{12}:secret:[A-Za-z0-9/_+=.@-]{1,512}-[A-Za-z0-9]{6}$` > > > modelId -> (string) > > > > The identifier of the Deepgram speech-to-text model to use for processing speech input. > > > > Constraints: > > > > * min: `1` > > > > * max: `32` > > > > * pattern: `[A-Za-z0-9-_]+` Shorthand Syntax: ``` speechModelPreference=string,speechModelConfig={deepgramConfig={apiTokenSecretArn=string,modelId=string}} ``` JSON Syntax: ```json { "speechModelPreference": "Standard"|"Neural"|"Deepgram"|"Advanced", "speechModelConfig": { "deepgramConfig": { "apiTokenSecretArn": "string", "modelId": "string" } } } ``` `--generative-ai-settings` (structure) > 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. > runtimeSettings -> (structure) > > Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot. > > slotResolutionImprovement -> (structure) > > > An object containing specifications for the assisted slot resolution feature. > > > enabled -> (boolean) [required] > > > > Specifies whether assisted slot resolution is turned on or off. > > > bedrockModelSpecification -> (structure) > > > > An object containing information about the Amazon Bedrock model used to assist slot resolution. > > > > modelArn -> (string) [required] > > > > > The ARN of the foundation model used in descriptive bot building. > > > > > Constraints: > > > > > * pattern: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model\/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$` > > > > guardrail -> (structure) > > > > > The guardrail configuration in the Bedrock model specification details. > > > > > identifier -> (string) [required] > > > > > > The unique guardrail id for the Bedrock guardrail configuration. > > > > > > Constraints: > > > > > > * min: `1` > > > > > > * max: `2048` > > > > > > * pattern: `^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$` > > > > > version -> (string) [required] > > > > > > The guardrail version for the Bedrock guardrail configuration. > > > > > > Constraints: > > > > > > * pattern: `^(([1-9][0-9]{0,7})|(DRAFT))$` > > > > traceStatus -> (string) > > > > > The Bedrock trace status in the Bedrock model specification details. > > > > > Possible values: > > > > > * `ENABLED` > > > > > * `DISABLED` > > > > customPrompt -> (string) > > > > > The custom prompt used in the Bedrock model specification details. > > > > > Constraints: > > > > > * min: `1` > > > > > * max: `4000` > > nluImprovement -> (structure) > > > An object containing specifications for the Assisted NLU feature within the bot’s runtime settings. These settings determine how the bot processes and interprets user utterances during conversations. > > > enabled -> (boolean) [required] > > > > Determines whether the Assisted NLU feature is enabled for the bot. When set to `true` , Amazon Lex uses advanced models to improve intent recognition and slot resolution, with the default being `false` . > > > assistedNluMode -> (string) > > > > Specifies the mode for Assisted NLU operation. Use `Primary` to make Assisted NLU the primary intent recognition method, `Fallback` to use it only when standard NLU confidence is low, or `DialogManager` to use a large language model to manage the conversation, including intent recognition, slot elicitation, and confirmation. > > > > Possible values: > > > > * `Primary` > > > > * `Fallback` > > > > * `DialogManager` > > > intentDisambiguationSettings -> (structure) > > > > An object containing specifications for the Intent Disambiguation feature within the Assisted NLU settings. These settings determine how the bot handles ambiguous user inputs that could match multiple intents. > > > > enabled -> (boolean) [required] > > > > > Determines whether the Intent Disambiguation feature is enabled. When set to `true` , Amazon Lex will present disambiguation options to users when multiple intents could match their input, with the default being `false` . > > > > maxDisambiguationIntents -> (integer) > > > > > Specifies the maximum number of intent options (2-5) to present to users when disambiguation is needed. This setting determines how many intent options will be shown to users when the system detects ambiguous input. The default value is 3. > > > > > Constraints: > > > > > * min: `2` > > > > > * max: `5` > > > > customDisambiguationMessage -> (string) > > > > > Provides a custom message that will be displayed before presenting the disambiguation options to users. This message helps set the context for users and can be customized to match your bot’s tone and brand. If not specified, a default message will be used. > > > > > Constraints: > > > > > * min: `1` > > > > > * max: `1000` > buildtimeSettings -> (structure) > > Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot. > > descriptiveBotBuilder -> (structure) > > > An object containing specifications for the descriptive bot building feature. > > > enabled -> (boolean) [required] > > > > Specifies whether the descriptive bot building feature is activated or not. > > > bedrockModelSpecification -> (structure) > > > > An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building. > > > > modelArn -> (string) [required] > > > > > The ARN of the foundation model used in descriptive bot building. > > > > > Constraints: > > > > > * pattern: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model\/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$` > > > > guardrail -> (structure) > > > > > The guardrail configuration in the Bedrock model specification details. > > > > > identifier -> (string) [required] > > > > > > The unique guardrail id for the Bedrock guardrail configuration. > > > > > > Constraints: > > > > > > * min: `1` > > > > > > * max: `2048` > > > > > > * pattern: `^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$` > > > > > version -> (string) [required] > > > > > > The guardrail version for the Bedrock guardrail configuration. > > > > > > Constraints: > > > > > > * pattern: `^(([1-9][0-9]{0,7})|(DRAFT))$` > > > > traceStatus -> (string) > > > > > The Bedrock trace status in the Bedrock model specification details. > > > > > Possible values: > > > > > * `ENABLED` > > > > > * `DISABLED` > > > > customPrompt -> (string) > > > > > The custom prompt used in the Bedrock model specification details. > > > > > Constraints: > > > > > * min: `1` > > > > > * max: `4000` > > sampleUtteranceGeneration -> (structure) > > > Contains specifications for the sample utterance generation feature. > > > enabled -> (boolean) [required] > > > > Specifies whether to enable sample utterance generation or not. > > > bedrockModelSpecification -> (structure) > > > > Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building. > > > > modelArn -> (string) [required] > > > > > The ARN of the foundation model used in descriptive bot building. > > > > > Constraints: > > > > > * pattern: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model\/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$` > > > > guardrail -> (structure) > > > > > The guardrail configuration in the Bedrock model specification details. > > > > > identifier -> (string) [required] > > > > > > The unique guardrail id for the Bedrock guardrail configuration. > > > > > > Constraints: > > > > > > * min: `1` > > > > > > * max: `2048` > > > > > > * pattern: `^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$` > > > > > version -> (string) [required] > > > > > > The guardrail version for the Bedrock guardrail configuration. > > > > > > Constraints: > > > > > > * pattern: `^(([1-9][0-9]{0,7})|(DRAFT))$` > > > > traceStatus -> (string) > > > > > The Bedrock trace status in the Bedrock model specification details. > > > > > Possible values: > > > > > * `ENABLED` > > > > > * `DISABLED` > > > > customPrompt -> (string) > > > > > The custom prompt used in the Bedrock model specification details. > > > > > Constraints: > > > > > * min: `1` > > > > > * max: `4000` JSON Syntax: ```json { "runtimeSettings": { "slotResolutionImprovement": { "enabled": true|false, "bedrockModelSpecification": { "modelArn": "string", "guardrail": { "identifier": "string", "version": "string" }, "traceStatus": "ENABLED"|"DISABLED", "customPrompt": "string" } }, "nluImprovement": { "enabled": true|false, "assistedNluMode": "Primary"|"Fallback"|"DialogManager", "intentDisambiguationSettings": { "enabled": true|false, "maxDisambiguationIntents": integer, "customDisambiguationMessage": "string" } } }, "buildtimeSettings": { "descriptiveBotBuilder": { "enabled": true|false, "bedrockModelSpecification": { "modelArn": "string", "guardrail": { "identifier": "string", "version": "string" }, "traceStatus": "ENABLED"|"DISABLED", "customPrompt": "string" } }, "sampleUtteranceGeneration": { "enabled": true|false, "bedrockModelSpecification": { "modelArn": "string", "guardrail": { "identifier": "string", "version": "string" }, "traceStatus": "ENABLED"|"DISABLED", "customPrompt": "string" } } } } ``` `--speech-detection-sensitivity` (string) > 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. > Possible values: > * `Default` > * `HighNoiseTolerance` > * `MaximumNoiseTolerance` `--speaker-diarization-settings` (structure) > 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. > enabled -> (boolean) [required] > > Specifies whether speaker diarization is enabled for the bot locale. Set to `true` to have Amazon Lex treat speech from speakers other than the primary speaker as non-speech. Set to `false` to disable speaker diarization and rely on voice activity detection alone. Shorthand Syntax: ``` enabled=boolean ``` JSON Syntax: ```json { "enabled": true|false } ``` `--cli-input-json` | `--cli-input-yaml` (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those 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. This may not be specified along with `--cli-input-yaml`. `--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`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated. ## Global Options `--debug` (boolean) Turn on debug logging. `--endpoint-url` (string) Override command’s default URL with the given URL. `--no-verify-ssl` (boolean) By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates. `--no-paginate` (boolean) Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results. `--output` (string) The formatting style for command output. * json * text * table * yaml * yaml-stream * off `--query` (string) A JMESPath query to use in filtering the response data. `--profile` (string) Use a specific profile from your credential file. `--region` (string) The region to use. Overrides config/env settings. `--version` (string) Display the version of this tool. `--color` (string) Turn on/off color output. * on * off * auto `--no-sign-request` (boolean) Do not sign requests. Credentials will not be loaded if this argument is provided. `--ca-bundle` (string) The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings. `--cli-read-timeout` (int) The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds. `--cli-connect-timeout` (int) The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds. `--cli-binary-format` (string) The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`. * base64 * raw-in-base64-out `--no-cli-pager` (boolean) Disable cli pager for output. `--cli-auto-prompt` (boolean) Automatically prompt for CLI input parameters. `--no-cli-auto-prompt` (boolean) Disable automatically prompt for CLI input parameters. `--cli-error-format` (string) The formatting style for error output. By default, errors are displayed in enhanced format. * legacy * json * yaml * text * table * enhanced ## Output botId -> (string) > The identifier of the bot that contains the updated locale. > Constraints: > * min: `10` > * max: `10` > * pattern: `^[0-9a-zA-Z]+$` botVersion -> (string) > The version of the bot that contains the updated locale. > Constraints: > * min: `5` > * max: `5` > * pattern: `^DRAFT$` localeId -> (string) > The language and locale of the updated bot locale. localeName -> (string) > The updated locale name for the locale. description -> (string) > The updated description of the locale. > Constraints: > * min: `0` > * max: `2000` nluIntentConfidenceThreshold -> (double) > The updated confidence threshold for inserting the `AMAZON.FallbackIntent` and `AMAZON.KendraSearchIntent` intents in the list of possible intents for an utterance. > Constraints: > * min: `0` > * max: `1` voiceSettings -> (structure) > The updated Amazon Polly voice to use for voice interaction with the user. > engine -> (string) > > Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the \` `engine` parameter of the `SynthesizeSpeech` operation <[https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine](https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine)>\`_\_ in the *Amazon Polly developer guide* . > > If you do not specify a value, the default is `standard` . > > Possible values: > > * `standard` > > * `neural` > > * `long-form` > > * `generative` > voiceId -> (string) [required] > > The identifier of the Amazon Polly voice to use. unifiedSpeechSettings -> (structure) > The updated unified speech settings for the bot locale. > speechFoundationModel -> (structure) [required] > > The foundation model configuration to use for unified speech processing capabilities. > > modelArn -> (string) [required] > > > The Amazon Resource Name (ARN) of the foundation model used for speech processing. > > > Constraints: > > > * pattern: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model\/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$` > > voiceId -> (string) > > > The identifier of the voice to use for speech synthesis with the foundation model. audioFillerSettings -> (structure) > The updated audio filler settings for the bot locale. > enabled -> (boolean) > > Specifies whether audio filler playback is enabled for the bot locale. Set to `true` to play filler audio while Amazon Lex processes a user utterance. Set to `false` to disable filler audio. > audioType -> (string) > > The identifier of the audio filler to play while Amazon Lex processes the user’s input. This field is required when `enabled` is `true` . > > Possible values: > > * `MELODY_CHIPPER_CHIME` > > * `MELODY_CURIOUS_CRAWL` > > * `MELODY_RISING_RIPPLE` > > * `MELODY_PATIENT_PING` > > * `MELODY_PONDERING_PONG` > > * `TYPING_KINETIC_KEYS` > > * `TYPING_QUIET_QWERTY` > > Constraints: > > * min: `1` > > * max: `64` > startDelayInMilliseconds -> (integer) > > The time, in milliseconds, to wait after the end of the user’s utterance before starting audio filler playback. Valid range is `500` to `5000` milliseconds. If not specified, Amazon Lex uses a default of `2500` milliseconds. > minimumPlayDurationInMilliseconds -> (integer) > > The minimum time, in milliseconds, that audio filler plays once it has started, even if the bot response becomes ready sooner. Valid range is `1000` to `5000` milliseconds. If not specified, Amazon Lex uses a default of `3000` milliseconds. > responseDeliveryDelayInMilliseconds -> (integer) > > The silent delay, in milliseconds, inserted between the end of audio filler playback and the start of the bot’s response. Valid range is `200` to `1000` milliseconds. If not specified, Amazon Lex uses a default of `500` milliseconds. speechRecognitionSettings -> (structure) > The updated speech-to-text settings for the bot locale. > speechModelPreference -> (string) > > The speech-to-text model to use. > > Possible values: > > * `Standard` > > * `Neural` > > * `Deepgram` > > * `Advanced` > speechModelConfig -> (structure) > > Configuration settings for the selected speech-to-text model. > > deepgramConfig -> (structure) > > > Configuration settings for using Deepgram as the speech-to-text provider. > > > apiTokenSecretArn -> (string) [required] > > > > The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the Deepgram API token. > > > > Constraints: > > > > * min: `20` > > > > * max: `2048` > > > > * pattern: `^arn:aws[A-Za-z-]*:secretsmanager:[a-z0-9-]{1,20}:[0-9]{12}:secret:[A-Za-z0-9/_+=.@-]{1,512}-[A-Za-z0-9]{6}$` > > > modelId -> (string) > > > > The identifier of the Deepgram speech-to-text model to use for processing speech input. > > > > Constraints: > > > > * min: `1` > > > > * max: `32` > > > > * pattern: `[A-Za-z0-9-_]+` botLocaleStatus -> (string) > The current status of the locale. When the bot status is `Built` the locale is ready for use. > Possible values: > * `Creating` > * `Building` > * `Built` > * `ReadyExpressTesting` > * `Failed` > * `Deleting` > * `NotBuilt` > * `Importing` > * `Processing` failureReasons -> (list) > If the `botLocaleStatus` is `Failed` , the `failureReasons` field lists the errors that occurred while building the bot. > (string) creationDateTime -> (timestamp) > A timestamp of the date and time that the locale was created. lastUpdatedDateTime -> (timestamp) > A timestamp of the date and time that the locale was last updated. recommendedActions -> (list) > Recommended actions to take to resolve an error in the `failureReasons` field. > (string) generativeAISettings -> (structure) > Contains settings for generative AI features powered by Amazon Bedrock for your bot locale. > runtimeSettings -> (structure) > > Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot. > > slotResolutionImprovement -> (structure) > > > An object containing specifications for the assisted slot resolution feature. > > > enabled -> (boolean) [required] > > > > Specifies whether assisted slot resolution is turned on or off. > > > bedrockModelSpecification -> (structure) > > > > An object containing information about the Amazon Bedrock model used to assist slot resolution. > > > > modelArn -> (string) [required] > > > > > The ARN of the foundation model used in descriptive bot building. > > > > > Constraints: > > > > > * pattern: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model\/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$` > > > > guardrail -> (structure) > > > > > The guardrail configuration in the Bedrock model specification details. > > > > > identifier -> (string) [required] > > > > > > The unique guardrail id for the Bedrock guardrail configuration. > > > > > > Constraints: > > > > > > * min: `1` > > > > > > * max: `2048` > > > > > > * pattern: `^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$` > > > > > version -> (string) [required] > > > > > > The guardrail version for the Bedrock guardrail configuration. > > > > > > Constraints: > > > > > > * pattern: `^(([1-9][0-9]{0,7})|(DRAFT))$` > > > > traceStatus -> (string) > > > > > The Bedrock trace status in the Bedrock model specification details. > > > > > Possible values: > > > > > * `ENABLED` > > > > > * `DISABLED` > > > > customPrompt -> (string) > > > > > The custom prompt used in the Bedrock model specification details. > > > > > Constraints: > > > > > * min: `1` > > > > > * max: `4000` > > nluImprovement -> (structure) > > > An object containing specifications for the Assisted NLU feature within the bot’s runtime settings. These settings determine how the bot processes and interprets user utterances during conversations. > > > enabled -> (boolean) [required] > > > > Determines whether the Assisted NLU feature is enabled for the bot. When set to `true` , Amazon Lex uses advanced models to improve intent recognition and slot resolution, with the default being `false` . > > > assistedNluMode -> (string) > > > > Specifies the mode for Assisted NLU operation. Use `Primary` to make Assisted NLU the primary intent recognition method, `Fallback` to use it only when standard NLU confidence is low, or `DialogManager` to use a large language model to manage the conversation, including intent recognition, slot elicitation, and confirmation. > > > > Possible values: > > > > * `Primary` > > > > * `Fallback` > > > > * `DialogManager` > > > intentDisambiguationSettings -> (structure) > > > > An object containing specifications for the Intent Disambiguation feature within the Assisted NLU settings. These settings determine how the bot handles ambiguous user inputs that could match multiple intents. > > > > enabled -> (boolean) [required] > > > > > Determines whether the Intent Disambiguation feature is enabled. When set to `true` , Amazon Lex will present disambiguation options to users when multiple intents could match their input, with the default being `false` . > > > > maxDisambiguationIntents -> (integer) > > > > > Specifies the maximum number of intent options (2-5) to present to users when disambiguation is needed. This setting determines how many intent options will be shown to users when the system detects ambiguous input. The default value is 3. > > > > > Constraints: > > > > > * min: `2` > > > > > * max: `5` > > > > customDisambiguationMessage -> (string) > > > > > Provides a custom message that will be displayed before presenting the disambiguation options to users. This message helps set the context for users and can be customized to match your bot’s tone and brand. If not specified, a default message will be used. > > > > > Constraints: > > > > > * min: `1` > > > > > * max: `1000` > buildtimeSettings -> (structure) > > Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot. > > descriptiveBotBuilder -> (structure) > > > An object containing specifications for the descriptive bot building feature. > > > enabled -> (boolean) [required] > > > > Specifies whether the descriptive bot building feature is activated or not. > > > bedrockModelSpecification -> (structure) > > > > An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building. > > > > modelArn -> (string) [required] > > > > > The ARN of the foundation model used in descriptive bot building. > > > > > Constraints: > > > > > * pattern: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model\/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$` > > > > guardrail -> (structure) > > > > > The guardrail configuration in the Bedrock model specification details. > > > > > identifier -> (string) [required] > > > > > > The unique guardrail id for the Bedrock guardrail configuration. > > > > > > Constraints: > > > > > > * min: `1` > > > > > > * max: `2048` > > > > > > * pattern: `^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$` > > > > > version -> (string) [required] > > > > > > The guardrail version for the Bedrock guardrail configuration. > > > > > > Constraints: > > > > > > * pattern: `^(([1-9][0-9]{0,7})|(DRAFT))$` > > > > traceStatus -> (string) > > > > > The Bedrock trace status in the Bedrock model specification details. > > > > > Possible values: > > > > > * `ENABLED` > > > > > * `DISABLED` > > > > customPrompt -> (string) > > > > > The custom prompt used in the Bedrock model specification details. > > > > > Constraints: > > > > > * min: `1` > > > > > * max: `4000` > > sampleUtteranceGeneration -> (structure) > > > Contains specifications for the sample utterance generation feature. > > > enabled -> (boolean) [required] > > > > Specifies whether to enable sample utterance generation or not. > > > bedrockModelSpecification -> (structure) > > > > Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building. > > > > modelArn -> (string) [required] > > > > > The ARN of the foundation model used in descriptive bot building. > > > > > Constraints: > > > > > * pattern: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model\/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$` > > > > guardrail -> (structure) > > > > > The guardrail configuration in the Bedrock model specification details. > > > > > identifier -> (string) [required] > > > > > > The unique guardrail id for the Bedrock guardrail configuration. > > > > > > Constraints: > > > > > > * min: `1` > > > > > > * max: `2048` > > > > > > * pattern: `^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$` > > > > > version -> (string) [required] > > > > > > The guardrail version for the Bedrock guardrail configuration. > > > > > > Constraints: > > > > > > * pattern: `^(([1-9][0-9]{0,7})|(DRAFT))$` > > > > traceStatus -> (string) > > > > > The Bedrock trace status in the Bedrock model specification details. > > > > > Possible values: > > > > > * `ENABLED` > > > > > * `DISABLED` > > > > customPrompt -> (string) > > > > > The custom prompt used in the Bedrock model specification details. > > > > > Constraints: > > > > > * min: `1` > > > > > * max: `4000` speechDetectionSensitivity -> (string) > The updated sensitivity level for voice activity detection (VAD) in the bot locale. > Possible values: > * `Default` > * `HighNoiseTolerance` > * `MaximumNoiseTolerance` speakerDiarizationSettings -> (structure) > The updated speaker diarization settings for the bot locale. > enabled -> (boolean) [required] > > Specifies whether speaker diarization is enabled for the bot locale. Set to `true` to have Amazon Lex treat speech from speakers other than the primary speaker as non-speech. Set to `false` to disable speaker diarization and rely on voice activity detection alone.