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
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. How Tos
  5. Using nlMeta

Using nlMeta

At times one wants to control the flow of the virtual assistant by taking an alternate path to improve the user’s experience.

Consider the following scenarios:

  1. The NLP engine might have identified an intent based on the user utterance. But a  different task might be more suitable based on additional information gathered from the backend systems or from the webpage where the SDK is hosted or any other external information.
  2. Consider a flight booking virtual assistant that greets the user with the best ongoing deals as part of the Welcome message. Based on the user selection, the ‘book flight’ task can be programmatically invoked by prepopulating the travel details like source city, destination city, travel, etc. from the deal information presented to the user.

Kore.ai provides a way to pass information to the virtual assistant programmatically using nlMeta data. This can be used in the BotKit SDK, Widget SDK, and Web SDK to pass information like intent to be triggered along with the entity values, and other task settings as per your need.

nlMeta

nlMeta is an object which can be used to pass information to the bot. The bot would use this information to execute the intent specified therein before attempting at decoding any other information.

Sample

The following is a sample of how the nlMeta object needs to be populated:

      'nlMeta': {
            'intent': '<intent_name>',  
            'childBotName': '<child_bot_name>',
            'isRefresh': <true/false>, 
            'entities': {      
			'<entity1_value>': value1,
                        '<entity2_value>': value2,
			},
      	    'interruptionOptions': {
               'hr': {
                 'h': 1;
                 'r': 1;
                 'nn': true
                }
              }
      }

Parameters

The following are the parameters that can be used in this object:

Parameters Description
nlMeta An object for natural language information for the bot
intent Intent identified via 3rd party which needs to be triggered by the bot
childBotName Only used in case of a universal bot to identify the child bot intent to trigger
entities Object with entity-value pairs as needed by the intent to be triggered
isRefresh
  • Set to true to end the current task and start executing incoming task
  • If not set or if set to false the incoming task would be executed as per hold and resume settings
interruptionOptions

To indicate the interruption behavior, in case any task is in progress when the bot receives this nlMeta information. Values can be:

  • discardAll – to discard current and previous tasks, if any
  • hr – for hold and resume options
    h

    for hold option, following are the options:

    • 1 – “Hold the current task and resume back once the new task is completed”
    • 2- “Discard the current task and switch to new”
    • 3- “Switch to new task without any notification to user and discard current task”
    • 4- “Continue the current task and add new task to the follow-up task list”
    • 5- “Allow the end user to select the behavior”
    r

    for resume option, following are the options:

    • 1 – “Get confirmation with the user before resuming an on-hold task”
    • 2- “Notify the user with a message that the on hold task is being resumed”
    • 3- “Resume the on hold task without any specific message to the user”
    nn

    neverNotify – notification to the user

    • True – Always resume the on hold task without any specific message to the user if the task ended in a single response
    • False – inform the user

In case, the requested task is not found the bot would respond with a standard response “Dialog task required for conversation not available”.

Usage

As mentioned, nlMeta can be populated and sent to the virtual assistant via BotKit SDK, and web/widget SDK. The following illustrates how it can be accomplished:

  • BotKit SDK – as part of metaInfo object:
    data.metaInfo = {
          'nlMeta': {
                'intent': 'Authenticate User', 
                'isRefresh': true, 
        	     'entities': {
    		"Name": "John"
    		},
     	    'interruptionOptions': 'discardAll'
          }
    }
  • Web SDK – the nlMeta information can be sent as a parameter using the sendMessage function. You can find this function in the chatWindow.js file. Add a condition when the nlMeta data needs to consumed as follows:
    if(_this.text() == “Existing”){
    me.sendMessage(_this, attachmentinfo, {'nlMeta': {
                'intent': 'Authenticate User'}}); 
    }
        	else{
    		me.sendMessage(_this, attachmentinfo);
    		}

    In the above example, the Authenticate User intent would be triggered if the text field contains the value “Existing”.

  • Widget SDK – the nlMeta information can be sent as part of the payload for various templates like button, menu, list, etc., see here for details

