AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the PostContent operation. Sends user input (text or speech) to Amazon Lex. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model that it built for the bot.
The PostContent
operation supports audio input at 8kHz and 16kHz. You can use
8kHz audio to achieve higher speech recognition accuracy in telephone audio applications.
In response, Amazon Lex returns the next message to convey to the user. 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 get user confirmation: "Order the pizza?".
After the user replies "Yes" to the confirmation prompt, Amazon Lex might return a conclusion statement: "Thank you, your cheese pizza has been ordered.".
Not all Amazon Lex messages require a response from the user. For example, conclusion
statements do not require a response. Some messages require only a yes or no response.
In addition to the message
, Amazon Lex provides additional context about the
message in the response that you can use to enhance client behavior, such as displaying
the appropriate client user interface. Consider the following examples:
If the message is to elicit slot data, Amazon Lex returns the following context information:
x-amz-lex-dialog-state
header set to ElicitSlot
x-amz-lex-intent-name
header set to the intent name in the current context
x-amz-lex-slot-to-elicit
header set to the slot name for which the message
is eliciting information
x-amz-lex-slots
header set to a map of slots configured for the intent with
their current values
If the message is a confirmation prompt, the x-amz-lex-dialog-state
header
is set to Confirmation
and the x-amz-lex-slot-to-elicit
header is omitted.
If the message is a clarification prompt configured for the intent, indicating that
the user intent is not understood, the x-amz-dialog-state
header is set to
ElicitIntent
and the x-amz-slot-to-elicit
header is omitted.
In addition, Amazon Lex also returns your application-specific sessionAttributes
.
For more information, see Managing
Conversation Context.
Namespace: Amazon.Lex.Model
Assembly: AWSSDK.Lex.dll
Version: 3.x.y.z
public class PostContentRequest : AmazonLexRequest IAmazonWebServiceRequest
The PostContentRequest type exposes the following members
Name | Description | |
---|---|---|
PostContentRequest() |
Name | Type | Description | |
---|---|---|---|
Accept | System.String |
Gets and sets the property Accept.
You pass this value as the
The message Amazon Lex returns in the response can be either text or speech based
on the
|
|
ActiveContexts | System.String |
Gets and sets the property ActiveContexts. A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request, If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared. |
|
BotAlias | System.String |
Gets and sets the property BotAlias. Alias of the Amazon Lex bot. |
|
BotName | System.String |
Gets and sets the property BotName. Name of the Amazon Lex bot. |
|
ContentType | System.String |
Gets and sets the property ContentType.
You pass this value as the Indicates the audio format or text. The header value must start with one of the following prefixes:
|
|
InputStream | System.IO.Stream |
Gets and sets the property InputStream.
User input in PCM or Opus audio format or text format as described in the You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally. |
|
RequestAttributes | System.String |
Gets and sets the property RequestAttributes.
You pass this value as the
Request-specific information passed between Amazon Lex and a client application. The
value must be a JSON serialized and base64 encoded map with string keys and values.
The total size of the
The namespace For more information, see Setting Request Attributes. |
|
SessionAttributes | System.String |
Gets and sets the property SessionAttributes.
You pass this value as the
Application-specific information passed between Amazon Lex and a client application.
The value must be a JSON serialized and base64 encoded map with string keys and values.
The total size of the For more information, see Setting Session Attributes. |
|
UserId | System.String |
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.
|
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5