com.amazonaws.services.lexruntimev2

Interface AmazonLexRuntimeV2Async

All Superinterfaces:

AmazonLexRuntimeV2

All Known Implementing Classes:

AbstractAmazonLexRuntimeV2Async, AmazonLexRuntimeV2AsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonLexRuntimeV2Async
extends AmazonLexRuntimeV2

Interface for accessing Lex Runtime V2 asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonLexRuntimeV2Async instead.

This section contains documentation for the Amazon Lex V2 Runtime V2 API operations.

Field Summary

Fields inherited from interface com.amazonaws.services.lexruntimev2.AmazonLexRuntimeV2

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<DeleteSessionResult>	deleteSessionAsync(DeleteSessionRequest deleteSessionRequest) Removes session information for a specified bot, alias, and user ID.
Future<DeleteSessionResult>	deleteSessionAsync(DeleteSessionRequest deleteSessionRequest, AsyncHandler<DeleteSessionRequest,DeleteSessionResult> asyncHandler) Removes session information for a specified bot, alias, and user ID.
Future<GetSessionResult>	getSessionAsync(GetSessionRequest getSessionRequest) Returns session information for a specified bot, alias, and user.
Future<GetSessionResult>	getSessionAsync(GetSessionRequest getSessionRequest, AsyncHandler<GetSessionRequest,GetSessionResult> asyncHandler) Returns session information for a specified bot, alias, and user.
Future<PutSessionResult>	putSessionAsync(PutSessionRequest putSessionRequest) Creates a new session or modifies an existing session with an Amazon Lex V2 bot.
Future<PutSessionResult>	putSessionAsync(PutSessionRequest putSessionRequest, AsyncHandler<PutSessionRequest,PutSessionResult> asyncHandler) Creates a new session or modifies an existing session with an Amazon Lex V2 bot.
Future<RecognizeTextResult>	recognizeTextAsync(RecognizeTextRequest recognizeTextRequest) Sends user input to Amazon Lex V2.
Future<RecognizeTextResult>	recognizeTextAsync(RecognizeTextRequest recognizeTextRequest, AsyncHandler<RecognizeTextRequest,RecognizeTextResult> asyncHandler) Sends user input to Amazon Lex V2.
Future<RecognizeUtteranceResult>	recognizeUtteranceAsync(RecognizeUtteranceRequest recognizeUtteranceRequest) Sends user input to Amazon Lex V2.
Future<RecognizeUtteranceResult>	recognizeUtteranceAsync(RecognizeUtteranceRequest recognizeUtteranceRequest, AsyncHandler<RecognizeUtteranceRequest,RecognizeUtteranceResult> asyncHandler) Sends user input to Amazon Lex V2.

Methods inherited from interface com.amazonaws.services.lexruntimev2.AmazonLexRuntimeV2

deleteSession, getCachedResponseMetadata, getSession, putSession, recognizeText, recognizeUtterance, shutdown

Method Detail

deleteSessionAsync

