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. Creating Balance Tasks

Creating Balance Tasks

This is document details steps in creating a sample banking bot. This bot is used in various use case scenarios presented in the How-Tos section of the developer documentation.

Prerequisites:

  • You must have signed up with the Kore.ai Bots Platform
  • You must be aware of the basics of Bot building (refer to this link)
  • You must have created a simple bot (refer here for an example)
  • You must have created a Banking Bot with Get Balance task (refer here for example)

Bot Overview

The Bot we will be building will be performing the basic banking transactions.
This Bot will:

  • Get account balance based on the Account Number and Account Type entered by the user, as seen here.
  • Update accounts with the balance, on this page.
  • Transfer a specified amount from the payer account to a payee account, as given here.

Let us add the Update Balance task.

Update Balance Intent

  • The Update Balance task will prompt the user to enter the account number and the account type (Savings/Current).
  • It would then prompt for the type of update – credit or debit and the amount to be updated.
  • A service call will be made to fetch the details, calculate the balance, and then another service call to update the balance.
  • The success/failure message will be displayed.

Step 1: Dialog Task

  1. Open the Banking Bot with the Get Balance task already configured, see here for more.
  2. Ensure that the Build tab is selected from the top menu.
  3. Navigate to the Conversational Skills -> Dialog Task page from the left menu.
  4. Click Create Dialog from the top right.
  5. Create Dialog screen will open.
  6. Enter the following details:
    • Intent Name – Enter the Intent name, this is the phrase that triggers the dialog. The intent name should be simple and not more than 3-4 words. For example, ‘Update Balance‘.
    • You can add a description and under More Options other dialog-related details. Let’s retain the default settings without any changes.
    • You can also include utterances to train this intent.
    • Select Try Conversation Driven Dialog Builder option.
  7. Click Proceed.
  8. Property Panel for User Intent will be displayed. We will retain the default properties.
  9. Note: For instructions with the older Dialog Builder, refer here
  10. Close the User Intent Property Panel.

Step 2: Entity nodes

Entity Node is typically used to gather information from the user.
Here we will be using it to capture the user input for Account Number and Account Type, Type of transaction, and Amount.

  1. Click the + below the User Intent node
  2. Select the Entity option.
    • Select the Account Number entity already created while configuring the Get Balance task.
    • Close the AccountNumber Entity Property Panel.
  3. Click the + below the Account Number node
  4. Select the Entity option.
    • Select the Account Type entity already created while configuring the Get Balance task.
    • Close the AccountType Entity Property Panel.
  5. Click the + below the Account Type node
  6. Select the Entity option.
    • Click the + New entity 
    • Property Panel for the Entity Node is displayed, if not click on the newly created entity to open
      • Enter the following details:
        • Name: TransactionType
        • Display Name: Transaction Type 
        • Type: Select ‘List of Items (enumerated)‘ from the drop-down. We need to provide the list of values that the user can select.
          • Click the Settings (gear) icon that appears next to the field.
          • Opt for Static List.
          • Enter the following options under separate rows as the Display name – Credit and Debit.
            Value and Synonym columns will auto-populate, leave them as is.
          • Click Save.
        • Navigate back to Entity Property Panel.
        • User Prompts: Enter the following text and hit enter to save:
          Select the transaction type.
        • Display List Of Values: Mark as ‘Yes, use channel specific standard formatting for default messages and show the available list of values to end user‘. This will present the list of values in a button template for the supported channels.

      • Close the TransactionType Entity Property Panel.
  7. Click the + below the Transaction Type node
  8. Select the Entity option.
    • Click + New entity 
    • Property Panel for the Entity Node is displayed, if not click on the newly created entity node to open
    • Enter the following details:
      • Name: Amount
      • Display Name: Amount 
      • TypeNumber
      • User Prompts: Enter the following text and hit enter to save: Enter the amount to {{context.entities.TransactionType}}
    • Close the Amount Entity Property Panel.

Step 3: Bot Action – Service Node – Get Balance

