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. | UE, 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 valuesDue 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
Known issueExpressions such as “kilka” or “parę” trigger the sys.numeral entity, which maps them to specific numeric values (e.g. 2 or 3).
This may lead to complications, particularly when the system needs to distinguish between an exact number and a collective numeral.
A potential workaround involves creating a dedicated entity (for instance, a pattern-based one) to recognize collective numerals. The detection of this entity can then be incorporated into the system’s conditional logic, prompting the user to clarify and provide a precise number when necessary.
e.g. LABEL (ar"kilka" | ar"pare" | a"wiele" | a"mnostwo" | a"masa" | a"kupa" | a"chmara" | a"troche" | a"nieco" | a"odrobine" | a"duzo" | a"malo" | a"garsc") AS @"zbiorowe"
🇬🇧 English
List of built-in entities for the English language:
Entity name | Description | Examples |
|---|---|---|
sys.Person | People, including fictional | Harry Potter, James Bond, John Doe |
sys.Email | E-mail addresses | |
sys.Localization | All geographic names | Elbe, 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 | |
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 | Harry Potter, James Bond, John Doe |
sys.Email | E-mail address | |
sys.Localization | All geographic names | Elbe, 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 | |
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 | Olaf Scholz, Jürgen Klopp, Ludwig van Beethoven |
sys.Email | E-mail addresses | |
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 | |
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 | دونالد ترامب، جيمس بوند، جون دو |
sys.Email | E-mail addresses | |
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 | |
sys.AmountOfMoney | Amount of money (returns: numeral value and currency id) | 100 zł, $100, 200 euro, 99 AED |
🇫🇷 French
List of built-in entities for the French language:
| Nom de l'entité | Description | Exemples |
|---|---|---|
| sys.Person | Personnes, y compris les personnages fictifs \nNoms complets, prénoms et noms de famille | Jean Dupont, Napoléon Bonaparte, Victor Hugo |
| sys.Email | Adresses e-mail | [email protected], [email protected] |
| sys.Localization | Tous les noms géographiques | Seine, Alpes, Mer Méditerranée |
| sys.Numeral | Nombres en format numérique et alphabétique | 3, 12, douze |
| sys.DigitSequence | Séquence de chiffres | 1 7 3 4 2, cinq, deux, vingt |
| sys.Ordinal | Nombres ordinaux : « premier », « deuxième », etc. | troisième, dixième |
| sys.PhoneNumber | Numéros de téléphone | 0612345678, +33612345678, +33123456789 |
| sys.Time | Heures et dates | 5 heures, 17h30, 10:15 AM |
| sys.Duration | Durée de temps | une demi-heure, trois jours, 21 minutes, 60 sec |
| sys.Organization | Entreprises, agences, institutions, etc. | ONU, UNESCO, CNRS, EDF |
| sys.Url | Adresses URL | www.lemonde.fr |
| sys.AmountOfMoney | Montant d'argent (retourne : valeur numérique et devise) | 100 €, 200 euros, 99 CHF |
🇳🇱 Dutch
List of built-in entities for the Dutch language:
| Naam van de entiteit | Beschrijving | Voorbeelden |
|---|---|---|
| sys.Person | Personen, inclusief fictieve personen \nVolledige namen, voornamen en achternamen | Jan Janssen, Vincent van Gogh, Max Verstappen |
| sys.Email | E-mailadressen | [email protected], [email protected] |
| sys.Localization | Alle geografische namen | Rijn, Alpen, Noordzee |
| sys.Numeral | Getallen in zowel numerieke als alfabetische vorm | 3, 12, twaalf |
| sys.DigitSequence | Reeks cijfers | 1 7 3 4 2, vijf twee twintig |
| sys.Ordinal | Rangtelwoorden: “eerste”, “tweede”, etc. | derde, tiende |
| sys.PhoneNumber | Telefoonnummers | 0612345678, +31612345678, +31201234567 |
| sys.Time | Tijden en datums | 5 uur, 17:30, 10:15 AM |
| sys.Duration | Duur van tijd | een half uur, drie dagen, 21 minuten, 60 sec |
| sys.Organization | Bedrijven, agentschappen, instellingen, etc. | VN, EU, KLM, ING |
| sys.Url | URL-adressen | www.nu.nl |
| sys.AmountOfMoney | Geldbedragen (geeft terug: numerieke waarde en valuta) | 100 €, 200 euro, 99 CHF |
🇪🇸 Spanish
List of built-in entities for the Spanish language:
| Nombre de la entidad | Descripción | Ejemplos |
|---|---|---|
| sys.Person | Personas, incluyendo personajes ficticios \nNombres completos, nombres y apellidos | Juan Pérez, Miguel de Cervantes, Lionel Messi |
| sys.Email | Direcciones de correo electrónico | [email protected], [email protected] |
| sys.Localization | Todos los nombres geográficos | Amazonas, Andes, Mar Caribe |
| sys.Numeral | Números en formato numérico y alfabético | 3, 12, doce |
| sys.DigitSequence | Secuencia de dígitos | 1 7 3 4 2, cinco dos veinte |
| sys.Ordinal | Números ordinales: “primero”, “segundo”, etc. | tercero, décimo |
| sys.PhoneNumber | Números de teléfono | 612345678, +34612345678, +34912345678 |
| sys.Time | Horas y fechas | 5 en punto, 17:30, 10:15 AM |
| sys.Duration | Duración del tiempo | media hora, tres días, 21 minutos, 60 seg |
| sys.Organization | Empresas, agencias, instituciones, etc. | ONU, UNESCO, BBVA, Real Madrid |
| sys.Url | Direcciones URL | www.elpais.com |
| sys.AmountOfMoney | Cantidad de dinero (devuelve: valor numérico y moneda) | 100 €, 200 euros, 99 MXN |
🇮🇹 Italian
List of built-in entities for the Italian language:
| Nome dell'entità | Descrizione | Esempi |
|---|---|---|
| sys.Person | Persone, inclusi personaggi fittizi \nNomi completi, nomi e cognomi | Marco Rossi, Leonardo da Vinci, Giuseppe Verdi |
| sys.Email | Indirizzi e-mail | [email protected], [email protected] |
| sys.Localization | Tutti i nomi geografici | Tevere, Alpi, Mar Tirreno |
| sys.Numeral | Numeri in formato numerico e alfabetico | 3, 12, dodici |
| sys.DigitSequence | Sequenza di cifre | 1 7 3 4 2, cinque due venti |
| sys.Ordinal | Numeri ordinali: “primo”, “secondo”, ecc. | terzo, decimo |
| sys.PhoneNumber | Numeri di telefono | 0612345678, +393471234567, +390612345678 |
| sys.Time | Ore e date | 5 in punto, 17:30, 10:15 AM |
| sys.Duration | Durata del tempo | mezz'ora, tre giorni, 21 minuti, 60 sec |
| sys.Organization | Aziende, agenzie, istituzioni, ecc. | ONU, FAO, Ferrari, Eni |
| sys.Url | Indirizzi URL | www.repubblica.it |
| sys.AmountOfMoney | Somma di denaro (restituisce: valore numerico e valuta) | 100 €, 200 euro, 99 CHF |
🇵🇹 Portuguese
List of built-in entities for the Portuguese language:
| Nome da entidade | Descrição | Exemplos |
|---|---|---|
| sys.Person | Pessoas, incluindo personagens fictícios \nNomes completos, primeiros nomes e sobrenomes | João Silva, Fernando Pessoa, Cristiano Ronaldo |
| sys.Email | Endereços de e-mail | [email protected], [email protected] |
| sys.Localization | Todos os nomes geográficos | Amazonas, Andes, Oceano Atlântico |
| sys.Numeral | Números em formato numérico e alfabético | 3, 12, doze |
| sys.DigitSequence | Sequência de dígitos | 1 7 3 4 2, cinco dois vinte |
| sys.Ordinal | Números ordinais: “primeiro”, “segundo”, etc. | terceiro, décimo |
| sys.PhoneNumber | Números de telefone | 11987654321, +5511987654321, +351912345678 |
| sys.Time | Horários e datas | 5 horas, 17:30, 10:15 AM |
| sys.Duration | Duração do tempo | meia hora, três dias, 21 minutos, 60 seg |
| sys.Organization | Empresas, agências, instituições, etc. | ONU, Petrobras, Banco do Brasil, Sporting |
| sys.Url | Endereços URL | www.globo.com |
| sys.AmountOfMoney | Quantia de dinheiro (retorna: valor numérico e moeda) | 100 €, 200 reais, 99 BRL |
Updated 19 days ago