Entities

Entities are background or any additional information that is valueable to the message. At times, users tend to provide all the information(entities) upfront in an utterance. Using entities appropriately in bot model training leads to a better conversational experience.

For Example -

I want to book an appointment with the Dentist on 27th May

- Dentist is type of Doctor and 27th May is Date.

Buy the latest SUV for your brand

- Here, SUV referes to the type of car.

Entity Types#

In cloud.yellow.ai, there are two kind of entities that can be defined -

  1. List Type
  2. Pattern Type
  3. System Entities
  4. Text Type

List Type#

These consist of around 60-70% usecases such as product catalogues, type of leaves, mode of payments, etc. Ideally when all possible distinct values of the entity are known, list type of entity can be used. For example -

Type of loan : Home, Personal, Car, Bike Type of Leave : Sick, Casual, Privilege, Maternity, Paternity

Additionally, each value can have multiple variations - Car can be regarded as 4 wheeler and Bike as 2 wheeler. These variations can be added as synonyms to each value. Synonyms can be other meanings of the entity in other languages.

Pattern Type#

Cases when the pattern of the information is known but there is no way to list all the possible exact values of the same entity. This includes entities like Fligh Number, ID cards, etc.

Policy Numbers - OG - XXXX -XXX -XXXX PAN Number - ABCDE1234F

Defining these entities is very simple, by entering the regular expression (general format of input).

System Entities#

Apart from the List and Pattern type entities, a set of entities are recognized by the model out of the box without any specific training. These include -

  • Name
  • Date
  • Email
  • Location

Text type#

Text Type entities should be used when your use case doesn't fall into any of the above entities use cases or when you do not have a specific list/format of you entity items.

⚠️ Most cases are covered by above 3 entity types, it's highly recommended you do not use text entity unless needed as it is not very definate as above 3.

ℹ️ Text entites also need tagging on utterances for training purposes. Add a few utterances to your intent (where you might need to detect this entity) containing some examples of this entity and double click to tag.

warning

Don't forget to Train Entities before trying!


Autoskipping prompts using entities#

As a next step, to detect entity and skip prompts, we need to go to prompt settings of that prompt, and select entity value of which if mentioned or present in memory, that prompt should be skipped.

For example, in above 1st example, if date entity is selected for autoskipping in date prompt, value of date will be automatically assigned to given date and user will not be shown that prompt.

info

You can test Entities detected in a phrase/utterance using Test your bot option in tools !