To add Amazon Alexa as a channel to your Kore.ai assistant, you must extract supported Dialog Tasks of this VA from the Configurations tab and add to your Amazon Alexa’s Skills. Additionally, you must configure your VA’s Webhook URL as your Alexa Skill Set’s Service Endpoint for the XO Platform to receive messages. To enable the Alexa channel, you must have or register for an Amazon Developer account.
Important NotesAlexa as a channel must be enabled for VAs that are specifically built to work on voice-based channels. Review the following constraints before enabling Alexa as a channel:
|
Setup Overview
To add the Amazon Alexa channel, you must:
- Add a New Skill – To enable the Alexa channel to your Kore.ai assistant, create a new Alexa skill in the Amazon developer console.
- Configure the Interaction Model – Alexa skill can be built in one of the following ways:
- Dialog Migration to extract the dialog tasks from Kore.ai and import them into Amazon Alexa’s Skills. This will entail re-import for reflecting ongoing changes in the dialog definition. Intent detection and execution are primarily controlled by Alexa.
- Redirection to create a single intent in your skill with one SearchQuery slot that accepts user inputs and redirects them to your Kore.ai VA. Intent detection and execution are primarily controlled by the Kore.ai VA.
- Enable Account Linking – To access end user’s authentication details to make API calls to external services. This step is optional.
- Enable Webhook Integration – To integrate Amazon Alexa with your Kore.ai VA, enable webhook integration by copying the Webhook URL provided on the Configurations tab of the Amazon Alexa Channel page in the XO Platform and select HTTPS as Service Endpoint type.
- Enable Channel – After completing the integration setup, enable the channel.
- Test Integration – Once the channel is enabled, to validate a successful integration, test any intent utterance using the Test tab of your Alexa Skill and check its responses for the given test utterances.
- Distribution, Privacy & Compliance, and Certification – You must publish your Alexa Skill on Alexa App and provide details for Privacy and Compliance to enable Skills Beta Testing that allows you to invite your co-developers to test your app. You must also submit your Skill to Amazon for certification to enable your skill to become visible on Alexa Skills on Amazon App Store after it is certified.
Step 1: Add a New Skill
- Log into your Amazon Developer Portal and click the Alexa tab. Choose Skills from Your Alexa Console and Create a New Skill.
- In the Create a New Alexa Skill section, enter the required information in the respective fields.
- Click Create Skill at the top right of the page.
Step 2: Configure the Interaction Model
- Now, from under the Interaction Model section, select JSON Editor.
- In the Code Editor, define the intents and entities to associate with your newly created skill. For this, follow the steps below in the XO Platform:
- Select the assistant you want to work with.
- Go to Deploy > Channels > Amazon Alexa > Configurations.
- From under Alexa Skill Definition JSON, download the VA’s tasks as a JSON file to be uploaded into Alexa Skills JSON Editor.
- Upload the JSON file to the Alexa Code Editor, review and ensure that there are no errors, click Save Model, then Build Model.
Note: It takes 2-5 mins for the Model to build. Any changes implemented to the built model must be followed by rebuilding the model.
Step 3: Enable Account Linking (Optional)
You can enable the Account Linking feature in your Alexa Skill if your assistant expects end users’ authorization for making API calls to external services.
- Within your skill’s Build tab, go to Tools.
- Click on Account Linking and set up the integration as per the instructions available from Amazon, and as per your requirements. Alexa requests users to provide the required authorization details for linking the accounts. During skill execution, Alexa shares the user access tokens with Kore.ai assistants, which are then used to make API calls defined in Service nodes.
Step 4: Enable the Webhook Integration
- Go to the Endpoint section.
- Select HTTPS as the Service Endpoint Type. Copy the Webhook URL provided in the Configurations tab of the Amazon Alexa channel page in the XO Platform and enter it in the Default textbox.
- In the SSL Certificate dropdown, select the option My development endpoint is a sub-domain of a domain that has a wildcard certificate from a certificate authority.
- Click Save Endpoint.
Step 5: Enable the Channel
Before you can start testing your assistant on Alexa, you must complete the channel setup. Go to the Configurations tab of the Amazon Alexa channel page, review the details and select Yes; click Save to enable Amazon Alexa Channel.
Step 6: Test the Integration
Once done, you can use the Test tab of your Alexa Skill to test your utterances against the integration. In the Test tab, go to the Service Simulator section and provide any intent utterance and click Ask <skill-name> to test the utterance. If you get a successful response then the integration is considered a success.
Step 7: Distribution
Now, go to the Distribution tab and provide all the required details for publishing your Alexa Skill on the Alexa App and Save the details.
Privacy & Compliance
Next, go to the Privacy & Compliance tab and provide all the required details requested and click Save.
After completing these steps, the Skills Beta Testing option is enabled and this allows you to invite your co-developers to test your app.
When you are ready to submit your Skill to Amazon, Submit for Certification. Your skill will be visible on Alexa Skills on Amazon App Store after it is certified.
After the channel is enabled and all configurations are verified, you can optionally publish the assistant to make it available for end-users, with the new channel. Learn more about Publishing your Virtual Assistant.
To learn more about working with Channels within the Kore.ai XO Platform, please see Channel Enablement.