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
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
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
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
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. Builder
  5. Dialog Task
  6. Entity Node

Entity Node

Virtual Assistants need to extract relevant information from the user utterance to fulfill the intent.

Take a look at this sample utterance: Book me a flight from LA to NYC on Sunday.  To act on this user intent, which is to book a flight ticket, the bot should extract the entities such as the source city (LA), destination city (NYC), and the departure date (Sunday).

So, in a Dialog Task, for every critical data you want to get from a user utterance, you should create a corresponding entity node. You can add prompt messages to these nodes for users to input the required values.

The Kore.ai XO Platform supports ~30 entity types such as Address, Airport, Quantity, and so on. You can also define the entities as a selection from a list, free-form entry, file or image attachment from a user, or as regex expressions.

Note: You need to follow one entity node with several other entity nodes to collect a series of user inputs to complete a transaction, such as a username, location, amount, and due date, followed by a Webhook node to process a request to an API to complete an online transaction.

Add the Node

Setting up an entity node in a dialog task involves the following steps:

  1. Open the dialog task to add the Entity node.
  2. Add the entity node in the designated place. For information on adding nodes, refer here.
  3. The Entity window is displayed with the Component Properties tab selected by default.


Configure the Node

Component Properties

The Entity window allows you to configure the General Settings, User, and Error Prompts.

Note: The configurations you set up or modify in this section are reflected in all other dialog tasks that use this node.

 

  1. On the Component Properties tab, under the General Settings section, enter a Name and Display Name for the entity node. Entity names cannot include spaces.
  2. From the Type drop-down list, select an entity type depending on the expected user input. For example, if you want the user to type the departure date, select Date from the drop-down. The platform does the basic validation based upon the Type selected.
    The Entity Type provides the NLP Interpreter with the expected type of data from a user utterance to enhance recognition and system performance. For more information, refer to Entity Types
  3. Based on the Type selected, you have an option to set the Entity as Multi-item thereby allowing the user multiple selections. If enabled, the VA should expect multiple items for this entity from the user.
  4. Under the User Prompt section, enter the prompt message that you want the user to see for this entity. For example, Enter the Departure Date.
    1. You can enter channel-specific messages for user prompts using the Manage link. For more information, refer to Using the Prompt Editor.
    2. You can override the user prompt for this particular instance.
      To override,
      1. Click the Settings icon on the right.
      2. Enable the Override for this instance toggle. Once you enable this option, you can enter the user prompt for this particular instance. Disabling this option would delete the instance-specific prompt and revert it to the component property.
  5. Under the Error Prompts section, review the default error message, and if required, you can modify the error messages displayed for this entity.
    1. To manage the error messages, click Manage link. For more information, refer to User Prompts.
    2. You can override the user prompt for this particular instance.
      To override,
      1. Click the Settings icon on the right.
      2. Enable the Override for this instance toggle. Once you enable this option, you can enter the user prompt for this particular instance. Disabling this option would delete the instance-specific prompt and revert it to the component property.
    3. You can also reorder the error messages. To reorder,
      1. Click the Settings icon on the right.
      2. Enable the Present Prompts in the Order of Retries toggle. Once you enable this option, the handlebar icon would be visible before each error prompt message. You can use this to re-order the messages so that they will be displayed in that sequence.

        This image corresponds to the new Dialog Builder, you will find this feature in the legacy builder at the same location: i.e. Entity node -> Component Properties.
  6. In the Variable Namespaces section, associate the Variable Namespaces to execute this node and its transitions. This option is visible only when the Variable Namespace is enabled for the bot. You can go with the task level settings or customize it for this node. For more information, refer to Managing Namespace.
  7. Under Redaction of PII Data, you can configure how the value of this entity should be presented if it is identified as PII data and is used in defining any messages or responses. You can choose to de-identify PII Data or use the original values while presenting this data to the user. 

Instance Properties

Use the Instance Properties to determine whether to make the entity value mandatory as well as to choose if you want to consider values from previous user utterances to capture entities.