Using nlMeta

At times one wants to control the flow of the virtual assistant by taking an alternate path to improve the user’s experience.

Consider the following scenarios:

  1. The NLP engine might have identified an intent based on the user utterance. But a  different task might be more suitable based on additional information gathered from the backend systems or from the webpage where the SDK is hosted or any other external information.
  2. Consider a flight booking virtual assistant that greets the user with the best ongoing deals as part of the Welcome message. Based on the user selection, the ‘book flight’ task can be programmatically invoked by prepopulating the travel details like source city, destination city, travel, etc. from the deal information presented to the user.

Kore.ai provides a way to pass information to the virtual assistant programmatically using nlMeta data. This can be used in the BotKit SDK, Widget SDK, and Web SDK to pass information like intent to be triggered along with the entity values, and other task settings as per your need.

nlMeta

nlMeta is an object which can be used to pass information to the bot. The bot would use this information to execute the intent specified therein before attempting at decoding any other information.

Sample

The following is a sample of how the nlMeta object needs to be populated:

      'nlMeta': {
            'intent': '<intent_name>',  
            'childBotName': '<child_bot_name>',
            'isRefresh': <true/false>, 
            'entities': {      
			'<entity1_value>': value1,
                        '<entity2_value>': value2,
			},
      	    'interruptionOptions': {
               'hr': {
                 'h': 1;
                 'r': 1;
                 'nn': true
                }
              }
      }

Parameters

The following are the parameters that can be used in this object:

Parameters Description
nlMeta An object for natural language information for the bot
intent Intent identified via 3rd party which needs to be triggered by the bot
childBotName Only used in case of a universal bot to identify the child bot intent to trigger
entities Object with entity-value pairs as needed by the intent to be triggered
isRefresh
  • Set to true to end the current task and start executing incoming task
  • If not set or if set to false the incoming task would be executed as per hold and resume settings
interruptionOptions

To indicate the interruption behavior, in case any task is in progress when the bot receives this nlMeta information. Values can be:

  • discardAll – to discard current and previous tasks, if any
  • hr – for hold and resume options
    h

    for hold option, following are the options:

    • 1 – “Hold the current task and resume back once the new task is completed”
    • 2- “Discard the current task and switch to new”
    • 3- “Switch to new task without any notification to user and discard current task”
    • 4- “Continue the current task and add new task to the follow-up task list”
    • 5- “Allow the end user to select the behavior”
    r

    for resume option, following are the options:

    • 1 – “Get confirmation with the user before resuming an on-hold task”
    • 2- “Notify the user with a message that the on hold task is being resumed”
    • 3- “Resume the on hold task without any specific message to the user”
    nn

    neverNotify – notification to the user

    • True – Always resume the on hold task without any specific message to the user if the task ended in a single response
    • False – inform the user

In case, the requested task is not found the bot would respond with a standard response “Dialog task required for conversation not available”.

Usage

As mentioned, nlMeta can be populated and sent to the virtual assistant via BotKit SDK, and web/widget SDK. The following illustrates how it can be accomplished:

  • BotKit SDK – as part of metaInfo object:
    data.metaInfo = {
          'nlMeta': {
                'intent': 'Authenticate User', 
                'isRefresh': true, 
        	     'entities': {
    		"Name": "John"
    		},
     	    'interruptionOptions': 'discardAll'
          }
    }
  • Web SDK – the nlMeta information can be sent as a parameter using the sendMessage function. You can find this function in the chatWindow.js file. Add a condition when the nlMeta data needs to consumed as follows:
    if(_this.text() == “Existing”){
    me.sendMessage(_this, attachmentinfo, {'nlMeta': {
                'intent': 'Authenticate User'}}); 
    }
        	else{
    		me.sendMessage(_this, attachmentinfo);
    		}

    In the above example, the Authenticate User intent would be triggered if the text field contains the value “Existing”.

  • Widget SDK – the nlMeta information can be sent as part of the payload for various templates like button, menu, list, etc., see here for details
Menu