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

Travel VA: Using Bot Functions

In this use case we will explore a scenario in a Travel Planning Assistant, where Bot Functions can help reuse the same functionality in several places. We will see how a travel spend report can be programmed as a function and used, for example, to send to users upon request in different circumstances, to integrate with apps or create digital views

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

Problem Statement

In a Travel Planning Assistant used by a travel agency, we have a reporting task that requires the VA to provide information on how much a traveller has spent in different categories, as part of a booking made via the agency. 

This information can be provided in several ways. For the purpose of this article, we will demonstrate how to create a dialog task that sends the user these details upon request, and how to create a widget, as part of a Digital View, that will display the information, say within an app that is integrated via the Widget SDK.

Prerequisites

  • To go through these configurations, you need to know at least the basics of building a Virtual Assistant
  • A pre-built Virtual Assistant. We will use the Travel Planning VA for this example.
  • Following is the Script file with two functions using the message templates to display the data (see here for more on message templates):
    • tableTemplate – takes a two-dimensional array and displays the content in a tabular format
    • pieTemplate – takes a two-dimensional array and displays the content in a pie format
      Copy the following content and save it as a .js file (say, functionEX.js)
      function tableTemplate(data){
       var message = {
         "type": "template",
         "payload": {
         "template_type": "mini_table",
         "layout": "vertical",
         "text":"Travel Spend",
         "elements": []  }
       };
       for (i=0; i < data.length; i++) {
         var j=0;
         var element = {
           "primary":[[data[i][j]],[data[i][j+1],"right"]],
           "additional":[[data[i][j+2],data[i][j+3]],[data[i][j+4],data[i][j+5]]]   };
       message.payload.elements.push(element);
       }
       return JSON.stringify(message);
      };

      function pieTemplate(data){
        var message = {
         "type": "template",
         "payload": {
         "template_type": "piechart",
         "pie_type": "regular",
         "text": "Travel Spend",
         "elements": []   }
        };
       for (i=0; i < data.length; i++) {
        var element = {
         "title": data[i][0],
         "value": data[i][1]   };
        message.payload.elements.push(element);
       }
       return JSON.stringify(message);
      };

Implementation

Import the Bot Function Script

To begin using Bot Functions, you first need to import a script into your assistant, by following the steps below:

  1. Open the Travel Planning Assistant.
  2. Select the Build tab from the top menu
  3. From Configurations select the Bot Functions section.
  4. Click Import (or Import New) to open the Import Custom Script window
  5. Drag and drop or Browse the script file that you saved from the Prerequisites section and click Import.
  6. Once the success message is displayed click Done.
  7. Your Script file is ready to use.

Create a Dialog Task

Open the Dialog Tasks page and create a New Dialog Task called “Get Travel Spend”.

  1. Add entities to capture the Flight Number and Fare.
  2. Ideally, there would be a service call to fetch the =details. Here we will use static values for demonstration purposes.
  3. Add a Script node using the Bot Action and enter the following – we are declaring an array carrying the spent amount on Airlines, Hotels and Experiences.
    context.travelspend = [["Airlines",1264],["Hotels",568],["Experiences", 324];
  4. Add a Message node to send this data to the Bot Function declared earlier and get the report.
    1. From Bot Responses section, click Manage Responses
    2. Add Bot Response, select Web/Mobile Client as the Channel, switch to JavaScript tab and enter the following code to display the values in a tabular format:
      var info = context.travelspend;
      print(tableTemplate(info));
  5. Add another Message node to send this data to the Bot Function declared earlier and get the report.
    1. From Bot Responses section, click Manage Responses
    2. Add Bot Response, select Web/Mobile Client as the Channel, switch to JavaScript tab and enter the following code to display the values in a pie chart:
      var info = context.travelspend;
      print(pieTemplate(info));
  6. Close the Dialog Task.

Create a Widget

The bot function can also be used to create a Widget using Digital Views, as follows:

    1. Go to Build > Digital Skills > Digital Views.
    2. Click Create Widget.
    3. Name your Widget as Travel Spend.
    4. Select Pie Chart as the Template Hint.
    5. You can link the Widget to the Dialog Task you just created. For this example, we will choose JSON as the Source to populate the data for this widget.
    6. Add the following script:
var message =
{
      "templateType": "piechart",
      "pie_type": "regular",
      "title": "Summary",
      "description": "monthly report",
      "elements": [
        {
          "title": "Airlines",
          "value": "1264.0",
          "displayValue": "$ 1,234"
        },
        {
          "title": "Hotels",
          "value": "568",
          "displayValue": "$ 568"
        },
        {
          "title": "Experiences",
          "value": "324",
          "displayValue": "$ 324"
        }
      ]
    };
print(JSON.stringify(message));

Testing

Use Talk to Bot and try both functions. Thus we have used the same function to display the reports in multiple places.

Menu