com.amazonaws.services.lexruntime

Class AbstractAmazonLexRuntime

java.lang.Object

com.amazonaws.services.lexruntime.AbstractAmazonLexRuntime

All Implemented Interfaces:

AmazonLexRuntime

Direct Known Subclasses:

AbstractAmazonLexRuntimeAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonLexRuntime
extends Object
implements AmazonLexRuntime

Abstract implementation of AmazonLexRuntime. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.lexruntime.AmazonLexRuntime

ENDPOINT_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAmazonLexRuntime()

Method Summary

Modifier and Type	Method and Description
DeleteSessionResult	deleteSession(DeleteSessionRequest request) 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 request) Returns session information for a specified bot, alias, and user ID.
PostContentResult	postContent(PostContentRequest request) Sends user input (text or speech) to Amazon Lex.
PostTextResult	postText(PostTextRequest request) Sends user input to Amazon Lex.
PutSessionResult	putSession(PutSessionRequest request) Creates a new session or modifies an existing session with an Amazon Lex bot.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAmazonLexRuntime

protected AbstractAmazonLexRuntime()

Method Detail

deleteSession

public DeleteSessionResult deleteSession(DeleteSessionRequest request)

Description copied from interface: AmazonLexRuntime

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

Specified by:

deleteSession in interface AmazonLexRuntime

Returns:

Result of the DeleteSession operation returned by the service.

See Also:

AWS API Documentation

getSession

public GetSessionResult getSession(GetSessionRequest request)

Description copied from interface: AmazonLexRuntime

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

Specified by:

getSession in interface AmazonLexRuntime

Returns:

Result of the GetSession operation returned by the service.

See Also:

AWS API Documentation

postContent

public PostContentResult postContent(PostContentRequest request)

Description copied from interface: AmazonLexRuntime

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

Returns:

Result of the PostContent operation returned by the service.

See Also:

AWS API Documentation

postText

public PostTextResult postText(PostTextRequest request)

Description copied from interface: AmazonLexRuntime

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

Returns:

Result of the PostText operation returned by the service.

See Also:

AWS API Documentation

putSession

public PutSessionResult putSession(PutSessionRequest request)

Description copied from interface: AmazonLexRuntime

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

Returns:

Result of the PutSession operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonLexRuntime

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.

Specified by:

shutdown in interface AmazonLexRuntime

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonLexRuntime

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.

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.