2025/12/01 - Amazon Lex Model Building V2 - 5 updated api methods
{'speechRecognitionSettings': {'speechModelConfig': {'deepgramConfig': {'apiTokenSecretArn': 'string',
'modelId': 'string'}},
'speechModelPreference': 'Standard | Neural | '
'Deepgram'},
'unifiedSpeechSettings': {'speechFoundationModel': {'modelArn': 'string',
'voiceId': 'string'}}}
Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.
See also: AWS API Documentation
Request Syntax
client.create_bot_locale(
botId='string',
botVersion='string',
localeId='string',
description='string',
nluIntentConfidenceThreshold=123.0,
voiceSettings={
'engine': 'standard'|'neural'|'long-form'|'generative',
'voiceId': 'string'
},
unifiedSpeechSettings={
'speechFoundationModel': {
'modelArn': 'string',
'voiceId': 'string'
}
},
speechRecognitionSettings={
'speechModelPreference': 'Standard'|'Neural'|'Deepgram',
'speechModelConfig': {
'deepgramConfig': {
'apiTokenSecretArn': 'string',
'modelId': 'string'
}
}
},
generativeAISettings={
'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',
'intentDisambiguationSettings': {
'enabled': True|False,
'maxDisambiguationIntents': 123,
'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'
}
}
}
},
speechDetectionSensitivity='Default'|'HighNoiseTolerance'|'MaximumNoiseTolerance'
)
string
[REQUIRED]
The identifier of the bot to create the locale for.
string
[REQUIRED]
The version of the bot to create the locale for. This can only be the draft version of the bot.
string
[REQUIRED]
The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.
string
A description of the bot locale. Use this to help identify the bot locale in lists.
float
[REQUIRED]
Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.
For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the RecognizeText operation would be:
AMAZON.FallbackIntent
IntentA
IntentB
IntentC
dict
The Amazon Polly voice ID that Amazon Lex uses 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 in the Amazon Polly developer guide.
If you do not specify a value, the default is standard.
voiceId (string) -- [REQUIRED]
The identifier of the Amazon Polly voice to use.
dict
Unified speech settings to configure for the new bot locale.
speechFoundationModel (dict) -- [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.
voiceId (string) --
The identifier of the voice to use for speech synthesis with the foundation model.
dict
Speech-to-text settings to configure for the new bot locale.
speechModelPreference (string) --
The speech-to-text model to use.
speechModelConfig (dict) --
Configuration settings for the selected speech-to-text model.
deepgramConfig (dict) --
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.
modelId (string) --
The identifier of the Deepgram speech-to-text model to use for processing speech input.
dict
Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
runtimeSettings (dict) --
Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
slotResolutionImprovement (dict) --
An object containing specifications for the assisted slot resolution feature.
enabled (boolean) -- [REQUIRED]
Specifies whether assisted slot resolution is turned on or off.
bedrockModelSpecification (dict) --
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.
guardrail (dict) --
The guardrail configuration in the Bedrock model specification details.
identifier (string) -- [REQUIRED]
The unique guardrail id for the Bedrock guardrail configuration.
version (string) -- [REQUIRED]
The guardrail version for the Bedrock guardrail configuration.
traceStatus (string) --
The Bedrock trace status in the Bedrock model specification details.
customPrompt (string) --
The custom prompt used in the Bedrock model specification details.
nluImprovement (dict) --
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, or Fallback to use it only when standard NLU confidence is low.
intentDisambiguationSettings (dict) --
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.
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.
buildtimeSettings (dict) --
Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
descriptiveBotBuilder (dict) --
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 (dict) --
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.
guardrail (dict) --
The guardrail configuration in the Bedrock model specification details.
identifier (string) -- [REQUIRED]
The unique guardrail id for the Bedrock guardrail configuration.
version (string) -- [REQUIRED]
The guardrail version for the Bedrock guardrail configuration.
traceStatus (string) --
The Bedrock trace status in the Bedrock model specification details.
customPrompt (string) --
The custom prompt used in the Bedrock model specification details.
sampleUtteranceGeneration (dict) --
Contains specifications for the sample utterance generation feature.
enabled (boolean) -- [REQUIRED]
Specifies whether to enable sample utterance generation or not.
bedrockModelSpecification (dict) --
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.
guardrail (dict) --
The guardrail configuration in the Bedrock model specification details.
identifier (string) -- [REQUIRED]
The unique guardrail id for the Bedrock guardrail configuration.
version (string) -- [REQUIRED]
The guardrail version for the Bedrock guardrail configuration.
traceStatus (string) --
The Bedrock trace status in the Bedrock model specification details.
customPrompt (string) --
The custom prompt used in the Bedrock model specification details.
string
The 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.
dict
Response Syntax
{
'botId': 'string',
'botVersion': 'string',
'localeName': 'string',
'localeId': 'string',
'description': 'string',
'nluIntentConfidenceThreshold': 123.0,
'voiceSettings': {
'engine': 'standard'|'neural'|'long-form'|'generative',
'voiceId': 'string'
},
'unifiedSpeechSettings': {
'speechFoundationModel': {
'modelArn': 'string',
'voiceId': 'string'
}
},
'speechRecognitionSettings': {
'speechModelPreference': 'Standard'|'Neural'|'Deepgram',
'speechModelConfig': {
'deepgramConfig': {
'apiTokenSecretArn': 'string',
'modelId': 'string'
}
}
},
'botLocaleStatus': 'Creating'|'Building'|'Built'|'ReadyExpressTesting'|'Failed'|'Deleting'|'NotBuilt'|'Importing'|'Processing',
'creationDateTime': datetime(2015, 1, 1),
'generativeAISettings': {
'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',
'intentDisambiguationSettings': {
'enabled': True|False,
'maxDisambiguationIntents': 123,
'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'
}
}
}
},
'speechDetectionSensitivity': 'Default'|'HighNoiseTolerance'|'MaximumNoiseTolerance'
}
Response Structure
(dict) --
botId (string) --
The specified bot identifier.
botVersion (string) --
The specified bot version.
localeName (string) --
The specified locale name.
localeId (string) --
The specified locale identifier.
description (string) --
The specified description of the bot locale.
nluIntentConfidenceThreshold (float) --
The specified confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents.
voiceSettings (dict) --
The Amazon Polly voice ID that Amazon Lex uses 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 in the Amazon Polly developer guide.
If you do not specify a value, the default is standard.
voiceId (string) --
The identifier of the Amazon Polly voice to use.
unifiedSpeechSettings (dict) --
The unified speech settings configured for the created bot locale.
speechFoundationModel (dict) --
The foundation model configuration to use for unified speech processing capabilities.
modelArn (string) --
The Amazon Resource Name (ARN) of the foundation model used for speech processing.
voiceId (string) --
The identifier of the voice to use for speech synthesis with the foundation model.
speechRecognitionSettings (dict) --
The speech-to-text settings configured for the created bot locale.
speechModelPreference (string) --
The speech-to-text model to use.
speechModelConfig (dict) --
Configuration settings for the selected speech-to-text model.
deepgramConfig (dict) --
Configuration settings for using Deepgram as the speech-to-text provider.
apiTokenSecretArn (string) --
The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the Deepgram API token.
modelId (string) --
The identifier of the Deepgram speech-to-text model to use for processing speech input.
botLocaleStatus (string) --
The status of the bot.
When the status is Creating the bot locale is being configured. When the status is Building Amazon Lex is building the bot for testing and use.
If the status of the bot is ReadyExpressTesting, you can test the bot using the exact utterances specified in the bots' intents. When the bot is ready for full testing or to run, the status is Built.
If there was a problem with building the bot, the status is Failed. If the bot was saved but not built, the status is NotBuilt.
creationDateTime (datetime) --
A timestamp specifying the date and time that the bot locale was created.
generativeAISettings (dict) --
Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
runtimeSettings (dict) --
Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
slotResolutionImprovement (dict) --
An object containing specifications for the assisted slot resolution feature.
enabled (boolean) --
Specifies whether assisted slot resolution is turned on or off.
bedrockModelSpecification (dict) --
An object containing information about the Amazon Bedrock model used to assist slot resolution.
modelArn (string) --
The ARN of the foundation model used in descriptive bot building.
guardrail (dict) --
The guardrail configuration in the Bedrock model specification details.
identifier (string) --
The unique guardrail id for the Bedrock guardrail configuration.
version (string) --
The guardrail version for the Bedrock guardrail configuration.
traceStatus (string) --
The Bedrock trace status in the Bedrock model specification details.
customPrompt (string) --
The custom prompt used in the Bedrock model specification details.
nluImprovement (dict) --
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) --
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, or Fallback to use it only when standard NLU confidence is low.
intentDisambiguationSettings (dict) --
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) --
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.
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.
buildtimeSettings (dict) --
Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
descriptiveBotBuilder (dict) --
An object containing specifications for the descriptive bot building feature.
enabled (boolean) --
Specifies whether the descriptive bot building feature is activated or not.
bedrockModelSpecification (dict) --
An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn (string) --
The ARN of the foundation model used in descriptive bot building.
guardrail (dict) --
The guardrail configuration in the Bedrock model specification details.
identifier (string) --
The unique guardrail id for the Bedrock guardrail configuration.
version (string) --
The guardrail version for the Bedrock guardrail configuration.
traceStatus (string) --
The Bedrock trace status in the Bedrock model specification details.
customPrompt (string) --
The custom prompt used in the Bedrock model specification details.
sampleUtteranceGeneration (dict) --
Contains specifications for the sample utterance generation feature.
enabled (boolean) --
Specifies whether to enable sample utterance generation or not.
bedrockModelSpecification (dict) --
Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn (string) --
The ARN of the foundation model used in descriptive bot building.
guardrail (dict) --
The guardrail configuration in the Bedrock model specification details.
identifier (string) --
The unique guardrail id for the Bedrock guardrail configuration.
version (string) --
The guardrail version for the Bedrock guardrail configuration.
traceStatus (string) --
The Bedrock trace status in the Bedrock model specification details.
customPrompt (string) --
The custom prompt used in the Bedrock model specification details.
speechDetectionSensitivity (string) --
The sensitivity level for voice activity detection (VAD) that was specified for the bot locale.
{'speechRecognitionSettings': {'speechModelConfig': {'deepgramConfig': {'apiTokenSecretArn': 'string',
'modelId': 'string'}},
'speechModelPreference': 'Standard | Neural | '
'Deepgram'},
'unifiedSpeechSettings': {'speechFoundationModel': {'modelArn': 'string',
'voiceId': 'string'}}}
Describes the settings that a bot has for a specific locale.
See also: AWS API Documentation
Request Syntax
client.describe_bot_locale(
botId='string',
botVersion='string',
localeId='string'
)
string
[REQUIRED]
The identifier of the bot associated with the locale.
string
[REQUIRED]
The version of the bot associated with the locale.
string
[REQUIRED]
The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see Supported languages.
dict
Response Syntax
{
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'localeName': 'string',
'description': 'string',
'nluIntentConfidenceThreshold': 123.0,
'voiceSettings': {
'engine': 'standard'|'neural'|'long-form'|'generative',
'voiceId': 'string'
},
'unifiedSpeechSettings': {
'speechFoundationModel': {
'modelArn': 'string',
'voiceId': 'string'
}
},
'speechRecognitionSettings': {
'speechModelPreference': 'Standard'|'Neural'|'Deepgram',
'speechModelConfig': {
'deepgramConfig': {
'apiTokenSecretArn': 'string',
'modelId': 'string'
}
}
},
'intentsCount': 123,
'slotTypesCount': 123,
'botLocaleStatus': 'Creating'|'Building'|'Built'|'ReadyExpressTesting'|'Failed'|'Deleting'|'NotBuilt'|'Importing'|'Processing',
'failureReasons': [
'string',
],
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'lastBuildSubmittedDateTime': datetime(2015, 1, 1),
'botLocaleHistoryEvents': [
{
'event': 'string',
'eventDate': datetime(2015, 1, 1)
},
],
'recommendedActions': [
'string',
],
'generativeAISettings': {
'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',
'intentDisambiguationSettings': {
'enabled': True|False,
'maxDisambiguationIntents': 123,
'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'
}
}
}
},
'speechDetectionSensitivity': 'Default'|'HighNoiseTolerance'|'MaximumNoiseTolerance'
}
Response Structure
(dict) --
botId (string) --
The identifier of the bot associated with the locale.
botVersion (string) --
The version of the bot associated with the locale.
localeId (string) --
The unique identifier of the described locale.
localeName (string) --
The name of the locale.
description (string) --
The description of the locale.
nluIntentConfidenceThreshold (float) --
The confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.
voiceSettings (dict) --
The Amazon Polly voice Amazon Lex uses 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 in the Amazon Polly developer guide.
If you do not specify a value, the default is standard.
voiceId (string) --
The identifier of the Amazon Polly voice to use.
unifiedSpeechSettings (dict) --
The unified speech settings configured for the bot locale.
speechFoundationModel (dict) --
The foundation model configuration to use for unified speech processing capabilities.
modelArn (string) --
The Amazon Resource Name (ARN) of the foundation model used for speech processing.
voiceId (string) --
The identifier of the voice to use for speech synthesis with the foundation model.
speechRecognitionSettings (dict) --
The speech-to-text settings configured for the bot locale.
speechModelPreference (string) --
The speech-to-text model to use.
speechModelConfig (dict) --
Configuration settings for the selected speech-to-text model.
deepgramConfig (dict) --
Configuration settings for using Deepgram as the speech-to-text provider.
apiTokenSecretArn (string) --
The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the Deepgram API token.
modelId (string) --
The identifier of the Deepgram speech-to-text model to use for processing speech input.
intentsCount (integer) --
The number of intents defined for the locale.
slotTypesCount (integer) --
The number of slot types defined for the locale.
botLocaleStatus (string) --
The status of the bot. If the status is Failed, the reasons for the failure are listed in the failureReasons field.
failureReasons (list) --
if botLocaleStatus is Failed, Amazon Lex explains why it failed to build the bot.
(string) --
creationDateTime (datetime) --
The date and time that the locale was created.
lastUpdatedDateTime (datetime) --
The date and time that the locale was last updated.
lastBuildSubmittedDateTime (datetime) --
The date and time that the locale was last submitted for building.
botLocaleHistoryEvents (list) --
History of changes, such as when a locale is used in an alias, that have taken place for the locale.
(dict) --
Provides information about an event that occurred affecting the bot locale.
event (string) --
A description of the event that occurred.
eventDate (datetime) --
A timestamp of the date and time that the event occurred.
recommendedActions (list) --
Recommended actions to take to resolve an error in the failureReasons field.
(string) --
generativeAISettings (dict) --
Contains settings for Amazon Bedrock's generative AI features for your bot locale.
runtimeSettings (dict) --
Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
slotResolutionImprovement (dict) --
An object containing specifications for the assisted slot resolution feature.
enabled (boolean) --
Specifies whether assisted slot resolution is turned on or off.
bedrockModelSpecification (dict) --
An object containing information about the Amazon Bedrock model used to assist slot resolution.
modelArn (string) --
The ARN of the foundation model used in descriptive bot building.
guardrail (dict) --
The guardrail configuration in the Bedrock model specification details.
identifier (string) --
The unique guardrail id for the Bedrock guardrail configuration.
version (string) --
The guardrail version for the Bedrock guardrail configuration.
traceStatus (string) --
The Bedrock trace status in the Bedrock model specification details.
customPrompt (string) --
The custom prompt used in the Bedrock model specification details.
nluImprovement (dict) --
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) --
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, or Fallback to use it only when standard NLU confidence is low.
intentDisambiguationSettings (dict) --
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) --
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.
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.
buildtimeSettings (dict) --
Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
descriptiveBotBuilder (dict) --
An object containing specifications for the descriptive bot building feature.
enabled (boolean) --
Specifies whether the descriptive bot building feature is activated or not.
bedrockModelSpecification (dict) --
An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn (string) --
The ARN of the foundation model used in descriptive bot building.
guardrail (dict) --
The guardrail configuration in the Bedrock model specification details.
identifier (string) --
The unique guardrail id for the Bedrock guardrail configuration.
version (string) --
The guardrail version for the Bedrock guardrail configuration.
traceStatus (string) --
The Bedrock trace status in the Bedrock model specification details.
customPrompt (string) --
The custom prompt used in the Bedrock model specification details.
sampleUtteranceGeneration (dict) --
Contains specifications for the sample utterance generation feature.
enabled (boolean) --
Specifies whether to enable sample utterance generation or not.
bedrockModelSpecification (dict) --
Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn (string) --
The ARN of the foundation model used in descriptive bot building.
guardrail (dict) --
The guardrail configuration in the Bedrock model specification details.
identifier (string) --
The unique guardrail id for the Bedrock guardrail configuration.
version (string) --
The guardrail version for the Bedrock guardrail configuration.
traceStatus (string) --
The Bedrock trace status in the Bedrock model specification details.
customPrompt (string) --
The custom prompt used in the Bedrock model specification details.
speechDetectionSensitivity (string) --
The sensitivity level for voice activity detection (VAD) configured for the bot locale.
{'resourceSpecification': {'botLocaleImportSpecification': {'speechRecognitionSettings': {'speechModelConfig': {'deepgramConfig': {'apiTokenSecretArn': 'string',
'modelId': 'string'}},
'speechModelPreference': 'Standard '
'| '
'Neural '
'| '
'Deepgram'},
'unifiedSpeechSettings': {'speechFoundationModel': {'modelArn': 'string',
'voiceId': 'string'}}}}}
Gets information about a specific import.
See also: AWS API Documentation
Request Syntax
client.describe_import(
importId='string'
)
string
[REQUIRED]
The unique identifier of the import to describe.
dict
Response Syntax
{
'importId': 'string',
'resourceSpecification': {
'botImportSpecification': {
'botName': 'string',
'roleArn': 'string',
'dataPrivacy': {
'childDirected': True|False
},
'errorLogSettings': {
'enabled': True|False
},
'idleSessionTTLInSeconds': 123,
'botTags': {
'string': 'string'
},
'testBotAliasTags': {
'string': 'string'
}
},
'botLocaleImportSpecification': {
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'nluIntentConfidenceThreshold': 123.0,
'voiceSettings': {
'engine': 'standard'|'neural'|'long-form'|'generative',
'voiceId': 'string'
},
'speechRecognitionSettings': {
'speechModelPreference': 'Standard'|'Neural'|'Deepgram',
'speechModelConfig': {
'deepgramConfig': {
'apiTokenSecretArn': 'string',
'modelId': 'string'
}
}
},
'speechDetectionSensitivity': 'Default'|'HighNoiseTolerance'|'MaximumNoiseTolerance',
'unifiedSpeechSettings': {
'speechFoundationModel': {
'modelArn': 'string',
'voiceId': 'string'
}
}
},
'customVocabularyImportSpecification': {
'botId': 'string',
'botVersion': 'string',
'localeId': 'string'
},
'testSetImportResourceSpecification': {
'testSetName': 'string',
'description': 'string',
'roleArn': 'string',
'storageLocation': {
's3BucketName': 'string',
's3Path': 'string',
'kmsKeyArn': 'string'
},
'importInputLocation': {
's3BucketName': 'string',
's3Path': 'string'
},
'modality': 'Text'|'Audio',
'testSetTags': {
'string': 'string'
}
}
},
'importedResourceId': 'string',
'importedResourceName': 'string',
'mergeStrategy': 'Overwrite'|'FailOnConflict'|'Append',
'importStatus': 'InProgress'|'Completed'|'Failed'|'Deleting',
'failureReasons': [
'string',
],
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
importId (string) --
The unique identifier of the described import.
resourceSpecification (dict) --
The specifications of the imported bot, bot locale, or custom vocabulary.
botImportSpecification (dict) --
Parameters for importing a bot.
botName (string) --
The name that Amazon Lex should use for the bot.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
dataPrivacy (dict) --
By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.
childDirected (boolean) --
For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
errorLogSettings (dict) --
Allows you to configure destinations where error logs will be published during the bot import process.
enabled (boolean) --
Settings parameters for the error logs, when it is enabled.
idleSessionTTLInSeconds (integer) --
The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
botTags (dict) --
A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.
(string) --
(string) --
testBotAliasTags (dict) --
A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.
(string) --
(string) --
botLocaleImportSpecification (dict) --
Parameters for importing a bot locale.
botId (string) --
The identifier of the bot to import the locale to.
botVersion (string) --
The version of the bot to import the locale to. This can only be the DRAFT version of the bot.
localeId (string) --
The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.
nluIntentConfidenceThreshold (float) --
Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.
For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the PostText operation would be:
AMAZON.FallbackIntent
IntentA
IntentB
IntentC
voiceSettings (dict) --
Defines settings for using an Amazon Polly voice to communicate with a user.
Valid values include:
standard
neural
long-form
generative
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 in the Amazon Polly developer guide.
If you do not specify a value, the default is standard.
voiceId (string) --
The identifier of the Amazon Polly voice to use.
speechRecognitionSettings (dict) --
Speech-to-text settings to apply when importing the bot locale configuration.
speechModelPreference (string) --
The speech-to-text model to use.
speechModelConfig (dict) --
Configuration settings for the selected speech-to-text model.
deepgramConfig (dict) --
Configuration settings for using Deepgram as the speech-to-text provider.
apiTokenSecretArn (string) --
The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the Deepgram API token.
modelId (string) --
The identifier of the Deepgram speech-to-text model to use for processing speech input.
speechDetectionSensitivity (string) --
The 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.
unifiedSpeechSettings (dict) --
Unified speech settings to apply when importing the bot locale configuration.
speechFoundationModel (dict) --
The foundation model configuration to use for unified speech processing capabilities.
modelArn (string) --
The Amazon Resource Name (ARN) of the foundation model used for speech processing.
voiceId (string) --
The identifier of the voice to use for speech synthesis with the foundation model.
customVocabularyImportSpecification (dict) --
Provides the parameters required for importing a custom vocabulary.
botId (string) --
The identifier of the bot to import the custom vocabulary to.
botVersion (string) --
The version of the bot to import the custom vocabulary to.
localeId (string) --
The identifier of the local to import the custom vocabulary to. The value must be en_GB.
testSetImportResourceSpecification (dict) --
Specifications for the test set that is imported.
testSetName (string) --
The name of the test set.
description (string) --
The description of the test set.
roleArn (string) --
The Amazon Resource Name (ARN) of an IAM role that has permission to access the test set.
storageLocation (dict) --
Contains information about the location that Amazon Lex uses to store the test-set.
s3BucketName (string) --
The name of the Amazon S3 bucket in which the test set is stored.
s3Path (string) --
The path inside the Amazon S3 bucket where the test set is stored.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.
importInputLocation (dict) --
Contains information about the input location from where test-set should be imported.
s3BucketName (string) --
The name of the Amazon S3 bucket.
s3Path (string) --
The path inside the Amazon S3 bucket pointing to the test-set CSV file.
modality (string) --
Specifies whether the test-set being imported contains written or spoken data.
testSetTags (dict) --
A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the UpdateTestSet operation to update tags. To update tags, use the TagResource operation.
(string) --
(string) --
importedResourceId (string) --
The unique identifier that Amazon Lex assigned to the resource created by the import.
importedResourceName (string) --
The name of the imported resource.
mergeStrategy (string) --
The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.
importStatus (string) --
The status of the import process. When the status is Completed the resource is imported and ready for use.
failureReasons (list) --
If the importStatus field is Failed, this provides one or more reasons for the failure.
(string) --
creationDateTime (datetime) --
The date and time that the import was created.
lastUpdatedDateTime (datetime) --
The date and time that the import was last updated.
{'resourceSpecification': {'botLocaleImportSpecification': {'speechRecognitionSettings': {'speechModelConfig': {'deepgramConfig': {'apiTokenSecretArn': 'string',
'modelId': 'string'}},
'speechModelPreference': 'Standard '
'| '
'Neural '
'| '
'Deepgram'},
'unifiedSpeechSettings': {'speechFoundationModel': {'modelArn': 'string',
'voiceId': 'string'}}}}}
Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.
See also: AWS API Documentation
Request Syntax
client.start_import(
importId='string',
resourceSpecification={
'botImportSpecification': {
'botName': 'string',
'roleArn': 'string',
'dataPrivacy': {
'childDirected': True|False
},
'errorLogSettings': {
'enabled': True|False
},
'idleSessionTTLInSeconds': 123,
'botTags': {
'string': 'string'
},
'testBotAliasTags': {
'string': 'string'
}
},
'botLocaleImportSpecification': {
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'nluIntentConfidenceThreshold': 123.0,
'voiceSettings': {
'engine': 'standard'|'neural'|'long-form'|'generative',
'voiceId': 'string'
},
'speechRecognitionSettings': {
'speechModelPreference': 'Standard'|'Neural'|'Deepgram',
'speechModelConfig': {
'deepgramConfig': {
'apiTokenSecretArn': 'string',
'modelId': 'string'
}
}
},
'speechDetectionSensitivity': 'Default'|'HighNoiseTolerance'|'MaximumNoiseTolerance',
'unifiedSpeechSettings': {
'speechFoundationModel': {
'modelArn': 'string',
'voiceId': 'string'
}
}
},
'customVocabularyImportSpecification': {
'botId': 'string',
'botVersion': 'string',
'localeId': 'string'
},
'testSetImportResourceSpecification': {
'testSetName': 'string',
'description': 'string',
'roleArn': 'string',
'storageLocation': {
's3BucketName': 'string',
's3Path': 'string',
'kmsKeyArn': 'string'
},
'importInputLocation': {
's3BucketName': 'string',
's3Path': 'string'
},
'modality': 'Text'|'Audio',
'testSetTags': {
'string': 'string'
}
}
},
mergeStrategy='Overwrite'|'FailOnConflict'|'Append',
filePassword='string'
)
string
[REQUIRED]
The unique identifier for the import. It is included in the response from the CreateUploadUrl operation.
dict
[REQUIRED]
Parameters for creating the bot, bot locale or custom vocabulary.
botImportSpecification (dict) --
Parameters for importing a bot.
botName (string) -- [REQUIRED]
The name that Amazon Lex should use for the bot.
roleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
dataPrivacy (dict) -- [REQUIRED]
By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.
childDirected (boolean) -- [REQUIRED]
For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
errorLogSettings (dict) --
Allows you to configure destinations where error logs will be published during the bot import process.
enabled (boolean) -- [REQUIRED]
Settings parameters for the error logs, when it is enabled.
idleSessionTTLInSeconds (integer) --
The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
botTags (dict) --
A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.
(string) --
(string) --
testBotAliasTags (dict) --
A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.
(string) --
(string) --
botLocaleImportSpecification (dict) --
Parameters for importing a bot locale.
botId (string) -- [REQUIRED]
The identifier of the bot to import the locale to.
botVersion (string) -- [REQUIRED]
The version of the bot to import the locale to. This can only be the DRAFT version of the bot.
localeId (string) -- [REQUIRED]
The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.
nluIntentConfidenceThreshold (float) --
Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.
For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the PostText operation would be:
AMAZON.FallbackIntent
IntentA
IntentB
IntentC
voiceSettings (dict) --
Defines settings for using an Amazon Polly voice to communicate with a user.
Valid values include:
standard
neural
long-form
generative
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 in the Amazon Polly developer guide.
If you do not specify a value, the default is standard.
voiceId (string) -- [REQUIRED]
The identifier of the Amazon Polly voice to use.
speechRecognitionSettings (dict) --
Speech-to-text settings to apply when importing the bot locale configuration.
speechModelPreference (string) --
The speech-to-text model to use.
speechModelConfig (dict) --
Configuration settings for the selected speech-to-text model.
deepgramConfig (dict) --
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.
modelId (string) --
The identifier of the Deepgram speech-to-text model to use for processing speech input.
speechDetectionSensitivity (string) --
The 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.
unifiedSpeechSettings (dict) --
Unified speech settings to apply when importing the bot locale configuration.
speechFoundationModel (dict) -- [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.
voiceId (string) --
The identifier of the voice to use for speech synthesis with the foundation model.
customVocabularyImportSpecification (dict) --
Provides the parameters required for importing a custom vocabulary.
botId (string) -- [REQUIRED]
The identifier of the bot to import the custom vocabulary to.
botVersion (string) -- [REQUIRED]
The version of the bot to import the custom vocabulary to.
localeId (string) -- [REQUIRED]
The identifier of the local to import the custom vocabulary to. The value must be en_GB.
testSetImportResourceSpecification (dict) --
Specifications for the test set that is imported.
testSetName (string) -- [REQUIRED]
The name of the test set.
description (string) --
The description of the test set.
roleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of an IAM role that has permission to access the test set.
storageLocation (dict) -- [REQUIRED]
Contains information about the location that Amazon Lex uses to store the test-set.
s3BucketName (string) -- [REQUIRED]
The name of the Amazon S3 bucket in which the test set is stored.
s3Path (string) -- [REQUIRED]
The path inside the Amazon S3 bucket where the test set is stored.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.
importInputLocation (dict) -- [REQUIRED]
Contains information about the input location from where test-set should be imported.
s3BucketName (string) -- [REQUIRED]
The name of the Amazon S3 bucket.
s3Path (string) -- [REQUIRED]
The path inside the Amazon S3 bucket pointing to the test-set CSV file.
modality (string) -- [REQUIRED]
Specifies whether the test-set being imported contains written or spoken data.
testSetTags (dict) --
A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the UpdateTestSet operation to update tags. To update tags, use the TagResource operation.
(string) --
(string) --
string
[REQUIRED]
The strategy to use when there is a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.
string
The password used to encrypt the zip archive that contains the resource definition. You should always encrypt the zip archive to protect it during transit between your site and Amazon Lex.
dict
Response Syntax
{
'importId': 'string',
'resourceSpecification': {
'botImportSpecification': {
'botName': 'string',
'roleArn': 'string',
'dataPrivacy': {
'childDirected': True|False
},
'errorLogSettings': {
'enabled': True|False
},
'idleSessionTTLInSeconds': 123,
'botTags': {
'string': 'string'
},
'testBotAliasTags': {
'string': 'string'
}
},
'botLocaleImportSpecification': {
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'nluIntentConfidenceThreshold': 123.0,
'voiceSettings': {
'engine': 'standard'|'neural'|'long-form'|'generative',
'voiceId': 'string'
},
'speechRecognitionSettings': {
'speechModelPreference': 'Standard'|'Neural'|'Deepgram',
'speechModelConfig': {
'deepgramConfig': {
'apiTokenSecretArn': 'string',
'modelId': 'string'
}
}
},
'speechDetectionSensitivity': 'Default'|'HighNoiseTolerance'|'MaximumNoiseTolerance',
'unifiedSpeechSettings': {
'speechFoundationModel': {
'modelArn': 'string',
'voiceId': 'string'
}
}
},
'customVocabularyImportSpecification': {
'botId': 'string',
'botVersion': 'string',
'localeId': 'string'
},
'testSetImportResourceSpecification': {
'testSetName': 'string',
'description': 'string',
'roleArn': 'string',
'storageLocation': {
's3BucketName': 'string',
's3Path': 'string',
'kmsKeyArn': 'string'
},
'importInputLocation': {
's3BucketName': 'string',
's3Path': 'string'
},
'modality': 'Text'|'Audio',
'testSetTags': {
'string': 'string'
}
}
},
'mergeStrategy': 'Overwrite'|'FailOnConflict'|'Append',
'importStatus': 'InProgress'|'Completed'|'Failed'|'Deleting',
'creationDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
importId (string) --
A unique identifier for the import.
resourceSpecification (dict) --
The parameters used when importing the resource.
botImportSpecification (dict) --
Parameters for importing a bot.
botName (string) --
The name that Amazon Lex should use for the bot.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
dataPrivacy (dict) --
By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.
childDirected (boolean) --
For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
errorLogSettings (dict) --
Allows you to configure destinations where error logs will be published during the bot import process.
enabled (boolean) --
Settings parameters for the error logs, when it is enabled.
idleSessionTTLInSeconds (integer) --
The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
botTags (dict) --
A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.
(string) --
(string) --
testBotAliasTags (dict) --
A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.
(string) --
(string) --
botLocaleImportSpecification (dict) --
Parameters for importing a bot locale.
botId (string) --
The identifier of the bot to import the locale to.
botVersion (string) --
The version of the bot to import the locale to. This can only be the DRAFT version of the bot.
localeId (string) --
The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.
nluIntentConfidenceThreshold (float) --
Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.
For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the PostText operation would be:
AMAZON.FallbackIntent
IntentA
IntentB
IntentC
voiceSettings (dict) --
Defines settings for using an Amazon Polly voice to communicate with a user.
Valid values include:
standard
neural
long-form
generative
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 in the Amazon Polly developer guide.
If you do not specify a value, the default is standard.
voiceId (string) --
The identifier of the Amazon Polly voice to use.
speechRecognitionSettings (dict) --
Speech-to-text settings to apply when importing the bot locale configuration.
speechModelPreference (string) --
The speech-to-text model to use.
speechModelConfig (dict) --
Configuration settings for the selected speech-to-text model.
deepgramConfig (dict) --
Configuration settings for using Deepgram as the speech-to-text provider.
apiTokenSecretArn (string) --
The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the Deepgram API token.
modelId (string) --
The identifier of the Deepgram speech-to-text model to use for processing speech input.
speechDetectionSensitivity (string) --
The 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.
unifiedSpeechSettings (dict) --
Unified speech settings to apply when importing the bot locale configuration.
speechFoundationModel (dict) --
The foundation model configuration to use for unified speech processing capabilities.
modelArn (string) --
The Amazon Resource Name (ARN) of the foundation model used for speech processing.
voiceId (string) --
The identifier of the voice to use for speech synthesis with the foundation model.
customVocabularyImportSpecification (dict) --
Provides the parameters required for importing a custom vocabulary.
botId (string) --
The identifier of the bot to import the custom vocabulary to.
botVersion (string) --
The version of the bot to import the custom vocabulary to.
localeId (string) --
The identifier of the local to import the custom vocabulary to. The value must be en_GB.
testSetImportResourceSpecification (dict) --
Specifications for the test set that is imported.
testSetName (string) --
The name of the test set.
description (string) --
The description of the test set.
roleArn (string) --
The Amazon Resource Name (ARN) of an IAM role that has permission to access the test set.
storageLocation (dict) --
Contains information about the location that Amazon Lex uses to store the test-set.
s3BucketName (string) --
The name of the Amazon S3 bucket in which the test set is stored.
s3Path (string) --
The path inside the Amazon S3 bucket where the test set is stored.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.
importInputLocation (dict) --
Contains information about the input location from where test-set should be imported.
s3BucketName (string) --
The name of the Amazon S3 bucket.
s3Path (string) --
The path inside the Amazon S3 bucket pointing to the test-set CSV file.
modality (string) --
Specifies whether the test-set being imported contains written or spoken data.
testSetTags (dict) --
A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the UpdateTestSet operation to update tags. To update tags, use the TagResource operation.
(string) --
(string) --
mergeStrategy (string) --
The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.
importStatus (string) --
The current status of the import. When the status is Complete the bot, bot alias, or custom vocabulary is ready to use.
creationDateTime (datetime) --
The date and time that the import request was created.
{'speechRecognitionSettings': {'speechModelConfig': {'deepgramConfig': {'apiTokenSecretArn': 'string',
'modelId': 'string'}},
'speechModelPreference': 'Standard | Neural | '
'Deepgram'},
'unifiedSpeechSettings': {'speechFoundationModel': {'modelArn': 'string',
'voiceId': 'string'}}}
Updates the settings that a bot has for a specific locale.
See also: AWS API Documentation
Request Syntax
client.update_bot_locale(
botId='string',
botVersion='string',
localeId='string',
description='string',
nluIntentConfidenceThreshold=123.0,
voiceSettings={
'engine': 'standard'|'neural'|'long-form'|'generative',
'voiceId': 'string'
},
unifiedSpeechSettings={
'speechFoundationModel': {
'modelArn': 'string',
'voiceId': 'string'
}
},
speechRecognitionSettings={
'speechModelPreference': 'Standard'|'Neural'|'Deepgram',
'speechModelConfig': {
'deepgramConfig': {
'apiTokenSecretArn': 'string',
'modelId': 'string'
}
}
},
generativeAISettings={
'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',
'intentDisambiguationSettings': {
'enabled': True|False,
'maxDisambiguationIntents': 123,
'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'
}
}
}
},
speechDetectionSensitivity='Default'|'HighNoiseTolerance'|'MaximumNoiseTolerance'
)
string
[REQUIRED]
The unique identifier of the bot that contains the locale.
string
[REQUIRED]
The version of the bot that contains the locale to be updated. The version can only be the DRAFT version.
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.
string
The new description of the locale.
float
[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.
dict
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 in the Amazon Polly developer guide.
If you do not specify a value, the default is standard.
voiceId (string) -- [REQUIRED]
The identifier of the Amazon Polly voice to use.
dict
Updated unified speech settings to apply to the bot locale.
speechFoundationModel (dict) -- [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.
voiceId (string) --
The identifier of the voice to use for speech synthesis with the foundation model.
dict
Updated speech-to-text settings to apply to the bot locale.
speechModelPreference (string) --
The speech-to-text model to use.
speechModelConfig (dict) --
Configuration settings for the selected speech-to-text model.
deepgramConfig (dict) --
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.
modelId (string) --
The identifier of the Deepgram speech-to-text model to use for processing speech input.
dict
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 (dict) --
Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
slotResolutionImprovement (dict) --
An object containing specifications for the assisted slot resolution feature.
enabled (boolean) -- [REQUIRED]
Specifies whether assisted slot resolution is turned on or off.
bedrockModelSpecification (dict) --
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.
guardrail (dict) --
The guardrail configuration in the Bedrock model specification details.
identifier (string) -- [REQUIRED]
The unique guardrail id for the Bedrock guardrail configuration.
version (string) -- [REQUIRED]
The guardrail version for the Bedrock guardrail configuration.
traceStatus (string) --
The Bedrock trace status in the Bedrock model specification details.
customPrompt (string) --
The custom prompt used in the Bedrock model specification details.
nluImprovement (dict) --
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, or Fallback to use it only when standard NLU confidence is low.
intentDisambiguationSettings (dict) --
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.
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.
buildtimeSettings (dict) --
Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
descriptiveBotBuilder (dict) --
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 (dict) --
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.
guardrail (dict) --
The guardrail configuration in the Bedrock model specification details.
identifier (string) -- [REQUIRED]
The unique guardrail id for the Bedrock guardrail configuration.
version (string) -- [REQUIRED]
The guardrail version for the Bedrock guardrail configuration.
traceStatus (string) --
The Bedrock trace status in the Bedrock model specification details.
customPrompt (string) --
The custom prompt used in the Bedrock model specification details.
sampleUtteranceGeneration (dict) --
Contains specifications for the sample utterance generation feature.
enabled (boolean) -- [REQUIRED]
Specifies whether to enable sample utterance generation or not.
bedrockModelSpecification (dict) --
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.
guardrail (dict) --
The guardrail configuration in the Bedrock model specification details.
identifier (string) -- [REQUIRED]
The unique guardrail id for the Bedrock guardrail configuration.
version (string) -- [REQUIRED]
The guardrail version for the Bedrock guardrail configuration.
traceStatus (string) --
The Bedrock trace status in the Bedrock model specification details.
customPrompt (string) --
The custom prompt used in the Bedrock model specification details.
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.
dict
Response Syntax
{
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'localeName': 'string',
'description': 'string',
'nluIntentConfidenceThreshold': 123.0,
'voiceSettings': {
'engine': 'standard'|'neural'|'long-form'|'generative',
'voiceId': 'string'
},
'unifiedSpeechSettings': {
'speechFoundationModel': {
'modelArn': 'string',
'voiceId': 'string'
}
},
'speechRecognitionSettings': {
'speechModelPreference': 'Standard'|'Neural'|'Deepgram',
'speechModelConfig': {
'deepgramConfig': {
'apiTokenSecretArn': 'string',
'modelId': 'string'
}
}
},
'botLocaleStatus': 'Creating'|'Building'|'Built'|'ReadyExpressTesting'|'Failed'|'Deleting'|'NotBuilt'|'Importing'|'Processing',
'failureReasons': [
'string',
],
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'recommendedActions': [
'string',
],
'generativeAISettings': {
'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',
'intentDisambiguationSettings': {
'enabled': True|False,
'maxDisambiguationIntents': 123,
'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'
}
}
}
},
'speechDetectionSensitivity': 'Default'|'HighNoiseTolerance'|'MaximumNoiseTolerance'
}
Response Structure
(dict) --
botId (string) --
The identifier of the bot that contains the updated locale.
botVersion (string) --
The version of the bot that contains the updated locale.
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.
nluIntentConfidenceThreshold (float) --
The updated confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.
voiceSettings (dict) --
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 in the Amazon Polly developer guide.
If you do not specify a value, the default is standard.
voiceId (string) --
The identifier of the Amazon Polly voice to use.
unifiedSpeechSettings (dict) --
The updated unified speech settings for the bot locale.
speechFoundationModel (dict) --
The foundation model configuration to use for unified speech processing capabilities.
modelArn (string) --
The Amazon Resource Name (ARN) of the foundation model used for speech processing.
voiceId (string) --
The identifier of the voice to use for speech synthesis with the foundation model.
speechRecognitionSettings (dict) --
The updated speech-to-text settings for the bot locale.
speechModelPreference (string) --
The speech-to-text model to use.
speechModelConfig (dict) --
Configuration settings for the selected speech-to-text model.
deepgramConfig (dict) --
Configuration settings for using Deepgram as the speech-to-text provider.
apiTokenSecretArn (string) --
The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the Deepgram API token.
modelId (string) --
The identifier of the Deepgram speech-to-text model to use for processing speech input.
botLocaleStatus (string) --
The current status of the locale. When the bot status is Built the locale is ready for use.
failureReasons (list) --
If the botLocaleStatus is Failed, the failureReasons field lists the errors that occurred while building the bot.
(string) --
creationDateTime (datetime) --
A timestamp of the date and time that the locale was created.
lastUpdatedDateTime (datetime) --
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 (dict) --
Contains settings for generative AI features powered by Amazon Bedrock for your bot locale.
runtimeSettings (dict) --
Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
slotResolutionImprovement (dict) --
An object containing specifications for the assisted slot resolution feature.
enabled (boolean) --
Specifies whether assisted slot resolution is turned on or off.
bedrockModelSpecification (dict) --
An object containing information about the Amazon Bedrock model used to assist slot resolution.
modelArn (string) --
The ARN of the foundation model used in descriptive bot building.
guardrail (dict) --
The guardrail configuration in the Bedrock model specification details.
identifier (string) --
The unique guardrail id for the Bedrock guardrail configuration.
version (string) --
The guardrail version for the Bedrock guardrail configuration.
traceStatus (string) --
The Bedrock trace status in the Bedrock model specification details.
customPrompt (string) --
The custom prompt used in the Bedrock model specification details.
nluImprovement (dict) --
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) --
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, or Fallback to use it only when standard NLU confidence is low.
intentDisambiguationSettings (dict) --
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) --
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.
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.
buildtimeSettings (dict) --
Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
descriptiveBotBuilder (dict) --
An object containing specifications for the descriptive bot building feature.
enabled (boolean) --
Specifies whether the descriptive bot building feature is activated or not.
bedrockModelSpecification (dict) --
An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn (string) --
The ARN of the foundation model used in descriptive bot building.
guardrail (dict) --
The guardrail configuration in the Bedrock model specification details.
identifier (string) --
The unique guardrail id for the Bedrock guardrail configuration.
version (string) --
The guardrail version for the Bedrock guardrail configuration.
traceStatus (string) --
The Bedrock trace status in the Bedrock model specification details.
customPrompt (string) --
The custom prompt used in the Bedrock model specification details.
sampleUtteranceGeneration (dict) --
Contains specifications for the sample utterance generation feature.
enabled (boolean) --
Specifies whether to enable sample utterance generation or not.
bedrockModelSpecification (dict) --
Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
modelArn (string) --
The ARN of the foundation model used in descriptive bot building.
guardrail (dict) --
The guardrail configuration in the Bedrock model specification details.
identifier (string) --
The unique guardrail id for the Bedrock guardrail configuration.
version (string) --
The guardrail version for the Bedrock guardrail configuration.
traceStatus (string) --
The Bedrock trace status in the Bedrock model specification details.
customPrompt (string) --
The custom prompt used in the Bedrock model specification details.
speechDetectionSensitivity (string) --
The updated sensitivity level for voice activity detection (VAD) in the bot locale.