Overview
The following documentation outlines the configuration for the connector and how to implement functions specifically for Amazon Lex V2.
At this time, audio response from Lex is not supported and will get ignored by the connector.
Configuration
See the Getting Started guide before using this document to complete the prerequisite steps.
You will be presented with the following screen to complete the Vendor Settings in order to add a bot connector.
Figure 1.1 Showing the configuration that needed to be filled
The user should provide the following Amazon Lex V2 information to LivePerson:
Lex APIs adhere to Signature V4 Signing Process. Some degree of familiarity with AWS IAM policies and the AWS IAM console is necessary for setting up a valid Lex client with Read Only API Key access. A service account is a prerequisite for setting up the above config. Documentation is available here.
| Item | Description | Example |
|---|---|---|
| AWS Region | AWS region of the lex bot | us-east-1 |
| IAM Access Key | Access Key ID of the IAM role | AKIAXXXXXXXXXXXBWN3 |
| IAM Secret Key | IAM secret key of the IAM role | lwRQJUxxxxxxxxxxxxRQFpoxxxxxxxdE6JR |
| Bot Id | The bot identifier from the LexV2 bot details | KFPKMHZDYR |
| Bot Alias Id | The alias identifier from the LexV2 bot deployment information | TSTALIASID |
| Bot locale | The language identifier to be used by the bot | en_US |
You have to agree to the Data Disclaimer in order to use the services of the bot connector. For that, you can click on the checkbox "I agree to the Data Disclaimer"
Validate the credentials by performing a test connection request. Use the "Test Connection" button to check if the connection is successful, as shown in Figures 1.2 and 1.3, respectively. If the connection fails, the error can be displayed, allowing you to determine the cause of the connection failure from the AI vendor. Please note that your bot should be capable of handling unsupported messages either via fallback intents or as your design pleases. This will ensure the success of the call to the API of Lex for testing the connection.
Figure 1.2 Showing the success case of the valid credentials
Figure 1.3 Showing the fail case of the invalid bot Id or alias as returned from Amazon Lex
Once you filled out all necessary fields, you can save the configuration by pressing "Done". Congratulations! You have completed the configuration of the Amazon Lex V2 bot connector.
Limitations
Max input text limitation
Lex has a limitation of 1024 characters on the length of the input text it can process. If the input length exceeds the limit, Third-Party Bots will truncate it and attach the original text length as a request attribute with the key BC-INPUTTEXT-LIMIT-EXCEEDED.
To handle this limitation gracefully we recommend adding a lambda function that checks the request attribute BC-INPUTTEXT-LIMIT-EXCEEDED if exists.
session timeout
Lex retains slot data and session attributes until a conversation session ends. The session default duration is 5 minutes. The session timeout value for intents in Lex can be increased from the Lex console if it is expected that it takes longer than 5 minutes to collect information from the customer and fulfill the request.
Figure 1.4 — Change session timeout for a specific bot version
SSML response
Lex Speech Synthesis Markup Language (SSML) is not supported by LivePerson. As a result, any response with the SSML type will be dropped by the Third-party bots connector.
Streaming to a bot
The Lex V2 streaming API allows for a bidirectional communication stream between the bot and the connector. This version of the Third-Party Bots connector does not support the streaming API.