Creating an Entity
U-Self Serve enables users to create Account-level Entities, in addition to System-level Entities. You can create Custom, Alphanumeric and Bulk Entity types.
Go to the Entities page of the Virtual Agent which displays all Entities created for the VA.
Go to the top left corner and click Create New Entity. The Create New Entity page is displayed:
Enter a unique Name for the new Entity.
Select the Type of the Entity from the drop down list.
Custom: Any information specific to a VA can be categorized as Custom Entity. You can add multiple Synonyms for an Entity Value. For more information, refer Create Custom Entity.
Alphanumeric: Any information that contains Alphanumeric value can be categorized as Alphanumeric Entity. You can add Entity value and one Synonym for the value. A Regex pattern can be added from the catalogue in order to define a search pattern. For more information, refer Create Alphanumeric Entity.
Enter a Description for the Entity.
Select the Language for the Entity from the drop down list. The Languages that are mapped to the current VA is listed.
Click Add New Value.
Add the Entity Value and its Synonym. At least one Entity Value is required for a language.
Click Delete icon if you wish to delete an Entity Value and its Synonym.
Click Save. Once the Entity is created, it can be used in Slots available under Intents.
Once the Entity is saved, a confirmation message will popup following which you can either Create another new Entity or Go to Entity Listing page where you can view and edit all entities.
System Entity
A System Entity is a built-in-entity type which is enabled to capture the most commonly-used data such as dates, email addresses, URLs, phone numbers, etc.
U-Self Serve currently supports the following System Entities:
System Entity Name | Description | Example |
|---|---|---|
amount-of-money | Captures any currency value | 200$ Rupees 1000 300€ |
Captures an email address | support@uniphore.com | |
global-intent | Stores a Global Intent value | Not applicable |
number | Captures a whole number | 101 67890 |
numeric-string | Captures a number that includes leading zero(s) or zeros as part of the sequence of digits. | 000987654321 123000789 |
phone-number | Captures landline and mobile phone numbers | +1 (650) 123-4567 +91 9876543210 |
text | Captures text value | This is an example text message. |
time | Captures date and time | 2016-12-14T09:00:00.000-08:00 |
url | Captures a website address | www.uniphore.com |
Creating a Custom Entity
When you create a Custom Entity, you can add multiple synonyms to the Entity Value. The basic steps to create any Entity is explained in detail in Creating an Entity. Once the basic information is added, follow the below given steps to create a Custom Entity:
 |
Ensure the Entity Type is set as Custom.
Click Add New Value to add Entity Values and Synonyms to the Entity.
Add the Entity Value and its Synonym. At least one Entity Value is required for a Language.
In Synonym, add all meanings or words that can be used interchangeably for the Entity Value.
To add multiple Synonyms, enter the Synonym and press Tab. Multiple Synonyms can be added to Custom Entities only.
Click Save. Once the Entity is created, it can be used in Slots available under Intents.
Entity Name | Entity Value | Synonym |
|---|---|---|
Auto_Type | sedan motorcycle | sedan, SEDAN, Sedan Motorbike, Motorcycle, motorcycle, motorbike |
Product_Name | Model | Model numbers can be given as Synonyms. |
City | San Francisco, London, Chennai, New Delhi | SFO, sfo, Sfo, LHR, Lhr, lhr, LGW, Lgw, lgw, MAA, maa, Maa, DEL, del, Del |
Creating Alphanumeric Entity
Any information that contains Alphanumeric value are categorized as Alphanumeric Entity. Regex is used as Synonym for the Entity Value which helps to improve Alphanumeric Entity extraction.
The basic steps to create any Entity is explained in detail in Creating an Entity. Once the basic information is added, follow the below given steps to create a Alphanumeric Entity:
Ensure the Entity Type is set as Alphanumeric.
Click Add New Value to add Entity Values and Synonym.
Add the Entity Value and its Synonym.
Once the Entity Value is entered, select Regex from the Regex Catalogue. The selected Regex is added as Synonym for the Entity Value.
Regex helps the bot to identify the matching string or text, spoken or entered by the end user.
Only one Synonym (Regex) is allowed per Entity Value.
Multiple Entity Values can be added.
Click Save. Once the Entity is created, it can be used in Slots available under Intents.
Example of Alphanumeric Entity
Entity Name | Entity Value | Synonym |
|---|---|---|
Unique_ID | Social Security Number, Policy number, Driving license number | Regex |