Service Node allows you to make a backend API call. It is included in the Bot Actions.
Here the service node is used to call an API to get the account balance for the user entered account number.
We will be using a dummy API setup for this tutorial. We will be using a mock API created specifically for this purpose with the following fields – FirstName, LastName, Address, City, Country, ZipCode, AccountNumber, AccountType, Balance.

  1. Click the + below the Amount Entity node
  2. Select Bot Action, click to open properties, name it ToGetBalance, and close the properties window.
  3. To add a service node, click the + next to the ToGetBalance bot action to expand it
  4. Click the + within the bot action layout.
  5. Select Service – Service node is used to make a backend API call to get account balance information.
  6. Select the existing GetAccountBalance service node, created in the Get Balance task.

Step 4: Bot Action – Script Node

Script Node allows you to incorporate programming logic into the bot and is part of Bot Action.
Here the script node is used to credit/debit the user entered amount to/from the account.

  1. Click the + below the GetAccountBalance node within the Bot Action layout
  2. Select Script – Script node is used to calculate the balance to be updated.
  3. Click the + New Script
  4. Property Panel for the Script Node is displayed, if not click on the newly created script node to open
  5. Enter the following details:
    • Name: BalanceCalculation
    • Display Name: Balance Calculation
    • Under the Script Definition section click the Define Script link
    • In the Add Script window enter the following script. This script first checks the account type to match the user entry and then extracts the balance for that record
      var balance, i;
      for (i=0; i < context.GetAccountBalance.response.body.length; i++ )
      { if (context.GetAccountBalance.response.body[i].AccountType == context.entities.AccountType)
         { balance = parseFloat(context.GetAccountBalance.response.body[i].Balance);
         }
      }
      
    • Click Save
  6. Close the Script Property Panel

Step 4: Bot Action – Service Node – Update Balance

Here the service node is used to call an API to update the account balance for the user entered account number.
We will be using a dummy API setup for this tutorial.

  1. Click the + below the BalanceCalculation script node
  2. Select Service – Service node is used to make a backend API call to update account balance information.
  3. Click the + New service 
  4. Property Panel for the Service Node is displayed, if not click on the newly added service node to open
  5. Enter the following details:
    • Name: UpdateBalance
    • Display Name: Update Balance
    • Service Type: Custom Service
    • Type: Webservice
    • Sub Type: REST
    • Click DEFINE REQUEST
      • In the Define Request Page, enter the following details:
        • Request typePUT
        • Request URLhttps://5c3c633d29429300143fe4d2.mockapi.io/AccountDetails/{{context.entities.AccountNumber}}.
        • This API does not require any Auth Parameters.
        • In the Body tab, select the type as application/json
        • Select the Test Request tab
        • Enter an account number and balance in the Sample Context Values section.
        • Click the Test button
        • Wait for the test to be completed and you get a Status: 200
        • Click Save as Sample Response
        • Click Save
    • On the Service node Property window, click the Connections tab.
      • Under the Connection Rules section, ensure that the Default connection is set to End of Bot Action.
    • Close the Service Property Panel
    • Click  next to the Bot Action node to collapse the bot action node.

Step 5: Message Node

A Message Node is used to display a message from the Bot to the user.
Here we will be using the Message node to show the success message.

  1. Click the + below the ToUpdateBalance Bot Action
  2. Select Message and click the + New message 
  3. Property Panel for the Message Node is displayed
  4. Enter the following details:
    • Name: UpdateMessage
    • Display Name: Update Message
    • Bot Responses: Enter Your account balance has been updated and hit enter to save
  5. On the Bot Response Property Panel, open the connections tab by clicking the ‘Connections‘ icon.
    • Change the Default connection from ‘Not Connected‘ to ‘End of Dialog‘.
    • Click Save.
  6. Close the Property Panel.

Test

To test the Dialog task, you can use the ‘Talk to bot’ at the bottom right corner.
Enter the following utterance (intent name) – “Update Balance
Follow the Bot instructions:

  • Enter Account Number – 29565731;
  • Select Account Type – Savings or Current;
  • Select the Transaction Type – Credit or Debit;
  • Enter the Amount – 100;
  • See the success message.

Next Steps

Your Banking Bot is almost complete, you have successfully added Get Balance and Update Balance dialog tasks to the Bot. The next step would be to include the Transfer Funds task. Click here to continue.

