Webex Assistant Skills Guide Developer Portal Guide
The Developer Portal is a tool for skills developers to manage and maintain their skills in a simple way. This tool works on top of the Skills API, so it removes the need of having to use REST requests in order to create, update and manage skills.
This tool is not intended for organization administrators to provide their users access to a give skill. That functionality is available in Control Hub. This is for developers only, so they can have access to all the skills they develop from a single place.
The Developer Portal URL is: https://skills-developer.intelligence.webex.com We'll go through the following topics in this guide, which will explain how to use this tool):
When you first go into the Developer Portal you'll land at the Overview page. This page offers a high level overview of what Skills are and what they can do.
Once you enter the tool, the first step you should take is to log in. For that can you use the Log in button in the top-right corner:
In the Next few sections, we'll be working on the Developer tab. Log in and go into the Developer section.
anchorCreating a Skillanchor
Creating a Skill is very simple. Simply click on the Create New Skill button:
You will now be presented with a form that you need to fill out in order to register the Skill:
The details you need to fill in are the following:
- Name: The official name of the Skill.
- Description: An optional description of what this Skill does.
- Home Page: An optional URL to a website with more information about the Skill.
- Suggested Invocation Names: Optional keywords used to identify this Skill, these are sugestions for when organization administrators register your skill.
- Languages: The list of languages that your Skill can support.
- URL: Address to invoke this Skill.
- Contact Email: Email of who should be contacted with inquires about the Skill.
- Secret: Private string used by the Assistant Service to identify itself to the Skill. This string is configured in the application code.
- Public Key: A RSA public key needed to securely communicate between the Assistant Skills Service and the Skill.
Fill in all the fields with your skill details above. When ready click the OK button.
anchorLooking at your Skillsanchor
Once you have created at least one skill, you will see your skills listed in the Developer section as follows:
You will see 6 columns for each of the skills you have. We have already mentioned a few of them in the Creating a Skill section. The ones we didn't cover are:
- Public: An indicator showing if the Skill has been made public for broader use.
- Last Active Time: Last time the skill was invoked if available.
- Actions: This column contains 2 buttons Edit and Delete, which we explore in upcoming sections.
If you happen to have an error in one of the form fields (they all have different requiremtns), the tool will highlight the field in red and will tell you what the error is. Here's an example:
anchorEditing a Skillanchor
Let's say that now we want to edit a skill we already created. To do that, we click on the Edit button of the specific skill we want to update:
This will open a drawer from the right where we can see 2 tabs: Skill and Registration. We are going to work on the Skill tab in this section:
Initially you will see all the details of your skill listed there. If you want to make modifications, click on the blue Edit button:
You will now see a form where you can edit all the details about your skill. As an example, we have added a new suggested invocation name to our sample skill:
We can now save the changes by clicking the OK button at the bottom of the form:
We should now see the updated skill:
anchorLooking at a Registrationanchor
With right drawer open, click on the Registration tab. This will display the registration details for the skill:
You are looking at the developer registration associated with your skill. For a developer registration you can customize the invocation names that are used when you, the skill developer, try to invoke the skill. Please note that these are separate from the Suggested Invocation Names in the skill, those names are only suggestions for the admins on what invocation names they can use when registering your skill, but these suggestions are not used for invocation until added to a registration.
anchorEditing a Registrationanchor
You can edit a registration (update the invocation names) by clicking on the blue Edit button in the Registration tab:
After clicking that button, you should see the registration edit form:
In our example, we have added the invocation names light switch and light control to our registration, to match the suggested invocation names. Normally the process would be a bit different: you would add invocation names to your registration first in order to test them, and then, if you think they can help other people use your skill better, you would add these to the Suggested Invocation Names of the skill. Normally new invocation names should be added as fixes for ASR errors (for example if there are common miss-transcriptions of the name of your skill). Or you can also add them if you find your skill name has some synonyms you think people would use commonly.
You can save the changes by clicking the OK button:
After that, you should see the registration has been updated: