com.amazonaws.services.lexrts

Class AmazonLexRuntimeClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.lexrts.AmazonLexRuntimeClient

All Implemented Interfaces:

AmazonLexRuntime

public class AmazonLexRuntimeClient
extends AmazonWebServiceClient
implements AmazonLexRuntime

Client for accessing Amazon Lex Runtime Service. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Lex provides both build and runtime endpoints. Each endpoint provides a set of operations (API). Your conversational bot uses the runtime API to understand user utterances (user input text or voice). For example, suppose a user says "I want pizza", your bot sends this input to Amazon Lex using the runtime API. Amazon Lex recognizes that the user request is for the OrderPizza intent (one of the intents defined in the bot). Then Amazon Lex engages in user conversation on behalf of the bot to elicit required information (slot values, such as pizza size and crust type), and then performs fulfillment activity (that you configured when you created the bot). You use the build-time API to create and manage your Amazon Lex bot. For a list of build-time operations, see the build-time API, .

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Constructor Summary

Constructors

Constructor and Description
AmazonLexRuntimeClient() Deprecated.
AmazonLexRuntimeClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonLexRuntime using the specified AWS account credentials.
AmazonLexRuntimeClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonLexRuntime using the specified AWS account credentials and client configuration options.
AmazonLexRuntimeClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonLexRuntime using the specified AWS account credentials provider.
AmazonLexRuntimeClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonLexRuntime using the specified AWS account credentials provider and client configuration options.
AmazonLexRuntimeClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient) Constructs a new client to invoke service methods on AmazonLexRuntime using the specified AWS account credentials provider, client configuration options and request metric collector.
AmazonLexRuntimeClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector) Deprecated.
AmazonLexRuntimeClient(ClientConfiguration clientConfiguration) Deprecated.

Method Summary

Modifier and Type	Method and Description
DeleteSessionResult	deleteSession(DeleteSessionRequest deleteSessionRequest) Removes session information for a specified bot, alias, and user ID.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
GetSessionResult	getSession(GetSessionRequest getSessionRequest) Returns session information for a specified bot, alias, and user ID.
PostContentResult	postContent(PostContentRequest postContentRequest) Sends user input (text or speech) to Amazon Lex.
PostTextResult	postText(PostTextRequest postTextRequest) Sends user input to Amazon Lex.
PutSessionResult	putSession(PutSessionRequest putSessionRequest) Creates a new session or modifies an existing session with an Amazon Lex bot.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.lexrts.AmazonLexRuntime

setEndpoint, setRegion, shutdown

Constructor Detail

AmazonLexRuntimeClient

@Deprecated
public AmazonLexRuntimeClient()

Deprecated.

Constructs a new client to invoke service methods on AmazonLexRuntime. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonLexRuntimeClient

@Deprecated
public AmazonLexRuntimeClient(ClientConfiguration clientConfiguration)

Deprecated.

Constructs a new client to invoke service methods on AmazonLexRuntime. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonLexRuntime (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonLexRuntimeClient

public AmazonLexRuntimeClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonLexRuntime using the specified AWS account credentials.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonLexRuntimeClient client = new AmazonLexRuntimeClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonLexRuntimeClient

public AmazonLexRuntimeClient(AWSCredentials awsCredentials,
                              ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonLexRuntime using the specified AWS account credentials and client configuration options.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonLexRuntimeClient client = new AmazonLexRuntimeClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonLexRuntime (ex: proxy settings, retry counts, etc.).

AmazonLexRuntimeClient

public AmazonLexRuntimeClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonLexRuntime using the specified AWS account credentials provider.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonLexRuntimeClient client = new AmazonLexRuntimeClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonLexRuntimeClient

public AmazonLexRuntimeClient(AWSCredentialsProvider awsCredentialsProvider,
                              ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonLexRuntime using the specified AWS account credentials provider and client configuration options.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonLexRuntimeClient client = new AmazonLexRuntimeClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonLexRuntime (ex: proxy settings, retry counts, etc.).

AmazonLexRuntimeClient

@Deprecated
public AmazonLexRuntimeClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ClientConfiguration clientConfiguration,
                                          com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)

Deprecated.

Constructs a new client to invoke service methods on AmazonLexRuntime using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonLexRuntime (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

AmazonLexRuntimeClient

public AmazonLexRuntimeClient(AWSCredentialsProvider awsCredentialsProvider,
                              ClientConfiguration clientConfiguration,
                              HttpClient httpClient)

Constructs a new client to invoke service methods on AmazonLexRuntime using the specified AWS account credentials provider, client configuration options and request metric collector.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonLexRuntimeClient client = new AmazonLexRuntimeClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonLexRuntime (ex: proxy settings, retry counts, etc.).

httpClient - A http client

Method Detail

deleteSession

public DeleteSessionResult deleteSession(DeleteSessionRequest deleteSessionRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Removes session information for a specified bot, alias, and user ID.

Specified by:

deleteSession in interface AmazonLexRuntime

Parameters:

deleteSessionRequest -

Returns:

deleteSessionResult The response from the DeleteSession service method, as returned by Amazon Lex Runtime Service.

Throws:

NotFoundException

BadRequestException

LimitExceededException

InternalFailureException

ConflictException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Lex Runtime Service indicating either a problem with the data in the request, or a server side issue.

getSession

public GetSessionResult getSession(GetSessionRequest getSessionRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Returns session information for a specified bot, alias, and user ID.

Specified by:

getSession in interface AmazonLexRuntime

Parameters:

getSessionRequest -

Returns:

getSessionResult The response from the GetSession service method, as returned by Amazon Lex Runtime Service.

Throws:

NotFoundException

BadRequestException

LimitExceededException

InternalFailureException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Lex Runtime Service indicating either a problem with the data in the request, or a server side issue.

postContent

public PostContentResult postContent(PostContentRequest postContentRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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.

Specified by:

postContent in interface AmazonLexRuntime

Parameters:

postContentRequest -

Returns:

postContentResult The response from the PostContent service method, as returned by Amazon Lex Runtime Service.

Throws:

NotFoundException

BadRequestException

LimitExceededException

InternalFailureException

ConflictException

UnsupportedMediaTypeException

NotAcceptableException

RequestTimeoutException

DependencyFailedException

BadGatewayException

LoopDetectedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Lex Runtime Service indicating either a problem with the data in the request, or a server side issue.

postText

public PostTextResult postText(PostTextRequest postTextRequest)
                        throws AmazonServiceException,
                               AmazonClientException

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

Specified by:

postText in interface AmazonLexRuntime

Parameters:

postTextRequest -

Returns:

postTextResult The response from the PostText service method, as returned by Amazon Lex Runtime Service.

Throws:

NotFoundException

BadRequestException

LimitExceededException

InternalFailureException

ConflictException

DependencyFailedException

BadGatewayException

LoopDetectedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Lex Runtime Service indicating either a problem with the data in the request, or a server side issue.

putSession

public PutSessionResult putSession(PutSessionRequest putSessionRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

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.

For more information, see Managing Sessions.

Specified by:

putSession in interface AmazonLexRuntime

Parameters:

putSessionRequest -

Returns:

putSessionResult The response from the PutSession service method, as returned by Amazon Lex Runtime Service.

Throws:

NotFoundException

BadRequestException

LimitExceededException

InternalFailureException

ConflictException

NotAcceptableException

DependencyFailedException

BadGatewayException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Lex Runtime Service indicating either a problem with the data in the request, or a server side issue.

getCachedResponseMetadata

@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonLexRuntime

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.