Custom App Series - Step 1 - Building a Custom App
The purpose of this document is to describe how to create an app in the VoiceWorx. After going through this document, you should be able to create custom app for channels such as Amazon Alexa, Google Assistant, Amazon Lex, Twilio and Slack.
You should have a connection and/or a Data Source established.
You want to build an Amazon Alexa Skill where you can ask for a person’s phone number. All the phone numbers are stored in a Data Source, and for simplicity of this documents, it is assumed that the user has established a connection between the Data Source and the VoiceWorx Platform
We want to create a skill where the following commands should return a phone number:
“Get phone number for John Doe?”
“Find me the contact number for Doctor John Doe.”
Intent is the task the user wants to accomplish. Intent is not a specific word; it is the overall goal the user is trying to achieve. In our example, our intent is to find a phone number by name.
A user can convey an intent by saying various phrases. In our example, we are going to use the two above mentioned utterances.
Slots are variables contained in intent. In our example, the slot is the name of the person whose phone number we are trying to find.
A screenshot of a cell phone
Description automatically generated
Entities are the synonyms/variations for the slots. They define the various ways a user can specify an intent. For example, in our use case, the user can say the name of the person as ‘John Doe’ or ‘Doctor John Doe.’
Methods are the tasks performed on the database. Examples are search, put, push, delete etc.
Inputs are slot mappings to the methods. VoiceWorx gets ‘slots’ from channels such as Alexa, Google Assistant or chatbots and then has to map these to methods for task execution. Inputs can contain multiple Input parameters.
Step 1: Create an App
Creating a custom app that can be consumed from an external platform like Alexa or Lex, includes the following steps
Connect System (Data Source Integration)
Create the App Methods
Add intents to the App
Add Slots to the App
Create Entities for App Slots (This is optional)
Step 2: Set up a Data Source
Login to the VoiceWorx platform, go to Integration menu and select Connect System. In the resulting page, click connect external systems
In the resulting popup, choose “Custom” from the “Select External System” and choose “Rest API Service” from the Select System Type option then click connect system.
Add the web API endpoint , username and password and click “Validate System” to ensure you have access to the web API endpoint.