Rate this page:


Entities are necessary when you collect data and information from a customer. In this article you will learn what entities are, what built-in entities avatar has and how to create a custom entity.

What are entities?

Copy URL

Avatar entities are data types that an avatar can extract from the customer speech, if there is a task to collect some data from the customer. When you store a data received from the customer, you can assign it a specific format — entity.

There are some built-in entities and there are custom entities that you can create yourself.

The built-in entities are:

You can collect information from a customer, for example, with the help of avatar form state. When filling the form, specify the entity parameter to the form field to specify the type.

You can see the form state scenario example in the avatar scenarios article.

Creating custom entities

Copy URL

Sometimes, built-in entities are not enough to fulfill your needs. In this case, you can create custom entities.

For example, you have a pizza restaurant, and want avatar to understand when customers talk about different kinds of pizza. In this case, you can create a "pizza" entity, and give it some entries with your pizza types.

Let us see how it works. To create an entity:

  1. Log in to your control panel and go to the Avatar section.
  2. Choose an existing avatar, or create a new one.
  3. Go to the Entities section within an avatar.
  4. To add a new entity, click the Add button.
Add entity
Entities limits

An avatar application can have up to 128 custom entities.

  1. Give the entity a name. You use this name in the scenario, when you specify the entity parameter. A custom entity's name cannot have more than 258 characters.

In our case, let us give the "pizza" name to our new entity type.

  1. After you create the entity, open it and add some entries.

In our case, the entries can be "pepperoni", "carbonara", "margherita" and other kinds of pizza you have.

Entities limits

Each custom entry can have up to 100000 entry values.

  1. You can add some synonyms for each entry.

You need synonyms in case a customer call your pizza with a mistake, for example "carbanana" instead of "carbonara". Avatar understands the correct entry by analyzing all the synonyms and fills the form.

Entities limits

Each custom entry can have up to 32 synonyms.

After you close your new entity, it is ready for your scenario. Specify it in the entity parameter to the form field the same as built-in entity, to specify the type of this field.