Class PutBotRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutBotRequest.Builder,
PutBotRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Statement
When Amazon Lex can't understand the user's input in context, it tries to elicit the information a few times.static PutBotRequest.Builder
builder()
final String
checksum()
Identifies a specific revision of the$LATEST
version.final 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 specifyingtrue
orfalse
in thechildDirected
field.final Prompt
When Amazon Lex doesn't understand the user's intent, it uses this message to get clarification.final Boolean
When set totrue
a new numbered version of the bot is created.final String
A description of the bot.final Boolean
When set totrue
user utterances are sent to Amazon Comprehend for sentiment analysis.final Boolean
Set totrue
to enable access to natural language understanding improvements.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Intents property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Integer
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.intents()
An array ofIntent
objects.final Locale
locale()
Specifies the target locale for the bot.final String
Specifies the target locale for the bot.final String
name()
The name of the bot.final Double
Determines the threshold where Amazon Lex will insert theAMAZON.FallbackIntent
,AMAZON.KendraSearchIntent
, or both when returning alternative intents in a PostContent or PostText response.final ProcessBehavior
If you set theprocessBehavior
element toBUILD
, Amazon Lex builds the bot so that it can be run.final String
If you set theprocessBehavior
element toBUILD
, Amazon Lex builds the bot so that it can be run.static Class
<? extends PutBotRequest.Builder> tags()
A list of tags to add to the bot.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
voiceId()
The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the bot. The name is not case sensitive.
- Returns:
- The name of the bot. The name is not case sensitive.
-
description
A description of the bot.
- Returns:
- A description of the bot.
-
hasIntents
public final boolean hasIntents()For responses, this returns true if the service returned a value for the Intents property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
intents
An array of
Intent
objects. Each intent represents a command that a user can express. For example, a pizza ordering bot might support an OrderPizza intent. For more information, see how-it-works.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasIntents()
method.- Returns:
- An array of
Intent
objects. Each intent represents a command that a user can express. For example, a pizza ordering bot might support an OrderPizza intent. For more information, see how-it-works.
-
enableModelImprovements
Set to
true
to enable access to natural language understanding improvements.When you set the
enableModelImprovements
parameter totrue
you can use thenluIntentConfidenceThreshold
parameter to configure confidence scores. For more information, see Confidence Scores.You can only set the
enableModelImprovements
parameter in certain Regions. If you set the parameter totrue
, your bot has access to accuracy improvements.The Regions where you can set the
enableModelImprovements
parameter totrue
are:-
US East (N. Virginia) (us-east-1)
-
US West (Oregon) (us-west-2)
-
Asia Pacific (Sydney) (ap-southeast-2)
-
EU (Ireland) (eu-west-1)
In other Regions, the
enableModelImprovements
parameter is set totrue
by default. In these Regions setting the parameter tofalse
throws aValidationException
exception.- Returns:
- Set to
true
to enable access to natural language understanding improvements.When you set the
enableModelImprovements
parameter totrue
you can use thenluIntentConfidenceThreshold
parameter to configure confidence scores. For more information, see Confidence Scores.You can only set the
enableModelImprovements
parameter in certain Regions. If you set the parameter totrue
, your bot has access to accuracy improvements.The Regions where you can set the
enableModelImprovements
parameter totrue
are:-
US East (N. Virginia) (us-east-1)
-
US West (Oregon) (us-west-2)
-
Asia Pacific (Sydney) (ap-southeast-2)
-
EU (Ireland) (eu-west-1)
In other Regions, the
enableModelImprovements
parameter is set totrue
by default. In these Regions setting the parameter tofalse
throws aValidationException
exception. -
-
-
nluIntentConfidenceThreshold
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
andAMAZON.KendraSearchIntent
are only inserted if they are configured for the bot.You must set the
enableModelImprovements
parameter totrue
to use confidence scores in the following regions.-
US East (N. Virginia) (us-east-1)
-
US West (Oregon) (us-west-2)
-
Asia Pacific (Sydney) (ap-southeast-2)
-
EU (Ireland) (eu-west-1)
In other Regions, the
enableModelImprovements
parameter is set totrue
by default.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 thePostText
operation would be:-
AMAZON.FallbackIntent
-
IntentA
-
IntentB
-
IntentC
- Returns:
- 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
andAMAZON.KendraSearchIntent
are only inserted if they are configured for the bot.You must set the
enableModelImprovements
parameter totrue
to use confidence scores in the following regions.-
US East (N. Virginia) (us-east-1)
-
US West (Oregon) (us-west-2)
-
Asia Pacific (Sydney) (ap-southeast-2)
-
EU (Ireland) (eu-west-1)
In other Regions, the
enableModelImprovements
parameter is set totrue
by default.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 thePostText
operation would be:-
AMAZON.FallbackIntent
-
IntentA
-
IntentB
-
IntentC
-
-
-
clarificationPrompt
When Amazon Lex doesn't understand the user's intent, it uses this message to get clarification. To specify how many times Amazon Lex should repeat the clarification prompt, use the
maxAttempts
field. If Amazon Lex still doesn't understand, it sends the message in theabortStatement
field.When you create a clarification prompt, make sure that it suggests the correct response from the user. for example, for a bot that orders pizza and drinks, you might create this clarification prompt: "What would you like to do? You can say 'Order a pizza' or 'Order a drink.'"
If you have defined a fallback intent, it will be invoked if the clarification prompt is repeated the number of times defined in the
maxAttempts
field. For more information, see AMAZON.FallbackIntent.If you don't define a clarification prompt, at runtime Amazon Lex will return a 400 Bad Request exception in three cases:
-
Follow-up prompt - When the user responds to a follow-up prompt but does not provide an intent. For example, in response to a follow-up prompt that says "Would you like anything else today?" the user says "Yes." Amazon Lex will return a 400 Bad Request exception because it does not have a clarification prompt to send to the user to get an intent.
-
Lambda function - When using a Lambda function, you return an
ElicitIntent
dialog type. Since Amazon Lex does not have a clarification prompt to get an intent from the user, it returns a 400 Bad Request exception. -
PutSession operation - When using the
PutSession
operation, you send anElicitIntent
dialog type. Since Amazon Lex does not have a clarification prompt to get an intent from the user, it returns a 400 Bad Request exception.
- Returns:
- When Amazon Lex doesn't understand the user's intent, it uses this message to get clarification. To
specify how many times Amazon Lex should repeat the clarification prompt, use the
maxAttempts
field. If Amazon Lex still doesn't understand, it sends the message in theabortStatement
field.When you create a clarification prompt, make sure that it suggests the correct response from the user. for example, for a bot that orders pizza and drinks, you might create this clarification prompt: "What would you like to do? You can say 'Order a pizza' or 'Order a drink.'"
If you have defined a fallback intent, it will be invoked if the clarification prompt is repeated the number of times defined in the
maxAttempts
field. For more information, see AMAZON.FallbackIntent.If you don't define a clarification prompt, at runtime Amazon Lex will return a 400 Bad Request exception in three cases:
-
Follow-up prompt - When the user responds to a follow-up prompt but does not provide an intent. For example, in response to a follow-up prompt that says "Would you like anything else today?" the user says "Yes." Amazon Lex will return a 400 Bad Request exception because it does not have a clarification prompt to send to the user to get an intent.
-
Lambda function - When using a Lambda function, you return an
ElicitIntent
dialog type. Since Amazon Lex does not have a clarification prompt to get an intent from the user, it returns a 400 Bad Request exception. -
PutSession operation - When using the
PutSession
operation, you send anElicitIntent
dialog type. Since Amazon Lex does not have a clarification prompt to get an intent from the user, it returns a 400 Bad Request exception.
-
-
-
abortStatement
When Amazon Lex can't understand the user's input in context, it tries to elicit the information a few times. After that, Amazon Lex sends the message defined in
abortStatement
to the user, and then cancels the conversation. To set the number of retries, use thevalueElicitationPrompt
field for the slot type.For example, in a pizza ordering bot, Amazon Lex might ask a user "What type of crust would you like?" If the user's response is not one of the expected responses (for example, "thin crust, "deep dish," etc.), Amazon Lex tries to elicit a correct response a few more times.
For example, in a pizza ordering application,
OrderPizza
might be one of the intents. This intent might require theCrustType
slot. You specify thevalueElicitationPrompt
field when you create theCrustType
slot.If you have defined a fallback intent the cancel statement will not be sent to the user, the fallback intent is used instead. For more information, see AMAZON.FallbackIntent.
- Returns:
- When Amazon Lex can't understand the user's input in context, it tries to elicit the information a few
times. After that, Amazon Lex sends the message defined in
abortStatement
to the user, and then cancels the conversation. To set the number of retries, use thevalueElicitationPrompt
field for the slot type.For example, in a pizza ordering bot, Amazon Lex might ask a user "What type of crust would you like?" If the user's response is not one of the expected responses (for example, "thin crust, "deep dish," etc.), Amazon Lex tries to elicit a correct response a few more times.
For example, in a pizza ordering application,
OrderPizza
might be one of the intents. This intent might require theCrustType
slot. You specify thevalueElicitationPrompt
field when you create theCrustType
slot.If you have defined a fallback intent the cancel statement will not be sent to the user, the fallback intent is used instead. For more information, see AMAZON.FallbackIntent.
-
idleSessionTTLInSeconds
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
A user interaction session 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.
For example, suppose that a user chooses the OrderPizza intent, but gets sidetracked halfway through placing an order. If the user doesn't complete the order within the specified time, Amazon Lex discards the slot information that it gathered, and the user must start over.
If you don't include the
idleSessionTTLInSeconds
element in aPutBot
operation request, Amazon Lex uses the default value. This is also true if the request replaces an existing bot.The default is 300 seconds (5 minutes).
- Returns:
- The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
A user interaction session 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.
For example, suppose that a user chooses the OrderPizza intent, but gets sidetracked halfway through placing an order. If the user doesn't complete the order within the specified time, Amazon Lex discards the slot information that it gathered, and the user must start over.
If you don't include the
idleSessionTTLInSeconds
element in aPutBot
operation request, Amazon Lex uses the default value. This is also true if the request replaces an existing bot.The default is 300 seconds (5 minutes).
-
voiceId
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 Voices in Amazon Polly in the Amazon Polly Developer Guide.
- Returns:
- 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 Voices in Amazon Polly in the Amazon Polly Developer Guide.
-
checksum
Identifies a specific revision of the
$LATEST
version.When you create a new bot, leave the
checksum
field blank. If you specify a checksum you get aBadRequestException
exception.When you want to update a bot, set the
checksum
field to the checksum of the most recent revision of the$LATEST
version. If you don't specify thechecksum
field, or if the checksum does not match the$LATEST
version, you get aPreconditionFailedException
exception.- Returns:
- Identifies a specific revision of the
$LATEST
version.When you create a new bot, leave the
checksum
field blank. If you specify a checksum you get aBadRequestException
exception.When you want to update a bot, set the
checksum
field to the checksum of the most recent revision of the$LATEST
version. If you don't specify thechecksum
field, or if the checksum does not match the$LATEST
version, you get aPreconditionFailedException
exception.
-
processBehavior
If you set the
processBehavior
element toBUILD
, Amazon Lex builds the bot so that it can be run. If you set the element toSAVE
Amazon Lex saves the bot, but doesn't build it.If you don't specify this value, the default value is
BUILD
.If the service returns an enum value that is not available in the current SDK version,
processBehavior
will returnProcessBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprocessBehaviorAsString()
.- Returns:
- If you set the
processBehavior
element toBUILD
, Amazon Lex builds the bot so that it can be run. If you set the element toSAVE
Amazon Lex saves the bot, but doesn't build it.If you don't specify this value, the default value is
BUILD
. - See Also:
-
processBehaviorAsString
If you set the
processBehavior
element toBUILD
, Amazon Lex builds the bot so that it can be run. If you set the element toSAVE
Amazon Lex saves the bot, but doesn't build it.If you don't specify this value, the default value is
BUILD
.If the service returns an enum value that is not available in the current SDK version,
processBehavior
will returnProcessBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprocessBehaviorAsString()
.- Returns:
- If you set the
processBehavior
element toBUILD
, Amazon Lex builds the bot so that it can be run. If you set the element toSAVE
Amazon Lex saves the bot, but doesn't build it.If you don't specify this value, the default value is
BUILD
. - See Also:
-
locale
Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot.
The default is
en-US
.If the service returns an enum value that is not available in the current SDK version,
locale
will returnLocale.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlocaleAsString()
.- Returns:
- Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of
the bot.
The default is
en-US
. - See Also:
-
localeAsString
Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot.
The default is
en-US
.If the service returns an enum value that is not available in the current SDK version,
locale
will returnLocale.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlocaleAsString()
.- Returns:
- Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of
the bot.
The default is
en-US
. - See Also:
-
childDirected
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
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
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 specifyingfalse
in thechildDirected
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 thechildDirected
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.
- Returns:
- 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
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
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 specifyingfalse
in thechildDirected
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 thechildDirected
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.
-
detectSentiment
When set to
true
user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specifydetectSentiment
, the default isfalse
.- Returns:
- When set to
true
user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specifydetectSentiment
, the default isfalse
.
-
createVersion
When set to
true
a new numbered version of the bot is created. This is the same as calling theCreateBotVersion
operation. If you don't specifycreateVersion
, the default isfalse
.- Returns:
- When set to
true
a new numbered version of the bot is created. This is the same as calling theCreateBotVersion
operation. If you don't specifycreateVersion
, the default isfalse
.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
A list of tags to add to the bot. You can only add tags when you create a bot, you can't use the
PutBot
operation to update the tags on a bot. To update tags, use theTagResource
operation.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- A list of tags to add to the bot. You can only add tags when you create a bot, you can't use the
PutBot
operation to update the tags on a bot. To update tags, use theTagResource
operation.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<PutBotRequest.Builder,
PutBotRequest> - Specified by:
toBuilder
in classLexModelBuildingRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-