1. Help Center
  2. Learn More
  3. Watson Assistant and Intents

Setup a Watson Assistant in a Storyflow Project

This article will describe creating the necessary Storyflow catalogs, getting the appropriate values from IBM Watson and configuring the catalogs with those values.

Step 1: Create the Necessary Storyflow Catalogs

Three types of catalogs are needed to use Watson with Storyflow. 

  • Watson Assistant - This stores the Assistant ID of your IBM Watson Assistant and the associated service credentials in your Storyflow project. The Assistant ID can be found on the IBM Watson Assistant site. Steps to find these values are described below.
  • Watson Service Configuration - This stores the credentials used with a IBM Watson Assistant and the Speech-to-Text service. Steps to find these values are described below.
  • Watson Intents - The list of intents associated with a specific IBM Watson Assistant.

Log into Storyflow and open your project to create a catalog.

  1. Click the Catalogs tab
  2. Click the Create button

 

Select 'watsonAssistant'

Enter a name for the catalog and click Create

Using the same steps, create two more catalogs of types:

  • Watson Service Configuration
  • watsonIntent

When complete, the list of catalogs will look like this:

 

Step 2: Create a Watson Service Configuration

In Storyflow, open the Watson Service Configuration catalog. Click the "+" button to add a new item to the catalog.

 

A new catalog item will appear. There are two values we need to populate. Both can be found in your IBM Watson account on their site.

Leave Storyflow open as we will return to it shortly.

Step 3: Get the IBM Speech To Text API Key

On a separate browser tab, log into your IBM Watson account. A list of your IBM resources can be found here.

Find the Service which is Speech To Text and click on its name.

 

If you do not yet have a Speech To Text service set up, use the Create resource button in the upper right to make one.

 

In the Manage -> Credentials section the API key will be listed. Most likely it will be anonymized. Click on the Copy icon to the right of the API key value. This will copy the value to the clipboard.

 

Step 4: Paste the Speech To Text API Key into the Watson Service Configuration on Storyflow

Return to your Storyflow project and open the Watson Service Configuration Catalog.

In the Speech To Text Credentials section, paste the API key value into the API key field.

 

Save the Catalog.

 

The Speech To Text value is set. Next, we will get the Assistant API Key

 

Step 5: Get the IBM Watson Assistant API Key

On a separate browser tab, log into your IBM Watson account and locate your list of assistants.

Click the menu with the three dots associated with the assistant you want to use in your Storyflow project.

 

Click 'Settings' in the menu.

 

On the next screen, click 'API details'.

 

Several values will be displayed in the API details section. Find the API key and click the Copy button to the right of the value. This will copy the API key to the clipboard.

Keep this tab open as we will come back to it to get another value in a later step.

 

Step 6: Paste the Assistant API Key into the Watson Service Configuration

Return to your Storyflow project and open the Watson Service Configuration Catalog.

In the Assistant Credentials section, paste the API key value into the API key field.

Save the Catalog.

 

The Watson Service Configuration is complete. We can now set up the Watson Assistant.

 

Step 7: Create a Watson Assistant Catalog Item in Storyflow

Click the home button to return to the list of catalogs

 

Find the Watson Assistant catalog that you created in the first step. Click on it to open.

 

Click the "+" button to add a new item to the catalog.

 

Enter a name for the Assistant. 

This name does not need to be the same as the Watson Assistant you created on your IBM Account. It can be the same but it is not required.

 

Click the "+" button next to Service. 

This opens the sidebar and displays a list of Watson Service Configuration catalogs. Select the Watson Service Configuration catalog you created earlier.

 

The Watson Service Configuration will be added to the Watson Assistant catalog item.

Only the Assistant Id is remaining. Open the tab with the IBM Watson Assistant API details from the earlier step.

Click the Copy button to the right of the Assistant ID value.

 

Return to Storyflow and paste the value into the Assistant Id field.

 

Save the Catalog.

 

This Watson Assistant can now be used with a Watson Intent catalog item. Click the home button to return the main catalog view.

 

Step 8: Create a Watson Intent Catalog Item in Storyflow

Find the Watson Assistant catalog that you created in the first step. Click on it to open.

 

Click the "+" button to add a new item to the catalog.

 

Give the Intent a name. The description is optional.

The name must be exactly the same as the Intent name associated with the Watson Assistant Skill created on the IBM site. For more information about Watson Skills and Intents, see this document.

Click the "+" button next to Assistant.

This opens the sidebar and displays a list of Watson Assistant catalogs. Select the Watson Assistant catalog you created earlier.

 

Select the Watson Assistant catalog item you created earlier.

 

The Watson Intent item is complete. 

 

Save the Catalog.

 

The Watson Intent can now be used in an Storyflow script in the current project. More intents can be added. These can reuse the Watson Assistant which has already been created. On the IBM Watson site, you have created 15 intents for the Watson Assistant, you can create 15 Watson Intent catalog items in Storyflow to be used in any script.