Expand description
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, .
If you’re using the service, you’re probably looking for LexRuntimeClient and LexRuntime.
Structs§
- Button
Represents an option to be shown on the client platform (Facebook, Slack, etc.)
- Delete
Session Request - Delete
Session Response - Dialog
Action Describes the next action that the bot should take in its interaction with the user and provides information about the context in which the action takes place. Use the
DialogAction
data type to set the interaction to a specific state, or to return the interaction to a previous state.- Generic
Attachment Represents an option rendered to the user when a prompt is shown. It could be an image, a button, a link, or text.
- GetSession
Request - GetSession
Response - Intent
Summary Provides information about the state of an intent. You can use this information to get the current state of an intent so that you can process the intent, or so that you can return the intent to its previous state.
- LexRuntime
Client - A client for the Amazon Lex Runtime Service API.
- Post
Content Request - Post
Content Response - Post
Text Request - Post
Text Response - PutSession
Request - PutSession
Response - Response
Card If you configure a response card when creating your bots, Amazon Lex substitutes the session attributes and slot values that are available, and then returns it. The response card can also come from a Lambda function (
dialogCodeHook
andfulfillmentActivity
on an intent).- Sentiment
Response The sentiment expressed in an utterance.
When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field structure contains the result of the analysis.
Enums§
- Delete
Session Error - Errors returned by DeleteSession
- GetSession
Error - Errors returned by GetSession
- Post
Content Error - Errors returned by PostContent
- Post
Text Error - Errors returned by PostText
- PutSession
Error - Errors returned by PutSession
Traits§
- LexRuntime
- Trait representing the capabilities of the Amazon Lex Runtime Service API. Amazon Lex Runtime Service clients implement this trait.