2024/07/30 - Amazon Lex Model Building V2 - 6 updated api methods
{'generativeAISettings': {'buildtimeSettings': {'descriptiveBotBuilder': {'bedrockModelSpecification': {'customPrompt': 'string',
'guardrail': {'identifier': 'string',
'version': 'string'},
'traceStatus': 'ENABLED '
'| '
'DISABLED'}},
'sampleUtteranceGeneration': {'bedrockModelSpecification': {'customPrompt': 'string',
'guardrail': {'identifier': 'string',
'version': 'string'},
'traceStatus': 'ENABLED '
'| '
'DISABLED'}}},
'runtimeSettings': {'slotResolutionImprovement': {'bedrockModelSpecification': {'customPrompt': 'string',
'guardrail': {'identifier': 'string',
'version': 'string'},
'traceStatus': 'ENABLED '
'| '
'DISABLED'}}}}}
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={
'voiceId': 'string',
'engine': 'standard'|'neural'
},
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'
}
}
}
}
)
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.
voiceId (string) -- [REQUIRED]
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.
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.
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.
dict
Response Syntax
{
'botId': 'string',
'botVersion': 'string',
'localeName': 'string',
'localeId': 'string',
'description': 'string',
'nluIntentConfidenceThreshold': 123.0,
'voiceSettings': {
'voiceId': 'string',
'engine': 'standard'|'neural'
},
'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'
}
}
},
'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 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.
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.
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.
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.
{'qnAIntentConfiguration': {'bedrockModelConfiguration': {'customPrompt': 'string',
'guardrail': {'identifier': 'string',
'version': 'string'},
'traceStatus': 'ENABLED '
'| '
'DISABLED'},
'dataSourceConfiguration': {'bedrockKnowledgeStoreConfiguration': {'exactResponse': 'boolean',
'exactResponseFields': {'answerField': 'string'}}}}}
Creates an intent.
To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would create an OrderPizza intent.
When you create an intent, you must provide a name. You can optionally provide the following:
Sample utterances. For example, "I want to order a pizza" and "Can I order a pizza." You can't provide utterances for built-in intents.
Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application.
How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available.
A confirmation prompt to send to the user to confirm an intent. For example, "Shall I order your pizza?"
A conclusion statement to send to the user after the intent is fulfilled. For example, "I ordered your pizza."
A follow-up prompt that asks the user for additional activity. For example, "Do you want a drink with your pizza?"
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'generativeAISettings': {'buildtimeSettings': {'descriptiveBotBuilder': {'bedrockModelSpecification': {'customPrompt': 'string',
'guardrail': {'identifier': 'string',
'version': 'string'},
'traceStatus': 'ENABLED '
'| '
'DISABLED'}},
'sampleUtteranceGeneration': {'bedrockModelSpecification': {'customPrompt': 'string',
'guardrail': {'identifier': 'string',
'version': 'string'},
'traceStatus': 'ENABLED '
'| '
'DISABLED'}}},
'runtimeSettings': {'slotResolutionImprovement': {'bedrockModelSpecification': {'customPrompt': 'string',
'guardrail': {'identifier': 'string',
'version': 'string'},
'traceStatus': 'ENABLED '
'| '
'DISABLED'}}}}}
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': {
'voiceId': 'string',
'engine': 'standard'|'neural'
},
'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.
{'qnAIntentConfiguration': {'bedrockModelConfiguration': {'customPrompt': 'string',
'guardrail': {'identifier': 'string',
'version': 'string'},
'traceStatus': 'ENABLED '
'| '
'DISABLED'},
'dataSourceConfiguration': {'bedrockKnowledgeStoreConfiguration': {'exactResponse': 'boolean',
'exactResponseFields': {'answerField': 'string'}}}}}
Returns metadata about an intent.
See also: AWS API Documentation
Request Syntax
client.describe_intent(
intentId='string',
botId='string',
botVersion='string',
localeId='string'
)
string
[REQUIRED]
The identifier of the intent to describe.
string
[REQUIRED]
The identifier of the bot associated with the intent.
string
[REQUIRED]
The version of the bot associated with the intent.
string
[REQUIRED]
The identifier of the language and locale of the intent to describe. The string must match one of the supported locales. For more information, see Supported languages.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'generativeAISettings': {'buildtimeSettings': {'descriptiveBotBuilder': {'bedrockModelSpecification': {'customPrompt': 'string',
'guardrail': {'identifier': 'string',
'version': 'string'},
'traceStatus': 'ENABLED '
'| '
'DISABLED'}},
'sampleUtteranceGeneration': {'bedrockModelSpecification': {'customPrompt': 'string',
'guardrail': {'identifier': 'string',
'version': 'string'},
'traceStatus': 'ENABLED '
'| '
'DISABLED'}}},
'runtimeSettings': {'slotResolutionImprovement': {'bedrockModelSpecification': {'customPrompt': 'string',
'guardrail': {'identifier': 'string',
'version': 'string'},
'traceStatus': 'ENABLED '
'| '
'DISABLED'}}}}}
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={
'voiceId': 'string',
'engine': 'standard'|'neural'
},
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'
}
}
}
}
)
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.
voiceId (string) -- [REQUIRED]
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.
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.
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.
dict
Response Syntax
{
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'localeName': 'string',
'description': 'string',
'nluIntentConfidenceThreshold': 123.0,
'voiceSettings': {
'voiceId': 'string',
'engine': 'standard'|'neural'
},
'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'
}
}
},
'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 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.
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.
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.
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.
{'qnAIntentConfiguration': {'bedrockModelConfiguration': {'customPrompt': 'string',
'guardrail': {'identifier': 'string',
'version': 'string'},
'traceStatus': 'ENABLED '
'| '
'DISABLED'},
'dataSourceConfiguration': {'bedrockKnowledgeStoreConfiguration': {'exactResponse': 'boolean',
'exactResponseFields': {'answerField': 'string'}}}}}
Updates the settings for an intent.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.