com.amazonaws.services.lexrts

Interface AmazonLexRuntime

All Known Implementing Classes:

AmazonLexRuntimeClient

public interface AmazonLexRuntime

Interface for accessing Amazon Lex Runtime Service

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

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) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
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.
void	setEndpoint(java.lang.String endpoint) Overrides the default endpoint for this client ("https://runtime.lex.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Method Detail

setEndpoint

void setEndpoint(java.lang.String endpoint)
          throws java.lang.IllegalArgumentException

Overrides the default endpoint for this client ("https://runtime.lex.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "runtime.lex.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://runtime.lex.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "runtime.lex.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://runtime.lex.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
        throws java.lang.IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

java.lang.IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

deleteSession

DeleteSessionResult deleteSession(DeleteSessionRequest deleteSessionRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

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

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

GetSessionResult getSession(GetSessionRequest getSessionRequest)
                     throws AmazonClientException,
                            AmazonServiceException

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

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

PostContentResult postContent(PostContentRequest postContentRequest)
                       throws AmazonClientException,
                              AmazonServiceException

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.

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

PostTextResult postText(PostTextRequest postTextRequest)
                 throws AmazonClientException,
                        AmazonServiceException

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.

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

PutSessionResult putSession(PutSessionRequest putSessionRequest)
                     throws AmazonClientException,
                            AmazonServiceException

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.

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.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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 a request.

Parameters:

request - The originally executed request.

Returns:

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