GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Quick Start Guide
Accessing the Platform
Working with the Builder
Building a Virtual Assistant
Using Workspaces
Release Notes
Current Version
Previous Versions
Deprecations

CONCEPTS
Design
Storyboard
Dialog Tasks
Overview
Dialog Builder
Node Types
Intent Node
Dialog Node
Entity Node
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Group Node
Agent Transfer
User Prompts
Voice Call Properties
Dialog Task Management
Connections & Transitions
Component Transition
Context Object
Event Handlers
Knowledge Graph
Introduction
Knowledge Extraction
Build Knowledge Graph
Add Knowledge Graph to Bot
Create the Graph
Build Knowledge Graph
Add FAQs
Run a Task
Build FAQs from an Existing Source
Traits, Synonyms, and Stop Words
Manage Variable Namespaces
Update
Move Question and Answers Between Nodes
Edit and Delete Terms
Edit Questions and Responses
Knowledge Graph Training
Knowledge Graph Analysis
Knowledge Graph Import and Export
Importing Knowledge Graph
Exporting Knowledge Graph
Creating a Knowledge Graph
From a CSV File
From a JSON file
Auto-Generate Knowledge Graph
Alert Tasks
Small Talk
Digital Skills
Digital Forms
Views
Introduction
Panels
Widgets
Train
Introduction
ML Engine
Introduction
Model Validation
FM Engine
KG Engine
Traits Engine
Training Validations
Ranking and Resolver
NLP Configurations
NLP Guidelines
Intelligence
Introduction
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Sentinment Management
Tone Analysis
Test & Debug
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Health and Monitoring
Deploy
Channels
Publish
Analyze
Introduction
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Meta Tags
Dashboards and Widgets
NLP Insights
Conversations History
Conversation Flows
Analytics Dashboard Filters
Usage Metrics
Containment Metrics
Smart Bots
Universal Bots
Introduction
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Store
Manage Assistant
Plan & Usage
Overview
Usage Plans
Support Plans
Invoices
Authorization
Multilingual Virtual Assistants
Masking PII Details
Variables
IVR Settings
General Settings
Assistant Management
Data as Service
Data Table
Table Views
App Definitions
Sharing Data Tables or Views

HOW TOs
Build a Flight Status Assistant
Design Conversation Skills
Create a Sample Banking Assistant
Create a Transfer Funds Task
Create a Update Balance Task
Create a Knowledge Graph
Set Up a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Add Data to Data Tables
Update Data in Data Tables
Add Data from Digital Forms
Train the Assistant
Use Traits
Use Patterns for Intents & Entities
Manage Context Switching
Deploy the Assistant
Configure an Agent Transfer
Use Assistant Functions
Use Content Variables
Use Global Variables
Web SDK Tutorial
Widget SDK Tutorial
Analyze the Assistant
Create a Custom Dashboard
Use Custom Meta Tags in Filters

APIs & SDKs
API Reference
API Introduction
API List
API Collection
koreUtil Libraries
SDK Reference
SDK Introduction
SDK Security
SDK Registration
Web Socket Connect and RTM
Using the BotKit SDK
BotKit SDK Tutorial - Blue Prism

ADMINISTRATION
Introduction
Assistant Admin Console
Administration Dashboard
User Management
Add Users
Manage Groups
Manage Roles
Assistant Management
Enrollment
Invite Users
Send Bulk Invites
Import User Data
Synchronize Users from AD
Security & Compliance
Using Single-Sign On
Security Settings
Cloud Connector
Analytics
Billing
  1. Home
  2. Docs
  3. Virtual Assistants
  4. Bot Settings
  5. Bot Management
  6. Bot Versioning

Bot Versioning

Very often, as part of the development, you may want to mark specific stages of development as versions. The reasons could be as varied as:

  • creating a version of the bot before proceeding to subsequent changes;
  • to preserve a fully tested version till the production release while continuing to work on enhancements;
  • to keep track of all the changes made.

If the new changes are not working out, for any reason, then you would want to revert back to the previous state.

Overview

Kore.ai’s Bot Versions option is specifically designed to meet the above requirements.

Using this option, you as a bot developer can:

  • create multiple versions of the bot definition;
  • view and manage all versions available for the bot; and
  • restore the bot to a previous version.

Versioning is supported in Standard and Universal Bots.

This option can be accessed from the Deploy tab from the top menu, under the left menu option Bot Management -> Bot Versions.

Types

The version type is based on the ways in which a Bot version is created:

  • User Created: These versions are created by you as Bot Developer
    • See below for the process.
    • The maximum number of user-created versions that will be created is set to 20. Once this limit is reached new version will be created and the oldest versions are deleted.
  • Auto Created: These versions are created as part of the bot Publish cycle.
    • Whenever you publish a bot, the platform creates a version automatically.
    • This auto version includes the definition of the published copy of the bot after the current publish request is accepted.
    • In case the publish request is rejected, the version will not be created.
    • You cannot delete these versions.
    • While an auto-version creation is in-progress, you cannot raise any subsequent publish requests.
    • The maximum number of auto-versions that will be created is set to 20. Once this limit is reached new version will be created and the oldest versions are deleted.

Creation

Following are the steps to create a version:

  1. From the Bot Versions page, click the Create Version button.
  2. You will be prompted to enter:
    • Version Name – enter a unique name that would ideally give an idea of a major feature of the Bot.
    • Description – add in brief the changes that went into this version.
  3. Click Create Version when done. Your bot version is created.

Actions

Following are the actions you can perform from the bot version listing page:

  1. On the Bot Versions page, you will see a list of all versions of the bot.
  2. For each version you can view:
    • Name of the versions
    • Description of the version
    • Platform Version where this bot version was created
    • Created on – the version creation timestamp
    • Created by – the user who created the version.
  3. You can perform the following actions on each version:
    • Restore to a specific version;
    • Export a specific version;
    • Delete a specific version (not applicable for auto-versions).
  4. You can Compare versions to track changes.

Version Restoration

Using the Restore option against any version, you can replace the current ‘in-development’ version of the bot with the definition present in that version. The restoration honors the bot compatibility versions and will reject any non-compatible version restorations.

How restoration works

The following is how version restore is handled for each of the Bot components:

Tasks:

The following rules apply to Dialog Tasks, Action / Alert / Information Tasks, Small Talk (per language), UI Forms, Panels and Widgets

  • If there are one or more additional tasks in the bot, and if these are not present in the restoration version definition, then these tasks will be implicitly marked as ‘Deleted’ in the platform.
  • These ‘Deleted’ tasks will not be available for the bot development and they will automatically be removed from the Published copy of the bot during the first publish request post-restoration. You will not be allowed to exclude these delete requests from the publish requests.
  • Once deleted if you restore a version that contains these deleted tasks they will be included as new tasks with the same name and the original (deleted) tasks will still be marked as deleted in the Publish logs.
  • If you have restored a published bot to an unpublished state then bot import might be restricted.

Knowledge Graph:

The following rules apply to Knowledge Tasks (per Language)

  • If there are one or more additional FAQs in the bot, and if these are not present in the restoration version definition, then these tasks will be implicitly marked as ‘Deleted’ in the platform.
  • These ‘Deleted’ tasks will not be available for the bot development
  • These FAQs will be removed from published copy only if the corresponding parent nodes are selected for publishing during the publish request
  • If the corresponding parent nodes are not selected for publishing, then those FAQs will be present in the Published copy but considered as deleted in the in-development copy
  • Once deleted if you restore a version that contains these deleted tasks they will be included as new tasks with the same name and the original (deleted) tasks will still be marked as deleted in the Publish logs.

Small Talk:

The following rules apply to Small Talk (per Language)

  • If there are one or more additional QnAs in the bot, and if these are not present in the restoration version definition, then these tasks will be implicitly marked as ‘Deleted’ in the platform.
  • These ‘Deleted’ tasks will not be available for the bot development
  • These QnAs will be removed from published copy only if Small Talk is selected for publishing during the publish request

Languages

  • If there are one or more additional languages in the bot definition which are not present in the restore version definition, then such languages will be considered as ‘deleted’ from the configured version of the bot.
  • These ‘deleted’ languages will not be available for bot development
  • The language deletion will get reflected in the published copy after the subsequent publishing of the bot post-restoration

Channels

  • Channels are not part of bot definition and as such will bot be part of versioning ie. the current channel enablement will not change on version restoration.
  • One exception is the Webhook channel. The web channel configuration of the current version will be replaced by that of the restored version.

Bot Management

  • Bot Import will not be allowed until the restored version is published.

Version Compare

The Version Comparison feature allows you to understand the differences between different versions of the same bot. It helps to:

  • Debug issues in the recently published version by letting them compare the published version with any of the previous versions.
  • Analyze changes before Publish. The developer can take a snapshot of changes by comparing a copy of the in-development version and the published version of the bot.
  • Perform Impact Analysis before (or after) Version Restore. The developer can get a better understanding of the impact of version restoration by comparing the two versions.
  • Analyze changes in NLP/NLU. NLP trainers can analyze the change in the bot’s NLP performance by comparing the training present in two versions.

Using the Compare option against any version, you can compare any two versions of your bot to review the list of changes made to the bot definition between the two versions.

To compare bot versions, follow the below steps:

  1. On the Bot Versions page, you can find the list of your bot versions.
  2. Hover over the bot version you want to compare and click Compare.
  3. On the Select Another Version to Compare window, you can find the selected version (base) of your bot and a list that contains different versions (target). Select a bot version from the list to compare.
  4. Click Proceed.
  5. On the Version Comparison page, you can find the comparison details categorized into:
    • Tasks
    • Training 
    • Intelligence
    • Settings
    • Change Logs
  6. The following information is highlighted to the developer in a JSON format:
    • Data addition – Newly added data in the secondary version is highlighted, but not in the primary version.
    • Data removal – Data deleted from the primary version is highlighted, but not in the secondary version.
    • Data update – In the case of key-value pairs, the same key present in both versions with different values is highlighted. 
    • For data addition and removal, an empty line is shown in the version where the corresponding detail is missing to understand the position of the new line.

  7. A summary count of the total changes is displayed and supports search.
Menu