Overview
The following documentation outlines the configuration for the connector and how to implement functions specifically for Amazon Lex.
At this time, Lex response cards and audio messages are not supported. The Connector uses Lex ApiVersion 2016-11-28. Currently, we only support Amazon Lex V1 and we don't support Amazon Lex V2.
Configuration
See the Getting Started guide before using this document to complete pre-requisite steps.
You will be presented with following screen to complete the Vendor Settings in order to add bot connector.
Figure 1.1 Showing the configuration that needed to be filled
The following Amazon Lex information should be provided 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 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 name | The bots name in the IAM role | botConnectors |
| Bot alias | Bots alias of the IAM role | botConnectors |
You have to agree to Data Disclaimer from now onward in order to use the services of bot connector. For that you can click on the checkbox "I agree to the Data Disclaimer"
For validation of the credentials provided, you can now perform a test connection request to see if everything that you have provided is working and reachable. You can click on the button "Test Connection" to see if connection succeed or fail as shown in Figure 1.2 and 1.3 respectively. 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 credentials
Once you are done with providing configuration you can save it by pressing on "Done". Congratulations! You have completed the configuration of the Amazon Lex bot.