AWS SDK for C++  1.9.155
AWS SDK for C++
Public Member Functions | List of all members
Aws::LexModelBuildingService::Model::PutBotRequest Class Reference

#include <PutBotRequest.h>

+ Inheritance diagram for Aws::LexModelBuildingService::Model::PutBotRequest:

Public Member Functions

 PutBotRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
PutBotRequestWithName (const Aws::String &value)
 
PutBotRequestWithName (Aws::String &&value)
 
PutBotRequestWithName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
PutBotRequestWithDescription (const Aws::String &value)
 
PutBotRequestWithDescription (Aws::String &&value)
 
PutBotRequestWithDescription (const char *value)
 
const Aws::Vector< Intent > & GetIntents () const
 
bool IntentsHasBeenSet () const
 
void SetIntents (const Aws::Vector< Intent > &value)
 
void SetIntents (Aws::Vector< Intent > &&value)
 
PutBotRequestWithIntents (const Aws::Vector< Intent > &value)
 
PutBotRequestWithIntents (Aws::Vector< Intent > &&value)
 
PutBotRequestAddIntents (const Intent &value)
 
PutBotRequestAddIntents (Intent &&value)
 
bool GetEnableModelImprovements () const
 
bool EnableModelImprovementsHasBeenSet () const
 
void SetEnableModelImprovements (bool value)
 
PutBotRequestWithEnableModelImprovements (bool value)
 
double GetNluIntentConfidenceThreshold () const
 
bool NluIntentConfidenceThresholdHasBeenSet () const
 
void SetNluIntentConfidenceThreshold (double value)
 
PutBotRequestWithNluIntentConfidenceThreshold (double value)
 
const PromptGetClarificationPrompt () const
 
bool ClarificationPromptHasBeenSet () const
 
void SetClarificationPrompt (const Prompt &value)
 
void SetClarificationPrompt (Prompt &&value)
 
PutBotRequestWithClarificationPrompt (const Prompt &value)
 
PutBotRequestWithClarificationPrompt (Prompt &&value)
 
const StatementGetAbortStatement () const
 
bool AbortStatementHasBeenSet () const
 
void SetAbortStatement (const Statement &value)
 
void SetAbortStatement (Statement &&value)
 
PutBotRequestWithAbortStatement (const Statement &value)
 
PutBotRequestWithAbortStatement (Statement &&value)
 
int GetIdleSessionTTLInSeconds () const
 
bool IdleSessionTTLInSecondsHasBeenSet () const
 
void SetIdleSessionTTLInSeconds (int value)
 
PutBotRequestWithIdleSessionTTLInSeconds (int value)
 
const Aws::StringGetVoiceId () const
 
bool VoiceIdHasBeenSet () const
 
void SetVoiceId (const Aws::String &value)
 
void SetVoiceId (Aws::String &&value)
 
void SetVoiceId (const char *value)
 
PutBotRequestWithVoiceId (const Aws::String &value)
 
PutBotRequestWithVoiceId (Aws::String &&value)
 
PutBotRequestWithVoiceId (const char *value)
 
const Aws::StringGetChecksum () const
 
bool ChecksumHasBeenSet () const
 
void SetChecksum (const Aws::String &value)
 
void SetChecksum (Aws::String &&value)
 
void SetChecksum (const char *value)
 
PutBotRequestWithChecksum (const Aws::String &value)
 
PutBotRequestWithChecksum (Aws::String &&value)
 
PutBotRequestWithChecksum (const char *value)
 
const ProcessBehaviorGetProcessBehavior () const
 
bool ProcessBehaviorHasBeenSet () const
 
void SetProcessBehavior (const ProcessBehavior &value)
 
void SetProcessBehavior (ProcessBehavior &&value)
 
PutBotRequestWithProcessBehavior (const ProcessBehavior &value)
 
PutBotRequestWithProcessBehavior (ProcessBehavior &&value)
 
const LocaleGetLocale () const
 
bool LocaleHasBeenSet () const
 
void SetLocale (const Locale &value)
 
void SetLocale (Locale &&value)
 
PutBotRequestWithLocale (const Locale &value)
 
