GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Quick Start Guide
Accessing the Platform
Working with the Builder
Building a Virtual Assistant
Using Workspaces
Release Notes
Current Version
Previous Versions
Deprecations

CONCEPTS
Design
Storyboard
Dialog Tasks
Overview
Dialog Builder
Node Types
Intent Node
Dialog Node
Entity Node
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Group Node
Agent Transfer
User Prompts
Voice Call Properties
Dialog Task Management
Connections & Transitions
Component Transition
Context Object
Event Handlers
Knowledge Graph
Introduction
Knowledge Extraction
Build Knowledge Graph
Add Knowledge Graph to Bot
Create the Graph
Build Knowledge Graph
Add FAQs
Run a Task
Build FAQs from an Existing Source
Traits, Synonyms, and Stop Words
Manage Variable Namespaces
Update
Move Question and Answers Between Nodes
Edit and Delete Terms
Edit Questions and Responses
Knowledge Graph Training
Knowledge Graph Analysis
Knowledge Graph Import and Export
Importing Knowledge Graph
Exporting Knowledge Graph
Creating a Knowledge Graph
From a CSV File
From a JSON file
Auto-Generate Knowledge Graph
Alert Tasks
Small Talk
Digital Skills
Digital Forms
Views
Introduction
Panels
Widgets
Train
Introduction
ML Engine
Introduction
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
NLP Configurations
NLP Guidelines
Intelligence
Introduction
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Sentinment Management
Tone Analysis
Test & Debug
Talk to Bot
Utterence Testing
Batch Testing
Conversation Testing
Deploy
Channels
Publish
Analyze
Introduction
Conversations Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Meta Tags
Dashboards and Widgets
Conversation Flows
NLP Metrics
Containment Metrics
Usage 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
Masking PII Details
Variables
IVR Settings
General Settings
Assistant Management
Data Table
Table Views
App Definitions
Sharing Data Tables or Views

HOW TOs
Build a Flight Status 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
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
Web SDK Tutorial
Widget SDK Tutorial
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

ADMINISTRATION
Introduction
Assistant 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 & Compliance
Using Single-Sign On
Security Settings
Cloud Connector
Analytics
Billing
  1. Home
  2. Docs
  3. Virtual Assistants
  4. Intelligence
  5. Amend Entity

Amend Entity

Time and again, we come across situations wherein the users change their preferences during task execution.

For example, while booking a flight, the user might change the date of travel and at times even the destination.

Amend Entity is a feature for such scenarios. Using this feature, you can allow the users to amend entity values and also control the post-amendment dialog behavior.

The entity amendment process is divided into three stages:

  • Amend Identification: Identifying that the end-user wants to amend is driven by the bot’s built-in NLP capabilities.
  • Amending Entities: On identifying the intention to amend, the current task is put on hold and the amend flow is triggered. Three kinds of amend flows are possible based upon the user utterance:
    • When the user refers to the entity name (or entity synonyms), then they are prompted for the entity value. For example, the user utterance I want to change the destination triggers the prompt for the destination entity. If the same entity node is present multiple times in the dialog, then the latest entity node for which the user has already provided input will be amended.
    • When the user gives the entity value then the entity is updated accordingly. For example, the user utterance I want to fly to JFK changes the destination entity value. If the value is compatible with two or more entities in the dialog, then the user is prompted to select an entity to amend.
    • When the user refers to both the entity and its value, then the entity is updated. For example, the user utterance change my destination to JFK will change the destination entity value.
  • Post Amendment Behavior: After an entity is successfully amended, there are three possible dialog execution flows that your bot can be configured for:
    • The dialog can be re-executed from the node that is amended by evaluating that entity’s connections.
    • The dialog can resume from the node where amend was identified or made.
    • The dialog can be resumed from a specified node present in the dialog.

Note: This feature is not supported in all languages, Click here for details.

Implementation

On the Kore.ai platform, Amend Entity behavior is defined at two levels:

  • Bot level
  • Task level

Bot Level

To Set Bot Level Amend Entity Behavior, follow the below steps:

  1. Select the Build tab from the top menu
  2. From the left menu, click Intelligence -> Amend Entity. 
  3. By default amend entities is disabled.
  4. Once you Allow amend entities, various Dialog Resumption options are available:
    • Re-execute dialog from amended entity – use this option to resume the dialog by evaluating the amended entity’s connections. You can further choose to:
      • Clear entity values captured downstream – to clear all entities captured between the identified entity and the amend
      • Skip display of previously displayed messages – messages from Message nodes alone.
    • Resume dialog from amend identification node – use this option to resume the dialog from the node where the amend was identified.

  5. The amend process can be extended to entities marked as Hidden using the Amend Hidden Entities option.

Task Level

To set Task Level Amend Entity Behavior, follow the below steps:

Amend entity behavior is set at the Task level also. The configurations defined at the task level will override the bot-level configurations.

  1. On the Dialog Task page, click the Ellipses  icon and select the Manage Amend Behaviour.
  2. On the Manage Amend Behaviour dialog box, by default, the Use bot level settings option is selected and the bot level setting is displayed.
  3. Select Customize for this task to override the bot level settings:
    • Do not allow amend entities – It will not allow the user to amend entity values for this task.
    • Allow amend entities – It will further give you three Dialog Resumption options:
      • Re-execute dialog from amended entity – Amend entity behavior is set at the task level also. The configurations defined at the task level will override the bot-level configurations.
        • Clear entity values captured downstream – to clear all entities captured between the identified entity and the amend
        • Skip display of previously displayed messages – messages from Message nodes alone.
      • Resume dialog from amend identification node – use this option to resume the dialog from the node where the amend was identified.
        • Jump to a specific node in the dialog – use this option to select a node from the current dialog where the task flow needs to jump. You can use this option to add custom behavior before resuming with the dialog. Context object will contain the details of the entities amended, along with the previous and current values. You may use this information to customize the dialog.
      • The amend process can be extended to hidden entities using the Amend Hidden Entities option.

Triggers

The following are patterns supporting the Amend Entity behavior. User utterance around these patterns triggers Amend Entity.

  • ~amend_synonyms <entity_name> from <old_value> to <new_value>
    For example, “change the departure date from today to tomorrow“.
  • ~amend_synonyms <entity_name> [to as from with] <new_value> [instead_of rather_than not] <old_value>
    For example, “modify departure date to tomorrow instead of today“.
  • ~amend_synonyms <entity_name> <old_value> [to as with] <new_value>
    For example, “replace departure date with tomorrow“.
  • ~amend_synonyms <entity_name> from <old_value>
    For example “alter departure date from today“.
  • ~amend_synonyms <entity_name> [to as from with] <new_value>
    For example, “modify departure date to tomorrow“.
  • ~amend_synonyms {from} <old_value> [to as with] <new_value>
    For example, “change from today to tomorrow“.
  • ~amend_synonyms [to as from] <new_value> [instead_of rather_than not] <old_value>
    For example, “change to tomorrow instead of today“.
  • ~amend_synonyms [to as from] <new_value> instead
    For example, “change to tomorrow instead“.
  • ~amend_synonyms [([it that this] {to}) it that this to] <new_value>
    For example, “change it from today to tomorrow“.
  • ~amend_synonyms <entity_name>
    For example, “amend departure date“.
  • ~amend_synonyms <old_value>
    For example, “change today
  • [to as from] <new_value> [instead_of rather_than not] <old_value>
    For example, “to tomorrow instead of today
  • [to as from] <new_value> instead
    For example, “to tomorrow instead

In the above-mentioned patterns the concept ~amend_synonyms includes "amend", "change","modify","alter","update", "replace", "make", "move", "upgrade", "want".

Note: The user can use these patterns to change multiple entity values. For example, Change the departure date from today to tomorrow and departure city to Chicago results in the changes to both departure date and city.

Additional Notes

  • Amend functionality is not applicable for the universal bot’s default language. However, when a linked bot is in progress, amend the settings of the linked bot is honored.
  • The platform’s in-built training data drives the identification of the amend requests, and it is currently supported only for the dialog task conversations in English.
  • The scope of this feature currently includes only the replacement of previously populated entities. It does not include other scenarios like partial modifications, deletions, additions to entity values.
Menu