Creating a Universal Bot¶
This post refers to the upgraded version of the Universal Bot offered since version 7.3 of the platform, for the older version click here.
Creating a Universal Bot involves the following major steps:
- Create the Basic Universal Bot
- Add Linked Bots
- Train the Universal Bot
- Configure the Channels
- Test the Universal Bot
- Publish the Universal Bot
For an overall understanding of Universal Bots click here and to understand the differences with Standard bots click here.
Step 1: Creation¶
To create a Universal Bot, follow the steps below:
-
On the landing page, click New Bot.
-
In the Create New Bot window, select Start from Scratch.
- Enter a Name.
- Select an icon or click the + icon to upload your own. Images should be in PNG format and should not exceed 40×40 pixels. The file size is limited to 80kb.
- Select the Purpose of your VA. See Purposes for a complete list.
- Choose Universal Bot as the Bot Type.
- Select the Default Language.
-
Wait a few moments for your VA to be configured. Once done, you can continue developing it.
Universal Bot Version¶
(post ver7.3 release of the platform)
- You will be prompted to upgrade to the Universal Bot 2.0, this version provides training capability to the universal bot.
-
You can choose to Upgrade or continue with the older version.
Note
The older version will be deprecated soon in the platform.
- If you want to work with the older version, refer here for further instructions.
- This current document refers to the instructions for the upgraded version of the universal bot.
Step 2: Add Linked Bots¶
After you create a universal bot, link one or more existing bots to it. Since a universal bot comprises other bots, you must have already created at least one standard bot.
Important Notes:
- Linking a standard bot does not give the owner or the developers of the universal bot access to the linked Bot’s tasks and functions.
- The universal bot does not clone the tasks in the linked bots but performs them via the linked bot. So, any changes made to the linked bot reflect the universal bot’s functionality.
- The universal bot must be published for any changes made to a linked bot.
- Adding or linking a third-party bot as a standard/child bot to a universal bot is not supported.
Follow these steps to add linked bots to the Universal Bot:
- Open the universal bot to which you want to link other bots.
- Select the Build tab from the top menu.
-
Click Conversational Skills > Linked Bots from the left menu or use the +Link Bots link from the Bot Summary page (landing page when you open a Bot) Linked Bot card.
-
Click the Link a Bot link to open the Select a Bot dialog.
Note
On the Select a Bot dialog, you can only see the bots for which you are either the owner or a co-developer. If you cannot see a bot in this window, make sure the bot is shared with you by its owner.
-
Hover over the Bot to access the Link Bot button, and click the link.
-
Once linked you will see a message stating the same.
-
You can expand the Bot name to see details like Invocation Name and Training Utterances. You can add the same here or later as explained in Step 3: Training Universal Bot.
-
Select the bots that you want to link to the bot and close the dialog.
- Once you have linked Bots to the Universal Bot, the Linked Bots page will list all the Linked Bots. You can use the Link Bot button to link another Bot.
- You can mark some bots as fallback bots or inclusive bots:
- Use the toggle switch to enable or disable the Use as Fallback option for a given bot – the bots thus marked will be used for detecting intents when no other bots are identified from other training options. Up to 15 bots can be marked as fallback bots.
-
Use the toggle switch to enable or disable the Use as Inclusive option for a given bot – these bots need not be trained with sample utterances to participate in the bot scoping process. These bots will always be considered for Intent Detection at the time of evaluating the user utterances, except when the user invokes a linked bot either using ‘Invocation Phrases’ or ‘Trigger Phrases’. Up to 3 linked bots can be marked as inclusive bots.
Unlink a Bot¶
If you want to unlink a linked bot, follow these steps:
- On the Linked Bots page, hover over the bot you want to unlink to view the Un-Link icon.
- Click Un-Link.
Remember to Publish the bot for the changes to be reflected in the published bot.
Step 3: Training¶
Universal Bot functionality enables training of the bot. If your bot is trained in one or more languages that use NLP Version 2, you will see a banner notifying you about the upcoming auto-upgrade to NLP Version 3. This section details the steps in training the bot, for more details on training refer here.
- Open the universal bot that you want to train. This bot should have bots linked to it.
- Select the Build tab from the top menu.
- From the left menu, select Natural Language > Linked Bot Training.
- Select the Linked Bot Training section and Select Bot you want to train.
- Note that Inclusive bots do not need training, the training will not be used for bot scoping. If you choose to train the same, this training will be used later if the linked bot is deselected as an Inclusive Bot.
-
Expand the Invocation Names section to add the same. These will be treated as a special set of synonyms defined against linked bot names. Refer here for more.
-
Expand the Utterances section to add utterances. These refer to the typical ways in which the users are expected to ask for intent from a linked bot. Refer here for more.
-
You can also use the Copy from linked bot option to add the utterances from the linked bot.
- Selecting this option will open a copy from bot page for the linked bot under training.
- Select the relevant task from the linked bot from the Select Task dropdown.
- All the utterances for that task will be listed and you can select from the list. Multiselection is allowed.
- Click Done to add the utterances.
-
Expand the None Intent section to add utterances. The None Intents are used to qualify/disqualify the linked bots based on user utterances. For more information, see the None Intent article.
-
Train the bot to activate these above changes.
Step 4: Configure the Channels¶
The universal Bot requires channel configurations separate from its underlying linked Bots, so the channels must be set up or enabled again. You can set up channels for the universal Bot regardless of the linked Bot channels and the published tasks of the linked Bots will execute from the universal Bot channels.
Before you Begin
This article assumes that you understand the fundamentals of configuring channels in Kore.ai and therefore focuses on the configuration aspects specific to the universal bots. For fundamentals of configuring channels in the Bot Builder, refer to Adding Channels to your Bot.
Important Notes:
- The Universal Bot is available only on the channels enabled for it, regardless of the enabled channels for the linked Bots.
- If a channel is configured for both linked and universal Bots, the message delivered to the user follows the channel-specific messages and formatting configured at the linked Bot.
- If a channel enabled for the universal Bot is not enabled for the linked Bot, the universal Bot responds with the default messages defined for the linked Bot’s functionality.
- If you do not set up any channel-specific formatting at either the universal or the linked Bot’s settings, the default message with standard formatting gets applied.
- Alerts configured from the universal Bot will be delivered via the universal Bot.
Steps in Configuring a Channel
- Open the universal bot for which you want to configure new channels.
- Select the Deploy tab from the top menu.
- Click Channels.
- From the list of supported channels on the Channels page, click the channel to configure it.
- The configuration settings for each channel vary according to the channel. When you click a channel to configure it, the configuration instructions are displayed. Follow them for channel configuration.
-
Configure and save the channel settings.
Step 5: Testing¶
Since the universal Bot links together many standard Bots, the natural language processing settings may have to be optimized for several user utterances to accurately recognize the relevant bot and intent.
Testing the universal bot is similar to testing a standard bot where you type a user utterance and analyze the results. However, in the case of the universal bots, you see not just the shortlisted intents for the utterance but also the bots to which they belong. The name of the bot is prefixed to the intent in the following syntax: Bot Name: Task Name.
Before you begin
This article assumes that you understand the fundamentals of testing bots in the Kore.ai Bots platform and therefore focuses on the testing aspects specific to the universal bots. To refer to the fundamentals of testing bots in the Bots Builder, read Testing your bot.
Steps in Testing a User Utterance
Follow these steps to test user utterances for universal bots:
- Open the universal bot for which you want to test the user utterances.
- Select the Build tab from the top menu.
- From the left menu click Testing -> Utterance Testing.
- In the Type a user utterance field, enter the utterance that you want to test. For example weather.
- The results show up below with single, multiple, or no matching intents. For example, below is a multiple-match result for the weather utterance.
-
Clicking the bots scoped will give the details of the process involved in evaluating the linked bots. Refer here for more details.
Understanding the Test Results¶
The result for test utterances falls into one of these three categories:
- Single Matched Intent: A task or user intent of one of the linked bots matches the input.
- If it is a correct match, you can provide additional training for the same task in the same bot to enhance its score, or you can also train a different task from another bot to recognize the utterance.
- If it is an incorrect match, click the Mark as Incorrect Match link next to the matched intent. Clicking the link allows you to select the task or intent from the same or another bot that should match.
- Multiple Matches with Same Scores: More than one task with the same recognition score matched the intent. These tasks can belong to one or more linked bots. Select the radio button next to the task that you want to match for the utterance.
- Unidentified Intent: The user input did not match any task in any of the linked bots. Train the bot as explained below to match the right bot and linked task.
Improving the Universal Bot Performance¶
You can train the universal bot for more efficient and accurate functioning. Though you train the linked bot from the universal bot windows, the training is saved directly at the linked bot.
Follow these steps to train the linked bots in a universal bot:
- On the Utterance Testing window for the universal bot, select an intent.
-
It opens the following fields that enable you to train the task using machine-learning utterances, synonyms, and patterns.
-
You can also configure the thresholds from the Natural Language > Settings. See here for more.
Step 6: Publishing¶
After you have defined, trained, and saved a new configuration for a Universal Bot, it becomes visible on the Bot Builder home page. It is not available to users other than the developers of the bot until it is published and approved by the Bots Admin.
Note
If you change a linked bot, you must publish the universal bot. Otherwise, the change will not be reflected in the universal bot.
Universal Bot Statuses¶
The following are different statuses related to the universal bots, these will be displayed on the Linked Bots page against the linked Bots selected for publishing:
Universal Bot Status | Description |
Linked | Bot configuration is complete and the standard bots are linked. |
Awaiting Approval | The Bot is published for enterprise use but has not been approved by the Bots Admin. |
Published | The Universal Bot is published for personal, enterprise, or public use. |
Rejected | The Bots Admin did not deploy the bot to the enterprise. An email is sent to the developer with comments from the Bots Admin. |
Suspended | The Bots Admin suspended the use of a deployed bot. An email is sent to the developer with comments from the Bots Admin. |
Publish the Bot¶
Follow these steps to publish a universal bot:
- Open the universal bot that you want to publish.
- Select the Deploy tab from the top menu.
- From the left menu, select Bot Management > Publish option.
-
On the Publish page, select the linked bots you want to publish. This can be to:
- Include new linked bots, or
- Update already published linked bots, or
- Delete any unlinked bots
Note
Default dialog is automatically selected and as it is mandatory to publish it you cannot de-select it.
-
You can choose to Publish the following training components:
- Training Utterances, Invocation Names, Synonyms, Fallback Bots, NLP Settings
Note
The first time you are publishing a Universal Bot, all the NLP settings need to be selected for publishing
-
Enter appropriate Comments and click Publish.
Note
After you publish a universal bot, all the published tasks in the selected linked bots become accessible to the users and any changes made to the linked bots automatically reflect in the universal bot.