LexModelsV2 / Client / describe_bot_locale

describe_bot_locale#

LexModelsV2.Client.describe_bot_locale(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.describe_bot_locale(
    botId='string',
    botVersion='string',
    localeId='string'
)
Parameters:

  • botId (string) –

    [REQUIRED]

    The identifier of the bot associated with the locale.

  • botVersion (string) –

    [REQUIRED]

    The version of the bot associated with the locale.

  • localeId (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.

Return type:

dict

Returns:

Response Syntax

{
    'botId': 'string',
    'botVersion': 'string',
    'localeId': 'string',
    'localeName': 'string',
    'description': 'string',
    'nluIntentConfidenceThreshold': 123.0,
    'voiceSettings': {
        'voiceId': 'string',
        'engine': 'standard'|'neural'|'long-form'|'generative'
    },
    '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'
                }
            }
        },
        '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'
                }
            }
        }
    }
}

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.

      • voiceId (string) –

        The identifier of the Amazon Polly voice to use.

      • 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.

    • 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.

      • 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.

Exceptions