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
Sub-Intent Scoping
User Prompts
Voice Call Properties
Dialog Task Management
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
Session and Context Variables
Context Object
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
Event Handlers
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. SDKs
  5. Kore.ai Widget SDK Tutorial

Kore.ai Widget SDK Tutorial

This tutorial is an end-to-end walkthrough for setting up and running an instance of the Kore.ai Bots Web SDK to host widgets for presenting information from your bots and enabling interaction with your bots.

Widget SDK Overview

There are two ways to host the Kore.ai Widget SDK:

  • co-host them along with the WebSDK – enable and configure both Web/Mobile Client and Widget SDK channels; or
  • independently – enable and configure just the Widget SDK channel.

In this tutorial, we will be listing the instructions for both the variations.

Installing and Running the Kore.ai Widget SDK

This section provides detailed steps on how to run a Kore.ai bot using the Widget SDK and a test application running on your computer localhost server.

Pre-requisites

  1. To get started, you will need to build a bot with Digital Views to run in the test application (see here for more on Digital Views).
  2. You need enable the Widget SDK channel for the above bot by either creating a new client app or use an existing client app and define the channel settings. See here for a detailed explanation of the steps.
  3. If you want to co-host the Panels & Widgets along with the WebSDK, you need enable the Web/Mobile Client channel for the above bot by either creating a new client app or use an existing client app and define the channel settings. See here for a detailed explanation of the steps.
  4. Publish the bot.
  5. From the Channels -> Configured Channels click to open the configured Widget SDK channel. From the Configurations tab make a note of the following, we will be using them later in the Widget SDK setup:
    • Bot Name
    • Bot ID
    • Client ID
    • Client Secret
  6. If you want to co-host Panels & Widgets with Web/Mobile SDK, then from the Channels -> Configured Channels click to open the configured Web/Mobile Client channel. From the Configurations tab make a note of the following, we will be using them later in the Widget SDK setup:
    • Bot Name
    • Bot ID
    • Client ID
    • Client Secret

Next step would be to download, uncompress, install and configure the software packages required for the Widget SDK and a test application to run the bot locally on your localhost server.

Based upon your requirement see the appropriate sections below:

  • host Panels individually; or
  • co-host Panels with Web SDK.

Setup to host Panels individually:

To download the Kore.ai Widget SDK, go to https://github.com/Koredotcom/web-kore-sdk, and then click Download. Extract all files to the …/SDKApp/sdk folder.

  1. Open the UI folder.
  2. Locate and open the kore-widgets-config.js
  3. Configure your botOptions with the ‘Widget SDK’ channel configurations created in bot builder:
    • botOptions.botInfo
    • botOptions.clientId
    • botOptions.clientSecret
  4. Open the index_widgets.html file in the browser and see the Panels displayed. You can add this <div> element to your website html page to host the Panels there.

Setup to co-host Panels with Web/Mobile SDK:

To download the Kore.ai Widget SDK, go to https://github.com/Koredotcom/web-kore-sdk, and then click Download. Extract all files to the …/SDKApp/sdk folder.

  1. Open UI folder.
  2. Locate and open the kore-config.js
  3. Configure your botOptions with the ‘web/mobile client’ channel configurations created in bot builder
    • botOptions.botInfo
    • botOptions.clientId
    • botOptions.clientSecret
  4. Open the kore-widgets-config.js
  5. Configure your botOptions with the ‘Widget SDK’ channel configurations created in bot builder
    • botOptions.botInfo
    • botOptions.clientId
    • botOptions.clientSecret
  6. Open the index_widgets_chat.html file in the browser and see the chat window along with the widgets.
Menu