Bot Management

This article discusses the main features that allow you to manage your assistant at a high level. These include: Importing, Exporting and Deleting assistants, as well as viewing change logs.

Please also read about Variables and how these can be managed. Refer here for more.

Importing and Exporting Assistants

Kore.ai allows you to export and import assistant tasks and associated configurations into another assistant. This feature helps you in the migration of bot definition, cloning of assistants, or for maintaining a periodic backup of bot definitions. It is particularly helpful to test various versions of your assistant at different stages of the development process before it is released for end users. The articles in this section help you understand how the Export and Import features work and how to perform them. NOTE: Post v8.0 release, the enableNegativePatterns flag will be included in ‘NLP Settings’ under ‘NLP Data’ in the exported and imported bot definitions. This flag is used to check if the Negative Patterns are enabled/disabled in the assistant. Prior to this patch, this flag was part of ‘NLP Settings’ under ‘NLP Data’ in the imported bot definitions and ‘Bot Setting’ under ‘Setting’ in the exported bot definitions. This change is aimed at streamlining the functionality and might result in the failure to the incremental import of a bot from an export file generated before v8.0.

Importing an Assistant

You can import tasks and configurations of a specific assistant into a new or existing assistant using one of these import types:

• Full import: Replaces the existing assistant with the imported configurations. Any additional configurations in the target assistant that are not present in the import definition will be deleted. An exception to this rule is the webhook channel, which will be retained even if not present in the import bot definition.
  Note: We strongly recommend you exercise caution and take a backup of the target assistant before importing using this option.
• Incremental import: Upgrades the current assistant with the configurations available in the import file. Any additional configurations available in the target or imported bot are retained. You can select specific bot components to import from the bot tasks, NLP data, and bot settings. Refer to the Bot Items in the Incremental Import table at the end of the article to learn how the imported bot items replace the target bot’s items in incremental import.

Before you Begin The config.json file consists of bot variables that need values for the target assistant. Share the file with the relevant developers or enter suitable values yourself for the variables before importing the bot definition into a new bot.

Steps in Importing to an Existing Assistant

To import a Virtual Assistant, follow these steps:

1. Open the assistant you want to export
2. Select the Deploy tab from the top menu
3. From the left menu select Bot Management -> Import & Export
4. On the Import & Export page select the Import tab
5. Click the CHOOSE FILE buttons next to the BOT DEFINITION FILE field and BOT CONFIG FILE field, and upload the botDefinition.json and config.json files respectively.
6. Optionally, upload the custom script file from the imported assistant if any.
   
7. Select one of these import options: Full Import or Incremental Import.
8. If you select Full import, the bot definition in the in-development copy will be overwritten with the definition present in the import file.
   • If there are one or more additional tasks or languages in the assistant, and if these are not present in the import definition, then these tasks will be marked as deleted and will be removed when the bot is published.
   • You can choose to auto-publish the assistant post-import.

   

9. If you select Incremental import, you can also choose which components to import.
   
   • Tasks: Here is where you can select to import Tasks only (with or without comments), Knowledge Graph, Small Talk or Digital Forms.
     
   • NLP Data: This is where you can import NLP Settings, Utterances, Patterns and Standard Responses. ML Utterances and Patterns can either be Appended or Replaced.
     • Append can be used when the utterances present in the file should be imported into the assistant and any additional utterances in the bot should be retained (this is the default behavior)
     • Replace can be used when the utterances present in the file should be imported into the assistant. Any additional utterances will be removed.
       • In case you are importing Tasks too, the additional utterances related to tasks being imported will be removed.
         
   • Settings: Bot Settings, Bot Variables and Voice Call Properties.
   • Custom Dashboards – This is useful in case you have created custom dashboards under the Analyze section and you want to import these to the new VA as well. 
10. On the confirmation dialog that opens, click Backup to download the existing assistant configuration.
    Note: While backing up is an optional choice, we strongly recommend you do so, especially when choosing Full Import, as you cannot recover the configurations after the imported assistant replaces them.

    

    • Click Proceed to start the import.
    • After the import is completed, the following success message appears. Click Done.

Creating a New Assistant Using the Import Option

To import a VA while creating it, follow these steps:

1. On the top-right side of the XO Platform homepage, click New Bot > Import a Bot.
   
2. Enter a Name, Target Audience, and Color for the assistant.
3. Click the CHOOSE FILE buttons next to the BOT DEFINITION FILE field and BOT CONFIG FILE field and upload the botDefinition.json and config.json files respectively.
4. Optionally, upload a Custom Script file from the source assistant if any, and click Import.
   
5. On the success message after the end of importing, click Done to proceed to the Tasks page.

Components in the Incremental Import

Exporting a Assistant

You can export a bot’s definition and configuration using the Export option. When you export a assistant, it downloads a zipped file with the following:

• botDefinition.json: Includes metadata, tasks, bot and task-level synonyms, utterances, patterns, knowledge graph, standard responses, flows, and IDPs. You can select specific items to export from tasks, NLP data – NLP settings, utterances, standard responses – and Settings – bot settings, variables, IVR settings- while exporting the assistant.
• config.json: Includes bot settings, bot variables, and IVR settings.
• Icon.png: Includes the assistant icon.
• <Custom ScriptFile Name.js> (if available): Includes a script file with JavaScript functions. When you upload this file, you can access the functions in the file from anywhere in the assistant.

Export Modes

You can export assistants in two modes: Published and Latest Version. Depending on the mode that is selected, the corresponding versions of the tasks are exported. You can select specific components to export from the tasks, NLP data, and bot settings in both the modes. Further individual Tasks can also be selected.

Published Mode

When you export a VA in the Published mode, only the published versions of the tasks are exported, regardless of any other existing versions. For example, if a VA consists of a published version of a task and also version in Upgrade in Progress, only the published version gets exported. Refer to the table below to understand which versions of the tasks are exported in the Published mode:

Latest Version

When you export a VA in the Latest mode, the latest versions of the  tasks get exported, regardless of their publishing status. For example, if a VA consists of a published version of a task and also the version in Upgrade in Progress, the Upgrade in Progress version gets exported, whereas if it just has a Configured version, the configured version is exported. Refer to the table below to understand which versions of the tasks are exported in the Latest mode:

Steps in Exporting the Assistant

1. Open the assistant you want to export
2. Select Deploy tab from the top menu
3. From the left menu select Bot Management -> Import & Export
4. On the Import & Export page, select the Export tab
5. In the Export tab, select either Published or Latest Version exporting mode.
6. By default, all the components are selected for export. Deselect the items that you do not want to export.
7. For Tasks, you can further choose to export only select tasks. By default All Tasks are selected. Click the All Tasks link to open Select Tasks dialog to choose the tasks you want to export
8. You can also choose to Include dependent tasks or not for export. The existence of these will be checked before import and the import will fail if the dependent tasks are missing. These dependent tasks include the following:
   • Linked Dialogs i.e. dialog nodes present in the definition of another dialog;
   • Dialogs linked in defining ‘Behavior on Exceeding Retries’ for IVR Properties of any node of the dialog;
   • Dialog linked as part of sub-intent / interruption settings;
   • Any other scenario where a dialog execution could fail if a dependent task is not included;

   

9. Click Export. The export happens in the background and the Download button gets activated after it is complete. Click Download to download the file to your local computer.

Exported Bot Components

When you export a VA, the following components get exported, depending on your Latest or Published Mode selection:

Deleting an Assistant

You cannot delete a VA if any of the tasks are Published. Once you publish a task, the Bots Admin must approve and assign it to users. The developer cannot delete assigned tasks. To delete a published task, the Bots Admin needs to suspend the task. Also, you cannot delete a VA if it is part of a published flow. You must delete the flow or remove the assistant from the flow before attempting to delete it.

Steps to Delete an Assistant

• Open the assistant you want to delete
• Select the Deploy tab from the top menu
• From the left navigation under the Bot Management menu, click Delete Bot.
  

Viewing the Change Log

After creating a VA, you may need to edit it for various reasons such as changing its settings, adding tasks, enabling channels, and add flows. To track all the changes made to a VA, you can view the Change Logs, which show a chronological list of modifications to your assistant. It consists of all the changes from the initial save of your assistant to the last update. To view the changelog for a VA, follow these steps:

1. Select Deploy tab from the top menu
2. From the left menu click Change Logs.
   
3. On the Change Logs page, you will notice the following;  
   • The list is sorted in reverse chronological order.
   • Each page displays the ten most recent changes and the name of the user that made the change, followed by the change synopsis, and the timestamp of the applied change.
   • Logs of the Publish Event are consolidated for all selected tasks, with the tasks listed in case all tasks are not selected for publishing along with the Publish Comments.

Following actions can be performed on the logs:

• Using the search text box, you can enter any text and the platform will search for that text in the change description and the logs fulfilling the search criteria would be displayed.
• The filter option can be used to filter based on:
  • Developer Name collaborating on the assistant;
  • Date Range either past 24 hrs, past 7 days, or custom date by specifying the start and end date. By default,  changes from all developers in the past 24 hours would be displayed.
• The export icon can be used to Export the changelog in CSV format. The logs displayed after applying the search and filter criteria would be downloaded.