@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface LexRuntimeV2AsyncClient extends SdkClient
builder()
method.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static LexRuntimeV2AsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
LexRuntimeV2AsyncClient. |
static LexRuntimeV2AsyncClient |
create()
Create a
LexRuntimeV2AsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<DeleteSessionResponse> |
deleteSession(Consumer<DeleteSessionRequest.Builder> deleteSessionRequest)
Removes session information for a specified bot, alias, and user ID.
|
default CompletableFuture<DeleteSessionResponse> |
deleteSession(DeleteSessionRequest deleteSessionRequest)
Removes session information for a specified bot, alias, and user ID.
|
default CompletableFuture<GetSessionResponse> |
getSession(Consumer<GetSessionRequest.Builder> getSessionRequest)
Returns session information for a specified bot, alias, and user.
|
default CompletableFuture<GetSessionResponse> |
getSession(GetSessionRequest getSessionRequest)
Returns session information for a specified bot, alias, and user.
|
default <ReturnT> CompletableFuture<ReturnT> |
putSession(Consumer<PutSessionRequest.Builder> putSessionRequest,
AsyncResponseTransformer<PutSessionResponse,ReturnT> asyncResponseTransformer)
Creates a new session or modifies an existing session with an Amazon Lex bot.
|
default CompletableFuture<PutSessionResponse> |
putSession(Consumer<PutSessionRequest.Builder> putSessionRequest,
Path destinationPath)
Creates a new session or modifies an existing session with an Amazon Lex bot.
|
default <ReturnT> CompletableFuture<ReturnT> |
putSession(PutSessionRequest putSessionRequest,
AsyncResponseTransformer<PutSessionResponse,ReturnT> asyncResponseTransformer)
Creates a new session or modifies an existing session with an Amazon Lex bot.
|
default CompletableFuture<PutSessionResponse> |
putSession(PutSessionRequest putSessionRequest,
Path destinationPath)
Creates a new session or modifies an existing session with an Amazon Lex bot.
|
default CompletableFuture<RecognizeTextResponse> |
recognizeText(Consumer<RecognizeTextRequest.Builder> recognizeTextRequest)
Sends user input to Amazon Lex.
|
default CompletableFuture<RecognizeTextResponse> |
recognizeText(RecognizeTextRequest recognizeTextRequest)
Sends user input to Amazon Lex.
|
default <ReturnT> CompletableFuture<ReturnT> |
recognizeUtterance(Consumer<RecognizeUtteranceRequest.Builder> recognizeUtteranceRequest,
AsyncRequestBody requestBody,
AsyncResponseTransformer<RecognizeUtteranceResponse,ReturnT> asyncResponseTransformer)
Sends user input to Amazon Lex.
|
default CompletableFuture<RecognizeUtteranceResponse> |
recognizeUtterance(Consumer<RecognizeUtteranceRequest.Builder> recognizeUtteranceRequest,
Path sourcePath,
Path destinationPath)
Sends user input to Amazon Lex.
|
default <ReturnT> CompletableFuture<ReturnT> |
recognizeUtterance(RecognizeUtteranceRequest recognizeUtteranceRequest,
AsyncRequestBody requestBody,
AsyncResponseTransformer<RecognizeUtteranceResponse,ReturnT> asyncResponseTransformer)
Sends user input to Amazon Lex.
|
default CompletableFuture<RecognizeUtteranceResponse> |
recognizeUtterance(RecognizeUtteranceRequest recognizeUtteranceRequest,
Path sourcePath,
Path destinationPath)
Sends user input to Amazon Lex.
|
default CompletableFuture<Void> |
startConversation(Consumer<StartConversationRequest.Builder> startConversationRequest,
org.reactivestreams.Publisher<StartConversationRequestEventStream> requestStream,
StartConversationResponseHandler asyncResponseHandler)
Starts an HTTP/2 bidirectional event stream that enables you to send audio, text, or DTMF input in real time.
|
default CompletableFuture<Void> |
startConversation(StartConversationRequest startConversationRequest,
org.reactivestreams.Publisher<StartConversationRequestEventStream> requestStream,
StartConversationResponseHandler asyncResponseHandler)
Starts an HTTP/2 bidirectional event stream that enables you to send audio, text, or DTMF input in real time.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static LexRuntimeV2AsyncClient create()
LexRuntimeV2AsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static LexRuntimeV2AsyncClientBuilder builder()
LexRuntimeV2AsyncClient.default CompletableFuture<DeleteSessionResponse> deleteSession(DeleteSessionRequest deleteSessionRequest)
Removes session information for a specified bot, alias, and user ID.
You can use this operation to restart a conversation with a bot. When you remove a session, the entire history of the session is removed so that you can start again.
You don't need to delete a session. Sessions have a time limit and will expire. Set the session time limit when you create the bot. The default is 5 minutes, but you can specify anything between 1 minute and 24 hours.
If you specify a bot or alias ID that doesn't exist, you receive a BadRequestException.
If the locale doesn't exist in the bot, or if the locale hasn't been enables for the alias, you receive a
BadRequestException.
deleteSessionRequest - default CompletableFuture<DeleteSessionResponse> deleteSession(Consumer<DeleteSessionRequest.Builder> deleteSessionRequest)
Removes session information for a specified bot, alias, and user ID.
You can use this operation to restart a conversation with a bot. When you remove a session, the entire history of the session is removed so that you can start again.
You don't need to delete a session. Sessions have a time limit and will expire. Set the session time limit when you create the bot. The default is 5 minutes, but you can specify anything between 1 minute and 24 hours.
If you specify a bot or alias ID that doesn't exist, you receive a BadRequestException.
If the locale doesn't exist in the bot, or if the locale hasn't been enables for the alias, you receive a
BadRequestException.
This is a convenience which creates an instance of the DeleteSessionRequest.Builder avoiding the need to
create one manually via DeleteSessionRequest.builder()
deleteSessionRequest - A Consumer that will call methods on DeleteSessionRequest.Builder to create a request.default CompletableFuture<GetSessionResponse> getSession(GetSessionRequest getSessionRequest)
Returns session information for a specified bot, alias, and user.
For example, you can use this operation to retrieve session information for a user that has left a long-running session in use.
If the bot, alias, or session identifier doesn't exist, Amazon Lex returns a BadRequestException. If
the locale doesn't exist or is not enabled for the alias, you receive a BadRequestException.
getSessionRequest - default CompletableFuture<GetSessionResponse> getSession(Consumer<GetSessionRequest.Builder> getSessionRequest)
Returns session information for a specified bot, alias, and user.
For example, you can use this operation to retrieve session information for a user that has left a long-running session in use.
If the bot, alias, or session identifier doesn't exist, Amazon Lex returns a BadRequestException. If
the locale doesn't exist or is not enabled for the alias, you receive a BadRequestException.
This is a convenience which creates an instance of the GetSessionRequest.Builder avoiding the need to
create one manually via GetSessionRequest.builder()
getSessionRequest - A Consumer that will call methods on GetSessionRequest.Builder to create a request.default <ReturnT> CompletableFuture<ReturnT> putSession(PutSessionRequest putSessionRequest, AsyncResponseTransformer<PutSessionResponse,ReturnT> asyncResponseTransformer)
Creates 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.
putSessionRequest - asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
If the requested content type was audio, the audio version of the message to convey to the user.
'.default <ReturnT> CompletableFuture<ReturnT> putSession(Consumer<PutSessionRequest.Builder> putSessionRequest, AsyncResponseTransformer<PutSessionResponse,ReturnT> asyncResponseTransformer)
Creates 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.
This is a convenience which creates an instance of the PutSessionRequest.Builder avoiding the need to
create one manually via PutSessionRequest.builder()
putSessionRequest - A Consumer that will call methods on PutSessionRequest.Builder to create a request.asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
If the requested content type was audio, the audio version of the message to convey to the user.
'.default CompletableFuture<PutSessionResponse> putSession(PutSessionRequest putSessionRequest, Path destinationPath)
Creates 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.
putSessionRequest - destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
If the requested content type was audio, the audio version of the message to convey to the user.
'.default CompletableFuture<PutSessionResponse> putSession(Consumer<PutSessionRequest.Builder> putSessionRequest, Path destinationPath)
Creates 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.
This is a convenience which creates an instance of the PutSessionRequest.Builder avoiding the need to
create one manually via PutSessionRequest.builder()
putSessionRequest - A Consumer that will call methods on PutSessionRequest.Builder to create a request.destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
If the requested content type was audio, the audio version of the message to convey to the user.
'.default CompletableFuture<RecognizeTextResponse> recognizeText(RecognizeTextRequest recognizeTextRequest)
Sends user input to Amazon Lex. Client applications use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model that it build for the bot.
In response, Amazon Lex returns the next message to convey to the user and an optional response card to display.
recognizeTextRequest - default CompletableFuture<RecognizeTextResponse> recognizeText(Consumer<RecognizeTextRequest.Builder> recognizeTextRequest)
Sends user input to Amazon Lex. Client applications use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model that it build for the bot.
In response, Amazon Lex returns the next message to convey to the user and an optional response card to display.
This is a convenience which creates an instance of the RecognizeTextRequest.Builder avoiding the need to
create one manually via RecognizeTextRequest.builder()
recognizeTextRequest - A Consumer that will call methods on RecognizeTextRequest.Builder to create a request.default <ReturnT> CompletableFuture<ReturnT> recognizeUtterance(RecognizeUtteranceRequest recognizeUtteranceRequest, AsyncRequestBody requestBody, AsyncResponseTransformer<RecognizeUtteranceResponse,ReturnT> asyncResponseTransformer)
Sends user input to Amazon Lex. You can send text or speech. 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 built for the bot.
recognizeUtteranceRequest - requestBody - Functional interface that can be implemented to produce the request content in a non-blocking manner. The
size of the content is expected to be known up front. See AsyncRequestBody for specific details on
implementing this interface as well as links to precanned implementations for common scenarios like
uploading from a file. The service documentation for the request content is as follows '
User input in PCM or Opus audio format or text format as described in the requestContentType
parameter.
asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
The prompt or statement to send to the user. This is based on the bot configuration and context. For
example, if Amazon Lex did not understand the user intent, it sends the clarificationPrompt
configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends
the confirmationPrompt. Another example: Suppose that the Lambda function successfully
fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the
response.
default <ReturnT> CompletableFuture<ReturnT> recognizeUtterance(Consumer<RecognizeUtteranceRequest.Builder> recognizeUtteranceRequest, AsyncRequestBody requestBody, AsyncResponseTransformer<RecognizeUtteranceResponse,ReturnT> asyncResponseTransformer)
Sends user input to Amazon Lex. You can send text or speech. 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 built for the bot.
This is a convenience which creates an instance of the RecognizeUtteranceRequest.Builder avoiding the
need to create one manually via RecognizeUtteranceRequest.builder()
recognizeUtteranceRequest - A Consumer that will call methods on RecognizeUtteranceRequest.Builder to create a
request.requestBody - Functional interface that can be implemented to produce the request content in a non-blocking manner. The
size of the content is expected to be known up front. See AsyncRequestBody for specific details on
implementing this interface as well as links to precanned implementations for common scenarios like
uploading from a file. The service documentation for the request content is as follows '
User input in PCM or Opus audio format or text format as described in the requestContentType
parameter.
asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
The prompt or statement to send to the user. This is based on the bot configuration and context. For
example, if Amazon Lex did not understand the user intent, it sends the clarificationPrompt
configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends
the confirmationPrompt. Another example: Suppose that the Lambda function successfully
fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the
response.
default CompletableFuture<RecognizeUtteranceResponse> recognizeUtterance(RecognizeUtteranceRequest recognizeUtteranceRequest, Path sourcePath, Path destinationPath)
Sends user input to Amazon Lex. You can send text or speech. 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 built for the bot.
recognizeUtteranceRequest - sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows '
User input in PCM or Opus audio format or text format as described in the requestContentType
parameter.
destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
The prompt or statement to send to the user. This is based on the bot configuration and context. For
example, if Amazon Lex did not understand the user intent, it sends the clarificationPrompt
configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends
the confirmationPrompt. Another example: Suppose that the Lambda function successfully
fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the
response.
default CompletableFuture<RecognizeUtteranceResponse> recognizeUtterance(Consumer<RecognizeUtteranceRequest.Builder> recognizeUtteranceRequest, Path sourcePath, Path destinationPath)
Sends user input to Amazon Lex. You can send text or speech. 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 built for the bot.
This is a convenience which creates an instance of the RecognizeUtteranceRequest.Builder avoiding the
need to create one manually via RecognizeUtteranceRequest.builder()
recognizeUtteranceRequest - A Consumer that will call methods on RecognizeUtteranceRequest.Builder to create a
request.sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows '
User input in PCM or Opus audio format or text format as described in the requestContentType
parameter.
destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
The prompt or statement to send to the user. This is based on the bot configuration and context. For
example, if Amazon Lex did not understand the user intent, it sends the clarificationPrompt
configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends
the confirmationPrompt. Another example: Suppose that the Lambda function successfully
fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the
response.
default CompletableFuture<Void> startConversation(StartConversationRequest startConversationRequest, org.reactivestreams.Publisher<StartConversationRequestEventStream> requestStream, StartConversationResponseHandler asyncResponseHandler)
Starts an HTTP/2 bidirectional event stream that enables you to send audio, text, or DTMF input in real time. After your application starts a conversation, users send input to Amazon Lex as a stream of events. Amazon Lex processes the incoming events and responds with streaming text or audio events.
startConversationRequest - default CompletableFuture<Void> startConversation(Consumer<StartConversationRequest.Builder> startConversationRequest, org.reactivestreams.Publisher<StartConversationRequestEventStream> requestStream, StartConversationResponseHandler asyncResponseHandler)
Starts an HTTP/2 bidirectional event stream that enables you to send audio, text, or DTMF input in real time. After your application starts a conversation, users send input to Amazon Lex as a stream of events. Amazon Lex processes the incoming events and responds with streaming text or audio events.
This is a convenience which creates an instance of the StartConversationRequest.Builder avoiding the need
to create one manually via StartConversationRequest.builder()
startConversationRequest - A Consumer that will call methods on StartConversationRequest.Builder to create a request.Copyright © 2021. All rights reserved.