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

#include <PutIntentRequest.h>

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

Public Member Functions

 PutIntentRequest ()
 
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)
 
PutIntentRequestWithName (const Aws::String &value)
 
PutIntentRequestWithName (Aws::String &&value)
 
PutIntentRequestWithName (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)
 
PutIntentRequestWithDescription (const Aws::String &value)
 
PutIntentRequestWithDescription (Aws::String &&value)
 
PutIntentRequestWithDescription (const char *value)
 
const Aws::Vector< Slot > & GetSlots () const
 
bool SlotsHasBeenSet () const
 
void SetSlots (const Aws::Vector< Slot > &value)
 
void SetSlots (Aws::Vector< Slot > &&value)
 
PutIntentRequestWithSlots (const Aws::Vector< Slot > &value)
 
PutIntentRequestWithSlots (Aws::Vector< Slot > &&value)
 
PutIntentRequestAddSlots (const Slot &value)
 
PutIntentRequestAddSlots (Slot &&value)
 
const Aws::Vector< Aws::String > & GetSampleUtterances () const
 
bool SampleUtterancesHasBeenSet () const
 
void SetSampleUtterances (const Aws::Vector< Aws::String > &value)
 
void SetSampleUtterances (Aws::Vector< Aws::String > &&value)
 
PutIntentRequestWithSampleUtterances (const Aws::Vector< Aws::String > &value)
 
PutIntentRequestWithSampleUtterances (Aws::Vector< Aws::String > &&value)
 
PutIntentRequestAddSampleUtterances (const Aws::String &value)
 
PutIntentRequestAddSampleUtterances (Aws::String &&value)
 
PutIntentRequestAddSampleUtterances (const char *value)
 
const PromptGetConfirmationPrompt () const
 
bool ConfirmationPromptHasBeenSet () const
 
void SetConfirmationPrompt (const Prompt &value)
 
void SetConfirmationPrompt (Prompt &&value)
 
PutIntentRequestWithConfirmationPrompt (const Prompt &value)
 
PutIntentRequestWithConfirmationPrompt (Prompt &&value)
 
const StatementGetRejectionStatement () const
 
bool RejectionStatementHasBeenSet () const
 
void SetRejectionStatement (const Statement &value)
 
void SetRejectionStatement (Statement &&value)
 
PutIntentRequestWithRejectionStatement (const Statement &value)
 
PutIntentRequestWithRejectionStatement (Statement &&value)
 
const FollowUpPromptGetFollowUpPrompt () const
 
bool FollowUpPromptHasBeenSet () const
 
void SetFollowUpPrompt (const FollowUpPrompt &value)
 
void SetFollowUpPrompt (FollowUpPrompt &&value)
 
PutIntentRequestWithFollowUpPrompt (const FollowUpPrompt &value)
 
PutIntentRequestWithFollowUpPrompt (FollowUpPrompt &&value)
 
const StatementGetConclusionStatement () const
 
bool ConclusionStatementHasBeenSet () const
 
void SetConclusionStatement (const Statement &value)
 
void SetConclusionStatement (Statement &&value)
 
PutIntentRequestWithConclusionStatement (const Statement &value)
 
PutIntentRequestWithConclusionStatement (Statement &&value)
 
const CodeHookGetDialogCodeHook () const
 
bool DialogCodeHookHasBeenSet () const
 
void SetDialogCodeHook (const CodeHook &value)
 
void SetDialogCodeHook (CodeHook &&value)
 
PutIntentRequestWithDialogCodeHook (const CodeHook &value)
 
PutIntentRequestWithDialogCodeHook (CodeHook &&value)
 
const FulfillmentActivityGetFulfillmentActivity () const
 
bool FulfillmentActivityHasBeenSet () const
 
void SetFulfillmentActivity (const FulfillmentActivity &value)
 
void SetFulfillmentActivity (FulfillmentActivity &&value)
 
PutIntentRequestWithFulfillmentActivity (const FulfillmentActivity &value)
 
PutIntentRequestWithFulfillmentActivity (FulfillmentActivity &&value)
 
const Aws::StringGetParentIntentSignature () const
 
bool ParentIntentSignatureHasBeenSet () const
 
void SetParentIntentSignature (const Aws::String &value)
 
void SetParentIntentSignature (Aws::String &&value)
 
void SetParentIntentSignature (const char *value)
 
PutIntentRequestWithParentIntentSignature (const Aws::String &value)
 