Future<DeleteSessionResult> deleteSessionAsync(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.

Parameters:

deleteSessionRequest -

Returns:

A Java Future containing the result of the DeleteSession operation returned by the service.

See Also:

AWS API Documentation

deleteSessionAsync

Future<DeleteSessionResult> deleteSessionAsync(DeleteSessionRequest deleteSessionRequest,
                                               AsyncHandler<DeleteSessionRequest,DeleteSessionResult> asyncHandler)

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.

Parameters:

deleteSessionRequest -

asyncHandler - 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.

Returns:

A Java Future containing the result of the DeleteSession operation returned by the service.

See Also:

AWS API Documentation

getSessionAsync

Future<GetSessionResult> getSessionAsync(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 V2 returns a BadRequestException. If the locale doesn't exist or is not enabled for the alias, you receive a BadRequestException.

Parameters:

getSessionRequest -

Returns:

A Java Future containing the result of the GetSession operation returned by the service.

See Also:

AWS API Documentation

getSessionAsync

Future<GetSessionResult> getSessionAsync(GetSessionRequest getSessionRequest,
                                         AsyncHandler<GetSessionRequest,GetSessionResult> asyncHandler)

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 V2 returns a BadRequestException. If the locale doesn't exist or is not enabled for the alias, you receive a BadRequestException.

Parameters:

getSessionRequest -

asyncHandler - 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.

Returns:

A Java Future containing the result of the GetSession operation returned by the service.

See Also:

AWS API Documentation

putSessionAsync

Future<PutSessionResult> putSessionAsync(PutSessionRequest putSessionRequest)

Creates a new session or modifies an existing session with an Amazon Lex V2 bot. Use this operation to enable your application to set the state of the bot.

Parameters:

putSessionRequest -

Returns:

A Java Future containing the result of the PutSession operation returned by the service.

See Also:

AWS API Documentation

putSessionAsync

Future<PutSessionResult> putSessionAsync(PutSessionRequest putSessionRequest,
                                         AsyncHandler<PutSessionRequest,PutSessionResult> asyncHandler)

Creates a new session or modifies an existing session with an Amazon Lex V2 bot. Use this operation to enable your application to set the state of the bot.

Parameters:

putSessionRequest -

asyncHandler - 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.

Returns:

A Java Future containing the result of the PutSession operation returned by the service.

See Also:

AWS API Documentation

recognizeTextAsync

Future<RecognizeTextResult> recognizeTextAsync(RecognizeTextRequest recognizeTextRequest)

Sends user input to Amazon Lex V2. Client applications use this API to send requests to Amazon Lex V2 at runtime. Amazon Lex V2 then interprets the user input using the machine learning model that it build for the bot.

In response, Amazon Lex V2 returns the next message to convey to the user and an optional response card to display.

If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see PostFulfillmentStatusSpecification.

• Success message - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.

• Failed message - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.

• Timeout message - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.

For more information, see Completion message.

Parameters:

recognizeTextRequest -

Returns:

A Java Future containing the result of the RecognizeText operation returned by the service.

See Also:

AWS API Documentation

recognizeTextAsync

Future<RecognizeTextResult> recognizeTextAsync(RecognizeTextRequest recognizeTextRequest,
                                               AsyncHandler<RecognizeTextRequest,RecognizeTextResult> asyncHandler)

Sends user input to Amazon Lex V2. Client applications use this API to send requests to Amazon Lex V2 at runtime. Amazon Lex V2 then interprets the user input using the machine learning model that it build for the bot.

In response, Amazon Lex V2 returns the next message to convey to the user and an optional response card to display.

If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see PostFulfillmentStatusSpecification.

• Success message - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.

• Failed message - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.

• Timeout message - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.

For more information, see Completion message.

Parameters:

recognizeTextRequest -

asyncHandler - 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.

Returns:

A Java Future containing the result of the RecognizeText operation returned by the service.

See Also:

AWS API Documentation

recognizeUtteranceAsync

Future<RecognizeUtteranceResult> recognizeUtteranceAsync(RecognizeUtteranceRequest recognizeUtteranceRequest)

Sends user input to Amazon Lex V2. You can send text or speech. Clients use this API to send text and audio requests to Amazon Lex V2 at runtime. Amazon Lex V2 interprets the user input using the machine learning model built for the bot.

The following request fields must be compressed with gzip and then base64 encoded before you send them to Amazon Lex V2.

• requestAttributes

• sessionState

The following response fields are compressed using gzip and then base64 encoded by Amazon Lex V2. Before you can use these fields, you must decode and decompress them.

• inputTranscript

• interpretations

• messages

• requestAttributes

• sessionState

The example contains a Java application that compresses and encodes a Java object to send to Amazon Lex V2, and a second that decodes and decompresses a response from Amazon Lex V2.

If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see PostFulfillmentStatusSpecification.

• Success message - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.

• Failed message - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.

• Timeout message - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.

For more information, see Completion message.

Parameters:

recognizeUtteranceRequest -

Returns:

A Java Future containing the result of the RecognizeUtterance operation returned by the service.

See Also:

AWS API Documentation

recognizeUtteranceAsync

Future<RecognizeUtteranceResult> recognizeUtteranceAsync(RecognizeUtteranceRequest recognizeUtteranceRequest,
                                                         AsyncHandler<RecognizeUtteranceRequest,RecognizeUtteranceResult> asyncHandler)

Sends user input to Amazon Lex V2. You can send text or speech. Clients use this API to send text and audio requests to Amazon Lex V2 at runtime. Amazon Lex V2 interprets the user input using the machine learning model built for the bot.

The following request fields must be compressed with gzip and then base64 encoded before you send them to Amazon Lex V2.

• requestAttributes

• sessionState

The following response fields are compressed using gzip and then base64 encoded by Amazon Lex V2. Before you can use these fields, you must decode and decompress them.

• inputTranscript

• interpretations

• messages

• requestAttributes

• sessionState

The example contains a Java application that compresses and encodes a Java object to send to Amazon Lex V2, and a second that decodes and decompresses a response from Amazon Lex V2.

If the optional post-fulfillment response is specified, the messages are returned as follows. For more information, see PostFulfillmentStatusSpecification.

• Success message - Returned if the Lambda function completes successfully and the intent state is fulfilled or ready fulfillment if the message is present.

• Failed message - The failed message is returned if the Lambda function throws an exception or if the Lambda function returns a failed intent state without a message.

• Timeout message - If you don't configure a timeout message and a timeout, and the Lambda function doesn't return within 30 seconds, the timeout message is returned. If you configure a timeout, the timeout message is returned when the period times out.

For more information, see Completion message.

Parameters:

recognizeUtteranceRequest -

asyncHandler - 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.

Returns:

A Java Future containing the result of the RecognizeUtterance operation returned by the service.

See Also:

AWS API Documentation