Entities

Learn how to use entities which is essential for a smooth flow design.

Entities are data buckets that contain words and phrases with similar characteristic, such as countries, movie genres or a product list. You can create as many entities as you need. To save your time, you can also use the ready to use system entities.

Below are built-in system entities. You can use them in your intent parameters directly to validate user inputs.

Entities

System entities are used mainly to validate user input to help users avoid invalid responses. To understand the purpose of the system entities:

@sys.date: Validates date inputs with the format of YYYY-MM-DD

@sys.datetime: Validates date & time inputs with the format of YYYY-MM-DD HH:MM:SS

@sys.duration: ?

@sys.email: Validates email inputs with the format of [e-mail].

@sys.number: Validates number inputs with the format of double.

@sys.phone: Validates phone number inputs with the format of double.

@sys.text: Validates text inputs with the format of string.

@sys.time: Validates time inputs with the format of HH:MM:SS

@sys.url: Validates URL inputs with the format of ?

@sys.user.email: Validates email inputs received from users with the format of [e-mail].

@sys.user.fullname: Validates full name inputs received from users with the format of string.

@sys.user.lastname: Validates last name inputs received from users with the format of string.

@sys.user.name: Validates name inputs received from users with the format of string.

@sys.user.phonenumber: Validates phone numbers inputs received from users with the format of double.

To create a new Entity:

1. Click on Create User Entity button.

2. First, you need to give your entity a name.

3. We have two fields: Reference Value and Synonyms

   1. Reference Value: In this field add a general name, a container that will describe all the values.

   2. Synonyms: In this field type synonyms and words or phrases that refer to this container.

4. Fill the reference value.

5. Type synonyms and hit enter to add

6. Add as many entities as you need.

7. Hit the Save Change button. Your entities are ready!

Creating a new Entity