Table of Contents
A low-level client representing Amazon Lex Runtime Service:
client = session.create_client('lex-runtime')
These are the available methods:
Check if an operation can be paginated.
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
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:
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:
In addition, Amazon Lex also returns your application-specific sessionAttributes . For more information, see Managing Conversation Context .
See also: AWS API Documentation
Request Syntax
response = client.post_content(
botName='string',
botAlias='string',
userId='string',
sessionAttributes={...}|[...]|123|123.4|'string'|True|None,
requestAttributes={...}|[...]|123|123.4|'string'|True|None,
contentType='string',
accept='string',
inputStream=b'bytes'|file
)
[REQUIRED]
Name of the Amazon Lex bot.
[REQUIRED]
Alias of the Amazon Lex bot.
[REQUIRED]
The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the userID field.
To decide the user ID to use for your application, consider the following factors.
You pass this value as the x-amz-lex-session-attributes HTTP header.
Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the sessionAttributes and requestAttributes headers is limited to 12 KB.
For more information, see Setting Session Attributes .
You pass this value as the x-amz-lex-request-attributes HTTP header.
Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the requestAttributes and sessionAttributes headers is limited to 12 KB.
The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex: .
For more information, see Setting Request Attributes .
[REQUIRED]
You pass this value as the Content-Type HTTP header.
Indicates the audio format or text. The header value must start with one of the following prefixes:
You pass this value as the Accept HTTP header.
The message Amazon Lex returns in the response can be either text or speech based on the Accept HTTP header value in the request.
[REQUIRED]
User input in PCM or Opus audio format or text format as described in the Content-Type HTTP header.
You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally.
dict
Response Syntax
{
'contentType': 'string',
'intentName': 'string',
'slots': {...}|[...]|123|123.4|'string'|True|None,
'sessionAttributes': {...}|[...]|123|123.4|'string'|True|None,
'message': 'string',
'messageFormat': 'PlainText'|'CustomPayload'|'SSML'|'Composite',
'dialogState': 'ElicitIntent'|'ConfirmIntent'|'ElicitSlot'|'Fulfilled'|'ReadyForFulfillment'|'Failed',
'slotToElicit': 'string',
'inputTranscript': 'string',
'audioStream': StreamingBody()
}
Response Structure
(dict) --
contentType (string) --
Content type as specified in the Accept HTTP header in the request.
intentName (string) --
Current user intent that Amazon Lex is aware of.
slots (JSON serializable) --
Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation.
Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE , the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy , the default is ORIGINAL_VALUE .
sessionAttributes (JSON serializable) --
Map of key/value pairs representing the session-specific context information.
message (string) --
The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.
If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats .
If the Lambda function returns a message, Amazon Lex passes it to the client in its response.
messageFormat (string) --
The format of the response message. One of the following values:
dialogState (string) --
Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState . The client can optionally use this information to customize the user interface.
slotToElicit (string) --
If the dialogState value is ElicitSlot , returns the name of the slot for which Amazon Lex is eliciting a value.
inputTranscript (string) --
The text used to process the request.
If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send.
audioStream (StreamingBody) --
The prompt (or statement) to convey to the user. This is based on the bot configuration and context. For example, if Amazon Lex did not understand the user intent, it sends the clarificationPrompt configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the confirmationPrompt . Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the response.
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:
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:
In addition, Amazon Lex also returns your application-specific sessionAttributes . For more information, see Managing Conversation Context .
See also: AWS API Documentation
Request Syntax
response = client.post_text(
botName='string',
botAlias='string',
userId='string',
sessionAttributes={
'string': 'string'
},
requestAttributes={
'string': 'string'
},
inputText='string'
)
[REQUIRED]
The name of the Amazon Lex bot.
[REQUIRED]
The alias of the Amazon Lex bot.
[REQUIRED]
The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the userID field.
To decide the user ID to use for your application, consider the following factors.
Application-specific information passed between Amazon Lex and a client application.
For more information, see Setting Session Attributes .
Request-specific information passed between Amazon Lex and a client application.
The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex: .
For more information, see Setting Request Attributes .
[REQUIRED]
The text that the user entered (Amazon Lex interprets this text).
dict
Response Syntax
{
'intentName': 'string',
'slots': {
'string': 'string'
},
'sessionAttributes': {
'string': 'string'
},
'message': 'string',
'messageFormat': 'PlainText'|'CustomPayload'|'SSML'|'Composite',
'dialogState': 'ElicitIntent'|'ConfirmIntent'|'ElicitSlot'|'Fulfilled'|'ReadyForFulfillment'|'Failed',
'slotToElicit': 'string',
'responseCard': {
'version': 'string',
'contentType': 'application/vnd.amazonaws.card.generic',
'genericAttachments': [
{
'title': 'string',
'subTitle': 'string',
'attachmentLinkUrl': 'string',
'imageUrl': 'string',
'buttons': [
{
'text': 'string',
'value': 'string'
},
]
},
]
}
}
Response Structure
(dict) --
intentName (string) --
The current user intent that Amazon Lex is aware of.
slots (dict) --
The intent slots that Amazon Lex detected from the user input in the conversation.
Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE , the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy , the default is ORIGINAL_VALUE .
sessionAttributes (dict) --
A map of key-value pairs representing the session-specific context information.
message (string) --
The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.
If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats .
If the Lambda function returns a message, Amazon Lex passes it to the client in its response.
messageFormat (string) --
The format of the response message. One of the following values:
dialogState (string) --
Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState . The client can optionally use this information to customize the user interface.
slotToElicit (string) --
If the dialogState value is ElicitSlot , returns the name of the slot for which Amazon Lex is eliciting a value.
responseCard (dict) --
Represents the options that the user has to respond to the current prompt. Response Card can come from the bot configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda function).
version (string) --
The version of the response card format.
contentType (string) --
The content type of the response.
genericAttachments (list) --
An array of attachment objects representing options.
(dict) --
Represents an option rendered to the user when a prompt is shown. It could be an image, a button, a link, or text.
title (string) --
The title of the option.
subTitle (string) --
The subtitle shown below the title.
attachmentLinkUrl (string) --
The URL of an attachment to the response card.
imageUrl (string) --
The URL of an image that is displayed to the user.
buttons (list) --
The list of options to show to the user.
(dict) --
Represents an option to be shown on the client platform (Facebook, Slack, etc.)
text (string) --
Text that is visible to the user on the button.
value (string) --
The value sent to Amazon Lex when a user chooses the button. For example, consider button text "NYC." When the user chooses the button, the value sent can be "New York City."
The available paginators are: