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
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
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
SDK Security
SDK Registration
Web Socket Connect and RTM
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
SDK Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer
Widget SDK Tutorial
Web SDK Tutorial
ADMINISTRATION
Introduction to Admin Console
Administration Dashboard
User Management
Add Users
Manage Groups
Manage Roles
Data Tables and Views
Assistant Management
Enrollment
Invite Users
Send Bulk Invites
Import User Data
Synchronize Users from AD
Security & Control
Using Single-Sign On (SSO)
Two-Factor Authentication (2FA)
Security Settings
Cloud Connector
Analytics
Billing
  1. Home
  2. Docs
  3. Virtual Assistants
  4. Builder
  5. Panels & Widgets

Panels & Widgets

Interactions with virtual agents are typically conducted using chat / messaging tools, voice channels or digital assistants. In the majority of the cases, the virtual agents respond to the user queries only when the users have requested for some information. This works well for conducting on-demand tasks that need user input for execution and the result is usually a short response, confirmation or acknowledgment. But, with the emergence of Digital Assistants, the need for proactive updates to users via engaging user interface has become a key requirement. This can be achieved by providing engaging widgets that present relevant information to end-users with minimal need for user input. The widgets can also trigger mobile/web apps from within the chatbot.

Using Panels and Widgets from the Kore.ai Bots platform, you can design interactive components to proactively present relevant information to your customers. Panels are the placeholders that hold one or more widgets. Widgets are individual components that display information to the end-users.  Your customers can interact with your bot either in the conversation mode or directly get the required information from the widgets.

Note: This feature was introduced in ver 7.2 of the platform

This document gives an overview of the working and implementation of Panels and Widgets. For an step-by-step usage instructions, refer  to this how to.

Use Case

  1. Using Panels & Widgets, an organization offers to its employees a single interface for various work-related activities.
  2. Each of the Panels gives access to various functions like Sales, HR, ITSM, etc.
  3. Employee accesses these panels for information pertaining to each of the above functions and perform follow up actions.
  4. As an example, HR Panel has multiple widgets showing:
    • company-wide announcements;
    • leave balance;
    • benefits and option to enrol for additional benefits through bot conversation.
  5. Similarly, the ITSM panel shows the outage report and other details.

This document gives an overview and the implementation details of the features. For an use case example, refer here.

Setup

You can access Panels & Widgets from under the Bot Tasks menu.

Following are the steps to setting up Panels and Widgets:

  • Configure Widgets: Define widgets by connecting them either to your bot tasks or any other source like JavaScript generating JSON file. Note that the dialog tasks should have a Bot response defined for Widget SDK channel using the Widget SDK supported message template. See here for supported message templates.
  • Preview the Widgets: Preview your widgets from the Bot Builder.
  • Set up Panels: You may create multiple panels and each panel can host widgets that present relevant information. You can use the pre-defined widgets or create new.
  • Test the Panels to see how the Panels and Widgets will be rendered in the chat window.
  • Publish the Bot: Publish the bot so that the panels and widgets can be made available for your end-users.
  • Host the Panel: You can choose to host your widgets independently or co-host them along with the WebSDK. You can download the SDKs from Kore.ai GitHub page. Do ensure to enable WidgetSDK as a channel.

Configure Widgets

Widgets are individual components that can communicate with the bot for presenting information to the end-users. The source of information for widgets can be from a Dialog Task or a JSON using any of the pre-defined widget templates.

Steps in configuring Widgets:

  1. Use Create Widget button to create a widget.
  2. In the New Widget popover, enter
    • Name of the Widget
    • Display Name for the Widget
    • Auto Refresh to set the frequency with which this widget needs poll for fresh data. The refresh is applicable only when the Panel containing the Widget is active.
    • Source for a widget can be either from the execution of Dialog Task or from JavaScript defining a JSON:
      • JSON can be specified in the JavaScript Editor that is presented.
      • Dialog Task option allows you to trigger a task and present the output in the widget.
        1. Select Dialog Task dropdown will list all available tasks in the current bot, select one from the list.
          Note: In the connected Dialog Task make sure to use a Message node to present the required information in the widget using any of the supported widget templates. See here for supported message templates
          You can use the icon next to the Dialog Task to open the Dialog Task for checking the task details like entity names etc..
        2. Any Entities used by the selected Dialog Task needs to be pre-populated with values by mapping Entity Name with Entity Values.
        3. If the selected Dialog Task has any authorization profile defined, the same will be displayed here.
    • Save the Widget.
  3. Once Saved the Widget will be In Development state. You can Edit or Delete the Widget.
  4. Edit widget, apart from allowing modification to any of the above fields, will allow you to Run & Preview the widget.
    You can save the preview as the thumbnail display for the widget.

Set up Panels

Panel refers to containers that hold one or more widgets. You can add an existing widget to the Panel or create new widgets.

  1. Use Create Panel button to create a panel.
  2. In the New Panel popover, enter
    • Name of the Panel.
    • Display Name for the Panel.
    • Panel Icon to be displayed in the chat window (URL to the location of the image file).
    • Save the Panel.
  3. Once Saved the Panel will be In Development state.
  4. Use the Add Widget button to add widgets to the panel. Select widgets from the drop down list.
  5. You have the following options for a given Panel:
    • Edit the panel details;
    • Panel Management to add existing widgets, create new widget or remove already added widgets from the Panel;
    • Test the individual Panel – this will open the talk to bot window along with the panel listing with the current panel active and data presented;
    • Delete the Panel.

  6. Test panels will open the Talk to Bot window listing all the Panels with the chat window active. You can interact and test the Panels.

Publish

Publish your bot ensuring that the panels and widgets are selected.

