Built-in entities
Automate provides common built-in entities, called system entities or sys.entities.
System entities vary by language and it is important to understand which system entities are in use and how they behave.
System entities capture common variables in user phrases, such as name, location and times.
See the below tables for a detailed breakdown by language.
To access system entities in your flow use nlu.variables.variable_name. You can find variable names in NLU module in Analyze box.
🇵🇱 Polish
List of built-in entities for the polish language:
| Entity name | Description | Examples |
|---|---|---|
| sys.Forename | Forename or first name | Ania, Andrzej, Miłosz, Czesław |
| sys.Surname | Surname/last name | Kowalski, Nowak, Tomaszewski, Zięba |
| sys.Email | E-mail addresses | [email protected], [email protected] |
| sys.Country | Country names | Polska, Niemcy, USA |
| sys.Localization | Non-countries/cities locations, mountain ranges, bodies of water. | Wisła, Tatry, bałtyckie |
| sys.Numeral | Numbers in both numeral and alphabetic form | 2, 13, dwanaście |
| sys.Ordinal | Ordinal number: “first”, “second”, etc. | trzeci, czwarty, dziesiąty |
| sys.DigitSequence | Sequence of digits | 1 7 3 4 2, jeden dwa pięć |
| sys.PhoneNumber | Phone numbers | 882840253, +48882840253, +44791112345, +48566864455 |
| sys.Time | Times and dates | 8:33, piętnaście po piątej, dwunasta godzina |
| sys.Duration | Duration of time | 21 minut, pół godziny, 3 dni |
| sys.Settlement | Cities and villages | Warszawa, Londyn, Chełmno |
| sys.Organization | Companies, agencies, institutions, etc. | EU, NATO, ONZ |
| sys.Url | URL addresses | www.sentione.com |
| sys.AmountOfMoney | Amount of money (returns: numeral value and currency id) | 100 zł, $100, 200 euro, 99 AED |
Please note that entity names are not always compatible!
- sys.Forename, sys.Surname is available only in Polish, whereas in other languages there is sys.Person
- Definition of sys.Localization is broader in non Polish NLUs - sys.Country, sys.Settlement is exclusive only for Polish NLU
sys.Time returns multiple values
Due to the fact that providing time is ambiguous when presenting it as datetime we provide possible values.
- value - returns first possible matching time in the future
- values - returns list of 3 elements, where 1st element is first possible matching time in the past, 2nd and 3rd contains following possible matching time in the future
Please use NLU tester to check what dates will be returned for expected user utterances
🇬🇧 English
List of built-in entities for the English language:
| Entity name | Description | Examples |
|---|---|---|
| sys.Person | People, including fictional Full names, first names and last names | Harry Potter, James Bond, John Doe |
| sys.Email | E-mail addresses | [email protected], [email protected] |
| sys.Localization | All geographic names | Vistula, Pyrenees, Baltic Sea |
| sys.Numeral | Numbers in both numeral and alphabetic form | 3, 12, twelve |
| sys.DigitSequence | Sequence of digits | 1 7 3 4 2, five two twenty |
| sys.Ordinal | Ordinal number: “first”, “second”, etc. | third, tenth |
| sys.PhoneNumber | Phone numbers | 882840253, +48882840253, +44791112345, +48566864455 |
| sys.Time | Times and dates | 5 o'clock, 5:50 AM, 5:50 |
| sys.Duration | Duration of time | half an hour, three days, 21 minutes, 60 sec |
| sys.Organization | Companies, agencies, institutions, etc. | EU, NATO, ONZ |
| sys.Url | URL addresses | www.sentione.com |
| sys.AmountOfMoney | Amount of money (returns: numeral value and currency id) | 100 zł, $100, 200 euro, 99 AED |
🇪🇺 Multilingual projects
The multilingual projects currently use English entities for sys.Ordinal, sys.Time, sys.Duration. For sys.Person, sys.Localization, sys.Organization following languages are supported: Arabic, German, English, Spanish, French, Italian, Latvian, Dutch, Portuguese and Chinese
| Entity name | Description | Examples |
|---|---|---|
| sys.Person | People, including fictional Full names, first names and last names | Harry Potter, James Bond, John Doe |
| sys.Email | E-mail address | [email protected], [email protected] |
| sys.Localization | All geographic names | Vistula, Pyrenees, Baltic Sea |
| sys.Numeral | Numbers in both numeral and alphabetic form | 3, 12, twelve |
| sys.DigitSequence | Sequence of digits | 1 7 3 4 2, five two twenty |
| sys.Ordinal | Ordinal number: “first”, “second”, etc. | third, tenth |
| sys.PhoneNumber | Phone numbers | 882840253, +48882840253, +44791112345, +48566864455 |
| sys.Time | Times and dates | 5 o'clock, 5:50 AM, 5:50 |
| sys.Duration | Duration of time | half an hour, three days, 21 minutes, 60 sec |
| sys.Organization | Companies, agencies, institutions, etc. | EU, NATO, ONZ |
| sys.Url | URL addresses | www.sentione.com |
| sys.AmountOfMoney | Amount of money (returns: numeral value and currency id) | 100 zł, $100, 200 euro, 99 AED |
🇩🇪 German
List of built-in entities for the German language:
| Entity name | Description | Examples |
|---|---|---|
| sys.Person | People, including fictional Full names, first names and last names | Olaf Scholz, Jürgen Klopp, Ludwig van Beethoven |
| sys.Email | E-mail addresses | [email protected], [email protected] |
| sys.Localization | All geographic names | Weichsel, Pyrenäen, Ostsee, Polen, Wolfsburg |
| sys.Numeral | Numbers in both numeral and alphabetic form | 3, 12, zwölf |
| sys.DigitSequence | Sequence of digits | 1 7 3 4 2, fünf zwei zwanzig |
| sys.Ordinal | Ordinal number: “first”, “second”, etc. | dritter, zehnter |
| sys.PhoneNumber | Phone numbers | 882840253, +48882840253, +44791112345, +48566864455 |
| sys.Time | Times and dates | 5 Uhr, 5:50 Uhr, 5:19 |
| sys.Duration | Duration of time | 2 Stunden, drei Tage, 21 Minuten, 60 Sekunden |
| sys.Organization | Companies, agencies, institutions, etc. | EU, NATO, AfD |
| sys.Url | URL addresses | www.sentione.com |
| sys.AmountOfMoney | Amount of money (returns: numeral value and currency id) | 100 zł, $100, 200 euro, 99 AED |
☪ Arabic
List of built-in entities for the Arabic language:
| Entity name | Description | Examples |
|---|---|---|
| sys.Person | People, including fictional Full names, first names and last names | دونالد ترامب، جيمس بوند، جون دو |
| sys.Email | E-mail addresses | [email protected], [email protected] |
| sys.Localization | All geographic names | ألمانيا، الولايات المتحدة الأمريكية، بحر البلطيق، شبه الجزيرة العربية |
| sys.Numeral | Numbers in both numeral and alphabetic form | 3, 12, اثني عشر |
| sys.DigitSequence | Sequence of digits | 1 7 3 4 2, خمسة وعشرون |
| sys.Ordinal | Ordinal number: “first”, “second”, etc. | الثالث والعاشر |
| sys.PhoneNumber | Phone numbers | 882840253, +48882840253, +44791112345, +48566864455 |
| sys.Time | Times and dates | الساعة 5، 5:50 صباحًا، 5:19 |
| sys.Duration | Duration of time | نصف ساعة وثلاثة أيام و21 دقيقة و60 ثانية |
| sys.Organization | Companies, agencies, institutions, etc. | الاتحاد الأوروبي، حلف شمال الأطلسي، الأمم المتحدة |
| sys.Url | URL addresses | www.sentione.com |
| sys.AmountOfMoney | Amount of money (returns: numeral value and currency id) | 100 zł, $100, 200 euro, 99 AED |
Updated 2 months ago