AmazonLexRuntime (AWS SDK for Java

All Known Subinterfaces:

AmazonLexRuntimeAsync

All Known Implementing Classes:

AbstractAmazonLexRuntime, AbstractAmazonLexRuntimeAsync, AmazonLexRuntimeAsyncClient, AmazonLexRuntimeClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonLexRuntime
```
Interface for accessing Amazon Lex Runtime Service.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonLexRuntime instead.

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
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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.
`PostContentResult`	`postContent(PostContentRequest postContentRequest)` Sends user input (text or speech) to Amazon Lex.
`PostTextResult`	`postText(PostTextRequest postTextRequest)` Sends user input (text-only) to Amazon Lex.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - postContent
```
PostContentResult postContent(PostContentRequest postContentRequest)
```
    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:
    
    Result of the PostContent operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.
    
    BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.
    
    LimitExceededException - Exceeded a limit.
    
    InternalFailureException - Internal service error. Retry the call.
    
    ConflictException - Two clients are using the same AWS account, Amazon Lex bot, and user ID.
    
    UnsupportedMediaTypeException - The Content-Type header (PostContent API) has an invalid value.
    
    NotAcceptableException - The accept header in the request does not have a valid value.
    
    RequestTimeoutException - The input speech is too long.
    DependencyFailedException - One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,
    
    If Amazon Lex does not have sufficient permissions to call a Lambda function.
    
    If a Lambda function takes longer than 30 seconds to execute.
    
    If a fulfillment Lambda function returns a Delegate dialog action without removing any slot values.
    BadGatewayException - Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda) failed with an internal service error.
    
    LoopDetectedException - This exception is not used.
    
    See Also:
    
    AWS API Documentation
  - postText
```
PostTextResult postText(PostTextRequest postTextRequest)
```
    Sends user input (text-only) 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:
    
    Result of the PostText operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.
    
    BadRequestException - Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.
    
    LimitExceededException - Exceeded a limit.
    
    InternalFailureException - Internal service error. Retry the call.
    
    ConflictException - Two clients are using the same AWS account, Amazon Lex bot, and user ID.
    DependencyFailedException - One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,
    
    If Amazon Lex does not have sufficient permissions to call a Lambda function.
    
    If a Lambda function takes longer than 30 seconds to execute.
    
    If a fulfillment Lambda function returns a Delegate dialog action without removing any slot values.
    BadGatewayException - Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda) failed with an internal service error.
    
    LoopDetectedException - This exception is not used.
    
    See Also:
    
    AWS API Documentation
  - 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.

Did this page help you?

Interface AmazonLexRuntime

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

postContent

postText

shutdown

getCachedResponseMetadata