Container for the parameters to the PostText operation. Sends user input (text-only) to Amazon Lex. Client applications can use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model it built for the bot.
In response, Amazon Lex returns the next
message to convey to the user
responseCard to display. Consider the following example messages:
For a user input "I would like a pizza", Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): "What size pizza would you like?"
After the user provides all of the pizza order information, Amazon Lex might return a response with a message to obtain user confirmation "Proceed with the pizza order?".
After the user replies to a confirmation prompt with a "yes", Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.".
Not all Amazon Lex messages require a user response. For example, a conclusion statement
does not require a response. Some messages require only a "yes" or "no" user response.
In addition to the
message, Amazon Lex provides additional context about
the message in the response that you might use to enhance client behavior, for example,
to display the appropriate client user interface. These are the
slots fields in
the response. Consider the following examples:
If the message is to elicit slot data, Amazon Lex returns the following context information:
dialogState set to ElicitSlot
intentName set to the intent name in the current context
slotToElicit set to the slot name for which the
is eliciting information
slots set to a map of slots, configured for the intent, with currently
If the message is a confirmation prompt, the
dialogState is set to ConfirmIntent
SlotToElicit is set to null.
If the message is a clarification prompt (configured for the intent) that indicates
that user intent is not understood, the
dialogState is set to ElicitIntent
slotToElicit is set to null.
In addition, Amazon Lex also returns your application-specific
For more information, see Managing
public class PostTextRequest : AmazonLexRequest IAmazonWebServiceRequest
The PostTextRequest type exposes the following members
Gets and sets the property BotAlias.
The alias of the Amazon Lex bot.
Gets and sets the property BotName.
The name of the Amazon Lex bot.
Gets and sets the property InputText.
The text that the user entered (Amazon Lex interprets this text).
Gets and sets the property RequestAttributes.
Request-specific information passed between Amazon Lex and a client application.
For more information, see Setting Request Attributes.
Gets and sets the property SessionAttributes.
Application-specific information passed between Amazon Lex and a client application.
For more information, see Setting Session Attributes.
Gets and sets the property UserId.
The ID of the client application user. Amazon Lex uses this to identify a user's conversation
with your bot. At runtime, each request must contain the
To decide the user ID to use for your application, consider the following factors.
Supported in: 1.3
Supported in: 4.5, 4.0, 3.5
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms