OVERVIEW
Virtual Assistants
Kore.ai Platform
Key Concepts
Natural Language Processing (NLP)
Accessing Platform
VIRTUAL ASSISTANTS
Virtual Assistant Builder
Virtual Assistant Types
Getting Started
Creating a Simple Bot
SKILLS
Storyboard
Dialog Task
Introduction
Dialog Builder (New)
Dialog Builder (Legacy)
User Intent Node
Dialog Node
Entity Node
Supported Entity Types
Composite Entities
Supported Colors
Supported Company Names
Form Node
Logic Node
Message Nodes
Confirmation Nodes
Bot Action Node
Service Node
Custom Authentication
2-way SSL for Service nodes
Script Node
Agent Transfer Node
WebHook Node
Grouping Nodes
Connections & Transitions
Manage Dialogs
User Prompts
Knowledge Graph
Terminology
Building
Generation
Importing and Exporting
Analysis
Knowledge Extraction
Build
Alert Tasks
Introduction
Ignore Words and Field Memory
How to Schedule a Smart Alert
Small Talk
Digital Views
Overview
Configuring Digital Views
Digital Forms
Overview
How to Configure Digital Forms
NATURAL LANGUAGE
Overview
Machine Learning
Introduction
Model Validation
Fundamental Meaning
Introduction
NLP Guidelines
Knowledge Graph
Traits
Introduction
How to Use Traits
Ranking and Resolver
Advanced NLP Configurations
INTELLIGENCE
Overview
Context Management
Overview
Session and Context Variables
Context Object
How to Manage Context Switching
Manage Interruptions
Dialog Management
Sub-Intents & Follow-up Intents
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Event Based Bot Actions
Default Conversations
Default Standard Responses
TEST & DEBUG
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
CHANNELS
PUBLISH
ANALYZE
Overview
Dashboard
Custom Dashboard
Overview
How to Create Custom Dashboard
Conversation Flows
NLP Metrics
ADVANCED TOPICS
Universal Bots
Overview
Defining
Creating
Training
Customizing
Enabling Languages
Store
Smart Bots
Defining
koreUtil Libraries
SETTINGS
Authorization
Language Management
PII Settings
Variables
Functions
IVR Integration
General Settings
Management
Import & Export
Delete
Versioning
Collaborative Development
PLAN & USAGE
Overview
Usage Plans
Support Plans
Invoices
API GUIDE
API Overview
API List
API Collection
SDKs
SDK Overview
SDK Security
SDK App Registration
Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Widget SDK Tutorial
Widget SDK – Message Formatting and Templates
Web Socket Connect & RTM
Using the BotKit SDK
Installing
Configuring
Events
Functions
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
ADMINISTRATION
HOW TOs
Creating a Simple Bot
Creating a Banking Bot
Context Switching
Using Traits
Schedule a Smart Alert
Configure UI Forms
Add Form Data into Data Tables
Configuring Digital Views
Add Data to Data Tables
Update Data in Data Tables
Custom Dashboard
Custom Tags to filter Bot Metrics
Patterns for Intents & Entities
Build Knowledge Graph
Global Variables
Content Variables
Using Bot Functions
Configure Agent Transfer
Update Balance Task
Transfer Funds Task
RELEASE NOTES
  1. Home
  2. Docs
  3. Virtual Assistants
  4. Bot Settings
  5. Bot Management
  6. Collections

Collections

Collections enable you to store multiple value sets for Environment Variables so that you can select the appropriate variable set while promoting the bot definition to a different environment without manual intervention.

Note: This feature was enabled in v8.1 of the platform and is available only for the on-prem installation.

Environment variables are a primary type of bot variables where you define a key-value pair and use the variable across the bot. As the variables are declared globally, they can be used at any point in the bot configuration. These can be used to manage the bot variables with environment-specific values. For example, you might have authCode for authenticating a service that your bot uses. This authCode may have different values in the test, uat, and prod environments. The bot can be exported and imported based on the environment, and the values need to modified at one place in the variable configuration file. Refer here for more on Bot Variables.

Using collections, you can define multiple value sets for these variables and designate an active collection for the values to be used while bot execution. Instead of changing the values manually while moving the bot from one environment to another, you can define the values during bot development and set the active collection in different environments to use the appropriate values.

Creation

Following are the steps in creating Collections

  1. From the left navigation menu, select Settings -> Config Settings
  2. Click the Environment Variables option
  3. On the top left click the more/ellipses to access the Manage Collections
  4. This would open the Manage Collections page
  5. Click Add New Collection
  6. Enter the following details:
    1. Collection Name,
    2. Description,
    3. Select the Collection you want to Clone From – This would create the new collection with all the values from the selected clone, you can later edit the values as per requirement.
      The first time you create a collection, a Default collection is created by the platform and is set as the Active Collection.

  7. Save the collection

Adding Values

Create Environment Variables and add collection-specific values using the following steps:

  1. From the left navigation menu, select Settings -> Config Settings
  2. Click the Environment Variables option
  3. Click Add Environment Variable. You can also use the edit icon against an existing Environment Variable to add values.
  4. This would open the Add/Edit Environment Variable page
  5. Enter the following details:
    1. Variable Name,
    2. Against the listed Collection Name, enter the appropriate Value,
    3. Enter developer notes in the Notes field. While this is an optional field, entering useful notes can help the developer working on the target bot to understand and provide relevant values.
    4. Group can be used to categorize the variable.
    5. Assign a Namespace if enabled (refer here for more).

  6. Save the Variable

Active Collection

  1. Click Manage Collections to access the Collections listing window
  2. Mark as Active any one of the Collections created. The values from the Active collection are while executing the bot definition.
  3. When exporting the bot definition, you can mark as Active the collection to be set for the target bot. The export file would contain the details of all the collections as well as the collection-specific values.
  4. Bot Import
    • To a New bot – All the collections, collection-specific values, and the active collection information would be imported into the newly created bot
    • Full Bot Import – All the details as available in the export file would be imported into the newly created bot. Any existing collections and the collection-specific values would be overwritten with the details present in the export file.If the file has multiple collections but the target bot has does not have any collections, then the collections from the file would be imported into the target bot.
      If the file does not have collections but the target bot has collections, then the collections would be removed from the target bot.
    • Incremental Bot Import – The ‘incremental import’ will be allowed only when the collections from the file exactly match with the collections in the target botWhen the collections in the export file and bot are the same, the values from the file would override the values in the target bot, and any additional variables in the file will be imported into the target bot with the corresponding values. Any additional variables in the bot target bot would be retained as-is.

Import & Export

  1. The Bot Export file would contain the details of all the collections as well as the collection-specific values. The setting of a collection as ‘active’ would be reflected in the export file
  2. Bot Import
    • To a New bot – All the collections, collection-specific values, and the active collection information would be imported into the newly created bot
    • Full Bot Import – All the details as available in the export file would be imported into the newly created bot. Any existing collections and the collection-specific values would be overwritten with the details present in the export file.If the file has multiple collections but the target bot has does not have any collections, then the collections from the file would be imported into the target bot.
      If the file does not have collections but the target bot has collections, then the collections would be removed from the target bot.
    • Incremental Bot Import – The ‘incremental import’ will be allowed only when the collections from the file exactly match with the collections in the target botWhen the collections in the export file and bot are the same, the values from the file would override the values in the target bot, and any additional variables in the file will be imported into the target bot with the corresponding values. Any additional variables in the bot target bot would be retained as-is.
  3. Variable Import – The ‘variables import’ would be allowed only when the collections from the file exactly match with the collections in the target bot.When the collections in the export file and bot are the same the values from the file would override the values in the target bot. Any additional variables in the file will be imported into the target bot with the corresponding values. Any additional variables in the bot target bot will be retained as-is.
  4. Variable Export – The Variables export would include all the collections available in the bot and mapping of variables to collections. Note if the bot does not have any collections but the account has ‘collections enabled’, the export would be restricted.
Menu
Kore.ai Named a Leader in 2022 Gartner® Magic Quadrant™ for Enterprise Conversational AI PlatformsGet the Report