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

#include <PutBotResult.h>

Public Member Functions

 PutBotResult ()
 
 PutBotResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
PutBotResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetName () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
PutBotResultWithName (const Aws::String &value)
 
PutBotResultWithName (Aws::String &&value)
 
PutBotResultWithName (const char *value)
 
const Aws::StringGetDescription () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
PutBotResultWithDescription (const Aws::String &value)
 
PutBotResultWithDescription (Aws::String &&value)
 
PutBotResultWithDescription (const char *value)
 
const Aws::Vector< Intent > & GetIntents () const
 
void SetIntents (const Aws::Vector< Intent > &value)
 
void SetIntents (Aws::Vector< Intent > &&value)
 
PutBotResultWithIntents (const Aws::Vector< Intent > &value)
 
PutBotResultWithIntents (Aws::Vector< Intent > &&value)
 
PutBotResultAddIntents (const Intent &value)
 
PutBotResultAddIntents (Intent &&value)
 
bool GetEnableModelImprovements () const
 
void SetEnableModelImprovements (bool value)
 
PutBotResultWithEnableModelImprovements (bool value)
 
double GetNluIntentConfidenceThreshold () const
 
void SetNluIntentConfidenceThreshold (double value)
 
PutBotResultWithNluIntentConfidenceThreshold (double value)
 
const PromptGetClarificationPrompt () const
 
void SetClarificationPrompt (const Prompt &value)
 
void SetClarificationPrompt (Prompt &&value)
 
PutBotResultWithClarificationPrompt (const Prompt &value)
 
PutBotResultWithClarificationPrompt (Prompt &&value)
 
const StatementGetAbortStatement () const
 
void SetAbortStatement (const Statement &value)
 
void SetAbortStatement (Statement &&value)
 
PutBotResultWithAbortStatement (const Statement &value)
 
PutBotResultWithAbortStatement (Statement &&value)
 
const StatusGetStatus () const
 
void SetStatus (const Status &value)
 
void SetStatus (Status &&value)
 
PutBotResultWithStatus (const Status &value)
 
PutBotResultWithStatus (Status &&value)
 
const Aws::StringGetFailureReason () const
 
void SetFailureReason (const Aws::String &value)
 
void SetFailureReason (Aws::String &&value)
 
void SetFailureReason (const char *value)
 
PutBotResultWithFailureReason (const Aws::String &value)
 
PutBotResultWithFailureReason (Aws::String &&value)
 
PutBotResultWithFailureReason (const char *value)
 
const Aws::Utils::DateTimeGetLastUpdatedDate () const
 
void SetLastUpdatedDate (const Aws::Utils::DateTime &value)
 
void SetLastUpdatedDate (Aws::Utils::DateTime &&value)
 
PutBotResultWithLastUpdatedDate (const Aws::Utils::DateTime &value)
 
PutBotResultWithLastUpdatedDate (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetCreatedDate () const
 
void SetCreatedDate (const Aws::Utils::DateTime &value)
 
void SetCreatedDate (Aws::Utils::DateTime &&value)
 
PutBotResultWithCreatedDate (const Aws::Utils::DateTime &value)
 
PutBotResultWithCreatedDate (Aws::Utils::DateTime &&value)
 
int GetIdleSessionTTLInSeconds () const
 
void SetIdleSessionTTLInSeconds (int value)
 
PutBotResultWithIdleSessionTTLInSeconds (int value)
 
const Aws::StringGetVoiceId () const
 
void SetVoiceId (const Aws::String &value)
 
void SetVoiceId (Aws::String &&value)
 
void SetVoiceId (const char *value)
 
PutBotResultWithVoiceId (const Aws::String &value)
 
PutBotResultWithVoiceId (Aws::String &&value)
 
PutBotResultWithVoiceId (const char *value)
 
const Aws::StringGetChecksum () const
 
void SetChecksum (const Aws::String &value)
 
void SetChecksum (Aws::String &&value)
 
void SetChecksum (const char *value)
 
PutBotResultWithChecksum (const Aws::String &value)
 
PutBotResultWithChecksum (Aws::String &&value)
 
PutBotResultWithChecksum (const char *value)
 
const Aws::StringGetVersion () const
 
void SetVersion (const Aws::String &value)
 
void SetVersion (Aws::String &&value)
 
void SetVersion (const char *value)
 
PutBotResultWithVersion (const Aws::String &value)
 
PutBotResultWithVersion (Aws::String &&value)
 
PutBotResultWithVersion (const char *value)
 
const LocaleGetLocale () const
 
void SetLocale (const Locale &value)
 
void SetLocale (Locale &&value)
 
PutBotResultWithLocale (const Locale &value)
 
PutBotResultWithLocale (Locale &&value)
 
bool GetChildDirected () const
 
void SetChildDirected (bool value)
 
PutBotResultWithChildDirected (bool value)
 
bool GetCreateVersion () const
 
void SetCreateVersion (bool value)
 
PutBotResultWithCreateVersion (bool value)
 
bool GetDetectSentiment () const
 
void SetDetectSentiment (bool value)
 
PutBotResultWithDetectSentiment (bool value)
 
const Aws::Vector< Tag > & GetTags () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
PutBotResultWithTags (const Aws::Vector< Tag > &value)
 
PutBotResultWithTags (Aws::Vector< Tag > &&value)
 
PutBotResultAddTags (const Tag &value)
 
PutBotResultAddTags (Tag &&value)
 

Detailed Description

Definition at line 35 of file PutBotResult.h.

Constructor & Destructor Documentation

◆ PutBotResult() [1/2]

Aws::LexModelBuildingService::Model::PutBotResult::PutBotResult ( )

◆ PutBotResult() [2/2]

Aws::LexModelBuildingService::Model::PutBotResult::PutBotResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ AddIntents() [1/2]

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

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

Definition at line 149 of file PutBotResult.h.

◆ AddIntents() [2/2]

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

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

Definition at line 155 of file PutBotResult.h.

◆ AddTags() [1/2]

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

A list of tags associated with the bot.

Definition at line 782 of file PutBotResult.h.

◆ AddTags() [2/2]

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

A list of tags associated with the bot.

Definition at line 787 of file PutBotResult.h.

◆ GetAbortStatement()

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

The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.

Definition at line 255 of file PutBotResult.h.

◆ GetChecksum()

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

Checksum of the bot that you created.

Definition at line 523 of file PutBotResult.h.

◆ GetChildDirected()

bool Aws::LexModelBuildingService::Model::PutBotResult::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 650 of file PutBotResult.h.

◆ GetClarificationPrompt()

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

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

Definition at line 224 of file PutBotResult.h.

◆ GetCreatedDate()

const Aws::Utils::DateTime& Aws::LexModelBuildingService::Model::PutBotResult::GetCreatedDate ( ) const
inline

The date that the bot was created.

Definition at line 435 of file PutBotResult.h.

◆ GetCreateVersion()

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

True if a new version of the bot was created. If the createVersion field was not specified in the request, the createVersion field is set to false in the response.

Definition at line 712 of file PutBotResult.h.

◆ GetDescription()

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

A description of the bot.

Definition at line 82 of file PutBotResult.h.

◆ GetDetectSentiment()

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

true if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis. If the detectSentiment field was not specified in the request, the detectSentiment field is false in the response.

Definition at line 735 of file PutBotResult.h.

◆ GetEnableModelImprovements()

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

Indicates whether the bot uses accuracy improvements. true indicates that the bot is using the improvements, otherwise, false.

Definition at line 163 of file PutBotResult.h.

◆ GetFailureReason()

const Aws::String& Aws::LexModelBuildingService::Model::PutBotResult::GetFailureReason ( ) const
inline

If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.

Definition at line 362 of file PutBotResult.h.

◆ GetIdleSessionTTLInSeconds()

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

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

Definition at line 462 of file PutBotResult.h.

◆ GetIntents()

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

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

Definition at line 119 of file PutBotResult.h.

◆ GetLastUpdatedDate()

const Aws::Utils::DateTime& Aws::LexModelBuildingService::Model::PutBotResult::GetLastUpdatedDate ( ) const
inline

The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

Definition at line 405 of file PutBotResult.h.

◆ GetLocale()

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

The target locale for the bot.

Definition at line 602 of file PutBotResult.h.

◆ GetName()

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

The name of the bot.

Definition at line 46 of file PutBotResult.h.

◆ GetNluIntentConfidenceThreshold()

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

The score that determines where Amazon Lex inserts the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent is inserted if the confidence score for all intents is below this value. AMAZON.KendraSearchIntent is only inserted if it is configured for the bot.

Definition at line 191 of file PutBotResult.h.

◆ GetStatus()

const Status& Aws::LexModelBuildingService::Model::PutBotResult::GetStatus ( ) const
inline

When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex sets the status response element to BUILDING.

In the READY_BASIC_TESTING state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types.

If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

When you set processBehavior to SAVE, Amazon Lex sets the status code to NOT BUILT.

When the bot is in the READY state you can test and publish the bot.

Definition at line 295 of file PutBotResult.h.

◆ GetTags()

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

A list of tags associated with the bot.

Definition at line 757 of file PutBotResult.h.

◆ GetVersion()

const Aws::String& Aws::LexModelBuildingService::Model::PutBotResult::GetVersion ( ) const
inline

The version of the bot. For a new bot, the version is always $LATEST.

Definition at line 560 of file PutBotResult.h.

◆ GetVoiceId()

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

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

Definition at line 481 of file PutBotResult.h.

◆ operator=()

PutBotResult& Aws::LexModelBuildingService::Model::PutBotResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetAbortStatement() [1/2]

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

The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.

Definition at line 261 of file PutBotResult.h.

◆ SetAbortStatement() [2/2]

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

The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.

Definition at line 267 of file PutBotResult.h.

◆ SetChecksum() [1/3]

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

Checksum of the bot that you created.

Definition at line 533 of file PutBotResult.h.

◆ SetChecksum() [2/3]

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

Checksum of the bot that you created.

Definition at line 528 of file PutBotResult.h.

◆ SetChecksum() [3/3]

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

Checksum of the bot that you created.

Definition at line 538 of file PutBotResult.h.

◆ SetChildDirected()

void Aws::LexModelBuildingService::Model::PutBotResult::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 677 of file PutBotResult.h.

◆ SetClarificationPrompt() [1/2]

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

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

Definition at line 230 of file PutBotResult.h.

◆ SetClarificationPrompt() [2/2]

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

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

Definition at line 236 of file PutBotResult.h.

◆ SetCreatedDate() [1/2]

void Aws::LexModelBuildingService::Model::PutBotResult::SetCreatedDate ( Aws::Utils::DateTime &&  value)
inline

The date that the bot was created.

Definition at line 445 of file PutBotResult.h.

◆ SetCreatedDate() [2/2]

void Aws::LexModelBuildingService::Model::PutBotResult::SetCreatedDate ( const Aws::Utils::DateTime value)
inline

The date that the bot was created.

Definition at line 440 of file PutBotResult.h.

◆ SetCreateVersion()

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

True if a new version of the bot was created. If the createVersion field was not specified in the request, the createVersion field is set to false in the response.

Definition at line 719 of file PutBotResult.h.

◆ SetDescription() [1/3]

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

A description of the bot.

Definition at line 92 of file PutBotResult.h.

◆ SetDescription() [2/3]

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

A description of the bot.

Definition at line 87 of file PutBotResult.h.

◆ SetDescription() [3/3]

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

A description of the bot.

Definition at line 97 of file PutBotResult.h.

◆ SetDetectSentiment()

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

true if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis. If the detectSentiment field was not specified in the request, the detectSentiment field is false in the response.

Definition at line 743 of file PutBotResult.h.

◆ SetEnableModelImprovements()

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

Indicates whether the bot uses accuracy improvements. true indicates that the bot is using the improvements, otherwise, false.

Definition at line 170 of file PutBotResult.h.

◆ SetFailureReason() [1/3]

void Aws::LexModelBuildingService::Model::PutBotResult::SetFailureReason ( Aws::String &&  value)
inline

If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.

Definition at line 374 of file PutBotResult.h.

◆ SetFailureReason() [2/3]

void Aws::LexModelBuildingService::Model::PutBotResult::SetFailureReason ( const Aws::String value)
inline

If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.

Definition at line 368 of file PutBotResult.h.

◆ SetFailureReason() [3/3]

void Aws::LexModelBuildingService::Model::PutBotResult::SetFailureReason ( const char *  value)
inline

If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.

Definition at line 380 of file PutBotResult.h.

◆ SetIdleSessionTTLInSeconds()

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

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

Definition at line 468 of file PutBotResult.h.

◆ SetIntents() [1/2]

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

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

Definition at line 131 of file PutBotResult.h.

◆ SetIntents() [2/2]

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

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

Definition at line 125 of file PutBotResult.h.

◆ SetLastUpdatedDate() [1/2]

void Aws::LexModelBuildingService::Model::PutBotResult::SetLastUpdatedDate ( Aws::Utils::DateTime &&  value)
inline

The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

Definition at line 417 of file PutBotResult.h.

◆ SetLastUpdatedDate() [2/2]

void Aws::LexModelBuildingService::Model::PutBotResult::SetLastUpdatedDate ( const Aws::Utils::DateTime value)
inline

The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

Definition at line 411 of file PutBotResult.h.

◆ SetLocale() [1/2]

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

The target locale for the bot.

Definition at line 607 of file PutBotResult.h.

◆ SetLocale() [2/2]

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

The target locale for the bot.

Definition at line 612 of file PutBotResult.h.

◆ SetName() [1/3]

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

The name of the bot.

Definition at line 56 of file PutBotResult.h.

◆ SetName() [2/3]

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

The name of the bot.

Definition at line 51 of file PutBotResult.h.

◆ SetName() [3/3]

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

The name of the bot.

Definition at line 61 of file PutBotResult.h.

◆ SetNluIntentConfidenceThreshold()

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

The score that determines where Amazon Lex inserts the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent is inserted if the confidence score for all intents is below this value. AMAZON.KendraSearchIntent is only inserted if it is configured for the bot.

Definition at line 204 of file PutBotResult.h.

◆ SetStatus() [1/2]

void Aws::LexModelBuildingService::Model::PutBotResult::SetStatus ( const Status value)
inline

When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex sets the status response element to BUILDING.

In the READY_BASIC_TESTING state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types.

If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

When you set processBehavior to SAVE, Amazon Lex sets the status code to NOT BUILT.

When the bot is in the READY state you can test and publish the bot.

Definition at line 310 of file PutBotResult.h.

◆ SetStatus() [2/2]

void Aws::LexModelBuildingService::Model::PutBotResult::SetStatus ( Status &&  value)
inline

When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex sets the status response element to BUILDING.

In the READY_BASIC_TESTING state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types.

If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

When you set processBehavior to SAVE, Amazon Lex sets the status code to NOT BUILT.

When the bot is in the READY state you can test and publish the bot.

Definition at line 325 of file PutBotResult.h.

◆ SetTags() [1/2]

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

A list of tags associated with the bot.

Definition at line 767 of file PutBotResult.h.

◆ SetTags() [2/2]

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

A list of tags associated with the bot.

Definition at line 762 of file PutBotResult.h.

◆ SetVersion() [1/3]

void Aws::LexModelBuildingService::Model::PutBotResult::SetVersion ( Aws::String &&  value)
inline

The version of the bot. For a new bot, the version is always $LATEST.

Definition at line 572 of file PutBotResult.h.

◆ SetVersion() [2/3]

void Aws::LexModelBuildingService::Model::PutBotResult::SetVersion ( const Aws::String value)
inline

The version of the bot. For a new bot, the version is always $LATEST.

Definition at line 566 of file PutBotResult.h.

◆ SetVersion() [3/3]

void Aws::LexModelBuildingService::Model::PutBotResult::SetVersion ( const char *  value)
inline

The version of the bot. For a new bot, the version is always $LATEST.

Definition at line 578 of file PutBotResult.h.

◆ SetVoiceId() [1/3]

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

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

Definition at line 493 of file PutBotResult.h.

◆ SetVoiceId() [2/3]

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

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

Definition at line 487 of file PutBotResult.h.

◆ SetVoiceId() [3/3]

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

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

Definition at line 499 of file PutBotResult.h.

◆ WithAbortStatement() [1/2]

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

The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.

Definition at line 273 of file PutBotResult.h.

◆ WithAbortStatement() [2/2]

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

The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.

Definition at line 279 of file PutBotResult.h.

◆ WithChecksum() [1/3]

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

Checksum of the bot that you created.

Definition at line 548 of file PutBotResult.h.

◆ WithChecksum() [2/3]

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

Checksum of the bot that you created.

Definition at line 543 of file PutBotResult.h.

◆ WithChecksum() [3/3]

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

Checksum of the bot that you created.

Definition at line 553 of file PutBotResult.h.

◆ WithChildDirected()

PutBotResult& Aws::LexModelBuildingService::Model::PutBotResult::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 704 of file PutBotResult.h.

◆ WithClarificationPrompt() [1/2]

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

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

Definition at line 242 of file PutBotResult.h.

◆ WithClarificationPrompt() [2/2]

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

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

Definition at line 248 of file PutBotResult.h.

◆ WithCreatedDate() [1/2]

PutBotResult& Aws::LexModelBuildingService::Model::PutBotResult::WithCreatedDate ( Aws::Utils::DateTime &&  value)
inline

The date that the bot was created.

Definition at line 455 of file PutBotResult.h.

◆ WithCreatedDate() [2/2]

PutBotResult& Aws::LexModelBuildingService::Model::PutBotResult::WithCreatedDate ( const Aws::Utils::DateTime value)
inline

The date that the bot was created.

Definition at line 450 of file PutBotResult.h.

◆ WithCreateVersion()

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

True if a new version of the bot was created. If the createVersion field was not specified in the request, the createVersion field is set to false in the response.

Definition at line 726 of file PutBotResult.h.

◆ WithDescription() [1/3]

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

A description of the bot.

Definition at line 107 of file PutBotResult.h.

◆ WithDescription() [2/3]

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

A description of the bot.

Definition at line 102 of file PutBotResult.h.

◆ WithDescription() [3/3]

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

A description of the bot.

Definition at line 112 of file PutBotResult.h.

◆ WithDetectSentiment()

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

true if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis. If the detectSentiment field was not specified in the request, the detectSentiment field is false in the response.

Definition at line 751 of file PutBotResult.h.

◆ WithEnableModelImprovements()

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

Indicates whether the bot uses accuracy improvements. true indicates that the bot is using the improvements, otherwise, false.

Definition at line 177 of file PutBotResult.h.

◆ WithFailureReason() [1/3]

PutBotResult& Aws::LexModelBuildingService::Model::PutBotResult::WithFailureReason ( Aws::String &&  value)
inline

If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.

Definition at line 392 of file PutBotResult.h.

◆ WithFailureReason() [2/3]

PutBotResult& Aws::LexModelBuildingService::Model::PutBotResult::WithFailureReason ( const Aws::String value)
inline

If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.

Definition at line 386 of file PutBotResult.h.

◆ WithFailureReason() [3/3]

PutBotResult& Aws::LexModelBuildingService::Model::PutBotResult::WithFailureReason ( const char *  value)
inline

If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.

Definition at line 398 of file PutBotResult.h.

◆ WithIdleSessionTTLInSeconds()

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

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

Definition at line 474 of file PutBotResult.h.

◆ WithIntents() [1/2]

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

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

Definition at line 143 of file PutBotResult.h.

◆ WithIntents() [2/2]

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

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

Definition at line 137 of file PutBotResult.h.

◆ WithLastUpdatedDate() [1/2]

PutBotResult& Aws::LexModelBuildingService::Model::PutBotResult::WithLastUpdatedDate ( Aws::Utils::DateTime &&  value)
inline

The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

Definition at line 429 of file PutBotResult.h.

◆ WithLastUpdatedDate() [2/2]

PutBotResult& Aws::LexModelBuildingService::Model::PutBotResult::WithLastUpdatedDate ( const Aws::Utils::DateTime value)
inline

The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

Definition at line 423 of file PutBotResult.h.

◆ WithLocale() [1/2]

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

The target locale for the bot.

Definition at line 617 of file PutBotResult.h.

◆ WithLocale() [2/2]

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

The target locale for the bot.

Definition at line 622 of file PutBotResult.h.

◆ WithName() [1/3]

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

The name of the bot.

Definition at line 71 of file PutBotResult.h.

◆ WithName() [2/3]

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

The name of the bot.

Definition at line 66 of file PutBotResult.h.

◆ WithName() [3/3]

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

The name of the bot.

Definition at line 76 of file PutBotResult.h.

◆ WithNluIntentConfidenceThreshold()

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

The score that determines where Amazon Lex inserts the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent is inserted if the confidence score for all intents is below this value. AMAZON.KendraSearchIntent is only inserted if it is configured for the bot.

Definition at line 217 of file PutBotResult.h.

◆ WithStatus() [1/2]

PutBotResult& Aws::LexModelBuildingService::Model::PutBotResult::WithStatus ( const Status value)
inline

When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex sets the status response element to BUILDING.

In the READY_BASIC_TESTING state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types.

If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

When you set processBehavior to SAVE, Amazon Lex sets the status code to NOT BUILT.

When the bot is in the READY state you can test and publish the bot.

Definition at line 340 of file PutBotResult.h.

◆ WithStatus() [2/2]

PutBotResult& Aws::LexModelBuildingService::Model::PutBotResult::WithStatus ( Status &&  value)
inline

When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex sets the status response element to BUILDING.

In the READY_BASIC_TESTING state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types.

If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

When you set processBehavior to SAVE, Amazon Lex sets the status code to NOT BUILT.

When the bot is in the READY state you can test and publish the bot.

Definition at line 355 of file PutBotResult.h.

◆ WithTags() [1/2]

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

A list of tags associated with the bot.

Definition at line 777 of file PutBotResult.h.

◆ WithTags() [2/2]

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

A list of tags associated with the bot.

Definition at line 772 of file PutBotResult.h.

◆ WithVersion() [1/3]

PutBotResult& Aws::LexModelBuildingService::Model::PutBotResult::WithVersion ( Aws::String &&  value)
inline

The version of the bot. For a new bot, the version is always $LATEST.

Definition at line 590 of file PutBotResult.h.

◆ WithVersion() [2/3]

PutBotResult& Aws::LexModelBuildingService::Model::PutBotResult::WithVersion ( const Aws::String value)
inline

The version of the bot. For a new bot, the version is always $LATEST.

Definition at line 584 of file PutBotResult.h.

◆ WithVersion() [3/3]

PutBotResult& Aws::LexModelBuildingService::Model::PutBotResult::WithVersion ( const char *  value)
inline

The version of the bot. For a new bot, the version is always $LATEST.

Definition at line 596 of file PutBotResult.h.

◆ WithVoiceId() [1/3]

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

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

Definition at line 511 of file PutBotResult.h.

◆ WithVoiceId() [2/3]

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

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

Definition at line 505 of file PutBotResult.h.

◆ WithVoiceId() [3/3]

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

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

Definition at line 517 of file PutBotResult.h.


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