Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Help & Learning Resources
Quick Start Guide
Accessing the Platform
Navigating the XO Platform
Building a Virtual Assistant
Using Workspaces
Release Notes
Current Version
Previous Versions
Request a Feature
Conversation Designer
Dialog Tasks
Mock Scenes
Dialog Tasks
Navigate Dialog Tasks
Build Dialog Tasks
Nodes & Connections
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
Context Object
Sub-Intent Scoping
User Prompts
Voice Call Properties
Dialog Task Management
Event Handlers
Supported Entity Types
Supported Company Names
Supported Colors
Knowledge Graph
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
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
Digital Forms
Digital Views
NLP Optimization
ML Engine
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
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
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Health and Monitoring
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Custom Meta Tags
Create Custom Dashboard
NLP Insights
Conversations History
Conversation Flows
Analytics Dashboard Filters
Usage Metrics
Containment Metrics
Smart Bots
Universal Bots
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Manage Assistant
Plan & Usage
Usage Plans
Support Plans
Multilingual Virtual Assistants
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Masking PII Details
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data as Service
Data Table
Table Views
App Definitions
Sharing Data Tables or Views
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
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
Introduction to Admin Console
Administration Dashboard
User Management
Add Users
Manage Groups
Manage Roles
Assistant Management
Invite Users
Send Bulk Invites
Import User Data
Synchronize Users from AD
Security & Control
Using Single-Sign On
Security Settings
Cloud Connector
  1. Home
  2. Docs
  3. Virtual Assistants
  4. Builder
  5. Dialog Task
  6. Custom Meta Tags

Custom Meta Tags

While analyzing your Virtual Assistant’s performances, you might want to give preference to or discard a particular scenario. For example, you might want to track how many people are booking tickets to Chicago. Or you might want to track how a specific user, a premium customer, requests are being fulfilled.

By adding Custom Meta Tags to the conversation flows, you will be able to profile VA-user conversations and derive business-critical insights from usage and execution metrics. Tags can be defined as part of the VA definition at any point of interest. When users interact with your VA, the platform will dynamically resolve these tags and add them to chat transcripts so that you can later filter your conversations, and flows using these tags.

Defining Meta Tags

The XO Platform allows you to add tags to various nodes in a dialog task like dialog node, entity node, etc.

This option is available from the Instance Properties tab, under Advanced Controls.

You can define these tags at three levels:

  • User Level: These tags can be added to the user’s profile information to capture user information. For example, to track conversations with a premium customer you will define a user-level tag with the user name or some qualifier as the value.
  • Message Level: These tags can be added to the message of the current node. If the current node is not associated with a message, then the tag gets added to the immediately previous node that has a message associated with it. From the above example, to track bookings to a specific city Chicago, you would be defining a Message Level tag.
    The platform will roll-up these message level tags to task level. That is if a task ends up as ‘Success/Failed Task’, then all the ‘message level’ tags emitted anywhere during the task execution will be associated with the Success/Failed Task event. You can filter Success Tasks as well as Failed Tasks using the message level tags emitted anywhere during the task execution
  • Session Level: These tags can be added at the current session of the user. These can be used to track the conversation sessions from a specific time frame say holiday season or a geographic domain.

The tag values will be emitted at run time:

  • For service, script, webhook and form nodes, tags will be emitted on reaching the nodes;
  • For entity, message, confirmation, and other nodes, tags will be emitted on the successful execution of the nodes.

You can also define Tags as key-value pairs from a Script written anywhere in the application like in the Script node, Message, Entity, Confirmation Prompts, Error Prompts, Knowledge Task Responses, BotKit SDK, etc. This would be useful if you want conditional tagging.

Be aware that Script tagging would work only if the prompt where you added the tag script is triggered during the conversation.

The following script can be used to add meta tags:

  • To add a User level tag:
  • To add a Session level tag:
  • To add a Message level tag:

The tag value can be a value or a variable name containing the value.

Updating Meta Tag Values

Chances are the Meta Tag values, once assigned, may be modified, for either business or other reasons. In such cases the following points need to be noted:

  • The latest value assigned for a key will override the previously assigned value.
  • The updates to the tags follow these rules:
    • Message-level tags: You may set a value for a tag multiple times within the script and the last set value will be assigned against the message. The value cannot be updated after the message is sent to the user
    • Session level tags: The value for a given tag can be set any number of times throughout the session. The last value assigned will be retained and this is the value that you should be using for all analytics purposes. Values cannot be updated after the session is closed.
    • User level tags: Values for a given tag can be set any number of times throughout the session. The last value assigned will be retained and this is the value that you should be using for all analytics purposes. Values can be edited at any time.

Using Meta Tags

Once you have defined the Meta Tags, you can:

  • Use the filter option from NLP Insights to filter the conversations based upon the Meta Tag values. The export file for the NLP Insights would include the Meta tag information, too. See here for more.
  • Use the filter option from Usage Metrics Dashboard and Admin Console Dashboard to filter activity details based upon the Meta Tag values.
  • Use to filter the Chat History. Export of Chat History will also include the Meta Tag values. See here for more.
  • Filter the records from Conversation History API and Sessions API by meta tags.