PutIntentRequestWithParentIntentSignature (Aws::String &&value)
 
PutIntentRequestWithParentIntentSignature (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)
 
PutIntentRequestWithChecksum (const Aws::String &value)
 
PutIntentRequestWithChecksum (Aws::String &&value)
 
PutIntentRequestWithChecksum (const char *value)
 
bool GetCreateVersion () const
 
bool CreateVersionHasBeenSet () const
 
void SetCreateVersion (bool value)
 
PutIntentRequestWithCreateVersion (bool value)
 
const KendraConfigurationGetKendraConfiguration () const
 
bool KendraConfigurationHasBeenSet () const
 
void SetKendraConfiguration (const KendraConfiguration &value)
 
void SetKendraConfiguration (KendraConfiguration &&value)
 
PutIntentRequestWithKendraConfiguration (const KendraConfiguration &value)
 
PutIntentRequestWithKendraConfiguration (KendraConfiguration &&value)
 
const Aws::Vector< InputContext > & GetInputContexts () const
 
bool InputContextsHasBeenSet () const
 
void SetInputContexts (const Aws::Vector< InputContext > &value)
 
void SetInputContexts (Aws::Vector< InputContext > &&value)
 
PutIntentRequestWithInputContexts (const Aws::Vector< InputContext > &value)
 
PutIntentRequestWithInputContexts (Aws::Vector< InputContext > &&value)
 
PutIntentRequestAddInputContexts (const InputContext &value)
 
PutIntentRequestAddInputContexts (InputContext &&value)
 
const Aws::Vector< OutputContext > & GetOutputContexts () const
 
bool OutputContextsHasBeenSet () const
 
void SetOutputContexts (const Aws::Vector< OutputContext > &value)
 
void SetOutputContexts (Aws::Vector< OutputContext > &&value)
 
PutIntentRequestWithOutputContexts (const Aws::Vector< OutputContext > &value)
 
PutIntentRequestWithOutputContexts (Aws::Vector< OutputContext > &&value)
 
PutIntentRequestAddOutputContexts (const OutputContext &value)
 
PutIntentRequestAddOutputContexts (OutputContext &&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 31 of file PutIntentRequest.h.

Constructor & Destructor Documentation

◆ PutIntentRequest()

Aws::LexModelBuildingService::Model::PutIntentRequest::PutIntentRequest ( )

Member Function Documentation

◆ AddInputContexts() [1/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::AddInputContexts ( const InputContext value)
inline

An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

Definition at line 1025 of file PutIntentRequest.h.

◆ AddInputContexts() [2/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::AddInputContexts ( InputContext &&  value)
inline

An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

Definition at line 1032 of file PutIntentRequest.h.

◆ AddOutputContexts() [1/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::AddOutputContexts ( const OutputContext value)
inline

An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

Definition at line 1075 of file PutIntentRequest.h.

◆ AddOutputContexts() [2/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::AddOutputContexts ( OutputContext &&  value)
inline

An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

Definition at line 1081 of file PutIntentRequest.h.

◆ AddSampleUtterances() [1/3]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::AddSampleUtterances ( Aws::String &&  value)
inline

An array of utterances (strings) that a user might say to signal the intent. For example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas".

In each utterance, a slot name is enclosed in curly braces.

Definition at line 286 of file PutIntentRequest.h.

◆ AddSampleUtterances() [2/3]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::AddSampleUtterances ( const Aws::String value)
inline

An array of utterances (strings) that a user might say to signal the intent. For example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas".

In each utterance, a slot name is enclosed in curly braces.

Definition at line 279 of file PutIntentRequest.h.

◆ AddSampleUtterances() [3/3]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::AddSampleUtterances ( const char *  value)
inline

An array of utterances (strings) that a user might say to signal the intent. For example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas".

In each utterance, a slot name is enclosed in curly braces.

Definition at line 293 of file PutIntentRequest.h.

◆ AddSlots() [1/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::AddSlots ( const Slot value)
inline

An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see how-it-works.

Definition at line 222 of file PutIntentRequest.h.

◆ AddSlots() [2/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::AddSlots ( Slot &&  value)
inline

An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see how-it-works.

Definition at line 229 of file PutIntentRequest.h.

◆ ChecksumHasBeenSet()

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

Identifies a specific revision of the $LATEST version.

When you create a new intent, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a intent, 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 PutIntentRequest.h.

◆ ConclusionStatementHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutIntentRequest::ConclusionStatementHasBeenSet ( ) const
inline

The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function.

This element is relevant only if you provide a Lambda function in the fulfillmentActivity. If you return the intent to the client application, you can't specify this element.

The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one.

Definition at line 547 of file PutIntentRequest.h.

◆ ConfirmationPromptHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutIntentRequest::ConfirmationPromptHasBeenSet ( ) const
inline

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

You you must provide both the rejectionStatement and the confirmationPrompt, or neither.

Definition at line 320 of file PutIntentRequest.h.

◆ CreateVersionHasBeenSet()

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

When set to true a new numbered version of the intent is created. This is the same as calling the CreateIntentVersion operation. If you do not specify createVersion, the default is false.

Definition at line 904 of file PutIntentRequest.h.

◆ DescriptionHasBeenSet()

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

A description of the intent.

Definition at line 142 of file PutIntentRequest.h.

◆ DialogCodeHookHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutIntentRequest::DialogCodeHookHasBeenSet ( ) const
inline

Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize user interaction.

For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, GlutenIntolerant, to true. You might find John's phone number and set the corresponding session attribute.

Definition at line 614 of file PutIntentRequest.h.

◆ FollowUpPromptHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutIntentRequest::FollowUpPromptHasBeenSet ( ) const
inline

Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the OrderPizza intent is fulfilled, you might prompt the user to order a drink.

The action that Amazon Lex takes depends on the user's response, as follows:

  • If the user says "Yes" it responds with the clarification prompt that is configured for the bot.

  • if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation for the intent.

  • If the user says "No" it responds with the rejection statement configured for the the follow-up prompt.

  • If it doesn't recognize the utterance it repeats the follow-up prompt again.

The followUpPrompt field and the conclusionStatement field are mutually exclusive. You can specify only one.

Definition at line 460 of file PutIntentRequest.h.

◆ FulfillmentActivityHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutIntentRequest::FulfillmentActivityHasBeenSet ( ) const
inline

Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a pizza order, fulfillmentActivity defines how the bot places an order with a local pizza store.

You might configure Amazon Lex to return all of the intent information to the client application, or direct it to invoke a Lambda function that can process the intent (for example, place an order with a pizzeria).

Definition at line 681 of file PutIntentRequest.h.

◆ GetChecksum()

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

Identifies a specific revision of the $LATEST version.

When you create a new intent, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a intent, 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 803 of file PutIntentRequest.h.

◆ GetConclusionStatement()

const Statement& Aws::LexModelBuildingService::Model::PutIntentRequest::GetConclusionStatement ( ) const
inline

The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function.

This element is relevant only if you provide a Lambda function in the fulfillmentActivity. If you return the intent to the client application, you can't specify this element.

The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one.

Definition at line 536 of file PutIntentRequest.h.

◆ GetConfirmationPrompt()

const Prompt& Aws::LexModelBuildingService::Model::PutIntentRequest::GetConfirmationPrompt ( ) const
inline

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

You you must provide both the rejectionStatement and the confirmationPrompt, or neither.

Definition at line 307 of file PutIntentRequest.h.

◆ GetCreateVersion()

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

When set to true a new numbered version of the intent is created. This is the same as calling the CreateIntentVersion operation. If you do not specify createVersion, the default is false.

Definition at line 896 of file PutIntentRequest.h.

◆ GetDescription()

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

A description of the intent.

Definition at line 137 of file PutIntentRequest.h.

◆ GetDialogCodeHook()

const CodeHook& Aws::LexModelBuildingService::Model::PutIntentRequest::GetDialogCodeHook ( ) const
inline

Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize user interaction.

For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, GlutenIntolerant, to true. You might find John's phone number and set the corresponding session attribute.

Definition at line 603 of file PutIntentRequest.h.

◆ GetFollowUpPrompt()

const FollowUpPrompt& Aws::LexModelBuildingService::Model::PutIntentRequest::GetFollowUpPrompt ( ) const
inline

Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the OrderPizza intent is fulfilled, you might prompt the user to order a drink.

The action that Amazon Lex takes depends on the user's response, as follows:

  • If the user says "Yes" it responds with the clarification prompt that is configured for the bot.

  • if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation for the intent.

  • If the user says "No" it responds with the rejection statement configured for the the follow-up prompt.

  • If it doesn't recognize the utterance it repeats the follow-up prompt again.

The followUpPrompt field and the conclusionStatement field are mutually exclusive. You can specify only one.

Definition at line 444 of file PutIntentRequest.h.

◆ GetFulfillmentActivity()

const FulfillmentActivity& Aws::LexModelBuildingService::Model::PutIntentRequest::GetFulfillmentActivity ( ) const
inline

Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a pizza order, fulfillmentActivity defines how the bot places an order with a local pizza store.

You might configure Amazon Lex to return all of the intent information to the client application, or direct it to invoke a Lambda function that can process the intent (for example, place an order with a pizzeria).

Definition at line 670 of file PutIntentRequest.h.

◆ GetInputContexts()

const Aws::Vector<InputContext>& Aws::LexModelBuildingService::Model::PutIntentRequest::GetInputContexts ( ) const
inline

An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

Definition at line 983 of file PutIntentRequest.h.

◆ GetKendraConfiguration()

const KendraConfiguration& Aws::LexModelBuildingService::Model::PutIntentRequest::GetKendraConfiguration ( ) const
inline

Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.

Definition at line 930 of file PutIntentRequest.h.

◆ GetName()

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

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

The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For example, because there is a built-in intent called AMAZON.HelpIntent, you can't create a custom intent called HelpIntent.

For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit.

Definition at line 54 of file PutIntentRequest.h.

◆ GetOutputContexts()

const Aws::Vector<OutputContext>& Aws::LexModelBuildingService::Model::PutIntentRequest::GetOutputContexts ( ) const
inline

An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

Definition at line 1039 of file PutIntentRequest.h.

◆ GetParentIntentSignature()

const Aws::String& Aws::LexModelBuildingService::Model::PutIntentRequest::GetParentIntentSignature ( ) const
inline

A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

Definition at line 734 of file PutIntentRequest.h.

◆ GetRejectionStatement()

const Statement& Aws::LexModelBuildingService::Model::PutIntentRequest::GetRejectionStatement ( ) const
inline

When the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

You must provide both the rejectionStatement and the confirmationPrompt, or neither.

Definition at line 382 of file PutIntentRequest.h.

◆ GetSampleUtterances()

const Aws::Vector<Aws::String>& Aws::LexModelBuildingService::Model::PutIntentRequest::GetSampleUtterances ( ) const
inline

An array of utterances (strings) that a user might say to signal the intent. For example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas".

In each utterance, a slot name is enclosed in curly braces.

Definition at line 237 of file PutIntentRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 40 of file PutIntentRequest.h.

◆ GetSlots()

const Aws::Vector<Slot>& Aws::LexModelBuildingService::Model::PutIntentRequest::GetSlots ( ) const
inline

An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see how-it-works.

Definition at line 180 of file PutIntentRequest.h.

◆ InputContextsHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutIntentRequest::InputContextsHasBeenSet ( ) const
inline

An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

Definition at line 990 of file PutIntentRequest.h.

◆ KendraConfigurationHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutIntentRequest::KendraConfigurationHasBeenSet ( ) const
inline

Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.

Definition at line 939 of file PutIntentRequest.h.

◆ NameHasBeenSet()

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

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

The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For example, because there is a built-in intent called AMAZON.HelpIntent, you can't create a custom intent called HelpIntent.

For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit.

Definition at line 65 of file PutIntentRequest.h.

◆ OutputContextsHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutIntentRequest::OutputContextsHasBeenSet ( ) const
inline

An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

Definition at line 1045 of file PutIntentRequest.h.

◆ ParentIntentSignatureHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutIntentRequest::ParentIntentSignatureHasBeenSet ( ) const
inline

A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

Definition at line 742 of file PutIntentRequest.h.

◆ RejectionStatementHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutIntentRequest::RejectionStatementHasBeenSet ( ) const
inline

When the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

You must provide both the rejectionStatement and the confirmationPrompt, or neither.

Definition at line 391 of file PutIntentRequest.h.

◆ SampleUtterancesHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutIntentRequest::SampleUtterancesHasBeenSet ( ) const
inline

An array of utterances (strings) that a user might say to signal the intent. For example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas".

In each utterance, a slot name is enclosed in curly braces.

Definition at line 244 of file PutIntentRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetChecksum() [1/3]

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

Identifies a specific revision of the $LATEST version.

When you create a new intent, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a intent, 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 PutIntentRequest.h.

◆ SetChecksum() [2/3]

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

Identifies a specific revision of the $LATEST version.

When you create a new intent, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a intent, 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 PutIntentRequest.h.

◆ SetChecksum() [3/3]

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

Identifies a specific revision of the $LATEST version.

When you create a new intent, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a intent, 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 PutIntentRequest.h.

◆ SetConclusionStatement() [1/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetConclusionStatement ( const Statement value)
inline

The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function.

This element is relevant only if you provide a Lambda function in the fulfillmentActivity. If you return the intent to the client application, you can't specify this element.

The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one.

Definition at line 558 of file PutIntentRequest.h.

◆ SetConclusionStatement() [2/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetConclusionStatement ( Statement &&  value)
inline

The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function.

This element is relevant only if you provide a Lambda function in the fulfillmentActivity. If you return the intent to the client application, you can't specify this element.

The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one.

Definition at line 569 of file PutIntentRequest.h.

◆ SetConfirmationPrompt() [1/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetConfirmationPrompt ( const Prompt value)
inline

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

You you must provide both the rejectionStatement and the confirmationPrompt, or neither.

Definition at line 333 of file PutIntentRequest.h.

◆ SetConfirmationPrompt() [2/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetConfirmationPrompt ( Prompt &&  value)
inline

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

You you must provide both the rejectionStatement and the confirmationPrompt, or neither.

Definition at line 346 of file PutIntentRequest.h.

◆ SetCreateVersion()

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

When set to true a new numbered version of the intent is created. This is the same as calling the CreateIntentVersion operation. If you do not specify createVersion, the default is false.

Definition at line 912 of file PutIntentRequest.h.

◆ SetDescription() [1/3]

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

A description of the intent.

Definition at line 152 of file PutIntentRequest.h.

◆ SetDescription() [2/3]

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

A description of the intent.

Definition at line 147 of file PutIntentRequest.h.

◆ SetDescription() [3/3]

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

A description of the intent.

Definition at line 157 of file PutIntentRequest.h.

◆ SetDialogCodeHook() [1/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetDialogCodeHook ( CodeHook &&  value)
inline

Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize user interaction.

For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, GlutenIntolerant, to true. You might find John's phone number and set the corresponding session attribute.

Definition at line 636 of file PutIntentRequest.h.

◆ SetDialogCodeHook() [2/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetDialogCodeHook ( const CodeHook value)
inline

Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize user interaction.

For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, GlutenIntolerant, to true. You might find John's phone number and set the corresponding session attribute.

Definition at line 625 of file PutIntentRequest.h.

◆ SetFollowUpPrompt() [1/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetFollowUpPrompt ( const FollowUpPrompt value)
inline

Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the OrderPizza intent is fulfilled, you might prompt the user to order a drink.

The action that Amazon Lex takes depends on the user's response, as follows:

  • If the user says "Yes" it responds with the clarification prompt that is configured for the bot.

  • if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation for the intent.

  • If the user says "No" it responds with the rejection statement configured for the the follow-up prompt.

  • If it doesn't recognize the utterance it repeats the follow-up prompt again.

The followUpPrompt field and the conclusionStatement field are mutually exclusive. You can specify only one.

Definition at line 476 of file PutIntentRequest.h.

◆ SetFollowUpPrompt() [2/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetFollowUpPrompt ( FollowUpPrompt &&  value)
inline

Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the OrderPizza intent is fulfilled, you might prompt the user to order a drink.

The action that Amazon Lex takes depends on the user's response, as follows:

  • If the user says "Yes" it responds with the clarification prompt that is configured for the bot.

  • if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation for the intent.

  • If the user says "No" it responds with the rejection statement configured for the the follow-up prompt.

  • If it doesn't recognize the utterance it repeats the follow-up prompt again.

The followUpPrompt field and the conclusionStatement field are mutually exclusive. You can specify only one.

Definition at line 492 of file PutIntentRequest.h.

◆ SetFulfillmentActivity() [1/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetFulfillmentActivity ( const FulfillmentActivity value)
inline

Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a pizza order, fulfillmentActivity defines how the bot places an order with a local pizza store.

You might configure Amazon Lex to return all of the intent information to the client application, or direct it to invoke a Lambda function that can process the intent (for example, place an order with a pizzeria).

Definition at line 692 of file PutIntentRequest.h.

◆ SetFulfillmentActivity() [2/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetFulfillmentActivity ( FulfillmentActivity &&  value)
inline

Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a pizza order, fulfillmentActivity defines how the bot places an order with a local pizza store.

You might configure Amazon Lex to return all of the intent information to the client application, or direct it to invoke a Lambda function that can process the intent (for example, place an order with a pizzeria).

Definition at line 703 of file PutIntentRequest.h.

◆ SetInputContexts() [1/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetInputContexts ( Aws::Vector< InputContext > &&  value)
inline

An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

Definition at line 1004 of file PutIntentRequest.h.

◆ SetInputContexts() [2/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetInputContexts ( const Aws::Vector< InputContext > &  value)
inline

An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

Definition at line 997 of file PutIntentRequest.h.

◆ SetKendraConfiguration() [1/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetKendraConfiguration ( const KendraConfiguration value)
inline

Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.

Definition at line 948 of file PutIntentRequest.h.

◆ SetKendraConfiguration() [2/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetKendraConfiguration ( KendraConfiguration &&  value)
inline

Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.

Definition at line 957 of file PutIntentRequest.h.

◆ SetName() [1/3]

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

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

The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For example, because there is a built-in intent called AMAZON.HelpIntent, you can't create a custom intent called HelpIntent.

For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit.

Definition at line 87 of file PutIntentRequest.h.

◆ SetName() [2/3]

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

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

The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For example, because there is a built-in intent called AMAZON.HelpIntent, you can't create a custom intent called HelpIntent.

For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit.

Definition at line 76 of file PutIntentRequest.h.

◆ SetName() [3/3]

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

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

The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For example, because there is a built-in intent called AMAZON.HelpIntent, you can't create a custom intent called HelpIntent.

For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit.

Definition at line 98 of file PutIntentRequest.h.

◆ SetOutputContexts() [1/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetOutputContexts ( Aws::Vector< OutputContext > &&  value)
inline

An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

Definition at line 1057 of file PutIntentRequest.h.

◆ SetOutputContexts() [2/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetOutputContexts ( const Aws::Vector< OutputContext > &  value)
inline

An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

Definition at line 1051 of file PutIntentRequest.h.

◆ SetParentIntentSignature() [1/3]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetParentIntentSignature ( Aws::String &&  value)
inline

A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

Definition at line 758 of file PutIntentRequest.h.

◆ SetParentIntentSignature() [2/3]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetParentIntentSignature ( const Aws::String value)
inline

A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

Definition at line 750 of file PutIntentRequest.h.

◆ SetParentIntentSignature() [3/3]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetParentIntentSignature ( const char *  value)
inline

A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

Definition at line 766 of file PutIntentRequest.h.

◆ SetRejectionStatement() [1/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetRejectionStatement ( const Statement value)
inline

When the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

You must provide both the rejectionStatement and the confirmationPrompt, or neither.

Definition at line 400 of file PutIntentRequest.h.

◆ SetRejectionStatement() [2/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetRejectionStatement ( Statement &&  value)
inline

When the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

You must provide both the rejectionStatement and the confirmationPrompt, or neither.

Definition at line 409 of file PutIntentRequest.h.

◆ SetSampleUtterances() [1/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetSampleUtterances ( Aws::Vector< Aws::String > &&  value)
inline

An array of utterances (strings) that a user might say to signal the intent. For example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas".

In each utterance, a slot name is enclosed in curly braces.

Definition at line 258 of file PutIntentRequest.h.

◆ SetSampleUtterances() [2/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetSampleUtterances ( const Aws::Vector< Aws::String > &  value)
inline

An array of utterances (strings) that a user might say to signal the intent. For example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas".

In each utterance, a slot name is enclosed in curly braces.

Definition at line 251 of file PutIntentRequest.h.

◆ SetSlots() [1/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetSlots ( Aws::Vector< Slot > &&  value)
inline

An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see how-it-works.

Definition at line 201 of file PutIntentRequest.h.

◆ SetSlots() [2/2]

void Aws::LexModelBuildingService::Model::PutIntentRequest::SetSlots ( const Aws::Vector< Slot > &  value)
inline

An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see how-it-works.

Definition at line 194 of file PutIntentRequest.h.

◆ SlotsHasBeenSet()

bool Aws::LexModelBuildingService::Model::PutIntentRequest::SlotsHasBeenSet ( ) const
inline

An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see how-it-works.

Definition at line 187 of file PutIntentRequest.h.

◆ WithChecksum() [1/3]

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

Identifies a specific revision of the $LATEST version.

When you create a new intent, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a intent, 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 PutIntentRequest.h.

◆ WithChecksum() [2/3]

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

Identifies a specific revision of the $LATEST version.

When you create a new intent, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a intent, 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 PutIntentRequest.h.

◆ WithChecksum() [3/3]

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

Identifies a specific revision of the $LATEST version.

When you create a new intent, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a intent, 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 PutIntentRequest.h.

◆ WithConclusionStatement() [1/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithConclusionStatement ( const Statement value)
inline

The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function.

This element is relevant only if you provide a Lambda function in the fulfillmentActivity. If you return the intent to the client application, you can't specify this element.

The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one.

Definition at line 580 of file PutIntentRequest.h.

◆ WithConclusionStatement() [2/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithConclusionStatement ( Statement &&  value)
inline

The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function.

This element is relevant only if you provide a Lambda function in the fulfillmentActivity. If you return the intent to the client application, you can't specify this element.

The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one.

Definition at line 591 of file PutIntentRequest.h.

◆ WithConfirmationPrompt() [1/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithConfirmationPrompt ( const Prompt value)
inline

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

You you must provide both the rejectionStatement and the confirmationPrompt, or neither.

Definition at line 359 of file PutIntentRequest.h.

◆ WithConfirmationPrompt() [2/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithConfirmationPrompt ( Prompt &&  value)
inline

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

You you must provide both the rejectionStatement and the confirmationPrompt, or neither.

Definition at line 372 of file PutIntentRequest.h.

◆ WithCreateVersion()

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

When set to true a new numbered version of the intent is created. This is the same as calling the CreateIntentVersion operation. If you do not specify createVersion, the default is false.

Definition at line 920 of file PutIntentRequest.h.

◆ WithDescription() [1/3]

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

A description of the intent.

Definition at line 167 of file PutIntentRequest.h.

◆ WithDescription() [2/3]

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

A description of the intent.

Definition at line 162 of file PutIntentRequest.h.

◆ WithDescription() [3/3]

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

A description of the intent.

Definition at line 172 of file PutIntentRequest.h.

◆ WithDialogCodeHook() [1/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithDialogCodeHook ( CodeHook &&  value)
inline

Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize user interaction.

For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, GlutenIntolerant, to true. You might find John's phone number and set the corresponding session attribute.

Definition at line 658 of file PutIntentRequest.h.

◆ WithDialogCodeHook() [2/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithDialogCodeHook ( const CodeHook value)
inline

Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize user interaction.

For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, GlutenIntolerant, to true. You might find John's phone number and set the corresponding session attribute.

Definition at line 647 of file PutIntentRequest.h.

◆ WithFollowUpPrompt() [1/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithFollowUpPrompt ( const FollowUpPrompt value)
inline

Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the OrderPizza intent is fulfilled, you might prompt the user to order a drink.

The action that Amazon Lex takes depends on the user's response, as follows:

  • If the user says "Yes" it responds with the clarification prompt that is configured for the bot.

  • if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation for the intent.

  • If the user says "No" it responds with the rejection statement configured for the the follow-up prompt.

  • If it doesn't recognize the utterance it repeats the follow-up prompt again.

The followUpPrompt field and the conclusionStatement field are mutually exclusive. You can specify only one.

Definition at line 508 of file PutIntentRequest.h.

◆ WithFollowUpPrompt() [2/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithFollowUpPrompt ( FollowUpPrompt &&  value)
inline

Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the OrderPizza intent is fulfilled, you might prompt the user to order a drink.

The action that Amazon Lex takes depends on the user's response, as follows:

  • If the user says "Yes" it responds with the clarification prompt that is configured for the bot.

  • if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation for the intent.

  • If the user says "No" it responds with the rejection statement configured for the the follow-up prompt.

  • If it doesn't recognize the utterance it repeats the follow-up prompt again.

The followUpPrompt field and the conclusionStatement field are mutually exclusive. You can specify only one.

Definition at line 524 of file PutIntentRequest.h.

◆ WithFulfillmentActivity() [1/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithFulfillmentActivity ( const FulfillmentActivity value)
inline

Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a pizza order, fulfillmentActivity defines how the bot places an order with a local pizza store.

You might configure Amazon Lex to return all of the intent information to the client application, or direct it to invoke a Lambda function that can process the intent (for example, place an order with a pizzeria).

Definition at line 714 of file PutIntentRequest.h.

◆ WithFulfillmentActivity() [2/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithFulfillmentActivity ( FulfillmentActivity &&  value)
inline

Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a pizza order, fulfillmentActivity defines how the bot places an order with a local pizza store.

You might configure Amazon Lex to return all of the intent information to the client application, or direct it to invoke a Lambda function that can process the intent (for example, place an order with a pizzeria).

Definition at line 725 of file PutIntentRequest.h.

◆ WithInputContexts() [1/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithInputContexts ( Aws::Vector< InputContext > &&  value)
inline

An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

Definition at line 1018 of file PutIntentRequest.h.

◆ WithInputContexts() [2/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithInputContexts ( const Aws::Vector< InputContext > &  value)
inline

An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

Definition at line 1011 of file PutIntentRequest.h.

◆ WithKendraConfiguration() [1/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithKendraConfiguration ( const KendraConfiguration value)
inline

Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.

Definition at line 966 of file PutIntentRequest.h.

◆ WithKendraConfiguration() [2/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithKendraConfiguration ( KendraConfiguration &&  value)
inline

Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. For more information, see AMAZON.KendraSearchIntent.

Definition at line 975 of file PutIntentRequest.h.

◆ WithName() [1/3]

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

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

The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For example, because there is a built-in intent called AMAZON.HelpIntent, you can't create a custom intent called HelpIntent.

For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit.

Definition at line 120 of file PutIntentRequest.h.

◆ WithName() [2/3]

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

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

The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For example, because there is a built-in intent called AMAZON.HelpIntent, you can't create a custom intent called HelpIntent.

For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit.

Definition at line 109 of file PutIntentRequest.h.

◆ WithName() [3/3]

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

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

The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For example, because there is a built-in intent called AMAZON.HelpIntent, you can't create a custom intent called HelpIntent.

For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit.

Definition at line 131 of file PutIntentRequest.h.

◆ WithOutputContexts() [1/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithOutputContexts ( Aws::Vector< OutputContext > &&  value)
inline

An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

Definition at line 1069 of file PutIntentRequest.h.

◆ WithOutputContexts() [2/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithOutputContexts ( const Aws::Vector< OutputContext > &  value)
inline

An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

Definition at line 1063 of file PutIntentRequest.h.

◆ WithParentIntentSignature() [1/3]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithParentIntentSignature ( Aws::String &&  value)
inline

A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

Definition at line 782 of file PutIntentRequest.h.

◆ WithParentIntentSignature() [2/3]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithParentIntentSignature ( const Aws::String value)
inline

A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

Definition at line 774 of file PutIntentRequest.h.

◆ WithParentIntentSignature() [3/3]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithParentIntentSignature ( const char *  value)
inline

A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

Definition at line 790 of file PutIntentRequest.h.

◆ WithRejectionStatement() [1/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithRejectionStatement ( const Statement value)
inline

When the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

You must provide both the rejectionStatement and the confirmationPrompt, or neither.

Definition at line 418 of file PutIntentRequest.h.

◆ WithRejectionStatement() [2/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithRejectionStatement ( Statement &&  value)
inline

When the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

You must provide both the rejectionStatement and the confirmationPrompt, or neither.

Definition at line 427 of file PutIntentRequest.h.

◆ WithSampleUtterances() [1/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithSampleUtterances ( Aws::Vector< Aws::String > &&  value)
inline

An array of utterances (strings) that a user might say to signal the intent. For example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas".

In each utterance, a slot name is enclosed in curly braces.

Definition at line 272 of file PutIntentRequest.h.

◆ WithSampleUtterances() [2/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithSampleUtterances ( const Aws::Vector< Aws::String > &  value)
inline

An array of utterances (strings) that a user might say to signal the intent. For example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas".

In each utterance, a slot name is enclosed in curly braces.

Definition at line 265 of file PutIntentRequest.h.

◆ WithSlots() [1/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithSlots ( Aws::Vector< Slot > &&  value)
inline

An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see how-it-works.

Definition at line 215 of file PutIntentRequest.h.

◆ WithSlots() [2/2]

PutIntentRequest& Aws::LexModelBuildingService::Model::PutIntentRequest::WithSlots ( const Aws::Vector< Slot > &  value)
inline

An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see how-it-works.

Definition at line 208 of file PutIntentRequest.h.


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