PutBotRequestWithLocale (Locale &&value)
 
bool GetChildDirected () const
 
bool ChildDirectedHasBeenSet () const
 
void SetChildDirected (bool value)
 
PutBotRequestWithChildDirected (bool value)
 
bool GetDetectSentiment () const
 
bool DetectSentimentHasBeenSet () const
 
void SetDetectSentiment (bool value)
 
PutBotRequestWithDetectSentiment (bool value)
 
bool GetCreateVersion () const
 
bool CreateVersionHasBeenSet () const
 
void SetCreateVersion (bool value)
 
PutBotRequestWithCreateVersion (bool value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
PutBotRequestWithTags (const Aws::Vector< Tag > &value)
 
PutBotRequestWithTags (Aws::Vector< Tag > &&value)
 
PutBotRequestAddTags (const Tag &value)
 
PutBotRequestAddTags (Tag &&value)
 
- Public Member Functions inherited from Aws::LexModelBuildingService::LexModelBuildingServiceRequest
virtual ~LexModelBuildingServiceRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::LexModelBuildingService::LexModelBuildingServiceRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 28 of file PutBotRequest.h.

Constructor & Destructor Documentation

◆ PutBotRequest()

Aws::LexModelBuildingService::Model::PutBotRequest::PutBotRequest ( )

Member Function Documentation

◆ AbortStatementHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutBotRequest::AbortStatementHasBeenSet ( ) const
inline

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

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.

Definition at line 584 of file PutBotRequest.h.

◆ AddIntents() [1/2]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::AddIntents ( const Intent value)
inline

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.

Definition at line 171 of file PutBotRequest.h.

◆ AddIntents() [2/2]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::AddIntents ( Intent &&  value)
inline

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.

Definition at line 178 of file PutBotRequest.h.

◆ AddTags() [1/2]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::AddTags ( const Tag value)
inline

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 the TagResource operation.

Definition at line 1208 of file PutBotRequest.h.

◆ AddTags() [2/2]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::AddTags ( Tag &&  value)
inline

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 the TagResource operation.

Definition at line 1215 of file PutBotRequest.h.

◆ ChecksumHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutBotRequest::ChecksumHasBeenSet ( ) const
inline

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.

Definition at line 827 of file PutBotRequest.h.

◆ ChildDirectedHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutBotRequest::ChildDirectedHasBeenSet ( ) const
inline

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.

Definition at line 1046 of file PutBotRequest.h.

◆ ClarificationPromptHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutBotRequest::ClarificationPromptHasBeenSet ( ) const
inline

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 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.'"

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

Definition at line 421 of file PutBotRequest.h.

◆ CreateVersionHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutBotRequest::CreateVersionHasBeenSet ( ) const
inline

When set to true a new numbered version of the bot is created. This is the same as calling the CreateBotVersion operation. If you don't specify createVersion, the default is false.

Definition at line 1144 of file PutBotRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutBotRequest::DescriptionHasBeenSet ( ) const
inline

A description of the bot.

Definition at line 91 of file PutBotRequest.h.

◆ DetectSentimentHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutBotRequest::DetectSentimentHasBeenSet ( ) const
inline

When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is false.

Definition at line 1115 of file PutBotRequest.h.

◆ EnableModelImprovementsHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutBotRequest::EnableModelImprovementsHasBeenSet ( ) const
inline

Set to true to enable access to natural language understanding improvements.

When you set the enableModelImprovements parameter to true you can use the nluIntentConfidenceThreshold 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 to true, your bot has access to accuracy improvements.

The Regions where you can set the enableModelImprovements parameter to true 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 to true by default. In these Regions setting the parameter to false throws a ValidationException exception.

Definition at line 219 of file PutBotRequest.h.

◆ GetAbortStatement()

const Statement& Aws::LexModelBuildingService::Model::PutBotRequest::GetAbortStatement ( ) const
inline

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

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.

Definition at line 563 of file PutBotRequest.h.

◆ GetChecksum()

const Aws::String& Aws::LexModelBuildingService::Model::PutBotRequest::GetChecksum ( ) const
inline

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.

Definition at line 815 of file PutBotRequest.h.

◆ GetChildDirected()

bool Aws::LexModelBuildingService::Model::PutBotRequest::GetChildDirected ( ) const
inline

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.

Definition at line 1019 of file PutBotRequest.h.

◆ GetClarificationPrompt()

const Prompt& Aws::LexModelBuildingService::Model::PutBotRequest::GetClarificationPrompt ( ) const
inline

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 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.'"

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

Definition at line 391 of file PutBotRequest.h.

◆ GetCreateVersion()

bool Aws::LexModelBuildingService::Model::PutBotRequest::GetCreateVersion ( ) const
inline

When set to true a new numbered version of the bot is created. This is the same as calling the CreateBotVersion operation. If you don't specify createVersion, the default is false.

Definition at line 1137 of file PutBotRequest.h.

◆ GetDescription()

const Aws::String& Aws::LexModelBuildingService::Model::PutBotRequest::GetDescription ( ) const
inline

A description of the bot.

Definition at line 86 of file PutBotRequest.h.

◆ GetDetectSentiment()

bool Aws::LexModelBuildingService::Model::PutBotRequest::GetDetectSentiment ( ) const
inline

When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is false.

Definition at line 1108 of file PutBotRequest.h.

◆ GetEnableModelImprovements()

bool Aws::LexModelBuildingService::Model::PutBotRequest::GetEnableModelImprovements ( ) const
inline

Set to true to enable access to natural language understanding improvements.

When you set the enableModelImprovements parameter to true you can use the nluIntentConfidenceThreshold 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 to true, your bot has access to accuracy improvements.

The Regions where you can set the enableModelImprovements parameter to true 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 to true by default. In these Regions setting the parameter to false throws a ValidationException exception.

Definition at line 199 of file PutBotRequest.h.

◆ GetIdleSessionTTLInSeconds()

int Aws::LexModelBuildingService::Model::PutBotRequest::GetIdleSessionTTLInSeconds ( ) const
inline

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

Definition at line 684 of file PutBotRequest.h.

◆ GetIntents()

const Aws::Vector<Intent>& Aws::LexModelBuildingService::Model::PutBotRequest::GetIntents ( ) const
inline

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.

Definition at line 129 of file PutBotRequest.h.

◆ GetLocale()

const Locale& Aws::LexModelBuildingService::Model::PutBotRequest::GetLocale ( ) const
inline

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.

Definition at line 956 of file PutBotRequest.h.

◆ GetName()

const Aws::String& Aws::LexModelBuildingService::Model::PutBotRequest::GetName ( ) const
inline

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

Definition at line 45 of file PutBotRequest.h.

◆ GetNluIntentConfidenceThreshold()

double Aws::LexModelBuildingService::Model::PutBotRequest::GetNluIntentConfidenceThreshold ( ) const
inline

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 and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

You must set the enableModelImprovements parameter to true 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 to true 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 the PostText operation would be:

  • AMAZON.FallbackIntent

  • IntentA

  • IntentB

  • IntentC

Definition at line 285 of file PutBotRequest.h.

◆ GetProcessBehavior()

const ProcessBehavior& Aws::LexModelBuildingService::Model::PutBotRequest::GetProcessBehavior ( ) const
inline

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

Definition at line 908 of file PutBotRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::LexModelBuildingService::Model::PutBotRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file PutBotRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::LexModelBuildingService::Model::PutBotRequest::GetTags ( ) const
inline

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 the TagResource operation.

Definition at line 1166 of file PutBotRequest.h.

◆ GetVoiceId()

const Aws::String& Aws::LexModelBuildingService::Model::PutBotRequest::GetVoiceId ( ) const
inline

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.

Definition at line 739 of file PutBotRequest.h.

◆ IdleSessionTTLInSecondsHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutBotRequest::IdleSessionTTLInSecondsHasBeenSet ( ) const
inline

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

Definition at line 699 of file PutBotRequest.h.

◆ IntentsHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutBotRequest::IntentsHasBeenSet ( ) const
inline

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.

Definition at line 136 of file PutBotRequest.h.

◆ LocaleHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutBotRequest::LocaleHasBeenSet ( ) const
inline

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.

Definition at line 963 of file PutBotRequest.h.

◆ NameHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutBotRequest::NameHasBeenSet ( ) const
inline

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

Definition at line 50 of file PutBotRequest.h.

◆ NluIntentConfidenceThresholdHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutBotRequest::NluIntentConfidenceThresholdHasBeenSet ( ) const
inline

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 and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

You must set the enableModelImprovements parameter to true 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 to true 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 the PostText operation would be:

  • AMAZON.FallbackIntent

  • IntentA

  • IntentB

  • IntentC

Definition at line 310 of file PutBotRequest.h.

◆ ProcessBehaviorHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutBotRequest::ProcessBehaviorHasBeenSet ( ) const
inline

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

Definition at line 916 of file PutBotRequest.h.

◆ SerializePayload()

Aws::String Aws::LexModelBuildingService::Model::PutBotRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAbortStatement() [1/2]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetAbortStatement ( const Statement value)
inline

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

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.

Definition at line 605 of file PutBotRequest.h.

◆ SetAbortStatement() [2/2]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetAbortStatement ( Statement &&  value)
inline

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

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.

Definition at line 626 of file PutBotRequest.h.

◆ SetChecksum() [1/3]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetChecksum ( Aws::String &&  value)
inline

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.

Definition at line 851 of file PutBotRequest.h.

◆ SetChecksum() [2/3]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetChecksum ( const Aws::String value)
inline

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.

Definition at line 839 of file PutBotRequest.h.

◆ SetChecksum() [3/3]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetChecksum ( const char *  value)
inline

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.

Definition at line 863 of file PutBotRequest.h.

◆ SetChildDirected()

void Aws::LexModelBuildingService::Model::PutBotRequest::SetChildDirected ( bool  value)
inline

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.

Definition at line 1073 of file PutBotRequest.h.

◆ SetClarificationPrompt() [1/2]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetClarificationPrompt ( const Prompt value)
inline

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 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.'"

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

Definition at line 451 of file PutBotRequest.h.

◆ SetClarificationPrompt() [2/2]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetClarificationPrompt ( Prompt &&  value)
inline

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 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.'"

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

Definition at line 481 of file PutBotRequest.h.

◆ SetCreateVersion()

void Aws::LexModelBuildingService::Model::PutBotRequest::SetCreateVersion ( bool  value)
inline

When set to true a new numbered version of the bot is created. This is the same as calling the CreateBotVersion operation. If you don't specify createVersion, the default is false.

Definition at line 1151 of file PutBotRequest.h.

◆ SetDescription() [1/3]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetDescription ( Aws::String &&  value)
inline

A description of the bot.

Definition at line 101 of file PutBotRequest.h.

◆ SetDescription() [2/3]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetDescription ( const Aws::String value)
inline

A description of the bot.

Definition at line 96 of file PutBotRequest.h.

◆ SetDescription() [3/3]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetDescription ( const char *  value)
inline

A description of the bot.

Definition at line 106 of file PutBotRequest.h.

◆ SetDetectSentiment()

void Aws::LexModelBuildingService::Model::PutBotRequest::SetDetectSentiment ( bool  value)
inline

When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is false.

Definition at line 1122 of file PutBotRequest.h.

◆ SetEnableModelImprovements()

void Aws::LexModelBuildingService::Model::PutBotRequest::SetEnableModelImprovements ( bool  value)
inline

Set to true to enable access to natural language understanding improvements.

When you set the enableModelImprovements parameter to true you can use the nluIntentConfidenceThreshold 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 to true, your bot has access to accuracy improvements.

The Regions where you can set the enableModelImprovements parameter to true 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 to true by default. In these Regions setting the parameter to false throws a ValidationException exception.

Definition at line 239 of file PutBotRequest.h.

◆ SetIdleSessionTTLInSeconds()

void Aws::LexModelBuildingService::Model::PutBotRequest::SetIdleSessionTTLInSeconds ( int  value)
inline

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

Definition at line 714 of file PutBotRequest.h.

◆ SetIntents() [1/2]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetIntents ( Aws::Vector< Intent > &&  value)
inline

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.

Definition at line 150 of file PutBotRequest.h.

◆ SetIntents() [2/2]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetIntents ( const Aws::Vector< Intent > &  value)
inline

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.

Definition at line 143 of file PutBotRequest.h.

◆ SetLocale() [1/2]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetLocale ( const Locale value)
inline

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.

Definition at line 970 of file PutBotRequest.h.

◆ SetLocale() [2/2]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetLocale ( Locale &&  value)
inline

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.

Definition at line 977 of file PutBotRequest.h.

◆ SetName() [1/3]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetName ( Aws::String &&  value)
inline

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

Definition at line 60 of file PutBotRequest.h.

◆ SetName() [2/3]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetName ( const Aws::String value)
inline

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

Definition at line 55 of file PutBotRequest.h.

◆ SetName() [3/3]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetName ( const char *  value)
inline

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

Definition at line 65 of file PutBotRequest.h.

◆ SetNluIntentConfidenceThreshold()

void Aws::LexModelBuildingService::Model::PutBotRequest::SetNluIntentConfidenceThreshold ( double  value)
inline

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 and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

You must set the enableModelImprovements parameter to true 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 to true 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 the PostText operation would be:

  • AMAZON.FallbackIntent

  • IntentA

  • IntentB

  • IntentC

Definition at line 335 of file PutBotRequest.h.

◆ SetProcessBehavior() [1/2]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetProcessBehavior ( const ProcessBehavior value)
inline

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

Definition at line 924 of file PutBotRequest.h.

◆ SetProcessBehavior() [2/2]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetProcessBehavior ( ProcessBehavior &&  value)
inline

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

Definition at line 932 of file PutBotRequest.h.

◆ SetTags() [1/2]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

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 the TagResource operation.

Definition at line 1187 of file PutBotRequest.h.

◆ SetTags() [2/2]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

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 the TagResource operation.

Definition at line 1180 of file PutBotRequest.h.

◆ SetVoiceId() [1/3]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetVoiceId ( Aws::String &&  value)
inline

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.

Definition at line 766 of file PutBotRequest.h.

◆ SetVoiceId() [2/3]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetVoiceId ( const Aws::String value)
inline

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.

Definition at line 757 of file PutBotRequest.h.

◆ SetVoiceId() [3/3]

void Aws::LexModelBuildingService::Model::PutBotRequest::SetVoiceId ( const char *  value)
inline

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.

Definition at line 775 of file PutBotRequest.h.

◆ TagsHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutBotRequest::TagsHasBeenSet ( ) const
inline

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 the TagResource operation.

Definition at line 1173 of file PutBotRequest.h.

◆ VoiceIdHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutBotRequest::VoiceIdHasBeenSet ( ) const
inline

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.

Definition at line 748 of file PutBotRequest.h.

◆ WithAbortStatement() [1/2]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithAbortStatement ( const Statement value)
inline

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

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.

Definition at line 647 of file PutBotRequest.h.

◆ WithAbortStatement() [2/2]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithAbortStatement ( Statement &&  value)
inline

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

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.

Definition at line 668 of file PutBotRequest.h.

◆ WithChecksum() [1/3]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithChecksum ( Aws::String &&  value)
inline

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.

Definition at line 887 of file PutBotRequest.h.

◆ WithChecksum() [2/3]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithChecksum ( const Aws::String value)
inline

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.

Definition at line 875 of file PutBotRequest.h.

◆ WithChecksum() [3/3]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithChecksum ( const char *  value)
inline

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.

Definition at line 899 of file PutBotRequest.h.

◆ WithChildDirected()

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithChildDirected ( bool  value)
inline

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.

Definition at line 1100 of file PutBotRequest.h.

◆ WithClarificationPrompt() [1/2]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithClarificationPrompt ( const Prompt value)
inline

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 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.'"

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

Definition at line 511 of file PutBotRequest.h.

◆ WithClarificationPrompt() [2/2]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithClarificationPrompt ( Prompt &&  value)
inline

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 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.'"

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

Definition at line 541 of file PutBotRequest.h.

◆ WithCreateVersion()

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithCreateVersion ( bool  value)
inline

When set to true a new numbered version of the bot is created. This is the same as calling the CreateBotVersion operation. If you don't specify createVersion, the default is false.

Definition at line 1158 of file PutBotRequest.h.

◆ WithDescription() [1/3]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithDescription ( Aws::String &&  value)
inline

A description of the bot.

Definition at line 116 of file PutBotRequest.h.

◆ WithDescription() [2/3]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithDescription ( const Aws::String value)
inline

A description of the bot.

Definition at line 111 of file PutBotRequest.h.

◆ WithDescription() [3/3]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithDescription ( const char *  value)
inline

A description of the bot.

Definition at line 121 of file PutBotRequest.h.

◆ WithDetectSentiment()

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithDetectSentiment ( bool  value)
inline

When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is false.

Definition at line 1129 of file PutBotRequest.h.

◆ WithEnableModelImprovements()

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithEnableModelImprovements ( bool  value)
inline

Set to true to enable access to natural language understanding improvements.

When you set the enableModelImprovements parameter to true you can use the nluIntentConfidenceThreshold 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 to true, your bot has access to accuracy improvements.

The Regions where you can set the enableModelImprovements parameter to true 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 to true by default. In these Regions setting the parameter to false throws a ValidationException exception.

Definition at line 259 of file PutBotRequest.h.

◆ WithIdleSessionTTLInSeconds()

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithIdleSessionTTLInSeconds ( int  value)
inline

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

Definition at line 729 of file PutBotRequest.h.

◆ WithIntents() [1/2]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithIntents ( Aws::Vector< Intent > &&  value)
inline

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.

Definition at line 164 of file PutBotRequest.h.

◆ WithIntents() [2/2]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithIntents ( const Aws::Vector< Intent > &  value)
inline

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.

Definition at line 157 of file PutBotRequest.h.

◆ WithLocale() [1/2]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithLocale ( const Locale value)
inline

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.

Definition at line 984 of file PutBotRequest.h.

◆ WithLocale() [2/2]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithLocale ( Locale &&  value)
inline

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.

Definition at line 991 of file PutBotRequest.h.

◆ WithName() [1/3]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithName ( Aws::String &&  value)
inline

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

Definition at line 75 of file PutBotRequest.h.

◆ WithName() [2/3]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithName ( const Aws::String value)
inline

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

Definition at line 70 of file PutBotRequest.h.

◆ WithName() [3/3]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithName ( const char *  value)
inline

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

Definition at line 80 of file PutBotRequest.h.

◆ WithNluIntentConfidenceThreshold()

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithNluIntentConfidenceThreshold ( double  value)
inline

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 and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

You must set the enableModelImprovements parameter to true 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 to true 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 the PostText operation would be:

  • AMAZON.FallbackIntent

  • IntentA

  • IntentB

  • IntentC

Definition at line 360 of file PutBotRequest.h.

◆ WithProcessBehavior() [1/2]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithProcessBehavior ( const ProcessBehavior value)
inline

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

Definition at line 940 of file PutBotRequest.h.

◆ WithProcessBehavior() [2/2]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithProcessBehavior ( ProcessBehavior &&  value)
inline

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

Definition at line 948 of file PutBotRequest.h.

◆ WithTags() [1/2]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

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 the TagResource operation.

Definition at line 1201 of file PutBotRequest.h.

◆ WithTags() [2/2]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

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 the TagResource operation.

Definition at line 1194 of file PutBotRequest.h.

◆ WithVoiceId() [1/3]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithVoiceId ( Aws::String &&  value)
inline

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.

Definition at line 793 of file PutBotRequest.h.

◆ WithVoiceId() [2/3]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithVoiceId ( const Aws::String value)
inline

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.

Definition at line 784 of file PutBotRequest.h.

◆ WithVoiceId() [3/3]

PutBotRequest& Aws::LexModelBuildingService::Model::PutBotRequest::WithVoiceId ( const char *  value)
inline

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.

Definition at line 802 of file PutBotRequest.h.


The documentation for this class was generated from the following file: