GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Quick Start Guide
Accessing the Platform
Navigating the Kore.ai XO Platform
Building a Virtual Assistant
Help & Learning Resources
Release Notes
Current Version
Recent Updates
Previous Versions
CONCEPTS
Design
Storyboard
Overview
FAQs
Conversation Designer
Overview
Dialog Tasks
Mock Scenes
Dialog Tasks
Overview
Navigate Dialog Tasks
Build Dialog Tasks
Node Types
Overview
Intent Node
Dialog Node
Dynamic Intent Node
GenAI Node
GenAI Prompt
Entity Node
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Process Node
Agent Transfer
Node Connections
Node Connections Setup
Sub-Intent Scoping
Entity Types
Entity Rules
User Prompts or Messages
Voice Call Properties
Knowledge AI
Introduction
Knowledge Graph
Introduction
Terminology
Build a Knowledge Graph
Manage FAQs
Knowledge Extraction
Import or Export Knowledge Graph
Prepare Data for Import
Importing Knowledge Graph
Exporting Knowledge Graph
Auto-Generate Knowledge Graph
Knowledge Graph Analysis
Answer from Documents
Alert Tasks
Small Talk
Digital Skills
Overview
Digital Forms
Digital Views
Introduction
Widgets
Panels
Session and Context Variables
Context Object
Intent Discovery
Train
NLP Optimization
ML Engine
Overview
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
LLM and Generative AI
Introduction
LLM Integration
Kore.ai XO GPT Module
Prompts & Requests Library
Co-Pilot Features
Dynamic Conversations Features
Intelligence
Introduction
Event Handlers
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentinment Management
Tone Analysis
Default Standard Responses
Ignore Words & Field Memory
Test & Debug
Overview
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Conversation Testing Overview
Create a Test Suite
Test Editor
Test Case Assertion
Test Case Execution Summary
Glossary
Health and Monitoring
NLP Health
Flow Health
Integrations
Actions
Actions Overview
Asana
Configure
Templates
Azure OpenAI
Configure
Templates
BambooHR
Configure
Templates
Bitly
Configure
Templates
Confluence
Configure
Templates
DHL
Configure
Templates
Freshdesk
Configure
Templates
Freshservice
Configure
Templates
Google Maps
Configure
Templates
Here
Configure
Templates
HubSpot
Configure
Templates
JIRA
Configure
Templates
Microsoft Graph
Configure
Templates
Open AI
Configure
Templates
Salesforce
Configure
Templates
ServiceNow
Configure
Templates
Stripe
Configure
Templates
Shopify
Configure
Templates
Twilio
Configure
Templates
Zendesk
Configure
Templates
Agents
Agent Transfer Overview
Custom (BotKit)
Drift
Genesys
Intercom
NiceInContact
NiceInContact(User Hub)
Salesforce
ServiceNow
Configure Tokyo and Lower versions
Configure Utah and Higher versions
Unblu
External NLU Adapters
Overview
Dialogflow Engine
Test and Debug
Deploy
Channels
Publishing
Versioning
Analyze
Introduction
Dashboard Filters
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Custom Meta Tags
Create Custom Dashboard
Create Custom Dashboard Filters
LLM and Generative AI Logs
NLP Insights
Task Execution Logs
Conversations History
Conversation Flows
Conversation Insights
Feedback Analytics
Usage Metrics
Containment Metrics
Universal Bots
Introduction
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Store
Manage Assistant
Team Collaboration
Plan & Usage
Overview
Usage Plans
Templates
Support Plans
Invoices
Authorization
Conversation Sessions
Multilingual Virtual Assistants
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Feedback Survey
Masking PII Details
Variables
Collections
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data
Overview
Data Table
Table Views
App Definitions
Data as Service
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
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
Migrate External Bots
Google Dialogflow Bot
APIs & SDKs
API Reference
API Introduction
Rate Limits
API List
koreUtil Libraries
SDK Reference
SDK Introduction
Web SDK
How the Web SDK Works
SDK Security
SDK Registration
Web Socket Connect and RTM
Tutorials
Widget SDK Tutorial
Web SDK Tutorial
BotKit SDK
BotKit SDK Deployment Guide
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer
  1. Home
  2. Docs
  3. Virtual Assistants
  4. SDKs
  5. Installing the BotKit SDK

Installing the BotKit SDK

The Kore.ai BotKit SDK runs as a Node.js application. You can add your own reverse proxy, firewall, and load balancer to meet your functional requirements for availability, scalability, and performance.

This section provides a high-level overview of BotKit SDK installation and configuration.

For a detailed end-to-end tutorial on installation and setup using our Kore.ai Sample Assistants, see this Kore.ai BotKit SDK Tutorial.

To install the BotKit SDK, you will need to:

  • Register your application on the Kore.ai XO Platform by creating a Virtual Assistant, and then configuring it for the Web/Mobile channel.
  • Download and deploy the BotKit SDK libraries.
  • Configure the config.json file.

Authorization

As a prerequisite for BotKit SDK installation, you need to register your SDK app with the Kore.ai XO Platform, as follows.

In the XO Platform you need to create a bot, and then from API Extensions -> BotKit SDK section, 

  • Go to Deploy > Integrations > BotKit.
  • Register/create an app for that assistant to generate the ClientID and Client Secret security credentials used for mutual SSL authentication for communication between your app and the XO Platform and to authorize API calls from your SDK to the Kore.ai XO Platform. 

In the config.json file in the SDK, you will need to copy the following authentication keys from the XO Platform.

  • appId = ClientID
  • appKey – Client Secret

For more information, see SDK App Registration.

Installation and Setup

The Kore.ai BotKit SDK libraries can be downloaded from the Github repository at:

https://github.com/Koredotcom/BotKit

To configure your SDK, you need to define the following keys in your config.json file to get your BotKit up and running.

KEY

DESCRIPTION

“server”: {

“port”:

}

Specifies the port to run the BotKit NodeJS app .

app”: {

“apiPrefix” :

}

Specifies the API path prefix to the NodeJS express route.

“credentials”: {

“appId”:

}

The Client ID value generated in Kore XO Platform when registering your SDK app.

Note that the JWT token would expire in 60 seconds, by default. You can change this using the following KoreConfig setting:

“botkit”:{

       “jwt_expiry”: 300 //seconds

  }

 

To run BotKit SDK, in a Terminal window, enter:

node app.js

 

Ensure that the node.js version is 10 or higher

Installing the BotKit SDK

The Kore.ai BotKit SDK runs as a Node.js application. You can add your own reverse proxy, firewall, and load balancer to meet your functional requirements for availability, scalability, and performance.

This section provides a high-level overview of BotKit SDK installation and configuration.

For a detailed end-to-end tutorial on installation and setup using our Kore.ai Sample Assistants, see this Kore.ai BotKit SDK Tutorial.

To install the BotKit SDK, you will need to:

  • Register your application on the Kore.ai XO Platform by creating a Virtual Assistant, and then configuring it for the Web/Mobile channel.
  • Download and deploy the BotKit SDK libraries.
  • Configure the config.json file.

Authorization

As a prerequisite for BotKit SDK installation, you need to register your SDK app with the Kore.ai XO Platform, as follows.

In the XO Platform you need to create a bot, and then from API Extensions -> BotKit SDK section, 

  • Go to Deploy > Integrations > BotKit.
  • Register/create an app for that assistant to generate the ClientID and Client Secret security credentials used for mutual SSL authentication for communication between your app and the XO Platform and to authorize API calls from your SDK to the Kore.ai XO Platform. 

In the config.json file in the SDK, you will need to copy the following authentication keys from the XO Platform.

  • appId = ClientID
  • appKey – Client Secret

For more information, see SDK App Registration.

Installation and Setup

The Kore.ai BotKit SDK libraries can be downloaded from the Github repository at:

https://github.com/Koredotcom/BotKit

To configure your SDK, you need to define the following keys in your config.json file to get your BotKit up and running.

KEY

DESCRIPTION

“server”: {

“port”:

}

Specifies the port to run the BotKit NodeJS app .

app”: {

“apiPrefix” :

}

Specifies the API path prefix to the NodeJS express route.

“credentials”: {

“appId”:

}

The Client ID value generated in Kore XO Platform when registering your SDK app.

Note that the JWT token would expire in 60 seconds, by default. You can change this using the following KoreConfig setting:

“botkit”:{

       “jwt_expiry”: 300 //seconds

  }

 

To run BotKit SDK, in a Terminal window, enter:

node app.js

 

Ensure that the node.js version is 10 or higher

Menu