BotLocaleImportSpecification - Amazon Lex API Reference

BotLocaleImportSpecification

Provides the bot locale parameters required for importing a bot locale.

Contents

botId

The identifier of the bot to import the locale to.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

Required: Yes

botVersion

The version of the bot to import the locale to. This can only be the DRAFT version of the bot.

Type: String

Length Constraints: Fixed length of 5.

Pattern: ^DRAFT$

Required: Yes

localeId

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.

Type: String

Required: Yes

nluIntentConfidenceThreshold

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

Type: Double

Valid Range: Minimum value of 0. Maximum value of 1.

Required: No

speechDetectionSensitivity

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.

Type: String

Valid Values: Default | HighNoiseTolerance | MaximumNoiseTolerance

Required: No

speechRecognitionSettings

Speech-to-text settings to apply when importing the bot locale configuration.

Type: SpeechRecognitionSettings object

Required: No

unifiedSpeechSettings

Unified speech settings to apply when importing the bot locale configuration.

Type: UnifiedSpeechSettings object

Required: No

voiceSettings

Defines settings for using an Amazon Polly voice to communicate with a user.

Valid values include:

  • standard

  • neural

  • long-form

  • generative

Type: VoiceSettings object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: