Interface PutBotResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<PutBotResponse.Builder,
,PutBotResponse> LexModelBuildingResponse.Builder
,SdkBuilder<PutBotResponse.Builder,
,PutBotResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
PutBotResponse
-
Method Summary
Modifier and TypeMethodDescriptiondefault PutBotResponse.Builder
abortStatement
(Consumer<Statement.Builder> abortStatement) The message that Amazon Lex uses to cancel a conversation.abortStatement
(Statement abortStatement) The message that Amazon Lex uses to cancel a conversation.Checksum of the bot that you created.childDirected
(Boolean 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 specifyingtrue
orfalse
in thechildDirected
field.default PutBotResponse.Builder
clarificationPrompt
(Consumer<Prompt.Builder> clarificationPrompt) The prompts that Amazon Lex uses when it doesn't understand the user's intent.clarificationPrompt
(Prompt clarificationPrompt) The prompts that Amazon Lex uses when it doesn't understand the user's intent.createdDate
(Instant createdDate) The date that the bot was created.createVersion
(Boolean createVersion) True
if a new version of the bot was created.description
(String description) A description of the bot.detectSentiment
(Boolean detectSentiment) true
if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis.enableModelImprovements
(Boolean enableModelImprovements) Indicates whether the bot uses accuracy improvements.failureReason
(String failureReason) Ifstatus
isFAILED
, Amazon Lex provides the reason that it failed to build the bot.idleSessionTTLInSeconds
(Integer idleSessionTTLInSeconds) The maximum length of time that Amazon Lex retains the data gathered in a conversation.intents
(Collection<Intent> intents) An array ofIntent
objects.intents
(Consumer<Intent.Builder>... intents) An array ofIntent
objects.An array ofIntent
objects.lastUpdatedDate
(Instant lastUpdatedDate) The date that the bot was updated.The target locale for the bot.The target locale for the bot.The name of the bot.nluIntentConfidenceThreshold
(Double nluIntentConfidenceThreshold) The score that determines where Amazon Lex inserts theAMAZON.FallbackIntent
,AMAZON.KendraSearchIntent
, or both when returning alternative intents in a PostContent or PostText response.When you send a request to create a bot withprocessBehavior
set toBUILD
, Amazon Lex sets thestatus
response element toBUILDING
.When you send a request to create a bot withprocessBehavior
set toBUILD
, Amazon Lex sets thestatus
response element toBUILDING
.tags
(Collection<Tag> tags) A list of tags associated with the bot.tags
(Consumer<Tag.Builder>... tags) A list of tags associated with the bot.A list of tags associated with the bot.The version of the bot.The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.lexmodelbuilding.model.LexModelBuildingResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
name
The name of the bot.
- Parameters:
name
- The name of the bot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
A description of the bot.
- Parameters:
description
- A description of the bot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
intents
An array of
Intent
objects. For more information, see PutBot.- Parameters:
intents
- An array ofIntent
objects. For more information, see PutBot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
intents
An array of
Intent
objects. For more information, see PutBot.- Parameters:
intents
- An array ofIntent
objects. For more information, see PutBot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
intents
An array of
This is a convenience method that creates an instance of theIntent
objects. For more information, see PutBot.Intent.Builder
avoiding the need to create one manually viaIntent.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tointents(List<Intent>)
.- Parameters:
intents
- a consumer that will call methods onIntent.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
enableModelImprovements
Indicates whether the bot uses accuracy improvements.
true
indicates that the bot is using the improvements, otherwise,false
.- Parameters:
enableModelImprovements
- Indicates whether the bot uses accuracy improvements.true
indicates that the bot is using the improvements, otherwise,false
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nluIntentConfidenceThreshold
The score that determines where Amazon Lex inserts the
AMAZON.FallbackIntent
,AMAZON.KendraSearchIntent
, or both when returning alternative intents in a PostContent or PostText response.AMAZON.FallbackIntent
is inserted if the confidence score for all intents is below this value.AMAZON.KendraSearchIntent
is only inserted if it is configured for the bot.- Parameters:
nluIntentConfidenceThreshold
- The score that determines where Amazon Lex inserts theAMAZON.FallbackIntent
,AMAZON.KendraSearchIntent
, or both when returning alternative intents in a PostContent or PostText response.AMAZON.FallbackIntent
is inserted if the confidence score for all intents is below this value.AMAZON.KendraSearchIntent
is only inserted if it is configured for the bot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clarificationPrompt
The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot.
- Parameters:
clarificationPrompt
- The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clarificationPrompt
The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot.
This is a convenience method that creates an instance of thePrompt.Builder
avoiding the need to create one manually viaPrompt.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toclarificationPrompt(Prompt)
.- Parameters:
clarificationPrompt
- a consumer that will call methods onPrompt.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
abortStatement
The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.
- Parameters:
abortStatement
- The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
abortStatement
The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.
This is a convenience method that creates an instance of theStatement.Builder
avoiding the need to create one manually viaStatement.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toabortStatement(Statement)
.- Parameters:
abortStatement
- a consumer that will call methods onStatement.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
When you send a request to create a bot with
processBehavior
set toBUILD
, Amazon Lex sets thestatus
response element toBUILDING
.In the
READY_BASIC_TESTING
state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types.If Amazon Lex can't build the bot, Amazon Lex sets
status
toFAILED
. Amazon Lex returns the reason for the failure in thefailureReason
response element.When you set
processBehavior
toSAVE
, Amazon Lex sets the status code toNOT BUILT
.When the bot is in the
READY
state you can test and publish the bot.- Parameters:
status
- When you send a request to create a bot withprocessBehavior
set toBUILD
, Amazon Lex sets thestatus
response element toBUILDING
.In the
READY_BASIC_TESTING
state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types.If Amazon Lex can't build the bot, Amazon Lex sets
status
toFAILED
. Amazon Lex returns the reason for the failure in thefailureReason
response element.When you set
processBehavior
toSAVE
, Amazon Lex sets the status code toNOT BUILT
.When the bot is in the
READY
state you can test and publish the bot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
When you send a request to create a bot with
processBehavior
set toBUILD
, Amazon Lex sets thestatus
response element toBUILDING
.In the
READY_BASIC_TESTING
state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types.If Amazon Lex can't build the bot, Amazon Lex sets
status
toFAILED
. Amazon Lex returns the reason for the failure in thefailureReason
response element.When you set
processBehavior
toSAVE
, Amazon Lex sets the status code toNOT BUILT
.When the bot is in the
READY
state you can test and publish the bot.- Parameters:
status
- When you send a request to create a bot withprocessBehavior
set toBUILD
, Amazon Lex sets thestatus
response element toBUILDING
.In the
READY_BASIC_TESTING
state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types.If Amazon Lex can't build the bot, Amazon Lex sets
status
toFAILED
. Amazon Lex returns the reason for the failure in thefailureReason
response element.When you set
processBehavior
toSAVE
, Amazon Lex sets the status code toNOT BUILT
.When the bot is in the
READY
state you can test and publish the bot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
failureReason
If
status
isFAILED
, Amazon Lex provides the reason that it failed to build the bot.- Parameters:
failureReason
- Ifstatus
isFAILED
, Amazon Lex provides the reason that it failed to build the bot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastUpdatedDate
The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
- Parameters:
lastUpdatedDate
- The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdDate
The date that the bot was created.
- Parameters:
createdDate
- The date that the bot was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
idleSessionTTLInSeconds
The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
- Parameters:
idleSessionTTLInSeconds
- The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
voiceId
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.
- Parameters:
voiceId
- The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
checksum
Checksum of the bot that you created.
- Parameters:
checksum
- Checksum of the bot that you created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
version
The version of the bot. For a new bot, the version is always
$LATEST
.- Parameters:
version
- The version of the bot. For a new bot, the version is always$LATEST
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
locale
The target locale for the bot.
- Parameters:
locale
- The target locale for the bot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
locale
The target locale for the bot.
- Parameters:
locale
- The target locale for the bot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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 specifyingtrue
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:
- Returns a reference to this object so that method calls can be chained together.
-
createVersion
True
if a new version of the bot was created. If thecreateVersion
field was not specified in the request, thecreateVersion
field is set to false in the response.- Parameters:
createVersion
-True
if a new version of the bot was created. If thecreateVersion
field was not specified in the request, thecreateVersion
field is set to false in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
detectSentiment
true
if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis. If thedetectSentiment
field was not specified in the request, thedetectSentiment
field isfalse
in the response.- Parameters:
detectSentiment
-true
if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis. If thedetectSentiment
field was not specified in the request, thedetectSentiment
field isfalse
in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of tags associated with the bot.
- Parameters:
tags
- A list of tags associated with the bot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of tags associated with the bot.
- Parameters:
tags
- A list of tags associated with the bot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of tags associated with the bot.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-