The following tables provide a reference to the pre-defined System Entities that are used by the Intelligent Assistant NLP engine, presented by category:

Date and Time
Entity Name Description Examples Returned Object Structure
@sys.date-time Matches date, time, intervals or date and time together Tomorrow

5:30 pm

Today at 4 pm

Last morning

1st to 3rd of January

January 1st at 3 pm
Date/time and intervals in ISO-8601 format:

dates: 2014-08-09

times: 17:30:00

date periods: 2014-01-01/2014-12-31

time periods: 13:30:00/14:30:00
combined date & time: 2014-08-09T16:30:00Z

combined date & time period: 2017-02-08T08:00:00Z/2017-02-08T12:00:00Z
@sys.date Matches a date.

Both absolute and relative dates are supported.
January 1

Tomorrow

January first
Date in ISO-8601 format: 2014-12-31
@sys.date-period Matches a date interval. April

weekend

from 1 till 3 of May

in 2 days
Date period in ISO-8601 format: 2014-01-01/2014-12-31
@sys.time-period Matches a time interval. afternoon

tonight

from 1 till 3:30 pm
Time period in ISO-8601 format (hh:mm:ss): 13:30:00/14:30:00

Note: Does not include time zone data.
Numbers
Entity Name Description Examples Returned Object Structure
@sys.number Matches ordinal and cardinal numbers 1

1st

two hundred thirty
Number, such as 10
@sys.ordinal Matches ordinal numbers tenth

second

2nd

10-th

10th
Returns integer, such as 10
Amounts with Units
Entity Name Description Examples Returned Object Structure
@sys.unit-currency Matches a number plus currency name 5 dollars

25 pounds
Integer for amount, string for currency code as per ISO 4217: {"amount":5,"currency":"USD"}
@sys.duration Number + duration units (seconds, hours, days, months etc.) 5 sec

10 minutes

5 days

3 years
Amount as integer, unit as string: {"amount":10,"unit":"min"}

{"amount":5,"unit":"day"}
Unit Names
Entity Name Description Examples Returned Object Structure
@sys.currency-name Currencies USD

Dollars

Euros
String: "USD"
@sys.unit-area-name Units of area square meters

acres
String: "sq m"
@sys.unit-length-name Units of length meters

centimeter
String: "cm"
@sys.unit-speed-name Units of speed kilometer per hour

miles per second
String: "mph"
@sys.unit-volume-name Units of volume cubic meters

gallons
String: "m3"
@sys.unit-weight-name Units of weight kilograms

ounce
String: "kg"
Geography
Entity Name Description Examples Returned Object Structure
@sys.address Full US address 111 W Evelyn Ave, Sunnyvale, CA 94086 String of the user input: "111 W Evelyn Ave, Sunnyvale, CA 94086"
@sys.zip-code 5 digit US postal codes,

alphanumeric UK postal codes
94122

SW1P 3PA
String: "94122", "SW1P 3PA"
@sys.geo-country Short and full names of country Great Britain

United States
Short country name as per

ISO 3166-1 e.g., "United States of America"
@sys.geo-city Major cities New York

Paris
Name of the city as per UNLOCODE, e.g., "Paris"
@sys.location General entity to refer to any location: full addresses, street names, zip codes, cities, countries, POI, airport names etc. Baxter Building 42nd St, New York, NY 10036 USA Strings for country, admin-area, subadmin-area, city, street-address, zip-code, business-name, shortcut: {"country":"United States of America",
"admin-area":"New York",
"business-name":"Baxter Building",
"city":"New York",
"street-address":"42nd St",
"zip-code":"10036"}
Contacts
Entity Name Description Examples Returned Object Structure
@sys.email email user@example.com Email address as string
@sys.phone-number Phone number (123) 456 7890

+1 (123) 456-7890
Phone number without punctuation and spaces, e.g., 11234567890
Names
Entity Name Description Examples Returned Object Structure
@sys.given-name Common given names John

Mary
String with the corresponding given name.

Note: The list contains over 2500 names according to the SSA popular names list.
@sys.last-name Common last names Smith

Adams
String with the corresponding last name.
Color
Entity Name Description Examples Returned Object Structure
@sys.color Words describing colors green

magenta
String with corresponding color: "carmine"
Language
Entity Name Description Examples Returned Object Structure
@sys.language Language names English

Japanese
String with corresponding language: "English"

Revision:

Comments