Entities

An Entity is a term or object, that provides context for an Intent (Question Category).

An Entity then, is something that will let you drill down to the options (Values) you want your end user to choose from.

Values

Values are the options that derive from an Entity. Different choices you have decided upon, that dig further into specific information your Virtual Assistant needs, in order to resolve any issue.

Values can also in turn provide more context, so that we dig even further into specific information.

Patterns

Patterns are used to control the way you ask for information. They have very specific structure like dates, telephone numbers, email addresses, credit card numbers, zip codes etc.

So with Patterns, we can control the way our End Users input info. For example:

  • An email will have the form of: xxx@xxxxx.xxx
  • A telephone number will have 10 digits

Synonyms

In the Entity | Value | Synonym Triad, Synonyms represent the last layer.

ENTITIESVALUESSYNONYMS & PATTERNS

For example, one of the most frequent uses for Synonyms, is payments, and it goes as follows:

Entity: Supported Payment Methods
Values: Credit Card | Cash | Web Payments
Synonyms: Visa, Mastercard, PayPal, Venmo (etc)
Patterns - example for Email: xxx@xxxxx.xxx

Add a new Entity

  1. While in your Brain, click on the Entities tab.
  2. Click on the + icon and change the Default name and description of your Entity.
  3. Add an Entity value along with its Synonyms

An Entity can contain synonyms OR patterns in the form of a Regular Expression.

Import an Entity

To import an entity from a file, you can click on the Import Icon on the top right in order to select a local csv file. The csv file needs to have the following format:

  1. 4 columns named Entity, Type, Value, Synonyms/Patterns
  2. Under the column Entity you should include the name of your imported entity. It could be empty
  3. Under the column Type you should include either synonym or pattern
  4. Under the column Value you should include the value of the entity
  5. Under the column Synonyms/Patterns you should include the comma separated synonyms or patterns.

Once the file is uploaded, you will see the new values. Click save to add your Entity

Example:

Download an example csv File

Last updated on