@Generated(value="software.amazon.awssdk:codegen") public class PutBotRequest extends LexModelBuildingRequest implements ToCopyableBuilder<PutBotRequest.Builder,PutBotRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
PutBotRequest.Builder |
Modifier and Type | Method and Description |
---|---|
Statement |
abortStatement()
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() |
String |
checksum()
Identifies a specific revision of the
$LATEST version. |
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. |
Prompt |
clarificationPrompt()
When Amazon Lex doesn't understand the user's intent, it uses this message to get clarification.
|
String |
description()
A description of the bot.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Integer |
idleSessionTTLInSeconds()
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
|
List<Intent> |
intents()
An array of
Intent objects. |
Locale |
locale()
Specifies the target locale for the bot.
|
String |
localeString()
Specifies the target locale for the bot.
|
String |
name()
The name of the bot.
|
ProcessBehavior |
processBehavior()
If you set the
processBehavior element to Build , Amazon Lex builds the bot so that it
can be run. |
String |
processBehaviorString()
If you set the
processBehavior element to Build , Amazon Lex builds the bot so that it
can be run. |
static Class<? extends PutBotRequest.Builder> |
serializableBuilderClass() |
PutBotRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
voiceId()
The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user.
|
requestOverrideConfig
copy
public String name()
The name of the bot. The name is not case sensitive.
public String description()
A description of the bot.
public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.public Prompt 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 repeate the clarification prompt, use the maxAttempts
field. If Amazon
Lex still doesn't understand, it sends the message in the abortStatement
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.'"
maxAttempts
field. If Amazon Lex still doesn't understand, it sends the message in the
abortStatement
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.'"
public 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.
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.
public 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).
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).
public 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 Available Voices in the Amazon Polly Developer Guide.
public 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.
$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.
public 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 Save
Amazon Lex saves the bot, but doesn't build it.
If you don't specify this value, the default value is Save
.
If the service returns an enum value that is not available in the current SDK version, processBehavior
will return ProcessBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from processBehaviorString()
.
processBehavior
element to Build
, Amazon Lex builds the bot so
that it can be run. If you set the element to Save
Amazon Lex saves the bot, but doesn't
build it.
If you don't specify this value, the default value is Save
.
ProcessBehavior
public String processBehaviorString()
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 Save
Amazon Lex saves the bot, but doesn't build it.
If you don't specify this value, the default value is Save
.
If the service returns an enum value that is not available in the current SDK version, processBehavior
will return ProcessBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from processBehaviorString()
.
processBehavior
element to Build
, Amazon Lex builds the bot so
that it can be run. If you set the element to Save
Amazon Lex saves the bot, but doesn't
build it.
If you don't specify this value, the default value is Save
.
ProcessBehavior
public 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
.
If the service returns an enum value that is not available in the current SDK version, locale
will
return Locale.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
localeString()
.
The default is en-US
.
Locale
public String localeString()
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
return Locale.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
localeString()
.
The default is en-US
.
Locale
public 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.
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.
public PutBotRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<PutBotRequest.Builder,PutBotRequest>
toBuilder
in class LexModelBuildingRequest
public static PutBotRequest.Builder builder()
public static Class<? extends PutBotRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.