The MessageBird Named Entity Recognition API extracts and parses a fixed set of entities from incoming phrases. A phrase is usually the text from an incoming message of your customer. This can happen in the context of receiving a Conversations API message or when receiving an SMS message, just to name a few.
An entity contains structured information, such as person names, time, durations, locations etc. The process of finding and parsing entities from phrases is known as named entity recognition.
Going from an unstructured phrase to structured data can be helpful for building intelligent conversational systems, such as chatbots. Chatbots often need to repeat information that was already said, for example to confirm whether they have extracted the right information. In other cases you might want your chat bot to call an internal or external API with a structured object. These things become straightforward using the MessageBird Named Entity Recognition API.
API access to AI services is currently available in Customer Preview with limited access. Please contact your account manager to request access. If you have any questions about how to use the API and get more guidance on your implementation, send an email to our AI team.
All paths referenced in this page uses the following base URL:
ner.messagebird.com
You need to set an access key to authenticate your HTTP requests. You can create, manage, and retrieve your access keys using the MessageBird Dashboard.
To provide the access key, set the Authorization HTTP header in the form of AccessKey {accessKey}.
Extracts named entities from a phrase. If no entities can be found, it returns an empty collection of entities. Each entity contains one or more (ambiguous) interpretations. Each recognized entity will most likely contain only one possible interpretation.
You can limit the named entities to search for by explicitly providing the entity types. If no types are specified upfront, all entity types will be extracted and returned if possible.
If no language is specified upfront, the Named Entity Recognition API will try to infer it automatically before proceeding with named entity recognition. An inferred or pre-specified language that is not supported will yield an error.
POST /api/v1/predict-entities
A request for predicting the entities from a given phrase. This process is also referred to as named entity recognition. It is possible to pre-specify the language when calling this endpoint. Otherwise, the Named Entity Recognition API will attempt to infer the language and proceed with extraction of the entities.
If no entities could be found, it will return an empty collection.
Parameter | Type | Description |
---|---|---|
phrase | string | The phrase to extract named entities from. |
language | string from LanguageCode | Language code in ISO639-3 format. More info can be found here: https://iso639-3.sil.org/code_tables/639/data. |
entityTypes | array of string from EntityType | A collection of entity types that can be detected. If empty, all found types are returned. |
timezone | string | The name of the timezone the samples should be detected in. For time or date related entities this ensures that the values are converted to the correct timezone. For an overview of available timezones see this list. |
curl -X POST "https://ner.messagebird.com/api/v1/predict-entities" \-H "Authorization: AccessKey your_access_key" \-H "Content-Type: application/json" \-d '{"language": "ENG","phrase": "Today we're in Amsterdam, building two chatbots using https://messagebird.com/en/solutions/faq-bots","timezone": "Europe/Amsterdam"}'
Response payload that is returned when predicting entities. Contains an empty list when no entities could be found.
Parameter | Type | Description |
---|---|---|
entities | array of Entity | The collection of entities that were extracted from the given phrase. The collection is empty if no entities could be found. |
{"entities": [{"ambiguous": false,"end_char_index": 5,"entity_values": [{"time": {"value": "2021-09-21T19:00:00.000+00:00"}}],"start_char_index": 0,"text": "Today","type": "TIME"},{"ambiguous": false,"end_char_index": 24,"entity_values": [{}],"start_char_index": 15,"text": "Amsterdam","type": "GEOPOLITICAL"},{"ambiguous": false,"end_char_index": 38,"entity_values": [{"numeral": {"value": "5"}}],"start_char_index": 35,"text": "two","type": "NUMERAL"},{"ambiguous": false,"end_char_index": 99,"entity_values": [{"url": {"domain": "messagebird.com","value": "https://messagebird.com/en/solutions/faq-bots"}}],"start_char_index": 54,"text": "https://messagebird.com/en/solutions/faq-bots","type": "URL"}]}
Code | Description |
---|---|
200 | A successful response. |
401 | Returned when the user is not authorized. |
404 | Returned when the resource does not exist. |
Lists the supported entity types per language.
GET /api/v1/supported-languages
curl -X GET "https://ner.messagebird.com/api/v1/supported-languages" \-H "Authorization: AccessKey your_access_key"
A response with a collection of languages and the entity types supported by those languages.
Parameter | Type | Description |
---|---|---|
languages | array of Language | Collection of supported languages. |
entitiesPerLanguage | array of SupportedEntitiesForLanguage | Collection of supported entity types per language. |
{"entitiesPerLanguage": [{"entity_types": ["GEOPOLITICAL","URL","TIME","NUMERAL"],"language": {"iso_639_3_code": "nld","language_code": "NLD","name": "Dutch"}},{"entity_types": ["GEOPOLITICAL","URL","TIME","NUMERAL"],"language": {"iso_639_3_code": "eng","language_code": "ENG","name": "English"}},{"entity_types": ["GEOPOLITICAL","URL","TIME","NUMERAL"],"language": {"iso_639_3_code": "spa","language_code": "SPA","name": "Spanish"}},{"entity_types": ["GEOPOLITICAL","URL","TIME","NUMERAL"],"language": {"iso_639_3_code": "zho","language_code": "ZHO","name": "Chinese"}}],"languages": [{"iso_639_3_code": "nld","language_code": "NLD","name": "Dutch"},{"iso_639_3_code": "eng","language_code": "ENG","name": "English"},{"iso_639_3_code": "spa","language_code": "SPA","name": "Spanish"},{"iso_639_3_code": "zho","language_code": "ZHO","name": "Chinese"}]}
Code | Description |
---|---|
200 | A successful response. |
401 | Returned when the user is not authorized. |
404 | Returned when the resource does not exist. |
An amount of money expressed in whole units, cents and a currency.
Parameter | Type | Description |
---|---|---|
units | string | The whole units of money. If the entity is $3.05, then units is 3. |
cents | integer | The number of cents. If the entity is $3.05, then cents is 5. |
currencyCode | CurrencyCodeIso4217Value | Wrapper with the ISO 4217 currency code (if known). |
currencyName | string | The name of the currency. Some currency names are not ISO4217 compliant. For those cases, this will hold the currency as a string. These include "Cent", "Dinar", "Dollar", "Rial", "Riyal", "Pound", "PTS". |
Value | Description |
---|---|
INVALID_CURRENCY_CODE | Invalid currency code.. |
ADP | Andorran Peseta, no longer an active currency. |
AED | UAE Dirham. |
AFA | Afghani, no longer an active currency. |
AFN | Afghani. |
ALK | Old Lek, no longer an active currency. |
ALL | Lek. |
AMD | Armenian Dram. |
ANG | Netherlands Antillean Guilder. |
AOA | Kwanza. |
AOK | Kwanza, no longer an active currency. |
AON | New Kwanza, no longer an active currency. |
AOR | Kwanza Reajustado, no longer an active currency. |
ARA | Austral, no longer an active currency. |
ARP | Peso Argentino, no longer an active currency. |
ARS | Argentine Peso. |
ARY | Peso, no longer an active currency. |
ATS | Schilling, no longer an active currency. |
AUD | Australian Dollar. |
AWG | Aruban Florin. |
AYM | Azerbaijan Manat, no longer an active currency. |
AZM | Azerbaijanian Manat, no longer an active currency. |
AZN | Azerbaijan Manat. |
BAD | Dinar, no longer an active currency. |
BAM | Convertible Mark. |
BBD | Barbados Dollar. |
BDT | Taka. |
BEC | Convertible Franc, no longer an active currency. |
BEF | Belgian Franc, no longer an active currency. |
BEL | Financial Franc, no longer an active currency. |
BGJ | Lev A/52, no longer an active currency. |
BGK | Lev A/62, no longer an active currency. |
BGL | Lev, no longer an active currency. |
BGN | Bulgarian Lev. |
BHD | Bahraini Dinar. |
BIF | Burundi Franc. |
BMD | Bermudian Dollar. |
BND | Brunei Dollar. |
BOB | Boliviano. |
BOP | Peso boliviano, no longer an active currency. |
BOV | Mvdol. |
BRB | Cruzeiro, no longer an active currency. |
BRC | Cruzado, no longer an active currency. |
BRE | Cruzeiro, no longer an active currency. |
BRL | Brazilian Real. |
BRN | New Cruzado, no longer an active currency. |
BRR | Cruzeiro Real, no longer an active currency. |
BSD | Bahamian Dollar. |
BTN | Ngultrum. |
BUK | Kyat, no longer an active currency. |
BWP | Pula. |
BYB | Belarusian Ruble, no longer an active currency. |
BYN | Belarusian Ruble. |
BYR | Belarusian Ruble, no longer an active currency. |
BZD | Belize Dollar. |
CAD | Canadian Dollar. |
CDF | Congolese Franc. |
CHC | WIR Franc, no longer an active currency. |
CHE | WIR Euro. |
CHF | Swiss Franc. |
CHW | WIR Franc. |
CLF | Unidad de Fomento. |
CLP | Chilean Peso. |
CNY | Yuan Renminbi. |
COP | Colombian Peso. |
COU | Unidad de Valor Real. |
CRC | Costa Rican Colon. |
CSD | Serbian Dinar, no longer an active currency. |
CSJ | Krona A/53, no longer an active currency. |
CSK | Koruna, no longer an active currency. |
CUC | Peso Convertible. |
CUP | Cuban Peso. |
CVE | Cabo Verde Escudo. |
CYP | Cyprus Pound, no longer an active currency. |
CZK | Czech Koruna. |
DDM | Mark der DDR, no longer an active currency. |
DEM | Deutsche Mark, no longer an active currency. |
DJF | Djibouti Franc. |
DKK | Danish Krone. |
DOP | Dominican Peso. |
DZD | Algerian Dinar. |
ECS | Sucre, no longer an active currency. |
ECV | Unidad de Valor Constante (UVC), no longer an active currency. |
EEK | Kroon, no longer an active currency. |
EGP | Egyptian Pound. |
ERN | Nakfa. |
ESA | Spanish Peseta, no longer an active currency. |
ESB | Spanish Peseta, no longer an active currency. |
ESP | Spanish Peseta, no longer an active currency. |
ETB | Ethiopian Birr. |
EUR | Euro. |
FIM | Markka, no longer an active currency. |
FJD | Fiji Dollar. |
FKP | Falkland Islands Pound. |
FRF | French Franc, no longer an active currency. |
GBP | Pound Sterling. |
GEK | Georgian Coupon, no longer an active currency. |
GEL | Lari. |
GHC | Cedi, no longer an active currency. |
GHP | Ghana Cedi, no longer an active currency. |
GHS | Ghana Cedi. |
GIP | Gibraltar Pound. |
GMD | Dalasi. |
GNE | Syli, no longer an active currency. |
GNF | Guinean Franc. |
GNS | Syli, no longer an active currency. |
GQE | Ekwele, no longer an active currency. |
GRD | Drachma, no longer an active currency. |
GTQ | Quetzal. |
GWE | Guinea Escudo, no longer an active currency. |
GWP | Guinea-Bissau Peso, no longer an active currency. |
GYD | Guyana Dollar. |
HKD | Hong Kong Dollar. |
HNL | Lempira. |
HRD | Croatian Dinar, no longer an active currency. |
HRK | Kuna. |
HTG | Gourde. |
HUF | Forint. |
IDR | Rupiah. |
IEP | Irish Pound, no longer an active currency. |
ILP | Pound, no longer an active currency. |
ILR | Old Shekel, no longer an active currency. |
ILS | New Israeli Sheqel. |
INR | Indian Rupee. |
IQD | Iraqi Dinar. |
IRR | Iranian Rial. |
ISJ | Old Krona, no longer an active currency. |
ISK | Iceland Krona. |
ITL | Italian Lira, no longer an active currency. |
JMD | Jamaican Dollar. |
JOD | Jordanian Dinar. |
JPY | Yen. |
KES | Kenyan Shilling. |
KGS | Som. |
KHR | Riel. |
KMF | Comorian Franc. |
KPW | North Korean Won. |
KRW | Won. |
KWD | Kuwaiti Dinar. |
KYD | Cayman Islands Dollar. |
KZT | Tenge. |
LAJ | Pathet Lao Kip, no longer an active currency. |
LAK | Lao Kip. |
LBP | Lebanese Pound. |
LKR | Sri Lanka Rupee. |
LRD | Liberian Dollar. |
LSL | Loti. |
LSM | Loti, no longer an active currency. |
LTL | Lithuanian Litas, no longer an active currency. |
LTT | Talonas, no longer an active currency. |
LUC | Luxembourg Convertible Franc, no longer an active currency. |
LUF | Luxembourg Franc, no longer an active currency. |
LUL | Luxembourg Financial Franc, no longer an active currency. |
LVL | Latvian Lats, no longer an active currency. |
LVR | Latvian Ruble, no longer an active currency. |
LYD | Libyan Dinar. |
MAD | Moroccan Dirham. |
MDL | Moldovan Leu. |
MGA | Malagasy Ariary. |
MGF | Malagasy Franc, no longer an active currency. |
MKD | Denar. |
MLF | Mali Franc, no longer an active currency. |
MMK | Kyat. |
MNT | Tugrik. |
MOP | Pataca. |
MRO | Ouguiya, no longer an active currency. |
MTL | Maltese Lira, no longer an active currency. |
MTP | Maltese Pound, no longer an active currency. |
MUR | Mauritius Rupee. |
MVQ | Maldive Rupee, no longer an active currency. |
MVR | Rufiyaa. |
MWK | Malawi Kwacha. |
MXN | Mexican Peso. |
MXP | Mexican Peso, no longer an active currency. |
MXV | Mexican Unidad de Inversion (UDI). |
MYR | Malaysian Ringgit. |
MZE | Mozambique Escudo, no longer an active currency. |
MZM | Mozambique Metical, no longer an active currency. |
MZN | Mozambique Metical. |
NAD | Namibia Dollar. |
NGN | Naira. |
NIC | Cordoba, no longer an active currency. |
NIO | Cordoba Oro. |
NLG | Netherlands Guilder, no longer an active currency. |
NOK | Norwegian Krone. |
NPR | Nepalese Rupee. |
NZD | New Zealand Dollar. |
OMR | Rial Omani. |
PAB | Balboa. |
PEH | Sol, no longer an active currency. |
PEI | Inti, no longer an active currency. |
PEN | Sol. |
PES | Sol, no longer an active currency. |
PGK | Kina. |
PHP | Philippine Peso. |
PKR | Pakistan Rupee. |
PLN | Zloty. |
PLZ | Zloty, no longer an active currency. |
PTE | Portuguese Escudo, no longer an active currency. |
PYG | Guarani. |
QAR | Qatari Rial. |
RHD | Rhodesian Dollar, no longer an active currency. |
ROK | Leu A/52, no longer an active currency. |
ROL | Old Leu, no longer an active currency. |
RON | Romanian Leu. |
RSD | Serbian Dinar. |
RUB | Russian Ruble. |
RUR | Russian Ruble, no longer an active currency. |
RWF | Rwanda Franc. |
SAR | Saudi Riyal. |
SBD | Solomon Islands Dollar. |
SCR | Seychelles Rupee. |
SDD | Sudanese Dinar, no longer an active currency. |
SDG | Sudanese Pound. |
SDP | Sudanese Pound, no longer an active currency. |
SEK | Swedish Krona. |
SGD | Singapore Dollar. |
SHP | Saint Helena Pound. |
SIT | Tolar, no longer an active currency. |
SKK | Slovak Koruna, no longer an active currency. |
SLL | Leone. |
SOS | Somali Shilling. |
SRD | Surinam Dollar. |
SRG | Surinam Guilder, no longer an active currency. |
SSP | South Sudanese Pound. |
STD | Dobra, no longer an active currency. |
SUR | Rouble, no longer an active currency. |
SVC | El Salvador Colon. |
SYP | Syrian Pound. |
SZL | Lilangeni. |
THB | Baht. |
TJR | Tajik Ruble, no longer an active currency. |
TJS | Somoni. |
TMM | Turkmenistan Manat, no longer an active currency. |
TMT | Turkmenistan New Manat. |
TND | Tunisian Dinar. |
TOP | Pa’anga. |
TPE | Timor Escudo, no longer an active currency. |
TRL | Old Turkish Lira, no longer an active currency. |
TRY | Turkish Lira. |
TTD | Trinidad and Tobago Dollar. |
TWD | New Taiwan Dollar. |
TZS | Tanzanian Shilling. |
UAH | Hryvnia. |
UAK | Karbovanet, no longer an active currency. |
UGS | Uganda Shilling, no longer an active currency. |
UGW | Old Shilling, no longer an active currency. |
UGX | Uganda Shilling. |
USD | US Dollar. |
USN | US Dollar (Next day). |
USS | US Dollar (Same day), no longer an active currency. |
UYI | Uruguay Peso en Unidades Indexadas (UI). |
UYN | Old Uruguay Peso, no longer an active currency. |
UYP | Uruguayan Peso, no longer an active currency. |
UYU | Peso Uruguayo. |
UZS | Uzbekistan Sum. |
VEB | Bolivar, no longer an active currency. |
VEF | Bolívar, no longer an active currency. |
VNC | Old Dong, no longer an active currency. |
VND | Dong. |
VUV | Vatu. |
WST | Tala. |
XAF | CFA Franc BEAC. |
XAG | Silver. |
XAU | Gold. |
XBA | Bond Markets Unit European Composite Unit (EURCO). |
XBB | Bond Markets Unit European Monetary Unit (E.M.U.-6). |
XBC | Bond Markets Unit European Unit of Account 9 (E.U.A.-9). |
XBD | Bond Markets Unit European Unit of Account 17 (E.U.A.-17). |
XCD | East Caribbean Dollar. |
XDR | SDR (Special Drawing Right). |
XEU | European Currency Unit (E.C.U), no longer an active currency. |
XFO | Gold-Franc, no longer an active currency. |
XFU | UIC-Franc, no longer an active currency. |
XOF | CFA Franc BCEAO. |
XPD | Palladium. |
XPF | CFP Franc. |
XPT | Platinum. |
XRE | RINET Funds Code, no longer an active currency. |
XSU | Sucre. |
XTS | Codes specifically reserved for testing purposes. |
XUA | ADB Unit of Account. |
XXX | The codes assigned for transactions where no currency is involved. |
YDD | Yemeni Dinar, no longer an active currency. |
YER | Yemeni Rial. |
YUD | New Yugoslavian Dinar, no longer an active currency. |
YUM | New Dinar, no longer an active currency. |
YUN | Yugoslavian Dinar, no longer an active currency. |
ZAL | Financial Rand, no longer an active currency. |
ZAR | Rand. |
ZMK | Zambian Kwacha, no longer an active currency. |
ZMW | Zambian Kwacha. |
ZRN | New Zaire, no longer an active currency. |
ZRZ | Zaire, no longer an active currency. |
ZWC | Rhodesian Dollar, no longer an active currency. |
ZWD | Zimbabwe Dollar, no longer an active currency. |
ZWL | Zimbabwe Dollar. |
ZWN | Zimbabwe Dollar, no longer an active currency. |
ZWR | Zimbabwe Dollar, no longer an active currency. |
A wrapper for the currency code enum.
Parameter | Type | Description |
---|---|---|
value | string from CurrencyCodeIso4217 | The ISO 4217 currency code (if known). |
A normalized value of an entity, e.g. for time the ISO8601 date format.
Parameter | Type | Description |
---|---|---|
value | string | The normalized value of an entity, e.g. for time the ISO8601 date format. |
A duration and the unit of the duration. Durations are normalized to whole seconds.
Parameter | Type | Description |
---|---|---|
value | string | The part of the phrase that expresses a duration. |
unit | string | The unit used to indicate the duration. |
seconds | string | The duration normalized to seconds. |
A (named) entity. Entities are sub-phrases with structured information, such as person name, locations, time, quantities etc. The process of extracting these entities from natural language is called Named Entity Recognition (NER).
Parameter | Type | Description |
---|---|---|
text | string | The raw text from the phrase where the entity was found. |
type | string from EntityType | The type of entity that was found. This entity type also determines which values are returned. |
ambiguous | boolean | Describes if the parsed value has multiple possible values. For example tomorrow at 7 could either mean tomorrow 07:00 or tomorrow 19:00. |
startCharIndex | string | The starting character index of the entity in the given phrase. |
endCharIndex | string | The ending character index of the entity in the given phrase. |
entityValues | array of EntityValuesWrapper | The collection of entity values. If the entity is ambiguous (see ambiguous), this collection will contain more than one value. For example tomorrow at 7 could either mean tomorrow 07:00 or tomorrow 19:00. |
Type of entity.
Value | Description |
---|---|
UNKNOWN | Unknown entity type. |
AMOUNT_OF_MONEY | Entity type that describes amount of money. |
CREDIT_CARD_NUMBER | Entity type that describes credit card number. Supported credit card types are Visa, American Express (Amex), Discover, Mastercard and DinerClub. Note: if a credit card number is invalid, it will not be extracted from the phrase. |
DISTANCE | Entity type that describes distance. Supports both the metric system (meters, kilometers etc.) and imperial (inch, yard etc.) measurements. |
DURATION | Entity type that describes duration. Durations are normalized to whole seconds. |
Entity type that describes email address. | |
NUMERAL | Entity type that describes a numeral. Can be written as digits, words, fractions, floating point numbers, as well as some language-specific ways of expressing certain numbers, such as "a dozen". |
ORDINAL | Entity type that describes an ordinal. Can be written as digits or as words. |
PHONE_NUMBER | Entity type that describes a phone number. Note that this phone number is not checked for validity. Supports leading area codes too. |
PRODUCT_QUANTITY | Entity type that describes a quantity of a product using a certain unit. Example use-cases are parsing of cooking recipes and grocery lists. |
TEMPERATURE | Entity type that describes a temperature. Supports values to be expressed as words, digits, fractions and floating point numbers. Units can be degree, Celsius or Fahrenheit. |
TIME | Entity type that describes a time. Supported values are exact times, but also time expressed as words, such as "tomorrow" or holidays such as "GroundHog Day". |
URL | Entity type that describes an URL. Will only be populated if the URL is formatted correctly. |
VOLUME | Entity type that describes a volume. Supports both metric and imperial measurements. |
INTERVAL | Entity type that describes an interval. |
PERSON | Entity type that describes a person, including fictional person names. |
ORGANISATION | Entity type that describes an organization, such as companies, agencies, institutions etc. |
PRODUCT | Entity type that describes a product. Vehicles and types of food etc. |
PLACE | Entity type that describes a place. Can be cities, countries, states, continents etc., but also descriptions of locations such as "East of the river". |
COUNTRY | Entity type that describes a country. |
A wrapper for entity values with varying type and structure.
Parameter | Type | Description |
---|---|---|
amountOfMoney | AmountOfMoneyValue | An amount of money value. |
creditCardNumber | DefaultValues | A credit card number. Supported credit card types are Visa, American Express (Amex), Discover, Mastercard and DinerClub. |
distance | UnitValues | A distance value. Supports both the metric system (meters, kilometers etc.) and imperial (inch, yard etc.) measurements. |
duration | DurationValues | The duration value. Durations are normalized to whole seconds. |
emailAddress | DefaultValues | The email address value. Will not be populated if an email address is invalid (for example due to misspelling). |
numeral | DefaultValues | The numeral value. Can be written as digits, words, fractions, floating point numbers, as well as some language-specific ways of expressing certain numbers, such as "a dozen". |
ordinal | DefaultValues | The ordinal value. Can be written as digits or as words. |
phoneNumber | DefaultValues | The phone number value. Note that this phone number is not checked for validity. Supports leading area codes too. |
productQuantity | ProductQuantityValue | The quantity of a product using a certain unit. Example use-cases are parsing of cooking recipes and grocery lists. |
temperature | UnitValues | The temperature value. Supports values to be expressed as words, digits, fractions and floating point numbers. Units can be degree, Celsius or Fahrenheit. |
time | DefaultValues | The time value. Supported values are exact times, but also time expressed as words, such as "tomorrow" or holidays such as "GroundHog Day". |
url | UrlValues | The URL value. Will only be populated if the URL is formatted correctly. |
volume | UnitValues | The volume value. Supports both metric and imperial measurements. |
interval | IntervalValues | The interval value. Intervals are given by a start and an end time. |
person | DefaultValues | The person name, including fictional person names. |
organization | DefaultValues | The organization name. |
product | DefaultValues | The product value. Includes vehicles, devices, types of food etc. |
place | DefaultValues | The place value. |
country | DefaultValues | The country value. |
A start time and an end time of an interval.
Parameter | Type | Description |
---|---|---|
start | string | The normalized start date in ISO8601 date format. |
end | string | The normalized end date in ISO8601 date format. |
Language that was detected from the given phrase.
Parameter | Type | Description |
---|---|---|
iso6393Code | string | The ISO-639-3 code of the language. |
name | string | The English name of the language. |
languageCode | string from LanguageCode | The enum value of the ISO639-3 language code. |
Language code in ISO639-3 format. More info can be found here: https://iso639-3.sil.org/code_tables/639/data.
Value | Description |
---|---|
LANGUAGE_INVALID | Language code is invalid. |
LANGUAGE_UNDETERMINED | Language could not be determined. |
ENG | English. |
RUS | Russian. |
DEU | German. |
FRA | French. |
ITA | Italian. |
JPN | Japanese. |
SPA | Spanish. |
CEB | Cebuano. |
TUR | Turkish. |
POR | Portuguese. |
UKR | Ukrainian. |
EPO | Esperanto. |
POL | Polish. |
SWE | Swedish. |
NLD | Dutch. |
HEB | Hebrew. |
ZHO | Chinese. |
HUN | Hungarian. |
ARA | Arabic. |
CAT | Catalan. |
FIN | Finnish. |
CES | Czech. |
FAS | Persian. |
SRP | Serbian. |
ELL | Greek. |
VIE | Vietnamese. |
BUL | Bulgarian. |
KOR | Korean. |
NOR | Norwegian. |
MKD | Macedonian. |
RON | Romanian. |
IND | Indonesian. |
THA | Thai. |
HYE | Armenian. |
DAN | Danish. |
TAM | Tamil. |
HIN | Hindi. |
HRV | Croatian. |
HBS | Serbo-Croatian. |
BEL | Belarusian. |
KAT | Georgian. |
TEL | Telugu. |
KAZ | Kazakh. |
WAR | Waray. |
LIT | Lithuanian. |
GLG | Galician. |
SLK | Slovak. |
BEN | Bengali. |
EUS | Basque. |
SLV | Slovenian. |
KAN | Kannada. |
MAL | Malayalam. |
MAR | Marathi. |
EST | Estonian. |
AZE | Azerbaijani. |
MSA | Malay. |
SQI | Albanian. |
LAT | Latin. |
BOS | Bosnian. |
NNO | Norwegian Nynorsk. |
URD | Urdu. |
LAV | Latvian. |
MYA | Burmese. |
TAT | Tatar. |
AFR | Afrikaans. |
OCI | Occitan. |
NDS | Low German. |
KIR | Kirghiz. |
AST | Asturian. |
TGL | Tagalog. |
ISL | Icelandic. |
INA | Interlingua. |
SIN | Sinhala. |
GUJ | Gujarati. |
KHM | Central Khmer. |
BRE | Breton. |
BAK | Bashkir. |
UZB | Uzbek. |
BOD | Tibetan. |
PAN | Panjabi. |
VOL | Volapük. |
ALS | Tosk Albanian. |
NEP | Nepali. |
CYM | Welsh. |
JBO | Lojban. |
FRY | Western Frisian. |
MON | Mongolian. |
LTZ | Luxembourgish. |
CHE | Chechen. |
UIG | Uighur. |
TGK | Tajik. |
SCO | Scots. |
SAN | Sanskrit. |
CHV | Chuvash. |
JAV | Javanese. |
MIN | Minangkabau. |
IDO | Ido. |
ORI | Oriya. |
ASM | Assamese. |
NEW | Newari. |
GLE | Irish. |
MLG | Malagasy. |
ARG | Aragonese. |
CKB | Central Kurdish. |
SWA | Swahili. |
BAR | Bavarian. |
LMO | Lombard. |
YID | Yiddish. |
ARZ | Egyptian Arabic. |
MHR | Eastern Mari. |
AZB | South Azerbaijani. |
SAH | Yakut. |
PNB | Western Panjabi. |
SUN | Sundanese. |
BPY | Bishnupriya. |
PMS | Piemontese. |
ILO | Iloko. |
WUU | Wu Chinese. |
KUR | Kurdish. |
PUS | Pushto. |
ILE | Interlingue. |
XMF | Mingrelian. |
YUE | Yue Chinese. |
GOM | Goan Konkani. |
LIM | Limburgan. |
MWL | Mirandese. |
COR | Cornish. |
SND | Sindhi. |
HSB | Upper Sorbian. |
SCN | Sicilian. |
GLA | Scottish Gaelic. |
PAM | Pampanga. |
BHO | Bhojpuri. |
MAI | Maithili. |
VEC | Venetian. |
MLT | Maltese. |
DIV | Dhivehi. |
WLN | Walloon. |
MZN | Mazanderani. |
AMH | Amharic. |
QUE | Quechua. |
CBK | Chavacano. |
TUK | Turkmen. |
ROH | Romansh. |
OSS | Ossetian. |
VLS | Vlaams. |
YOR | Yoruba. |
LAO | Lao. |
LEZ | Lezghian. |
SOM | Somali. |
MYV | Erzya. |
DIQ | Dimli. |
MRJ | Western Mari. |
DSB | Lower Sorbian. |
FRR | Northern Frisian. |
HAT | Haitian. |
GRN | Guarani. |
BXR | Russia Buriat. |
KOM | Komi. |
SRD | Sardinian. |
KRC | Karachay-Balkar. |
BCL | Central Bikol. |
NAP | Neapolitan. |
GLV | Manx. |
AVA | Avaric. |
RUE | Rusyn. |
XAL | Kalmyk. |
PFL | Pfaelzisch. |
DTY | Dotyali. |
HIF | Fiji Hindi. |
COS | Corsican. |
LRC | Northern Luri. |
VEP | Veps. |
TYV | Tuvinian. |
NOB | Norwegian Bokmål. |
SNA | Shona. |
KIN | Kinyarwanda. |
IBO | Igbo. |
SMO | Samoan. |
SOT | Southern Sotho. |
MRI | Maori. |
WOL | Wolof. |
XHO | Xhosa. |
HAU | Hausa. |
HAW | Hawaiian. |
NYA | Nyanja. |
ZUL | Zulu. |
HMN | Hmong. |
A response with a collection of languages and the entity types supported by those languages.
Parameter | Type | Description |
---|---|---|
languages | array of Language | Collection of supported languages. |
entitiesPerLanguage | array of SupportedEntitiesForLanguage | Collection of supported entity types per language. |
A request for predicting the entities from a given phrase. This process is also referred to as named entity recognition. It is possible to pre-specify the language when calling this endpoint. Otherwise, the Named Entity Recognition API will attempt to infer the language and proceed with extraction of the entities.
If no entities could be found, it will return an empty collection.
Parameter | Type | Description |
---|---|---|
phrase | string | The phrase to extract named entities from. |
language | string from LanguageCode | The language of the given phrase. If you're unsure of the language of a phrase, use our Language Detection API. |
entityTypes | array of string from EntityType | A collection of entity types that can be detected. If empty, all found types are returned. |
timezone | string | The name of the timezone the samples should be detected in. For time or date related entities this ensures that the values are converted to the correct timezone. For an overview of available timezones see this list. |
Response payload that is returned when predicting entities. Contains an empty list when no entities could be found.
Parameter | Type | Description |
---|---|---|
entities | array of Entity | The collection of entities that were extracted from the given phrase. The collection is empty if no entities could be found. |
A quantity of a product using a certain unit. Example use-cases are parsing of cooking recipes and shopping.
Parameter | Type | Description |
---|---|---|
value | string | The amount of the unit. |
unit | string | The unit describing the amount. |
product | string | The extracted product. |
A language and the entity types supported by that language.
Parameter | Type | Description |
---|---|---|
language | Language | Language that was detected from the given phrase. |
entityTypes | array of string from EntityType | Collection of the supported entity types for this language. |
An amount and a unit of the amount.
Parameter | Type | Description |
---|---|---|
unit | string | The unit describing the amount. |
A URL and its domain.
Parameter | Type | Description |
---|---|---|
value | string | The extracted url. |
domain | string | The domain of the url. |