Package software.amazon.awssdk.services.lexmodelbuilding.model

Interface PutBotRequest.Builder

All Superinterfaces:

CopyableBuilder<PutBotRequest.Builder,PutBotRequest>, SdkBuilder<PutBotRequest.Builder,PutBotRequest>

Enclosing class:

PutBotRequest

public static interface PutBotRequest.Builder
extends CopyableBuilder<PutBotRequest.Builder,PutBotRequest>

Method Summary

Modifier and Type	Method	Description
PutBotRequest.Builder	abortStatement(Statement abortStatement)	When Amazon Lex can't understand the user's input in context, it tries to elicit the information a few times.
PutBotRequest.Builder	checksum(String checksum)	Identifies a specific revision of the $LATEST version.
PutBotRequest.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.
PutBotRequest.Builder	clarificationPrompt(Prompt clarificationPrompt)	When Amazon Lex doesn't understand the user's intent, it uses one of these messages to get clarification.
PutBotRequest.Builder	description(String description)	A description of the bot.
PutBotRequest.Builder	idleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)	The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
PutBotRequest.Builder	intents(Collection<Intent> intents)	An array of Intent objects.
PutBotRequest.Builder	intents(Intent... intents)	An array of Intent objects.
PutBotRequest.Builder	locale(String locale)	Specifies the target locale for the bot.
PutBotRequest.Builder	locale(Locale locale)	Specifies the target locale for the bot.
PutBotRequest.Builder	name(String name)	The name of the bot.
PutBotRequest.Builder	processBehavior(String processBehavior)	If you set the processBehavior element to Build, Amazon Lex builds the bot so that it can be run.
PutBotRequest.Builder	processBehavior(ProcessBehavior processBehavior)	If you set the processBehavior element to Build, Amazon Lex builds the bot so that it can be run.
PutBotRequest.Builder	voiceId(String voiceId)	The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user.

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

copy

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

apply, build

Method Detail

name

PutBotRequest.Builder name(String name)

The name of the bot. The name is not case sensitive.

Parameters:

name - The name of the bot. The name is not case sensitive.

Returns:

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

description

PutBotRequest.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

PutBotRequest.Builder intents(Collection<Intent> 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.

Parameters:

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.

Returns:

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

intents

PutBotRequest.Builder intents(Intent... 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.

NOTE: This method appends the values to the existing list (if any). Use #setIntents(java.util.Collection) or #withIntents(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

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

clarificationPrompt

PutBotRequest.Builder clarificationPrompt(Prompt clarificationPrompt)

When Amazon Lex doesn't understand the user's intent, it uses one of these messages to get clarification. For example, "Sorry, I didn't understand. Please repeat." Amazon Lex repeats the clarification prompt the number of times specified in maxAttempts. If Amazon Lex still can't understand, it sends the message specified in abortStatement.

Parameters:

clarificationPrompt - When Amazon Lex doesn't understand the user's intent, it uses one of these messages to get clarification. For example, "Sorry, I didn't understand. Please repeat." Amazon Lex repeats the clarification prompt the number of times specified in maxAttempts. If Amazon Lex still can't understand, it sends the message specified in abortStatement.

Returns:

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

abortStatement

PutBotRequest.Builder abortStatement(Statement 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 aborts the conversation. To set the number of retries, use the valueElicitationPrompt 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 the CrustType slot. You specify the valueElicitationPrompt field when you create the CrustType slot.

Parameters:

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 aborts the conversation. To set the number of retries, use the valueElicitationPrompt 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 the CrustType slot. You specify the valueElicitationPrompt field when you create the CrustType slot.

Returns:

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

idleSessionTTLInSeconds

PutBotRequest.Builder idleSessionTTLInSeconds(Integer 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 a PutBot 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).

Parameters:

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 a PutBot 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:

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

voiceId

PutBotRequest.Builder voiceId(String 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 Voice in the Amazon Polly Developer Guide.

Parameters:

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 Voice in the Amazon Polly Developer Guide.

Returns:

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

checksum

PutBotRequest.Builder checksum(String 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 a BadRequestException 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 the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.

Parameters:

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 a BadRequestException 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 the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.

Returns:

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

processBehavior

PutBotRequest.Builder processBehavior(String processBehavior)

If you set the processBehavior element to Build, Amazon Lex builds the bot so that it can be run. If you set the element to SaveAmazon Lex saves the bot, but doesn't build it.

If you don't specify this value, the default value is Save.

Parameters:

processBehavior - If you set the processBehavior element to Build, Amazon Lex builds the bot so that it can be run. If you set the element to SaveAmazon Lex saves the bot, but doesn't build it.

If you don't specify this value, the default value is Save.

Returns:

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

See Also:

ProcessBehavior

processBehavior

PutBotRequest.Builder processBehavior(ProcessBehavior processBehavior)

If you set the processBehavior element to Build, Amazon Lex builds the bot so that it can be run. If you set the element to SaveAmazon Lex saves the bot, but doesn't build it.

If you don't specify this value, the default value is Save.

Parameters:

processBehavior - If you set the processBehavior element to Build, Amazon Lex builds the bot so that it can be run. If you set the element to SaveAmazon Lex saves the bot, but doesn't build it.

If you don't specify this value, the default value is Save.

Returns:

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

See Also:

ProcessBehavior

locale

PutBotRequest.Builder locale(String 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.

Parameters:

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.

Returns:

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

See Also:

Locale

locale

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

Parameters:

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.

Returns:

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

See Also:

Locale

childDirected

PutBotRequest.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.