Note: The settings in the Instance Properties tab are specific to the current dialog task and do not reflect in the other dialog tasks that use this entity node.

 

  1. On the Entity window, click the Instance Properties tab.
  2. Under the User Input section, select an option (Refer to the below section for how the entity flow is managed):
    1. Mandatory: This entity is required, and users must provide a valid entry before proceeding with the dialog flow. A prompt is displayed for the user to resolve in case ambiguous values for the entity are detected in the user utterance.
      You can configure the number of times the user would be prompted for this entity value by setting the number of Allowed Retries to any value between 1 and 5, the default being 5.
      Further, you can define the VA’s Behavior on Exceeding Retries, this can be set to trigger End of Dialog or Transition to a Node. This would result in the creation of a Connection Rule called Behavior on Exceeding Retries. The message displayed to the user on exceeding retries can be customized from the Standard Responses. Read more here..
    2. Optional: The user is prompted only once for this entity and the system proceeds with any input provided by the user. In case ambiguous values for these optional entities are detected in the User Utterance, then a resolution prompt is displayed allowing the user to pick the correct value.
      You can set a value under the Default Value field. This value would be assigned to this entity when the task execution reaches this entity and the user does not provide any value when prompted, and if no value is available from previous utterances.
    3. Hidden: If enabled, the VA will not prompt for the entity value. The value would be considered if explicitly provided by the user in previous utterances.
      You can set a value under the Default Value field. This value would be assigned to this entity when the task execution reaches this entity and no value is available from previous utterances.
  3. User Input Correction (v7.3) can be used to define whether the user input needs to be auto-corrected. This option is available only for string type entities. The two options are listed below:
      1. Auto-correct user input is the default setting. The platform builds a custom dictionary for each VA to include all synonyms, task names, pattern words, and small talk utterance words on top of a standard dictionary. This feature is not supported in all languages, Click here for details.
      2. Do not auto-correct user input: To ensure backward compatibility, the following settings are applied to existing VAs (migrating VAs that are older than v7.3 to v7.3):
      3. OLD STATE (ENTITY EXTRACTION)

        NEW STATE (USER INPUT CORRECTION)

        Evaluate unused text from previous utterances.

        Do not auto-correct user input.

        Evaluate unused text and text used for extracting entities from previous utterances.

        Do not auto-correct user input.

        Do not evaluate previous utterances and explicitly prompt the user – Do not auto-correct [Enabled].

        Do not auto-correct user input.

        Do not evaluate previous utterances and explicitly prompt the user – Do not auto-correct [Disabled].

        Auto-correct user input.

  4. Under the Entity Extraction section, select one of these options:
    1. Evaluate the unused text from the previous utterance: When this option is selected, the entity uses the text that was not used by any other entity in the dialog so far. This is the default option.
    2. Evaluate unused text and text used for extracting entities from previous utterances: Select this option if you want to reuse an entity value extracted by another entity node in the dialog.
    3. Do not evaluate previous utterances and explicitly prompt the user: Select this option if you want the VA to ignore the previous user utterances and explicitly prompt the user to provide value for the entity.
      • Further, you can restrict the platform from reusing the input provided for this entity to extract any other entities by selecting the Do not reuse option.
  5. Under the Entity Rules section, you can configure rules to validate the user input.
  6. Use the Add/Customize button to enter a JSON structure for the validation and entity extraction rules. Refer here for the details on entity rules.
  7. Click the Advanced Controls to set up these options:
    1. Intent Detection (Applies only to String and Description entities): Select one of these options to determine the course of action if the VA encounters an entity as a part of the user entry for the String or Description entities:
      • Accept input as entity value and discard intent detected: The VA captures the user entry as a string or description and ignores the intent.
      • Prefer user input as intent and proceed with Hold & Resume settings: The user input is considered for intent detection and the proceeds according to the Hold & Resume settings.
      • Ask the user how to proceed: Allow the user to specify if they meant intent or entity.
    2. Interruptions Behavior: To define the interruption handling at this node. You can select from the below options:
      1. Use the task level ‘Interruptions Behavior’ setting: The VA refers to the Interruptions Behavior settings set at the dialog task level.
      2. Customize for this node: You can customize the Interruptions Behavior settings for this node by selecting this option and configuring it . You can choose whether to allow interruptions or not, or whether to allow the end user to select the behavior. You can further customize Hold and Resume behavior. Read the Interruption Handling and Context Switching article for more information.
    3. Precedence (Applies to all Entity types except String and Description nodes): When the user’s input for an entity consists of a valid value for the entity and another intent, you can control the experience by choosing between Intent over Entity or Entity over Intent options. For example, if a Flight Booking VA prompts for the destination and the user enters, Bangalore, how’s the weather there? you get to define how the bot responds in such cases; pick the entity and add the intent to the Follow-up Intents stack or go ahead with the intent first based upon the Interruptions Behavior settings.
    4. Custom Tags: This is where you can define tags to build custom profiles of your VA conversations. Click here to learn more.

The User Input Flow

When a user is prompted for input, the following is the process performed by the Platform:

  • If the user responds with a valid value, then the entity populates with that value and the dialog flow continues.
  • If ambiguous values are identified in the user response, then an ambiguity resolution prompt is displayed.
  • If the user responds with an invalid utterance i.e. an utterance that does not contain a valid input for the ambiguity resolution, then:
    • If the given value is valid for the entity (any possible value for the entity), it is used for the entity and the conversation is continued.
    • If the given value is not valid for the entity and if the value triggers any task intent, faq, or small talk, then:
      • The intent is executed as per hold and resume settings and when (and if) the dialog (containing the entity) is resumed, the user is prompted for the entity value.
      • If the value does not trigger any task intent, faq, or small talk, the entity is left blank and the conversation is continued from the entity’s transitions.
  • If the user exceeds the retry limit, the behavior defined for exceeding retries would be triggered. Note that if this is a child task and the behavior is set to end the dialog then the parent task would also be terminated.


NLP Properties

  1. On the NLP Properties tab, under the Suggested Synonyms for the < entity name > section, enter synonyms for your entity. Click Enter after each entry to save it. For more information, refer to Managing Synonyms.
  2. Under the Suggested Patterns for < entity name > section, click + Add Pattern to add new patterns for your entity. The Patterns field is displayed. For more information, refer to Managing Patterns.
  3. Under the Manage Context section, in the Context Output field, define the context tags to be set in the context when this entity populates.
  4. You can select Auto emits the entity values captured option as part of the Context Object. (Click here to learn more about Context Management)


IVR Properties

You can use this tab to define the input mode, grammar, prompts, and call behavior parameters for this node to use in IVR Channel. You can define this at the node level. Click here for details.


Connections Properties

From the node’s Connections tab, you can determine which node in the dialog task to execute next. You can write the conditional statements based on the values of any Entity or Context Objects in the dialog task, or you can use intents for transitions. 

Note: These conditions are applicable only for this instance and will not affect the node when being used in any other dialog.

 

To set up component connection conditions, please follow the steps outlined in Adding IF-Else Conditions to Node Connections.

If you want to delete a condition, hover over it and click the bin icon at its top right. Keep in mind that deleted conditions cannot be restored.


Learn More

You might want to refer to the following articles, for further information:

Menu