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
Record Conversations
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 Management
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. 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