{"id":18023,"date":"2018-01-16T09:23:42","date_gmt":"2018-01-16T09:23:42","guid":{"rendered":"http:\/\/developer.kore.ai\/v7-2\/?post_type=docs&p=12557"},"modified":"2021-03-30T10:44:21","modified_gmt":"2021-03-30T09:44:21","slug":"defining-universal-bots","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v7-2\/docs\/bots\/advanced-topics\/universal-bot\/defining-universal-bots\/","title":{"rendered":"Defining a Universal Bot"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Universal Bots facilitate a scalable, modular approach to Bot building by helping you link several Bots into one. The Universal Bot executes the tasks and functions of the linked Bots by routing relevant utterances to the corresponding Bot.<\/p>\n

Once you publish a Universal Bot, changes made in the linked Bots automatically reflect in the Universal Bot. As a creator or developer of a Bot, you can add any Bots (published and configured) to a universal Bot and access their underlying tasks and functions. When you publish a universal bot, the end users can only access the tasks that are published in the linked bots.<\/p>\n

Note:<\/b> A universal Bot doesn\u2019t own the linked bots, but it interprets the user utterances and maps them to the correct linked bots. The changes that you make to a linked bot task from inside the universal bot, such as training the task, are saved directly to the linked bot. Also, you cannot create any task for the universal bots except for customizing a default dialog task that gets created automatically with every universal bot.<\/div>\n

Before starting with creating a Universal Bot<\/a>, let us understand how Univeral Bots work and how they differ from the Standard Bots.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Bot Responses<\/span><\/h3>\n

Universal bot responses vary with the number of bots and tasks that match the user intent along with their relevance (exact matches or suggestions). The Natural Language Processing (NLP)<\/a> engine processes the utterances sent to the linked bots, detects the user intents, and ranks them based on relevance. As a developer, you can test and train the bot responses as explained in Test the Universal Bot<\/a>.<\/p>\n

Following the table shows how universal bot responses operate in various possible NLP outcomes:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
NLP Outcome<\/th>\nBot Response<\/th>\n<\/tr>\n<\/thead>\n
Only one exact match found from any of the linked bots<\/td>\nExecutes the task with the exact match<\/td>\n<\/tr>\n
Exact matches found in more than one linked bot<\/td>\nShows the names of the bots to the user and prompts them to select one<\/td>\n<\/tr>\n
Exact matches found with two or more tasks of a single linked bot<\/td>\nShows all the matching tasks to the user and prompts them to select one<\/td>\n<\/tr>\n
Suggestions found in more than one linked bot<\/td>\nShows the names of the matching bots to the user and prompts them to select one<\/td>\n<\/tr>\n
Suggestions found with two or more tasks of a single linked bot<\/td>\nShows all the suggestions to the user and prompts them to select one<\/td>\n<\/tr>\n
Only one suggestion found<\/td>\nShows the suggestion to the user asking if they would like to select it<\/td>\n<\/tr>\n
No exact match or suggestion found<\/td>\nExecutes the universal bot\u2019s default dialog in the specified language.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Standard Bots vs. Universal Bots<\/span><\/h3>\n

Universal Bots connect multiple Standard Bots into a single bot. They support most Standard Bot features with a few exceptions.<\/p>\n

Enabled Features and Configurations<\/h4>\n

This section assumes that you understand the fundamentals of standard bots<\/a>. Details relevant to the Universal Bots alone are listed here. We recommend you to refer to the relevant standard bot documentation for help with the basics.
\nThe Feature<\/strong> column entries in the following table provide URLs to the standard bot documentation.
\nThe Learn more<\/em> links in the Description<\/strong> column refer to the universal bot documentation.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Feature<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
Natural Language<\/b><\/h5>\n<\/td>\n<\/tr>\n
Testing<\/a><\/td>\nSince the universal bot links together standard bots, the Natural Language Processing (NLP) settings are optimized to accurately recognize the relevant bot and intent. You can test and train the universal bot like a standard bot with small differences. When you train the task it happens at the linked bot level. Learn more<\/a>.<\/td>\n<\/tr>\n
Standard Responses<\/a><\/td>\nThe universal bot will hold a limited set of standard responses that are relevant to bot level functions like greetings. Go to Natural Language -> Default Conversation<\/b>, to access the Standard Responses<\/b> section to edit the relevant standard responses.<\/td>\n<\/tr>\n
Batch Testing<\/a><\/td>\nUniversal bots only support testing Custom-defined utterances<\/em> and not Developer-defined utterances<\/em> and Succesful user utterances<\/em>.
\nThe Custom-defined utterances<\/em> test suites remain similar to the standard bots’ except that the JSON Dataset file that you upload should contain a bot name along with the intent and input for every test case. Also, the downloaded batch test report shows the results with corresponding bot names.<\/td>\n<\/tr>\n
Default Dialog<\/a><\/td>\nUniversal bots come with a default dialog task that gets triggered for unidentified intents. You can customize this task or import a new one. Learn more<\/a>.<\/td>\n<\/tr>\n
Help<\/td>\n\n

When a user types\u00a0Help<\/strong> during a chat, a standard bot responds with the list of tasks that it can perform, allowing the user to select a task name to execute.<\/p>\n

When it comes to Universal bots, if a user types Help<\/strong>, the bot responds with the names of linked bots. The user cannot select or execute a task from the list.<\/td>\n<\/tr>\n

\n
Channel Configuration<\/b><\/h5>\n<\/td>\n<\/tr>\n
All<\/a><\/td>\nUniversal bots do not obtain the channel configurations of the linked bots and need an independent channel configuration. You can set up new channels for the universal bot independent of the linked bot channels. The published tasks in the linked bots execute from the universal bot channels. Learn more<\/a>.<\/td>\n<\/tr>\n
\n
Settings<\/b><\/h5>\n<\/td>\n<\/tr>\n
General Settings<\/a><\/td>\nUniversal and standard bots share the same general settings.<\/td>\n<\/tr>\n
Language Management<\/a><\/td>\nUniversal bots do not obtain the enabled languages of the linked bots. You must enable default and additional languages explicitly for the universal bot. But when user utterances are made in an enabled language, the universal bot routes it to only those linked bot tasks that support the language. For example, if German is enabled for the universal bot and a user utters in German, the NLP engine looks for all the linked bot tasks that support German and sends the utterance to those tasks. Learn more<\/a>.<\/td>\n<\/tr>\n
Developer Collaboration<\/a><\/td>\nWorks similar to standard bots. Once you share a Universal Bot with other developers, they can link and unlink bots.<\/td>\n<\/tr>\n
Change Logs<\/a><\/td>\n\n

Universal bot change logs record all the changes applicable to the standard bots, plus the following:<\/p>\n

    \n
  1. Linking of a bot<\/li>\n
  2. Un-linking of the bot<\/li>\n
  3. Change to default dialog<\/li>\n
  4. Publishing of default dialog<\/li>\n<\/ol>\n<\/td>\n<\/tr>\n
\n

Import & Export bot<\/a><\/p>\n

(supported from ver7.1)<\/td>\n

\n

Like standard bots, you can export and import the published and unpublished universal bots. Since universal bots deal with linked bots the following need to be taken care of:<\/p>\n

    \n
  • Export of a universal bot<\/span> – only the reference to the linked bot (reference id) will be included not the entire linked bot definition;<\/li>\n
  • Import of the universal bot<\/span> – in the environment where the bot is being imported to, the platform checks for the bots with reference id matching the linked bot. If found they are automatically linked to the imported universal bot. Also you should have permissions for the linke bot, else it will not be linked. Ensure that you import the linked bots before importing the universal bot.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
Delete bot<\/a><\/td>\nLike standard bots, you can delete the unpublished universal bots.<\/td>\n<\/tr>\n
\n
API Extensions<\/b><\/h5>\n<\/td>\n<\/tr>\n
SDK toolkit<\/a><\/td>\nEnabled with the following events – on message,\u00a0on hook,\u00a0on event,\u00a0on alert<\/td>\n<\/tr>\n
Agent Transfer<\/a><\/td>\nAgent Transfer can be configured for a Universal Bot. The Agent Node needs to be added in default dialog and addition of any subsequent nodes after the agent node is not allowed.<\/td>\n<\/tr>\n
WebHook Node<\/a><\/td>\nMultiple webhook nodes can be placed in the default dialog. When a webhook node is reached during the conversation, the platform invokes the BotKit similar to that of a Standard Bot.<\/td>\n<\/tr>\n
SDK as Channel<\/td>\nEnabled<\/td>\n<\/tr>\n
\n
Analyze<\/b><\/h5>\n<\/td>\n<\/tr>\n
Chat History<\/td>\nAll the Universal Bot chats get recorded. Any initiated training will affect the individual linked bot.<\/td>\n<\/tr>\n
\n
Publish<\/b><\/h5>\n<\/td>\n<\/tr>\n
All<\/a><\/td>\nYou can select one or more linked bots and publish the Universal Bot like any Standard Bot. Learn more<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Event Management<\/span><\/h3>\n

Let us see the behavior of Universal Bots for the following BotKit events in Linked Bots:<\/p>\n

    \n
  • On Message<\/li>\n
  • Agent<\/li>\n
  • Webhook<\/li>\n
  • Event<\/li>\n
  • Alert Events<\/li>\n<\/ul>\n

    When a child bot is in context i.e., a task from a child bot is in progress, then the events related to the child bots will be triggered based on the configurations set up by the developer:<\/p>\n

      \n
    • If an event is enabled in child bot, then the event will be forwarded to child bot BotKit<\/li>\n
    • If an event is not enabled in child bot and\n
        \n
      • if that event is enabled in Universal bot, then the event will be sent to Universal bot BotKit<\/li>\n
      • if that event is not enabled in Universal bot as well, then the event will not be forwarded to any BotKit.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n

        Following table summarises the above scenarios and behavior:<\/p>\n\n\n\n\n\n\n\n\n\n\n
        Event Name<\/th>\nChild Bot Status<\/th>\nUniversal Bot Status<\/th>\nExpected Behavior<\/th>\n<\/tr>\n<\/thead>\n
        On Message<\/td>\nEnabled<\/td>\n\u2013<\/td>\nEvent sent to child bot BotKit<\/td>\n<\/tr>\n
        <\/td>\nDisabled<\/td>\nEnabled<\/td>\nEvent sent to Universal BotKit<\/td>\n<\/tr>\n
        <\/td>\nDisabled<\/td>\nDisabled<\/td>\nInvalid scenario. The event does not trigger in this case<\/td>\n<\/tr>\n
        All other events<\/td>\nEnabled<\/td>\n\u2013<\/td>\nEvent sent to child bot BotKit<\/td>\n<\/tr>\n
        <\/td>\nDisabled<\/td>\nEnabled<\/td>\nEvent sent to Universal BotKit<\/td>\n<\/tr>\n
        <\/td>\nDisabled<\/td>\nDisabled<\/td>\nSame as the current behavior. E.g. dialog reaches Webhook node but ‘on Hook’ event is not enabled<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
        <\/div><\/div>\r\n\t
        \r\n\t\t
        \r\n\t\t\t

        Unsupported Features<\/span><\/h3>\n

        Universal Bots do not<\/span> support the following features:<\/p>\n

          \n
        • Natural Language\n
            \n
          • Training<\/li>\n
          • Intelligence<\/li>\n<\/ul>\n<\/li>\n
          • Variable Management<\/li>\n<\/ul>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
            <\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"Universal Bots facilitate a scalable, modular approach to Bot building by helping you link several Bots into one. The Universal Bot executes the tasks and functions of the linked Bots by routing relevant utterances to the corresponding Bot. Once you publish a Universal Bot, changes made in the linked Bots automatically reflect in the Universal...","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[57],"tags":[],"class_list":["post-18023","post","type-post","status-publish","format-standard","hentry","category-universal-bot"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v7-2\/wp-json\/wp\/v2\/posts\/18023","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v7-2\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v7-2\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v7-2\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v7-2\/wp-json\/wp\/v2\/comments?post=18023"}],"version-history":[{"count":10,"href":"https:\/\/developer.kore.ai\/v7-2\/wp-json\/wp\/v2\/posts\/18023\/revisions"}],"predecessor-version":[{"id":23786,"href":"https:\/\/developer.kore.ai\/v7-2\/wp-json\/wp\/v2\/posts\/18023\/revisions\/23786"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v7-2\/wp-json\/wp\/v2\/media?parent=18023"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v7-2\/wp-json\/wp\/v2\/categories?post=18023"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v7-2\/wp-json\/wp\/v2\/tags?post=18023"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}