software.amazon.awssdk.services.lexmodelbuilding.model

Interface GetBotResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetBotResponse.Builder,GetBotResponse>, LexModelBuildingResponse.Builder, SdkBuilder<GetBotResponse.Builder,GetBotResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetBotResponse

public static interface GetBotResponse.Builder
extends LexModelBuildingResponse.Builder, SdkPojo, CopyableBuilder<GetBotResponse.Builder,GetBotResponse>

Method Summary

Modifier and Type	Method and Description
default GetBotResponse.Builder	abortStatement(Consumer<Statement.Builder> abortStatement) The message that Amazon Lex returns when the user elects to end the conversation without completing it.
GetBotResponse.Builder	abortStatement(Statement abortStatement) The message that Amazon Lex returns when the user elects to end the conversation without completing it.
GetBotResponse.Builder	checksum(String checksum) Checksum of the bot used to identify a specific revision of the bot's $LATEST version.
GetBotResponse.Builder	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 specifying true or false in the childDirected field.
default GetBotResponse.Builder	clarificationPrompt(Consumer<Prompt.Builder> clarificationPrompt) The message Amazon Lex uses when it doesn't understand the user's request.
GetBotResponse.Builder	clarificationPrompt(Prompt clarificationPrompt) The message Amazon Lex uses when it doesn't understand the user's request.
GetBotResponse.Builder	createdDate(Instant createdDate) The date that the bot was created.
GetBotResponse.Builder	description(String description) A description of the bot.
GetBotResponse.Builder	detectSentiment(Boolean detectSentiment) Indicates whether user utterances should be sent to Amazon Comprehend for sentiment analysis.
GetBotResponse.Builder	enableModelImprovements(Boolean enableModelImprovements) Indicates whether the bot uses accuracy improvements.
GetBotResponse.Builder	failureReason(String failureReason) If status is FAILED, Amazon Lex explains why it failed to build the bot.
GetBotResponse.Builder	idleSessionTTLInSeconds(Integer idleSessionTTLInSeconds) The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
GetBotResponse.Builder	intents(Collection<Intent> intents) An array of intent objects.
GetBotResponse.Builder	intents(Consumer<Intent.Builder>... intents) An array of intent objects.
GetBotResponse.Builder	intents(Intent... intents) An array of intent objects.
GetBotResponse.Builder	lastUpdatedDate(Instant lastUpdatedDate) The date that the bot was updated.
GetBotResponse.Builder	locale(Locale locale) The target locale for the bot.
GetBotResponse.Builder	locale(String locale) The target locale for the bot.
GetBotResponse.Builder	name(String name) The name of the bot.
GetBotResponse.Builder	nluIntentConfidenceThreshold(Double 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.
GetBotResponse.Builder	status(Status status) The status of the bot.
GetBotResponse.Builder	status(String status) The status of the bot.
GetBotResponse.Builder	version(String version) The version of the bot.
GetBotResponse.Builder	voiceId(String voiceId) The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.

Methods inherited from interface software.amazon.awssdk.services.lexmodelbuilding.model.LexModelBuildingResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

GetBotResponse.Builder name(String 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

GetBotResponse.Builder description(String 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

GetBotResponse.Builder intents(Collection<Intent> intents)

An array of intent objects. For more information, see PutBot.

Parameters:

intents - An array of intent objects. For more information, see PutBot.

Returns:

Returns a reference to this object so that method calls can be chained together.

intents

GetBotResponse.Builder intents(Intent... intents)

An array of intent objects. For more information, see PutBot.

Parameters:

intents - An array of intent objects. For more information, see PutBot.

Returns:

Returns a reference to this object so that method calls can be chained together.

intents

GetBotResponse.Builder intents(Consumer<Intent.Builder>... intents)

An array of intent objects. For more information, see PutBot.

This is a convenience method that creates an instance of the Intent.Builder avoiding the need to create one manually via Intent.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #intents(List).

Parameters:

intents - a consumer that will call methods on Intent.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#intents(java.util.Collection)

enableModelImprovements

GetBotResponse.Builder enableModelImprovements(Boolean 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

GetBotResponse.Builder nluIntentConfidenceThreshold(Double 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 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

clarificationPrompt

GetBotResponse.Builder clarificationPrompt(Prompt clarificationPrompt)

The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.

Parameters:

clarificationPrompt - The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.

Returns:

Returns a reference to this object so that method calls can be chained together.

clarificationPrompt

default GetBotResponse.Builder clarificationPrompt(Consumer<Prompt.Builder> clarificationPrompt)

The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.

This is a convenience method that creates an instance of the Prompt.Builder avoiding the need to create one manually via Prompt.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to clarificationPrompt(Prompt).

Parameters:

clarificationPrompt - a consumer that will call methods on Prompt.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

clarificationPrompt(Prompt)

abortStatement

GetBotResponse.Builder abortStatement(Statement abortStatement)

The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.

Parameters:

abortStatement - The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.

Returns:

Returns a reference to this object so that method calls can be chained together.

abortStatement

default GetBotResponse.Builder abortStatement(Consumer<Statement.Builder> abortStatement)

The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.

This is a convenience method that creates an instance of the Statement.Builder avoiding the need to create one manually via Statement.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to abortStatement(Statement).

Parameters:

abortStatement - a consumer that will call methods on Statement.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

abortStatement(Statement)

status

GetBotResponse.Builder status(String status)

The status of the bot.

When the status is BUILDING Amazon Lex is building the bot for testing and use.

If the status of the bot is READY_BASIC_TESTING, you can test the bot using the exact utterances specified in the bot's intents. When the bot is ready for full testing or to run, the status is READY.

If there was a problem with building the bot, the status is FAILED and the failureReason field explains why the bot did not build.

If the bot was saved but not built, the status is NOT_BUILT.

Parameters:

status - The status of the bot.

When the status is BUILDING Amazon Lex is building the bot for testing and use.

If the status of the bot is READY_BASIC_TESTING, you can test the bot using the exact utterances specified in the bot's intents. When the bot is ready for full testing or to run, the status is READY.

If there was a problem with building the bot, the status is FAILED and the failureReason field explains why the bot did not build.

If the bot was saved but not built, the status is NOT_BUILT.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Status, Status

status

GetBotResponse.Builder status(Status status)

The status of the bot.

When the status is BUILDING Amazon Lex is building the bot for testing and use.

If the status of the bot is READY_BASIC_TESTING, you can test the bot using the exact utterances specified in the bot's intents. When the bot is ready for full testing or to run, the status is READY.

If there was a problem with building the bot, the status is FAILED and the failureReason field explains why the bot did not build.

If the bot was saved but not built, the status is NOT_BUILT.

Parameters:

status - The status of the bot.

When the status is BUILDING Amazon Lex is building the bot for testing and use.

If the status of the bot is READY_BASIC_TESTING, you can test the bot using the exact utterances specified in the bot's intents. When the bot is ready for full testing or to run, the status is READY.

If there was a problem with building the bot, the status is FAILED and the failureReason field explains why the bot did not build.

If the bot was saved but not built, the status is NOT_BUILT.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Status, Status

failureReason

GetBotResponse.Builder failureReason(String failureReason)

If status is FAILED, Amazon Lex explains why it failed to build the bot.

Parameters:

failureReason - If status is FAILED, Amazon Lex explains why it failed to build the bot.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastUpdatedDate

GetBotResponse.Builder lastUpdatedDate(Instant 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

GetBotResponse.Builder createdDate(Instant 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

GetBotResponse.Builder idleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.

Parameters:

idleSessionTTLInSeconds - The maximum time in seconds 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

GetBotResponse.Builder voiceId(String 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

GetBotResponse.Builder checksum(String checksum)

Checksum of the bot used to identify a specific revision of the bot's $LATEST version.

Parameters:

checksum - Checksum of the bot used to identify a specific revision of the bot's $LATEST version.

Returns:

Returns a reference to this object so that method calls can be chained together.

version

GetBotResponse.Builder version(String 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

GetBotResponse.Builder locale(String 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, Locale

locale

GetBotResponse.Builder locale(Locale 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, Locale

childDirected

GetBotResponse.Builder 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 specifying true or false in the childDirected field. By specifying true in the childDirected 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 specifying false in the childDirected 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 the childDirected 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 specifying true or false in the childDirected field. By specifying true in the childDirected 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 specifying false in the childDirected 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 the childDirected 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.

detectSentiment

GetBotResponse.Builder detectSentiment(Boolean detectSentiment)

Indicates whether user utterances should be sent to Amazon Comprehend for sentiment analysis.

Parameters:

detectSentiment - Indicates whether user utterances should be sent to Amazon Comprehend for sentiment analysis.

Returns:

Returns a reference to this object so that method calls can be chained together.