System entities can be used to identify and extract user data. Autopilot provides many system entities aimed at extracting common types of data. For example, the @sys.color type can be used to extract values like "red" or "blue".
For most applications, the values provided by system entities are sufficient. However, your specific use case may need to add additional values for specific system entities. For example, you may want to add "blue-green" to the list of values for @sys.color. Some system entities can be extended for this purpose.
Note: Bear in mind that some languages do not fully support all system entities. For more information, please read this.
System Entities Reference Table
| Category | Name | Description | Output Format |
|---|---|---|---|
| Date and Time | @sys.date-time | Matches date, time, intervals, or date and time together. If there is ambiguity in end-user input due to missing date/time elements, the nearest matching future date/time is returned. | String in ISO-8601 format or Object: Strings in ISO-8601 format |
| Date and Time | @sys.date | Matches a date. If there is ambiguity in end-user input due to missing date/time elements, the nearest matching future date/time is returned. | String in ISO-8601 format |
| Date and Time | @sys.date-period | Matches a date interval. | Object: Strings in ISO-8601 format |
| Date and Time | @sys.time | Matches a time. If there is ambiguity in end-user input due to missing date/time elements, the nearest matching future date/time is returned. | String in ISO-8601 format |
| Date and Time | @sys.time-period | Matches a time interval. | Object: Strings in ISO-8601 format |
| Numbers | @sys.number | Ordinal and cardinal numbers. | Number |
| Numbers | @sys.cardinal | Cardinal numbers. | Number |
| Numbers | @sys.ordinal | Ordinal numbers. | Number |
| Numbers | @sys.number-integer | Matches integers only. | Number |
| Numbers | @sys.number-sequence | Matches number sequences. | String |
| Numbers | @sys.flight-number | Alphanumeric flight numbers. | String |
| Amounts with Units | @sys.unit-area | Number + units of area. |
Object: amount integer + unit String |
| Amounts with Units | @sys.unit-currency | Number + currency name. |
Object: amount integer + currency String in ISO 4217 format |
| Amounts with Units | @sys.unit-length | Number + units of length. |
Object: amount integer + unit String |
| Amounts with Units | @sys.unit-speed | Number + units of speed. |
Object: amount integer + unit String |
| Amounts with Units | @sys.unit-volume | Number + units of volume. |
Object: amount integer + unit String |
| Amounts with Units | @sys.unit-weight | Number + units of weight. |
Object: amount integer + unit String |
| Amounts with Units | @sys.unit-information | Number + unit of information. |
Object: amount integer + unit String |
| Amounts with Units | @sys.percentage | Number + percentage. | String |
| Amounts with Units | @sys.temperature | Number + temperature units. |
Object: amount integer + unit String |
| Amounts with Units | @sys.duration | Number + duration units (hours, days, months, etc.). |
Object: amount integer + unit String |
| Amounts with Units | @sys.age | Number + age units (years old, months old, etc.). |
Object: amount integer + unit String |
| Unit Names | @sys.currency-name | Currencies. |
String in ISO 4217 format |
| Unit Names | @sys.unit-area-name | Units of area. | String |
| Unit Names | @sys.unit-length-name | Units of length. | String |
| Unit Names | @sys.unit-speed-name | Units of speed. | String |
| Unit Names | @sys.unit-information-name | Units of information. | String |
| Geography | @sys.address | Full addresses, from either the United States or Great Britain. | String of user input |
| Geography | @sys.zip-code | Postal codes from the United States, Great Britain, or Canada. | String |
| Geography | @sys.geo-capital | World capitals. | String in English |
| Geography | @sys.geo-country | Names of countries, in short, or in full. | String in English |
| Geography | @sys.geo-country-code | Short and full country names, alpha-2, alpha-3, and numeric codes as per ISO 3166-1. |
Object: Strings for name, alpha-2 and alpha-3 codes, integer for numeric code as per ISO 3166-1 |
| Geography | @sys.geo-city | Major cities. | String in English |
| Geography | @sys.geo-state | Major states in Great Britain, USA, India, Canada, and Australia. | String in English |
| Geography | @sys.geo-state | United States states. | String in English |
| Geography | @sys.place-attraction | Top tourist attractions. | String in English |
| Geography | @sys.airport | Airport names, IATA and ICAO codes. |
Object: Strings for country, city of the airport, its name and its IATA/ICAO codes |
| Geography | @sys.location | General entity to refer to any location: full addresses, street names, zip codes, cities, countries, POI, airport names, etc. |
Object with the following fields: admin-area business-name city country island shortcut street-address subadmin-area zip-code |
| Contacts | @sys.email | Email. | String |
| Contacts | @sys.phone-number | Phone number. |
String of phone number (spaces, dashes, and parentheses are omitted) |
| Names | @sys.person | Matches common given names, last names, or combinations. Options to match uncommon names:
|
Object: name string |
| Music | @sys.music-artist | Matches an artist / group name. | String |
| Music | @sys.music-genre | Matches a genre name. | String |
| Other | @sys.color | Words describing colors. | String |
| Other | @sys.language | Language names. | String |
| Generic | @sys.any | Matches any non-empty input. | String of user input |
| Generic | @sys.url | Matches a url. | String |