Refer here for details on Publishing a Bot

Hosting

Widget SDK is provided by the platform for hosting and managing panels and widgets. You can choose to host your widgets independently or co-host them along with the WebSDK. You can download the SDKs from Kore.ai GitHub page. Do ensure to enable WidgetSDK as a channel. Refer to this tutorial on how.

Panels & Widgets

Interactions with virtual agents are typically conducted using chat / messaging tools, voice channels or digital assistants. In the majority of the cases, the virtual agents respond to the user queries only when the users have requested for some information. This works well for conducting on-demand tasks that need user input for execution and the result is usually a short response, confirmation or acknowledgment. But, with the emergence of Digital Assistants, the need for proactive updates to users via engaging user interface has become a key requirement. This can be achieved by providing engaging widgets that present relevant information to end-users with minimal need for user input. The widgets can also trigger mobile/web apps from within the chatbot.

Using Panels and Widgets from the Kore.ai Bots platform, you can design interactive components to proactively present relevant information to your customers. Panels are the placeholders that hold one or more widgets. Widgets are individual components that display information to the end-users.  Your customers can interact with your bot either in the conversation mode or directly get the required information from the widgets.

Note: This feature was introduced in ver 7.2 of the platform

This document gives an overview of the working and implementation of Panels and Widgets. For an step-by-step usage instructions, refer  to this how to.

Use Case

  1. Using Panels & Widgets, an organization offers to its employees a single interface for various work-related activities.
  2. Each of the Panels gives access to various functions like Sales, HR, ITSM, etc.
  3. Employee accesses these panels for information pertaining to each of the above functions and perform follow up actions.
  4. As an example, HR Panel has multiple widgets showing:
    • company-wide announcements;
    • leave balance;
    • benefits and option to enrol for additional benefits through bot conversation.
  5. Similarly, the ITSM panel shows the outage report and other details.

This document gives an overview and the implementation details of the features. For an use case example, refer here.

Setup

You can access Panels & Widgets from under the Bot Tasks menu.

Following are the steps to setting up Panels and Widgets:

  • Configure Widgets: Define widgets by connecting them either to your bot tasks or any other source like JavaScript generating JSON file. Note that the dialog tasks should have a Bot response defined for Widget SDK channel using the Widget SDK supported message template. See here for supported message templates.
  • Preview the Widgets: Preview your widgets from the Bot Builder.
  • Set up Panels: You may create multiple panels and each panel can host widgets that present relevant information. You can use the pre-defined widgets or create new.
  • Test the Panels to see how the Panels and Widgets will be rendered in the chat window.
  • Publish the Bot: Publish the bot so that the panels and widgets can be made available for your end-users.
  • Host the Panel: You can choose to host your widgets independently or co-host them along with the WebSDK. You can download the SDKs from Kore.ai GitHub page. Do ensure to enable WidgetSDK as a channel.

Configure Widgets

Widgets are individual components that can communicate with the bot for presenting information to the end-users. The source of information for widgets can be from a Dialog Task or a JSON using any of the pre-defined widget templates.

Steps in configuring Widgets:

  1. Use Create Widget button to create a widget.
  2. In the New Widget popover, enter
    • Name of the Widget
    • Display Name for the Widget
    • Auto Refresh to set the frequency with which this widget needs poll for fresh data. The refresh is applicable only when the Panel containing the Widget is active.
    • Source for a widget can be either from the execution of Dialog Task or from JavaScript defining a JSON:
      • JSON can be specified in the JavaScript Editor that is presented.
      • Dialog Task option allows you to trigger a task and present the output in the widget.
        1. Select Dialog Task dropdown will list all available tasks in the current bot, select one from the list.
          Note: In the connected Dialog Task make sure to use a Message node to present the required information in the widget using any of the supported widget templates. See here for supported message templates
          You can use the icon next to the Dialog Task to open the Dialog Task for checking the task details like entity names etc..
        2. Any Entities used by the selected Dialog Task needs to be pre-populated with values by mapping Entity Name with Entity Values.
        3. If the selected Dialog Task has any authorization profile defined, the same will be displayed here.
    • Save the Widget.
  3. Once Saved the Widget will be In Development state. You can Edit or Delete the Widget.
  4. Edit widget, apart from allowing modification to any of the above fields, will allow you to Run & Preview the widget.
    You can save the preview as the thumbnail display for the widget.

Set up Panels

Panel refers to containers that hold one or more widgets. You can add an existing widget to the Panel or create new widgets.

  1. Use Create Panel button to create a panel.
  2. In the New Panel popover, enter
    • Name of the Panel.
    • Display Name for the Panel.
    • Panel Icon to be displayed in the chat window (URL to the location of the image file).
    • Save the Panel.
  3. Once Saved the Panel will be In Development state.
  4. Use the Add Widget button to add widgets to the panel. Select widgets from the drop down list.
  5. You have the following options for a given Panel:
    • Edit the panel details;
    • Panel Management to add existing widgets, create new widget or remove already added widgets from the Panel;
    • Test the individual Panel – this will open the talk to bot window along with the panel listing with the current panel active and data presented;
    • Delete the Panel.

  6. Test panels will open the Talk to Bot window listing all the Panels with the chat window active. You can interact and test the Panels.

Publish

Publish your bot ensuring that the panels and widgets are selected.

Refer here for details on Publishing a Bot

Hosting

Widget SDK is provided by the platform for hosting and managing panels and widgets. You can choose to host your widgets independently or co-host them along with the WebSDK. You can download the SDKs from Kore.ai GitHub page. Do ensure to enable WidgetSDK as a channel. Refer to this tutorial on how.

Menu