GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Help & Learning Resources
Quick Start Guide
Accessing the Platform
Navigating the Kore.ai XO Platform
Building a Virtual Assistant
Using Workspaces
Release Notes
Current Version
Previous Versions
Deprecations
Request a Feature
CONCEPTS
Design
Storyboard
Overview
FAQs
Conversation Designer
Overview
Dialog Tasks
Mock Scenes
Dialog Tasks
Overview
Navigate Dialog Tasks
Build Dialog Tasks
Nodes & Connections
Overview
Node Types
Intent Node
Dialog Node
Entity Node
Entity Rules
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Process Node
Agent Transfer
Node Connections Setup
Context Object
Sub-Intent Scoping
User Prompts
Voice Call Properties
Dialog Task Management
Event Handlers
Supported Entity Types
Supported Company Names
Supported Colors
Knowledge Graph
Introduction
Knowledge Extraction
Build Knowledge Graph
Create Node Structure
Build the Graph
Add FAQs
Add FAQs from an Existing Source
Run a Task
Traits, Synonyms, and Stop Words
Manage Variable Namespaces
Update Knowledge Graph
Introduction
Move Question and Answers Between Nodes
Edit and Delete Terms
Edit Questions and Responses
Knowledge Graph Analysis
Knowledge Graph Import and Export
Prepare Data for Import
From a CSV File
From a JSON File
Importing Knowledge Graph
Exporting Knowledge Graph
Auto-Generate Knowledge Graph
Alert Tasks
Small Talk
Digital Skills
Overview
Digital Forms
Digital Views
Introduction
Widgets
Panels
Train
NLP Optimization
ML Engine
Overview
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
Intelligence
Introduction
Default Standard Responses
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentinment Management
Tone Analysis
Test & Debug
Overview
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Health and Monitoring
Deploy
Channels
Publishing
Versioning
Analyze
Introduction
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Custom Meta Tags
Create Custom Dashboard
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
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Masking PII Details
Variables
Collections
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data as Service
Data Table
Table Views
App Definitions
Sharing Data Tables or Views
HOW TOs
Build a Travel Planning Assistant
Travel Assistant Overview
Create a Travel Virtual Assistant
Design Conversation Skills
Create an ‘Update Booking’ Task
Create a Change Flight Task
Build a Knowledge Graph
Schedule a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Train the Assistant
Use Traits
Use Patterns
Manage Context Switching
Deploy the Assistant
Configure Agent Transfer
Use Bot Functions
Use Content Variables
Use Global Variables
Use Web SDK
Build a Banking 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
Composite Entities
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
Intent Scoping using Group Node
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
Widget SDK Tutorial
Web SDK Tutorial
ADMINISTRATION
Introduction to 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 & Control
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 process, you may want to mark specific stages as versions. The reasons could be as varied as:

  • Creating a version of the assistant before proceeding to subsequent changes;
  • Preserving a fully tested version till the production release while continuing to work on enhancements;
  • Keeping 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 developer can:

  • create multiple versions of the definition;
  • view and manage all versions available for the assistant; and
  • restore the assistant 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.

Version 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 a developer, as discussed below.
    • The maximum number of user-created versions that will be created is set to 20. Once this limit is reached new versions will be created and the oldest versions are deleted.
  • Auto Created: These versions are created as part of the publishing cycle. Learn more.
    • Whenever you publish a VA, the Platform creates a version automatically.
    • This auto version includes the definition of the published copy of the assistant 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 versions will be created and the oldest versions are deleted.

Creating a Bot Version

In this section, we discuss user created versions. Following are the steps to create such a version:

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


Version Actions

Following are the actions you can perform from the Bot Versions listing page:

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

Comparing Versions

The Version Comparison feature facilitates understanding the differences between versions of the same assistant. It helps to:

  • Debug issues in the recently published version by letting developers compare the published version with any of the previous versions.
  • Analyze changes before Publish. Developers can take a snapshot of changes by comparing a copy of the in-development version and the published version of the assistant.
  • Perform Impact Analysis before (or after) Version Restore. Developers 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 assistant’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 assistant to review the list of changes made to its definition between the two versions.

To compare versions, follow the below steps:

  1. On the Bot Versions page, you can find a list of existing versions.
  2. Hover over the version you want to compare and click Compare.
  3. On the Select Another Version to Compare window, you can find the selected version (source) of your assistant and a list that contains different versions (target). Select a version from the list to compare to.
  4. Click Proceed.

  5. On the Version Comparison page, you can find the comparison details categorized into:
    1. Tasks
    2. Training 
    3. Intelligence
    4. Settings
    5. Variables
    6. Change Logs
  6. The following information is highlighted to the developer in a JSON format:
    1. Data addition – Newly added data in the secondary version is highlighted, but not in the primary version.
    2. Data removal – Data deleted from the primary version is highlighted, but not in the secondary version.
    3. Data update – In the case of key-value pairs, the same key present in both versions with different values is highlighted. 
    4. 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.

Restoring Versions

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

How restoration works

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

 

Tasks

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

  • If there are one or more additional tasks in the assistant, 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 development and they will automatically be removed from the Published copy of the assistant 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 assistant to an unpublished state then imports might be restricted.

 

Knowledge Graph

The following rules apply to Knowledge Tasks (per Language)

  • If there are one or more additional FAQs in the assistant, 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 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 FAQs in the assistant , 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 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 definition which are not present in the restored version definition, then such languages will be considered as ‘deleted’ from the configured version of the assistant.
  • These ‘deleted’ languages will not be available for development.
  • The language deletion will get reflected in the published copy after the subsequent publishing of the assistant, post-restoration.

 

Channels

  • Channels are not part of definition and as such will 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.

Exporting Versions

Using the Export option, you can download a .zip archive of your assistant. These exports can be useful for backup purposes or to use as imports during your development process.

Deleting User-Created Versions

You can delete user-created versions via the More Options Menu > Delete

Warning:

Deleted versions cannot be restored. Please proceed with caution and only delete versions if you are absolutely sure.

Menu