Creating Balance Tasks

This is document details steps in creating a sample banking bot. This bot is used in various use case scenarios presented in the How-Tos section of the developer documentation.

Prerequisites:

  • You must have signed up with the Kore.ai Bots Platform
  • You must be aware of the basics of Bot building (refer to this link)
  • You must have created a simple bot (refer here for an example)
  • You must have created a Banking Bot with Get Balance task (refer here for example)

Bot Overview

The Bot we will be building will be performing the basic banking transactions.
This Bot will:

  • Get account balance based on the Account Number and Account Type entered by the user, as seen here.
  • Update accounts with the balance, on this page.
  • Transfer a specified amount from the payer account to a payee account, as given here.

Let us add the Update Balance task.

Update Balance Intent

  • The Update Balance task will prompt the user to enter the account number and the account type (Savings/Current).
  • It would then prompt for the type of update – credit or debit and the amount to be updated.
  • A service call will be made to fetch the details, calculate the balance, and then another service call to update the balance.
  • The success/failure message will be displayed.

Step 1: Dialog Task

  1. Open the Banking Bot with the Get Balance task already configured, see here for more.
  2. Ensure that the Build tab is selected from the top menu.
  3. Navigate to the Conversational Skills -> Dialog Task page from the left menu.
  4. Click Create Dialog from the top right.
  5. Create Dialog screen will open.
  6. Enter the following details:
    • Intent Name – Enter the Intent name, this is the phrase that triggers the dialog. The intent name should be simple and not more than 3-4 words. For example, ‘Update Balance‘.
    • You can add a description and under More Options other dialog-related details. Let’s retain the default settings without any changes.
    • You can also include utterances to train this intent.
    • Select Try Conversation Driven Dialog Builder option.
  7. Click Proceed.
  8. Property Panel for User Intent will be displayed. We will retain the default properties.
  9. Note: For instructions with the older Dialog Builder, refer here
  10. Close the User Intent Property Panel.

Step 2: Entity nodes

Entity Node is typically used to gather information from the user.
Here we will be using it to capture the user input for Account Number and Account Type, Type of transaction, and Amount.

  1. Click the + below the User Intent node
  2. Select the Entity option.
    • Select the Account Number entity already created while configuring the Get Balance task.
    • Close the AccountNumber Entity Property Panel.
  3. Click the + below the Account Number node
  4. Select the Entity option.
    • Select the Account Type entity already created while configuring the Get Balance task.
    • Close the AccountType Entity Property Panel.
  5. Click the + below the Account Type node
  6. Select the Entity option.
    • Click the + New entity 
    • Property Panel for the Entity Node is displayed, if not click on the newly created entity to open
      • Enter the following details:
        • Name: TransactionType
        • Display Name: Transaction Type 
        • Type: Select ‘List of Items (enumerated)‘ from the drop-down. We need to provide the list of values that the user can select.
          • Click the Settings (gear) icon that appears next to the field.
          • Opt for Static List.
          • Enter the following options under separate rows as the Display name – Credit and Debit.
            Value and Synonym columns will auto-populate, leave them as is.
          • Click Save.
        • Navigate back to Entity Property Panel.
        • User Prompts: Enter the following text and hit enter to save:
          Select the transaction type.
        • Display List Of Values: Mark as ‘Yes, use channel specific standard formatting for default messages and show the available list of values to end user‘. This will present the list of values in a button template for the supported channels.

      • Close the TransactionType Entity Property Panel.
  7. Click the + below the Transaction Type node
  8. Select the Entity option.
    • Click + New entity 
    • Property Panel for the Entity Node is displayed, if not click on the newly created entity node to open
    • Enter the following details:
      • Name: Amount
      • Display Name: Amount 
      • TypeNumber
      • User Prompts: Enter the following text and hit enter to save: Enter the amount to {{context.entities.TransactionType}}
    • Close the Amount Entity Property Panel.

Step 3: Bot Action – Service Node – Get Balance

