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. How Tos
  5. How to use Custom Tags to filter Bot Metrics

How to use Custom Tags to filter Bot Metrics

In this How-To, we will explore a scenario in a Banking Bot, where, various metrics will be used to analyze the bot performance.

For details on what Bot Metrics are and how they are implemented in the Kore.ai Bots platform, refer here.

Problem Statement

A Banking Bot client can track the following metrics:

  • Frequent Intents used by customers;
  • Usage split based on the customer type;

This document gives a detailed step-by-step approach to viewing the above statistics from the Bot Metrics page and apply filters based on Custom Meta Tags.

Pre-requisites

  • Bot building knowledge.
  • Custom Meta Tags usage, refer here for more.
  • A Banking Bot with the dialogs as mentioned below:
    • Transfer Money – Dialog task walking the user through the steps in transferring money.
      In this diaog, we have included a Script node to add Custom Meta Tag, TransferValue, based upon the amount transferred. Following script was used:

      if(context.entities.TransferAmount[0].amount > 50000){
         tags.addSessionLevelTag("TransferValue","HighValue");
      }
      
      if(context.entities.TransferAmount[0].amount > 10000)
      tags.addSessionLevelTag("TransferValue","MediumValue");
      
      if(context.entities.TransferAmount[0].amount > 0)
      tags.addSessionLevelTag("TransferValue","LowValue");

    • Manage Payee – For the user to manage their payee list.

      Here we have a Script assigning customerType meta tags:

      if(context.custType == 3){
         tags.addUserLevelTag("CustomerType","Premium");
      }
      if(context.custType == 2){
         tags.addUserLevelTag("CustomerType","Gold");
      };
      if(context.custType == 1){
         tags.addUserLevelTag("CustomerType","Regular");
      };

Implementation

Let us consider how each of the metrics mentioned in the problem statement can be viewed from the Metrics.

  1. From the left navigation panel, under Analyze click Metrics.
  2. The page will display the Intent found metrics to include successful utterances, intents, userid of the user,  and other details.
  3. These are the successful intents in the past one week as captured by the Bot.
  4. Click the Filter button to customize the report.
  5. Customize the Date periodLanguangesChannel, and the Task/Intent you want to capture.
  6. Since we want to track the Transfer Money intent, we have selected accordingly.
  7. We want the report of all the interactions by the Gold and Premium customers doing High Value money transfers.
  8. For this select the Custom Tags as follows (you can select the tag name and tag value from the type ahead drop down:
    • Customer Type – Gold, Premium
    • Transfer Value – HighValue

  9. On Applying the filter, you will see the updated Metrics page. Note that tags filter is applied only on the published version on the bot.
  10. You can repeat the above steps for all metrics like Intent not foundFailed task, etc..
Menu