@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonLexRuntimeAsync extends AbstractAmazonLexRuntime implements AmazonLexRuntimeAsync
AmazonLexRuntimeAsync. Convenient method forms pass through to the corresponding
overload that takes a request object and an AsyncHandler, which throws an
UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
Future<DeleteSessionResult> |
deleteSessionAsync(DeleteSessionRequest request)
Removes session information for a specified bot, alias, and user ID.
|
Future<DeleteSessionResult> |
deleteSessionAsync(DeleteSessionRequest request,
AsyncHandler<DeleteSessionRequest,DeleteSessionResult> asyncHandler)
Removes session information for a specified bot, alias, and user ID.
|
Future<GetSessionResult> |
getSessionAsync(GetSessionRequest request)
Returns session information for a specified bot, alias, and user ID.
|
Future<GetSessionResult> |
getSessionAsync(GetSessionRequest request,
AsyncHandler<GetSessionRequest,GetSessionResult> asyncHandler)
Returns session information for a specified bot, alias, and user ID.
|
Future<PostContentResult> |
postContentAsync(PostContentRequest request)
Sends user input (text or speech) to Amazon Lex.
|
Future<PostContentResult> |
postContentAsync(PostContentRequest request,
AsyncHandler<PostContentRequest,PostContentResult> asyncHandler)
Sends user input (text or speech) to Amazon Lex.
|
Future<PostTextResult> |
postTextAsync(PostTextRequest request)
Sends user input to Amazon Lex.
|
Future<PostTextResult> |
postTextAsync(PostTextRequest request,
AsyncHandler<PostTextRequest,PostTextResult> asyncHandler)
Sends user input to Amazon Lex.
|
Future<PutSessionResult> |
putSessionAsync(PutSessionRequest request)
Creates a new session or modifies an existing session with an Amazon Lex bot.
|
Future<PutSessionResult> |
putSessionAsync(PutSessionRequest request,
AsyncHandler<PutSessionRequest,PutSessionResult> asyncHandler)
Creates a new session or modifies an existing session with an Amazon Lex bot.
|
deleteSession, getCachedResponseMetadata, getSession, postContent, postText, putSession, shutdownequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdeleteSession, getCachedResponseMetadata, getSession, postContent, postText, putSession, shutdownpublic Future<DeleteSessionResult> deleteSessionAsync(DeleteSessionRequest request)
AmazonLexRuntimeAsyncRemoves session information for a specified bot, alias, and user ID.
deleteSessionAsync in interface AmazonLexRuntimeAsyncpublic Future<DeleteSessionResult> deleteSessionAsync(DeleteSessionRequest request, AsyncHandler<DeleteSessionRequest,DeleteSessionResult> asyncHandler)
AmazonLexRuntimeAsyncRemoves session information for a specified bot, alias, and user ID.
deleteSessionAsync in interface AmazonLexRuntimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetSessionResult> getSessionAsync(GetSessionRequest request)
AmazonLexRuntimeAsyncReturns session information for a specified bot, alias, and user ID.
getSessionAsync in interface AmazonLexRuntimeAsyncpublic Future<GetSessionResult> getSessionAsync(GetSessionRequest request, AsyncHandler<GetSessionRequest,GetSessionResult> asyncHandler)
AmazonLexRuntimeAsyncReturns session information for a specified bot, alias, and user ID.
getSessionAsync in interface AmazonLexRuntimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PostContentResult> postContentAsync(PostContentRequest request)
AmazonLexRuntimeAsyncSends 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.
postContentAsync in interface AmazonLexRuntimeAsyncpublic Future<PostContentResult> postContentAsync(PostContentRequest request, AsyncHandler<PostContentRequest,PostContentResult> asyncHandler)
AmazonLexRuntimeAsyncSends 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.
postContentAsync in interface AmazonLexRuntimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PostTextResult> postTextAsync(PostTextRequest request)
AmazonLexRuntimeAsyncSends user input 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 an optional
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 slotToElicit,
dialogState, intentName, and 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 message is eliciting information
slots set to a map of slots, configured for the intent, with currently known values
If the message is a confirmation prompt, the dialogState is set to ConfirmIntent and
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 and slotToElicit is set to null.
In addition, Amazon Lex also returns your application-specific sessionAttributes. For more
information, see Managing Conversation
Context.
postTextAsync in interface AmazonLexRuntimeAsyncpublic Future<PostTextResult> postTextAsync(PostTextRequest request, AsyncHandler<PostTextRequest,PostTextResult> asyncHandler)
AmazonLexRuntimeAsyncSends user input 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 an optional
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 slotToElicit,
dialogState, intentName, and 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 message is eliciting information
slots set to a map of slots, configured for the intent, with currently known values
If the message is a confirmation prompt, the dialogState is set to ConfirmIntent and
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 and slotToElicit is set to null.
In addition, Amazon Lex also returns your application-specific sessionAttributes. For more
information, see Managing Conversation
Context.
postTextAsync in interface AmazonLexRuntimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutSessionResult> putSessionAsync(PutSessionRequest request)
AmazonLexRuntimeAsyncCreates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot.
For more information, see Managing Sessions.
putSessionAsync in interface AmazonLexRuntimeAsyncpublic Future<PutSessionResult> putSessionAsync(PutSessionRequest request, AsyncHandler<PutSessionRequest,PutSessionResult> asyncHandler)
AmazonLexRuntimeAsyncCreates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot.
For more information, see Managing Sessions.
putSessionAsync in interface AmazonLexRuntimeAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.