Service Node allows you to make a backend API call. It is included in the Bot Actions.
Here the service node is used to call an API to get the account balance for the user entered account number.
We will be using a dummy API setup for this tutorial. We will be using a mock API created specifically for this purpose with the following fields – FirstName, LastName, Address, City, Country, ZipCode, AccountNumber, AccountType, Balance.

  1. Click the + below the Amount Entity node
  2. Select Bot Action, click to open properties, name it ToGetBalance, and close the properties window.
  3. To add a service node, click the + next to the ToGetBalance bot action to expand it
  4. Click the + within the bot action layout.
  5. Select Service – Service node is used to make a backend API call to get account balance information.
  6. Select the existing GetAccountBalance service node, created in the Get Balance task.

Step 4: Bot Action – Script Node

Script Node allows you to incorporate programming logic into the bot and is part of Bot Action.
Here the script node is used to credit/debit the user entered amount to/from the account.

  1. Click the + below the GetAccountBalance node within the Bot Action layout
  2. Select Script – Script node is used to calculate the balance to be updated.
  3. Click the + New Script
  4. Property Panel for the Script Node is displayed, if not click on the newly created script node to open
  5. Enter the following details:
    • Name: BalanceCalculation
    • Display Name: Balance Calculation
    • Under the Script Definition section click the Define Script link
    • In the Add Script window enter the following script. This script first checks the account type to match the user entry and then extracts the balance for that record
      var balance, i;
      for (i=0; i < context.GetAccountBalance.response.body.length; i++ )
      { if (context.GetAccountBalance.response.body[i].AccountType == context.entities.AccountType)
         { balance = parseFloat(context.GetAccountBalance.response.body[i].Balance);
         }
      }
      
    • Click Save
  6. Close the Script Property Panel

Step 4: Bot Action – Service Node – Update Balance

Here the service node is used to call an API to update the account balance for the user entered account number.
We will be using a dummy API setup for this tutorial.

  1. Click the + below the BalanceCalculation script node
  2. Select Service – Service node is used to make a backend API call to update account balance information.
  3. Click the + New service 
  4. Property Panel for the Service Node is displayed, if not click on the newly added service node to open
  5. Enter the following details:
    • Name: UpdateBalance
    • Display Name: Update Balance
    • Service Type: Custom Service
    • Type: Webservice
    • Sub Type: REST
    • Click DEFINE REQUEST
      • In the Define Request Page, enter the following details:
        • Request typePUT
        • Request URLhttps://5c3c633d29429300143fe4d2.mockapi.io/AccountDetails/{{context.entities.AccountNumber}}.
        • This API does not require any Auth Parameters.
        • In the Body tab, select the type as application/json
        • Select the Test Request tab
        • Enter an account number and balance in the Sample Context Values section.
        • Click the Test button
        • Wait for the test to be completed and you get a Status: 200
        • Click Save as Sample Response
        • Click Save
    • On the Service node Property window, click the Connections tab.
      • Under the Connection Rules section, ensure that the Default connection is set to End of Bot Action.
    • Close the Service Property Panel
    • Click  next to the Bot Action node to collapse the bot action node.

Step 5: Message Node

A Message Node is used to display a message from the Bot to the user.
Here we will be using the Message node to show the success message.

  1. Click the + below the ToUpdateBalance Bot Action
  2. Select Message and click the + New message 
  3. Property Panel for the Message Node is displayed
  4. Enter the following details:
    • Name: UpdateMessage
    • Display Name: Update Message
    • Bot Responses: Enter Your account balance has been updated and hit enter to save
  5. On the Bot Response Property Panel, open the connections tab by clicking the ‘Connections‘ icon.
    • Change the Default connection from ‘Not Connected‘ to ‘End of Dialog‘.
    • Click Save.
  6. Close the Property Panel.

Test

To test the Dialog task, you can use the ‘Talk to bot’ at the bottom right corner.
Enter the following utterance (intent name) – “Update Balance
Follow the Bot instructions:

  • Enter Account Number – 29565731;
  • Select Account Type – Savings or Current;
  • Select the Transaction Type – Credit or Debit;
  • Enter the Amount – 100;
  • See the success message.

Next Steps

Your Banking Bot is almost complete, you have successfully added Get Balance and Update Balance dialog tasks to the Bot. The next step would be to include the Transfer Funds task. Click here to continue.

Menu