Expand description
Amazon Lex is an AWS service for building conversational voice and text interfaces. Use these actions to create, update, and delete conversational bots for new and existing client applications.
If you’re using the service, you’re probably looking for LexModelsClient and LexModels.
Structs§
- BotAlias
Metadata Provides information about a bot alias.
- BotChannel
Association Represents an association between an Amazon Lex bot and an external messaging platform.
- BotMetadata
Provides information about a bot. .
- Builtin
Intent Metadata Provides metadata for a built-in intent.
- Builtin
Intent Slot Provides information about a slot used in a built-in intent.
- Builtin
Slot Type Metadata Provides information about a built in slot type.
- Code
Hook Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot..
- Conversation
Logs Request Provides the settings needed for conversation logs.
- Conversation
Logs Response Contains information about conversation log settings.
- Create
BotVersion Request - Create
BotVersion Response - Create
Intent Version Request - Create
Intent Version Response - Create
Slot Type Version Request - Create
Slot Type Version Response - Delete
BotAlias Request - Delete
BotChannel Association Request - Delete
BotRequest - Delete
BotVersion Request - Delete
Intent Request - Delete
Intent Version Request - Delete
Slot Type Request - Delete
Slot Type Version Request - Delete
Utterances Request - Enumeration
Value Each slot type can have a set of values. Each enumeration value represents a value the slot type can take.
For example, a pizza ordering bot could have a slot type that specifies the type of crust that the pizza should have. The slot type could include the values
-
thick
-
thin
-
stuffed
-
- Follow
UpPrompt A prompt for additional activity after an intent is fulfilled. For example, after the
OrderPizzaintent is fulfilled, you might prompt the user to find out whether the user wants to order drinks.- Fulfillment
Activity Describes how the intent is fulfilled after the user provides all of the information required for the intent. You can provide a Lambda function to process the intent, or you can return the intent information to the client application. We recommend that you use a Lambda function so that the relevant logic lives in the Cloud and limit the client-side code primarily to presentation. If you need to update the logic, you only update the Lambda function; you don't need to upgrade your client application.
Consider the following examples:
-
In a pizza ordering application, after the user provides all of the information for placing an order, you use a Lambda function to place an order with a pizzeria.
-
In a gaming application, when a user says "pick up a rock," this information must go back to the client application so that it can perform the operation and update the graphics. In this case, you want Amazon Lex to return the intent data to the client.
-
- GetBot
Alias Request - GetBot
Alias Response - GetBot
Aliases Request - GetBot
Aliases Response - GetBot
Channel Association Request - GetBot
Channel Association Response - GetBot
Channel Associations Request - GetBot
Channel Associations Response - GetBot
Request - GetBot
Response - GetBot
Versions Request - GetBot
Versions Response - GetBots
Request - GetBots
Response - GetBuiltin
Intent Request - GetBuiltin
Intent Response - GetBuiltin
Intents Request - GetBuiltin
Intents Response - GetBuiltin
Slot Types Request - GetBuiltin
Slot Types Response - GetExport
Request - GetExport
Response - GetImport
Request - GetImport
Response - GetIntent
Request - GetIntent
Response - GetIntent
Versions Request - GetIntent
Versions Response - GetIntents
Request - GetIntents
Response - GetSlot
Type Request - GetSlot
Type Response - GetSlot
Type Versions Request - GetSlot
Type Versions Response - GetSlot
Types Request - GetSlot
Types Response - GetUtterances
View Request - GetUtterances
View Response - Input
Context The name of a context that must be active for an intent to be selected by Amazon Lex.
- Intent
Identifies the specific version of an intent.
- Intent
Metadata Provides information about an intent.
- Kendra
Configuration Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance. For more information, see AMAZON.KendraSearchIntent.
- LexModels
Client - A client for the Amazon Lex Model Building Service API.
- List
Tags ForResource Request - List
Tags ForResource Response - LogSettings
Request Settings used to configure delivery mode and destination for conversation logs.
- LogSettings
Response The settings for conversation logs.
- Message
The message object that provides the message text and its type.
- Output
Context The specification of an output context that is set when an intent is fulfilled.
- Prompt
Obtains information from the user. To define a prompt, provide one or more messages and specify the number of attempts to get information from the user. If you provide more than one message, Amazon Lex chooses one of the messages to use to prompt the user. For more information, see how-it-works.
- PutBot
Alias Request - PutBot
Alias Response - PutBot
Request - PutBot
Response - PutIntent
Request - PutIntent
Response - PutSlot
Type Request - PutSlot
Type Response - Resource
Reference Describes the resource that refers to the resource that you are attempting to delete. This object is returned as part of the
ResourceInUseExceptionexception.- Slot
Identifies the version of a specific slot.
- Slot
Default Value A default value for a slot.
- Slot
Default Value Spec Contains the default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot.
- Slot
Type Configuration Provides configuration information for a slot type.
- Slot
Type Metadata Provides information about a slot type..
- Slot
Type Regex Configuration Provides a regular expression used to validate the value of a slot.
- Start
Import Request - Start
Import Response - Statement
A collection of messages that convey information to the user. At runtime, Amazon Lex selects the message to convey.
- Tag
A list of key/value pairs that identify a bot, bot alias, or bot channel. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
- TagResource
Request - TagResource
Response - Untag
Resource Request - Untag
Resource Response - Utterance
Data Provides information about a single utterance that was made to your bot.
- Utterance
List Provides a list of utterances that have been made to a specific version of your bot. The list contains a maximum of 100 utterances.
Enums§
- Create
BotVersion Error - Errors returned by CreateBotVersion
- Create
Intent Version Error - Errors returned by CreateIntentVersion
- Create
Slot Type Version Error - Errors returned by CreateSlotTypeVersion
- Delete
BotAlias Error - Errors returned by DeleteBotAlias
- Delete
BotChannel Association Error - Errors returned by DeleteBotChannelAssociation
- Delete
BotError - Errors returned by DeleteBot
- Delete
BotVersion Error - Errors returned by DeleteBotVersion
- Delete
Intent Error - Errors returned by DeleteIntent
- Delete
Intent Version Error - Errors returned by DeleteIntentVersion
- Delete
Slot Type Error - Errors returned by DeleteSlotType
- Delete
Slot Type Version Error - Errors returned by DeleteSlotTypeVersion
- Delete
Utterances Error - Errors returned by DeleteUtterances
- GetBot
Alias Error - Errors returned by GetBotAlias
- GetBot
Aliases Error - Errors returned by GetBotAliases
- GetBot
Channel Association Error - Errors returned by GetBotChannelAssociation
- GetBot
Channel Associations Error - Errors returned by GetBotChannelAssociations
- GetBot
Error - Errors returned by GetBot
- GetBot
Versions Error - Errors returned by GetBotVersions
- GetBots
Error - Errors returned by GetBots
- GetBuiltin
Intent Error - Errors returned by GetBuiltinIntent
- GetBuiltin
Intents Error - Errors returned by GetBuiltinIntents
- GetBuiltin
Slot Types Error - Errors returned by GetBuiltinSlotTypes
- GetExport
Error - Errors returned by GetExport
- GetImport
Error - Errors returned by GetImport
- GetIntent
Error - Errors returned by GetIntent
- GetIntent
Versions Error - Errors returned by GetIntentVersions
- GetIntents
Error - Errors returned by GetIntents
- GetSlot
Type Error - Errors returned by GetSlotType
- GetSlot
Type Versions Error - Errors returned by GetSlotTypeVersions
- GetSlot
Types Error - Errors returned by GetSlotTypes
- GetUtterances
View Error - Errors returned by GetUtterancesView
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- PutBot
Alias Error - Errors returned by PutBotAlias
- PutBot
Error - Errors returned by PutBot
- PutIntent
Error - Errors returned by PutIntent
- PutSlot
Type Error - Errors returned by PutSlotType
- Start
Import Error - Errors returned by StartImport
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
Traits§
- LexModels
- Trait representing the capabilities of the Amazon Lex Model Building Service API. Amazon Lex Model Building Service clients implement this trait.