BotState class
Input properties used for looking up and filtering Bot resources.
Constructors
-
BotState({Input<
BotAbortStatement?> ? abortStatement, Input<String?> ? arn, Input<String?> ? checksum, Input<bool?> ? childDirected, Input<BotClarificationPrompt?> ? clarificationPrompt, Input<bool?> ? createVersion, Input<String?> ? createdDate, Input<String?> ? description, Input<bool?> ? detectSentiment, Input<bool?> ? enableModelImprovements, Input<String?> ? failureReason, Input<int?> ? idleSessionTtlInSeconds, Input<List< ? intents, Input<BotIntent> ?>String?> ? lastUpdatedDate, Input<String?> ? locale, Input<String?> ? name, Input<double?> ? nluIntentConfidenceThreshold, Input<String?> ? processBehavior, Input<String?> ? region, Input<String?> ? status, Input<String?> ? version, Input<String?> ? voiceId}) -
Creates a new BotState.
abortStatementThe message that Amazon Lex uses to abort a conversation. Attributes are documented under statement.arnOptional.checksumChecksum identifying the version of the bot that was created. The checksum is notchildDirectedBy specifying true, 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. For more information see the Amazon Lex FAQ and the Amazon Lex PutBot API Docs.clarificationPromptThe message that Amazon Lex uses when it doesn't understand the user's request. Attributes are documented under prompt.createVersionDetermines if a new bot version is created when the initial resource is created and on each update. Defaults tofalse.createdDateThe date when the bot version was created.descriptionA description of the bot. Must be less than or equal to 200 characters in length.detectSentimentWhen set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default isfalse.enableModelImprovementsSet totrueto enable access to natural language understanding improvements. When you set theenableModelImprovementsparameter to true you can use thenluIntentConfidenceThresholdparameter to configure confidence scores. For more information, see Confidence Scores. You can only set theenableModelImprovementsparameter in certain Regions. If you set the parameter to true, your bot has access to accuracy improvements. For more information see the Amazon Lex Bot PutBot API Docs.failureReasonIf status is FAILED, Amazon Lex provides the reason that it failed to build the bot.idleSessionTtlInSecondsThe maximum time in seconds that Amazon Lex retains the data gathered in a conversation. Default is300. Must be a number between 60 and 86400 (inclusive).intentsA set of Intent objects. Each intent represents a command that a user can express. Attributes are documented under intent. Can have up to 250 Intent objects.lastUpdatedDateThe date when the $LATEST version of this bot was updated.localeSpecifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot. For available locales, see Amazon Lex Bot PutBot API Docs. Default isen-US.nameThe name of the bot that you want to create, case sensitive. Must be between 2 and 50 characters in length.nluIntentConfidenceThresholdDetermines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot. For more information see Amazon Lex Bot PutBot API Docs This value requiresenableModelImprovementsto be set totrueand the default is0. Must be a float between 0 and 1.processBehaviorIf you set theprocessBehaviorelement toBUILD, Amazon Lex builds the bot so that it can be run. If you set the element toSAVEAmazon Lex saves the bot, but doesn't build it. Default isSAVE.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.statusWhen you send a request to create or update a bot, Amazon Lex sets the status responseversionThe version of the bot.voiceIdThe Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide.const -
BotState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
abortStatement
→ Input<
BotAbortStatement?> ? -
The message that Amazon Lex uses to abort a conversation. Attributes are documented under statement.
final
-
arn
→ Input<
String?> ? -
final
-
checksum
→ Input<
String?> ? -
Checksum identifying the version of the bot that was created. The checksum is not
included as an argument because the resource will add it automatically when updating the bot.
final
-
childDirected
→ Input<
bool?> ? -
By specifying true, 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. For more information see the Amazon Lex FAQ and the Amazon Lex PutBot API Docs.
final
-
clarificationPrompt
→ Input<
BotClarificationPrompt?> ? -
The message that Amazon Lex uses when it doesn't understand the user's request. Attributes are documented under prompt.
final
-
createdDate
→ Input<
String?> ? -
The date when the bot version was created.
final
-
createVersion
→ Input<
bool?> ? -
Determines if a new bot version is created when the initial resource is created and on each update. Defaults to
false.final -
description
→ Input<
String?> ? -
A description of the bot. Must be less than or equal to 200 characters in length.
final
-
detectSentiment
→ Input<
bool?> ? -
When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is
false.final -
enableModelImprovements
→ Input<
bool?> ? -
Set to
trueto enable access to natural language understanding improvements. When you set theenableModelImprovementsparameter to true you can use thenluIntentConfidenceThresholdparameter to configure confidence scores. For more information, see Confidence Scores. You can only set theenableModelImprovementsparameter in certain Regions. If you set the parameter to true, your bot has access to accuracy improvements. For more information see the Amazon Lex Bot PutBot API Docs.final -
failureReason
→ Input<
String?> ? -
If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
idleSessionTtlInSeconds
→ Input<
int?> ? -
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. Default is
300. Must be a number between 60 and 86400 (inclusive).final -
intents
→ Input<
List< ?BotIntent> ?> -
A set of Intent objects. Each intent represents a command that a user can express. Attributes are documented under intent. Can have up to 250 Intent objects.
final
-
lastUpdatedDate
→ Input<
String?> ? -
The date when the $LATEST version of this bot was updated.
final
-
locale
→ Input<
String?> ? -
Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot. For available locales, see Amazon Lex Bot PutBot API Docs. Default is
en-US.final -
name
→ Input<
String?> ? -
The name of the bot that you want to create, case sensitive. Must be between 2 and 50 characters in length.
final
-
nluIntentConfidenceThreshold
→ Input<
double?> ? -
Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot. For more information see Amazon Lex Bot PutBot API Docs This value requires
enableModelImprovementsto be set totrueand the default is0. Must be a float between 0 and 1.final -
processBehavior
→ Input<
String?> ? -
If you set the
processBehaviorelement toBUILD, Amazon Lex builds the bot so that it can be run. If you set the element toSAVEAmazon Lex saves the bot, but doesn't build it. Default isSAVE.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
status
→ Input<
String?> ? -
When you send a request to create or update a bot, Amazon Lex sets the status response
element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't
build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the
failureReason response element.
final
-
version
→ Input<
String?> ? -
The version of the bot.
final
-
voiceId
→ Input<
String?> ? -
The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited