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

#include <GetBotResult.h>

Public Member Functions

 GetBotResult ()
 
 GetBotResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
GetBotResultoperator= (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)
 
GetBotResultWithName (const Aws::String &value)
 
GetBotResultWithName (Aws::String &&value)
 
GetBotResultWithName (const char *value)
 
const Aws::StringGetDescription () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
GetBotResultWithDescription (const Aws::String &value)
 
GetBotResultWithDescription (Aws::String &&value)
 
GetBotResultWithDescription (const char *value)
 
const Aws::Vector< Intent > & GetIntents () const
 
void SetIntents (const Aws::Vector< Intent > &value)
 
void SetIntents (Aws::Vector< Intent > &&value)
 
GetBotResultWithIntents (const Aws::Vector< Intent > &value)
 
GetBotResultWithIntents (Aws::Vector< Intent > &&value)
 
GetBotResultAddIntents (const Intent &value)
 
GetBotResultAddIntents (Intent &&value)
 
bool GetEnableModelImprovements () const
 
void SetEnableModelImprovements (bool value)
 
GetBotResultWithEnableModelImprovements (bool value)
 
double GetNluIntentConfidenceThreshold () const
 
void SetNluIntentConfidenceThreshold (double value)
 
GetBotResultWithNluIntentConfidenceThreshold (double value)
 
const PromptGetClarificationPrompt () const
 
void SetClarificationPrompt (const Prompt &value)
 
void SetClarificationPrompt (Prompt &&value)
 
GetBotResultWithClarificationPrompt (const Prompt &value)
 
GetBotResultWithClarificationPrompt (Prompt &&value)
 
const StatementGetAbortStatement () const
 
void SetAbortStatement (const Statement &value)
 
void SetAbortStatement (Statement &&value)
 
GetBotResultWithAbortStatement (const Statement &value)
 
GetBotResultWithAbortStatement (Statement &&value)
 
const StatusGetStatus () const
 
void SetStatus (const Status &value)
 
void SetStatus (Status &&value)
 
GetBotResultWithStatus (const Status &value)
 
GetBotResultWithStatus (Status &&value)
 
const Aws::StringGetFailureReason () const
 
void SetFailureReason (const Aws::String &value)
 
void SetFailureReason (Aws::String &&value)
 
void SetFailureReason (const char *value)
 
GetBotResultWithFailureReason (const Aws::String &value)
 
GetBotResultWithFailureReason (Aws::String &&value)
 
GetBotResultWithFailureReason (const char *value)
 
const Aws::Utils::DateTimeGetLastUpdatedDate () const
 
void SetLastUpdatedDate (const Aws::Utils::DateTime &value)
 
void SetLastUpdatedDate (Aws::Utils::DateTime &&value)
 
GetBotResultWithLastUpdatedDate (const Aws::Utils::DateTime &value)
 
GetBotResultWithLastUpdatedDate (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetCreatedDate () const
 
void SetCreatedDate (const Aws::Utils::DateTime &value)
 
void SetCreatedDate (Aws::Utils::DateTime &&value)
 
GetBotResultWithCreatedDate (const Aws::Utils::DateTime &value)
 
GetBotResultWithCreatedDate (Aws::Utils::DateTime &&value)
 
int GetIdleSessionTTLInSeconds () const
 
void SetIdleSessionTTLInSeconds (int value)
 
GetBotResultWithIdleSessionTTLInSeconds (int value)
 
const Aws::StringGetVoiceId () const
 
void SetVoiceId (const Aws::String &value)
 
void SetVoiceId (Aws::String &&value)
 
void SetVoiceId (const char *value)
 
GetBotResultWithVoiceId (const Aws::String &value)
 
GetBotResultWithVoiceId (Aws::String &&value)
 
GetBotResultWithVoiceId (const char *value)
 
const Aws::StringGetChecksum () const
 
void SetChecksum (const Aws::String &value)
 
void SetChecksum (Aws::String &&value)
 
void SetChecksum (const char *value)
 
GetBotResultWithChecksum (const Aws::String &value)
 
GetBotResultWithChecksum (Aws::String &&value)
 
GetBotResultWithChecksum (const char *value)
 
const Aws::StringGetVersion () const
 
void SetVersion (const Aws::String &value)
 
void SetVersion (Aws::String &&value)
 
void SetVersion (const char *value)
 
GetBotResultWithVersion (const Aws::String &value)
 
GetBotResultWithVersion (Aws::String &&value)
 
GetBotResultWithVersion (const char *value)
 
const LocaleGetLocale () const
 
void SetLocale (const Locale &value)
 
void SetLocale (Locale &&value)
 
GetBotResultWithLocale (const Locale &value)
 
GetBotResultWithLocale (Locale &&value)
 
bool GetChildDirected () const
 
void SetChildDirected (bool value)
 
GetBotResultWithChildDirected (bool value)
 
bool GetDetectSentiment () const
 
void SetDetectSentiment (bool value)
 
GetBotResultWithDetectSentiment (bool value)
 

Detailed Description

Definition at line 34 of file GetBotResult.h.

Constructor & Destructor Documentation

◆ GetBotResult() [1/2]

Aws::LexModelBuildingService::Model::GetBotResult::GetBotResult ( )

◆ GetBotResult() [2/2]

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

Member Function Documentation

◆ AddIntents() [1/2]

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

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

Definition at line 148 of file GetBotResult.h.

◆ AddIntents() [2/2]

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

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

Definition at line 154 of file GetBotResult.h.

◆ GetAbortStatement()

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

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

Definition at line 254 of file GetBotResult.h.

◆ GetChecksum()

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

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

Definition at line 508 of file GetBotResult.h.

◆ GetChildDirected()

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

◆ GetClarificationPrompt()

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

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

Definition at line 223 of file GetBotResult.h.

◆ GetCreatedDate()

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

The date that the bot was created.

Definition at line 419 of file GetBotResult.h.

◆ GetDescription()

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

A description of the bot.

Definition at line 81 of file GetBotResult.h.

◆ GetDetectSentiment()

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

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

Definition at line 702 of file GetBotResult.h.

◆ GetEnableModelImprovements()

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

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

Definition at line 162 of file GetBotResult.h.

◆ GetFailureReason()

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

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

Definition at line 346 of file GetBotResult.h.

◆ GetIdleSessionTTLInSeconds()

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

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

Definition at line 446 of file GetBotResult.h.

◆ GetIntents()

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

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

Definition at line 118 of file GetBotResult.h.

◆ GetLastUpdatedDate()

const Aws::Utils::DateTime& Aws::LexModelBuildingService::Model::GetBotResult::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 389 of file GetBotResult.h.

◆ GetLocale()

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

The target locale for the bot.

Definition at line 593 of file GetBotResult.h.

◆ GetName()

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

The name of the bot.

Definition at line 45 of file GetBotResult.h.

◆ GetNluIntentConfidenceThreshold()

double Aws::LexModelBuildingService::Model::GetBotResult::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 190 of file GetBotResult.h.

◆ GetStatus()

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

The status of the bot.

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

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

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

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

Definition at line 291 of file GetBotResult.h.

◆ GetVersion()

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

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

Definition at line 551 of file GetBotResult.h.

◆ GetVoiceId()

const Aws::String& Aws::LexModelBuildingService::Model::GetBotResult::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 465 of file GetBotResult.h.

◆ operator=()

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

◆ SetAbortStatement() [1/2]

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

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

Definition at line 260 of file GetBotResult.h.

◆ SetAbortStatement() [2/2]

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

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

Definition at line 266 of file GetBotResult.h.

◆ SetChecksum() [1/3]

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

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

Definition at line 520 of file GetBotResult.h.

◆ SetChecksum() [2/3]

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

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

Definition at line 514 of file GetBotResult.h.

◆ SetChecksum() [3/3]

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

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

Definition at line 526 of file GetBotResult.h.

◆ SetChildDirected()

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

◆ SetClarificationPrompt() [1/2]

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

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

Definition at line 229 of file GetBotResult.h.

◆ SetClarificationPrompt() [2/2]

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

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

Definition at line 235 of file GetBotResult.h.

◆ SetCreatedDate() [1/2]

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

The date that the bot was created.

Definition at line 429 of file GetBotResult.h.

◆ SetCreatedDate() [2/2]

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

The date that the bot was created.

Definition at line 424 of file GetBotResult.h.

◆ SetDescription() [1/3]

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

A description of the bot.

Definition at line 91 of file GetBotResult.h.

◆ SetDescription() [2/3]

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

A description of the bot.

Definition at line 86 of file GetBotResult.h.

◆ SetDescription() [3/3]

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

A description of the bot.

Definition at line 96 of file GetBotResult.h.

◆ SetDetectSentiment()

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

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

Definition at line 708 of file GetBotResult.h.

◆ SetEnableModelImprovements()

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

◆ SetFailureReason() [1/3]

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

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

Definition at line 358 of file GetBotResult.h.

◆ SetFailureReason() [2/3]

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

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

Definition at line 352 of file GetBotResult.h.

◆ SetFailureReason() [3/3]

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

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

Definition at line 364 of file GetBotResult.h.

◆ SetIdleSessionTTLInSeconds()

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

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

Definition at line 452 of file GetBotResult.h.

◆ SetIntents() [1/2]

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

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

Definition at line 130 of file GetBotResult.h.

◆ SetIntents() [2/2]

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

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

Definition at line 124 of file GetBotResult.h.

◆ SetLastUpdatedDate() [1/2]

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

◆ SetLastUpdatedDate() [2/2]

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

◆ SetLocale() [1/2]

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

The target locale for the bot.

Definition at line 598 of file GetBotResult.h.

◆ SetLocale() [2/2]

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

The target locale for the bot.

Definition at line 603 of file GetBotResult.h.

◆ SetName() [1/3]

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

The name of the bot.

Definition at line 55 of file GetBotResult.h.

◆ SetName() [2/3]

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

The name of the bot.

Definition at line 50 of file GetBotResult.h.

◆ SetName() [3/3]

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

The name of the bot.

Definition at line 60 of file GetBotResult.h.

◆ SetNluIntentConfidenceThreshold()

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

◆ SetStatus() [1/2]

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

The status of the bot.

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

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

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

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

Definition at line 303 of file GetBotResult.h.

◆ SetStatus() [2/2]

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

The status of the bot.

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

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

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

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

Definition at line 315 of file GetBotResult.h.

◆ SetVersion() [1/3]

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

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

Definition at line 563 of file GetBotResult.h.

◆ SetVersion() [2/3]

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

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

Definition at line 557 of file GetBotResult.h.

◆ SetVersion() [3/3]

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

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

Definition at line 569 of file GetBotResult.h.

◆ SetVoiceId() [1/3]

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

◆ SetVoiceId() [2/3]

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

◆ SetVoiceId() [3/3]

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

◆ WithAbortStatement() [1/2]

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

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

Definition at line 272 of file GetBotResult.h.

◆ WithAbortStatement() [2/2]

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

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

Definition at line 278 of file GetBotResult.h.

◆ WithChecksum() [1/3]

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

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

Definition at line 538 of file GetBotResult.h.

◆ WithChecksum() [2/3]

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

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

Definition at line 532 of file GetBotResult.h.

◆ WithChecksum() [3/3]

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

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

Definition at line 544 of file GetBotResult.h.

◆ WithChildDirected()

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

◆ WithClarificationPrompt() [1/2]

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

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

Definition at line 241 of file GetBotResult.h.

◆ WithClarificationPrompt() [2/2]

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

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

Definition at line 247 of file GetBotResult.h.

◆ WithCreatedDate() [1/2]

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

The date that the bot was created.

Definition at line 439 of file GetBotResult.h.

◆ WithCreatedDate() [2/2]

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

The date that the bot was created.

Definition at line 434 of file GetBotResult.h.

◆ WithDescription() [1/3]

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

A description of the bot.

Definition at line 106 of file GetBotResult.h.

◆ WithDescription() [2/3]

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

A description of the bot.

Definition at line 101 of file GetBotResult.h.

◆ WithDescription() [3/3]

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

A description of the bot.

Definition at line 111 of file GetBotResult.h.

◆ WithDetectSentiment()

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

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

Definition at line 714 of file GetBotResult.h.

◆ WithEnableModelImprovements()

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

◆ WithFailureReason() [1/3]

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

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

Definition at line 376 of file GetBotResult.h.

◆ WithFailureReason() [2/3]

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

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

Definition at line 370 of file GetBotResult.h.

◆ WithFailureReason() [3/3]

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

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

Definition at line 382 of file GetBotResult.h.

◆ WithIdleSessionTTLInSeconds()

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

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

Definition at line 458 of file GetBotResult.h.

◆ WithIntents() [1/2]

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

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

Definition at line 142 of file GetBotResult.h.

◆ WithIntents() [2/2]

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

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

Definition at line 136 of file GetBotResult.h.

◆ WithLastUpdatedDate() [1/2]

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

◆ WithLastUpdatedDate() [2/2]

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

◆ WithLocale() [1/2]

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

The target locale for the bot.

Definition at line 608 of file GetBotResult.h.

◆ WithLocale() [2/2]

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

The target locale for the bot.

Definition at line 613 of file GetBotResult.h.

◆ WithName() [1/3]

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

The name of the bot.

Definition at line 70 of file GetBotResult.h.

◆ WithName() [2/3]

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

The name of the bot.

Definition at line 65 of file GetBotResult.h.

◆ WithName() [3/3]

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

The name of the bot.

Definition at line 75 of file GetBotResult.h.

◆ WithNluIntentConfidenceThreshold()

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

◆ WithStatus() [1/2]

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

The status of the bot.

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

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

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

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

Definition at line 327 of file GetBotResult.h.

◆ WithStatus() [2/2]

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

The status of the bot.

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

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

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

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

Definition at line 339 of file GetBotResult.h.

◆ WithVersion() [1/3]

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

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

Definition at line 581 of file GetBotResult.h.

◆ WithVersion() [2/3]

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

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

Definition at line 575 of file GetBotResult.h.

◆ WithVersion() [3/3]

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

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

Definition at line 587 of file GetBotResult.h.

◆ WithVoiceId() [1/3]

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

◆ WithVoiceId() [2/3]

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

◆ WithVoiceId() [3/3]

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


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