API Reference

OverviewSMSSMS batch APIVoice CallingVoice MessagingConversations APIIntegrations APIFile Storage APIOmnichannel WidgetNumbersPartner AccountsVerifyMMSHLRBalanceLookupContactsGroupsIntentFAQNamed Entity RecognitionLanguage Detection

Named Entity Recognition

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.

Notification icon

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.

Base URL

All paths referenced in this page uses the following base URL:

ner.messagebird.com

Authorization

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}.

PredictEntities

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

Request (PredictEntitiesRequest)

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.

ParameterTypeDescription
phrasestringThe phrase to extract named entities from.
languagestring from LanguageCodeLanguage code in ISO639-3 format. More info can be found here: https://iso639-3.sil.org/code_tables/639/data.
entityTypesarray of string from EntityTypeA collection of entity types that can be detected. If empty, all found types are returned.
timezonestringThe 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 (PredictEntitiesResponse)

Response payload that is returned when predicting entities. Contains an empty list when no entities could be found.

ParameterTypeDescription
entitiesarray of EntityThe 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"
}
]
}
Response codes
CodeDescription
200A successful response.
401Returned when the user is not authorized.
404Returned when the resource does not exist.

ListSupportedLanguages

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"

Response (ListSupportedLanguagesResponses)

A response with a collection of languages and the entity types supported by those languages.

ParameterTypeDescription
languagesarray of LanguageCollection of supported languages.
entitiesPerLanguagearray of SupportedEntitiesForLanguageCollection 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"
}
]
}
Response codes
CodeDescription
200A successful response.
401Returned when the user is not authorized.
404Returned when the resource does not exist.

Objects Reference

AmountOfMoneyValue object

An amount of money expressed in whole units, cents and a currency.

ParameterTypeDescription
unitsstringThe whole units of money. If the entity is $3.05, then units is 3.
centsintegerThe number of cents. If the entity is $3.05, then cents is 5.
currencyCodeCurrencyCodeIso4217ValueWrapper with the ISO 4217 currency code (if known).
currencyNamestringThe 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".

CurrencyCodeIso4217 enum

The ISO 4217 currency code.

ValueDescription
INVALID_CURRENCY_CODEInvalid currency code..
ADPAndorran Peseta, no longer an active currency.
AEDUAE Dirham.
AFAAfghani, no longer an active currency.
AFNAfghani.
ALKOld Lek, no longer an active currency.
ALLLek.
AMDArmenian Dram.
ANGNetherlands Antillean Guilder.
AOAKwanza.
AOKKwanza, no longer an active currency.
AONNew Kwanza, no longer an active currency.
AORKwanza Reajustado, no longer an active currency.
ARAAustral, no longer an active currency.
ARPPeso Argentino, no longer an active currency.
ARSArgentine Peso.
ARYPeso, no longer an active currency.
ATSSchilling, no longer an active currency.
AUDAustralian Dollar.
AWGAruban Florin.
AYMAzerbaijan Manat, no longer an active currency.
AZMAzerbaijanian Manat, no longer an active currency.
AZNAzerbaijan Manat.
BADDinar, no longer an active currency.
BAMConvertible Mark.
BBDBarbados Dollar.
BDTTaka.
BECConvertible Franc, no longer an active currency.
BEFBelgian Franc, no longer an active currency.
BELFinancial Franc, no longer an active currency.
BGJLev A/52, no longer an active currency.
BGKLev A/62, no longer an active currency.
BGLLev, no longer an active currency.
BGNBulgarian Lev.
BHDBahraini Dinar.
BIFBurundi Franc.
BMDBermudian Dollar.
BNDBrunei Dollar.
BOBBoliviano.
BOPPeso boliviano, no longer an active currency.
BOVMvdol.
BRBCruzeiro, no longer an active currency.
BRCCruzado, no longer an active currency.
BRECruzeiro, no longer an active currency.
BRLBrazilian Real.
BRNNew Cruzado, no longer an active currency.
BRRCruzeiro Real, no longer an active currency.
BSDBahamian Dollar.
BTNNgultrum.
BUKKyat, no longer an active currency.
BWPPula.
BYBBelarusian Ruble, no longer an active currency.
BYNBelarusian Ruble.
BYRBelarusian Ruble, no longer an active currency.
BZDBelize Dollar.
CADCanadian Dollar.
CDFCongolese Franc.
CHCWIR Franc, no longer an active currency.
CHEWIR Euro.
CHFSwiss Franc.
CHWWIR Franc.
CLFUnidad de Fomento.
CLPChilean Peso.
CNYYuan Renminbi.
COPColombian Peso.
COUUnidad de Valor Real.
CRCCosta Rican Colon.
CSDSerbian Dinar, no longer an active currency.
CSJKrona A/53, no longer an active currency.
CSKKoruna, no longer an active currency.
CUCPeso Convertible.
CUPCuban Peso.
CVECabo Verde Escudo.
CYPCyprus Pound, no longer an active currency.
CZKCzech Koruna.
DDMMark der DDR, no longer an active currency.
DEMDeutsche Mark, no longer an active currency.
DJFDjibouti Franc.
DKKDanish Krone.
DOPDominican Peso.
DZDAlgerian Dinar.
ECSSucre, no longer an active currency.
ECVUnidad de Valor Constante (UVC), no longer an active currency.
EEKKroon, no longer an active currency.
EGPEgyptian Pound.
ERNNakfa.
ESASpanish Peseta, no longer an active currency.
ESBSpanish Peseta, no longer an active currency.
ESPSpanish Peseta, no longer an active currency.
ETBEthiopian Birr.
EUREuro.
FIMMarkka, no longer an active currency.
FJDFiji Dollar.
FKPFalkland Islands Pound.
FRFFrench Franc, no longer an active currency.
GBPPound Sterling.
GEKGeorgian Coupon, no longer an active currency.
GELLari.
GHCCedi, no longer an active currency.
GHPGhana Cedi, no longer an active currency.
GHSGhana Cedi.
GIPGibraltar Pound.
GMDDalasi.
GNESyli, no longer an active currency.
GNFGuinean Franc.
GNSSyli, no longer an active currency.
GQEEkwele, no longer an active currency.
GRDDrachma, no longer an active currency.
GTQQuetzal.
GWEGuinea Escudo, no longer an active currency.
GWPGuinea-Bissau Peso, no longer an active currency.
GYDGuyana Dollar.
HKDHong Kong Dollar.
HNLLempira.
HRDCroatian Dinar, no longer an active currency.
HRKKuna.
HTGGourde.
HUFForint.
IDRRupiah.
IEPIrish Pound, no longer an active currency.
ILPPound, no longer an active currency.
ILROld Shekel, no longer an active currency.
ILSNew Israeli Sheqel.
INRIndian Rupee.
IQDIraqi Dinar.
IRRIranian Rial.
ISJOld Krona, no longer an active currency.
ISKIceland Krona.
ITLItalian Lira, no longer an active currency.
JMDJamaican Dollar.
JODJordanian Dinar.
JPYYen.
KESKenyan Shilling.
KGSSom.
KHRRiel.
KMFComorian Franc.
KPWNorth Korean Won.
KRWWon.
KWDKuwaiti Dinar.
KYDCayman Islands Dollar.
KZTTenge.
LAJPathet Lao Kip, no longer an active currency.
LAKLao Kip.
LBPLebanese Pound.
LKRSri Lanka Rupee.
LRDLiberian Dollar.
LSLLoti.
LSMLoti, no longer an active currency.
LTLLithuanian Litas, no longer an active currency.
LTTTalonas, no longer an active currency.
LUCLuxembourg Convertible Franc, no longer an active currency.
LUFLuxembourg Franc, no longer an active currency.
LULLuxembourg Financial Franc, no longer an active currency.
LVLLatvian Lats, no longer an active currency.
LVRLatvian Ruble, no longer an active currency.
LYDLibyan Dinar.
MADMoroccan Dirham.
MDLMoldovan Leu.
MGAMalagasy Ariary.
MGFMalagasy Franc, no longer an active currency.
MKDDenar.
MLFMali Franc, no longer an active currency.
MMKKyat.
MNTTugrik.
MOPPataca.
MROOuguiya, no longer an active currency.
MTLMaltese Lira, no longer an active currency.
MTPMaltese Pound, no longer an active currency.
MURMauritius Rupee.
MVQMaldive Rupee, no longer an active currency.
MVRRufiyaa.
MWKMalawi Kwacha.
MXNMexican Peso.
MXPMexican Peso, no longer an active currency.
MXVMexican Unidad de Inversion (UDI).
MYRMalaysian Ringgit.
MZEMozambique Escudo, no longer an active currency.
MZMMozambique Metical, no longer an active currency.
MZNMozambique Metical.
NADNamibia Dollar.
NGNNaira.
NICCordoba, no longer an active currency.
NIOCordoba Oro.
NLGNetherlands Guilder, no longer an active currency.
NOKNorwegian Krone.
NPRNepalese Rupee.
NZDNew Zealand Dollar.
OMRRial Omani.
PABBalboa.
PEHSol, no longer an active currency.
PEIInti, no longer an active currency.
PENSol.
PESSol, no longer an active currency.
PGKKina.
PHPPhilippine Peso.
PKRPakistan Rupee.
PLNZloty.
PLZZloty, no longer an active currency.
PTEPortuguese Escudo, no longer an active currency.
PYGGuarani.
QARQatari Rial.
RHDRhodesian Dollar, no longer an active currency.
ROKLeu A/52, no longer an active currency.
ROLOld Leu, no longer an active currency.
RONRomanian Leu.
RSDSerbian Dinar.
RUBRussian Ruble.
RURRussian Ruble, no longer an active currency.
RWFRwanda Franc.
SARSaudi Riyal.
SBDSolomon Islands Dollar.
SCRSeychelles Rupee.
SDDSudanese Dinar, no longer an active currency.
SDGSudanese Pound.
SDPSudanese Pound, no longer an active currency.
SEKSwedish Krona.
SGDSingapore Dollar.
SHPSaint Helena Pound.
SITTolar, no longer an active currency.
SKKSlovak Koruna, no longer an active currency.
SLLLeone.
SOSSomali Shilling.
SRDSurinam Dollar.
SRGSurinam Guilder, no longer an active currency.
SSPSouth Sudanese Pound.
STDDobra, no longer an active currency.
SURRouble, no longer an active currency.
SVCEl Salvador Colon.
SYPSyrian Pound.
SZLLilangeni.
THBBaht.
TJRTajik Ruble, no longer an active currency.
TJSSomoni.
TMMTurkmenistan Manat, no longer an active currency.
TMTTurkmenistan New Manat.
TNDTunisian Dinar.
TOPPa’anga.
TPETimor Escudo, no longer an active currency.
TRLOld Turkish Lira, no longer an active currency.
TRYTurkish Lira.
TTDTrinidad and Tobago Dollar.
TWDNew Taiwan Dollar.
TZSTanzanian Shilling.
UAHHryvnia.
UAKKarbovanet, no longer an active currency.
UGSUganda Shilling, no longer an active currency.
UGWOld Shilling, no longer an active currency.
UGXUganda Shilling.
USDUS Dollar.
USNUS Dollar (Next day).
USSUS Dollar (Same day), no longer an active currency.
UYIUruguay Peso en Unidades Indexadas (UI).
UYNOld Uruguay Peso, no longer an active currency.
UYPUruguayan Peso, no longer an active currency.
UYUPeso Uruguayo.
UZSUzbekistan Sum.
VEBBolivar, no longer an active currency.
VEFBolívar, no longer an active currency.
VNCOld Dong, no longer an active currency.
VNDDong.
VUVVatu.
WSTTala.
XAFCFA Franc BEAC.
XAGSilver.
XAUGold.
XBABond Markets Unit European Composite Unit (EURCO).
XBBBond Markets Unit European Monetary Unit (E.M.U.-6).
XBCBond Markets Unit European Unit of Account 9 (E.U.A.-9).
XBDBond Markets Unit European Unit of Account 17 (E.U.A.-17).
XCDEast Caribbean Dollar.
XDRSDR (Special Drawing Right).
XEUEuropean Currency Unit (E.C.U), no longer an active currency.
XFOGold-Franc, no longer an active currency.
XFUUIC-Franc, no longer an active currency.
XOFCFA Franc BCEAO.
XPDPalladium.
XPFCFP Franc.
XPTPlatinum.
XRERINET Funds Code, no longer an active currency.
XSUSucre.
XTSCodes specifically reserved for testing purposes.
XUAADB Unit of Account.
XXXThe codes assigned for transactions where no currency is involved.
YDDYemeni Dinar, no longer an active currency.
YERYemeni Rial.
YUDNew Yugoslavian Dinar, no longer an active currency.
YUMNew Dinar, no longer an active currency.
YUNYugoslavian Dinar, no longer an active currency.
ZALFinancial Rand, no longer an active currency.
ZARRand.
ZMKZambian Kwacha, no longer an active currency.
ZMWZambian Kwacha.
ZRNNew Zaire, no longer an active currency.
ZRZZaire, no longer an active currency.
ZWCRhodesian Dollar, no longer an active currency.
ZWDZimbabwe Dollar, no longer an active currency.
ZWLZimbabwe Dollar.
ZWNZimbabwe Dollar, no longer an active currency.
ZWRZimbabwe Dollar, no longer an active currency.

CurrencyCodeIso4217Value object

A wrapper for the currency code enum.

ParameterTypeDescription
valuestring from CurrencyCodeIso4217The ISO 4217 currency code (if known).

DefaultValues object

A normalized value of an entity, e.g. for time the ISO8601 date format.

ParameterTypeDescription
valuestringThe normalized value of an entity, e.g. for time the ISO8601 date format.

DurationValues object

A duration and the unit of the duration. Durations are normalized to whole seconds.

ParameterTypeDescription
valuestringThe part of the phrase that expresses a duration.
unitstringThe unit used to indicate the duration.
secondsstringThe duration normalized to seconds.

Entity object

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).

ParameterTypeDescription
textstringThe raw text from the phrase where the entity was found.
typestring from EntityTypeThe type of entity that was found. This entity type also determines which values are returned.
ambiguousbooleanDescribes if the parsed value has multiple possible values. For example tomorrow at 7 could either mean tomorrow 07:00 or tomorrow 19:00.
startCharIndexstringThe starting character index of the entity in the given phrase.
endCharIndexstringThe ending character index of the entity in the given phrase.
entityValuesarray of EntityValuesWrapperThe 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.

EntityType enum

Type of entity.

ValueDescription
UNKNOWNUnknown entity type.
AMOUNT_OF_MONEYEntity type that describes amount of money.
CREDIT_CARD_NUMBEREntity 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.
DISTANCEEntity type that describes distance. Supports both the metric system (meters, kilometers etc.) and imperial (inch, yard etc.) measurements.
DURATIONEntity type that describes duration. Durations are normalized to whole seconds.
EMAILEntity type that describes email address.
NUMERALEntity 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".
ORDINALEntity type that describes an ordinal. Can be written as digits or as words.
PHONE_NUMBEREntity type that describes a phone number. Note that this phone number is not checked for validity. Supports leading area codes too.
PRODUCT_QUANTITYEntity type that describes a quantity of a product using a certain unit. Example use-cases are parsing of cooking recipes and grocery lists.
TEMPERATUREEntity 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.
TIMEEntity 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".
URLEntity type that describes an URL. Will only be populated if the URL is formatted correctly.
VOLUMEEntity type that describes a volume. Supports both metric and imperial measurements.
INTERVALEntity type that describes an interval.
PERSONEntity type that describes a person, including fictional person names.
ORGANISATIONEntity type that describes an organization, such as companies, agencies, institutions etc.
PRODUCTEntity type that describes a product. Vehicles and types of food etc.
PLACEEntity type that describes a place. Can be cities, countries, states, continents etc., but also descriptions of locations such as "East of the river".
COUNTRYEntity type that describes a country.

EntityValuesWrapper object

A wrapper for entity values with varying type and structure.

ParameterTypeDescription
amountOfMoneyAmountOfMoneyValueAn amount of money value.
creditCardNumberDefaultValuesA credit card number. Supported credit card types are Visa, American Express (Amex), Discover, Mastercard and DinerClub.
distanceUnitValuesA distance value. Supports both the metric system (meters, kilometers etc.) and imperial (inch, yard etc.) measurements.
durationDurationValuesThe duration value. Durations are normalized to whole seconds.
emailAddressDefaultValuesThe email address value. Will not be populated if an email address is invalid (for example due to misspelling).
numeralDefaultValuesThe 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".
ordinalDefaultValuesThe ordinal value. Can be written as digits or as words.
phoneNumberDefaultValuesThe phone number value. Note that this phone number is not checked for validity. Supports leading area codes too.
productQuantityProductQuantityValueThe quantity of a product using a certain unit. Example use-cases are parsing of cooking recipes and grocery lists.
temperatureUnitValuesThe temperature value. Supports values to be expressed as words, digits, fractions and floating point numbers. Units can be degree, Celsius or Fahrenheit.
timeDefaultValuesThe time value. Supported values are exact times, but also time expressed as words, such as "tomorrow" or holidays such as "GroundHog Day".
urlUrlValuesThe URL value. Will only be populated if the URL is formatted correctly.
volumeUnitValuesThe volume value. Supports both metric and imperial measurements.
intervalIntervalValuesThe interval value. Intervals are given by a start and an end time.
personDefaultValuesThe person name, including fictional person names.
organizationDefaultValuesThe organization name.
productDefaultValuesThe product value. Includes vehicles, devices, types of food etc.
placeDefaultValuesThe place value.
countryDefaultValuesThe country value.

IntervalValues object

A start time and an end time of an interval.

ParameterTypeDescription
startstringThe normalized start date in ISO8601 date format.
endstringThe normalized end date in ISO8601 date format.

Language object

Language that was detected from the given phrase.

ParameterTypeDescription
iso6393CodestringThe ISO-639-3 code of the language.
namestringThe English name of the language.
languageCodestring from LanguageCodeThe enum value of the ISO639-3 language code.

LanguageCode enum

Language code in ISO639-3 format. More info can be found here: https://iso639-3.sil.org/code_tables/639/data.

ValueDescription
LANGUAGE_INVALIDLanguage code is invalid.
LANGUAGE_UNDETERMINEDLanguage could not be determined.
ENGEnglish.
RUSRussian.
DEUGerman.
FRAFrench.
ITAItalian.
JPNJapanese.
SPASpanish.
CEBCebuano.
TURTurkish.
PORPortuguese.
UKRUkrainian.
EPOEsperanto.
POLPolish.
SWESwedish.
NLDDutch.
HEBHebrew.
ZHOChinese.
HUNHungarian.
ARAArabic.
CATCatalan.
FINFinnish.
CESCzech.
FASPersian.
SRPSerbian.
ELLGreek.
VIEVietnamese.
BULBulgarian.
KORKorean.
NORNorwegian.
MKDMacedonian.
RONRomanian.
INDIndonesian.
THAThai.
HYEArmenian.
DANDanish.
TAMTamil.
HINHindi.
HRVCroatian.
HBSSerbo-Croatian.
BELBelarusian.
KATGeorgian.
TELTelugu.
KAZKazakh.
WARWaray.
LITLithuanian.
GLGGalician.
SLKSlovak.
BENBengali.
EUSBasque.
SLVSlovenian.
KANKannada.
MALMalayalam.
MARMarathi.
ESTEstonian.
AZEAzerbaijani.
MSAMalay.
SQIAlbanian.
LATLatin.
BOSBosnian.
NNONorwegian Nynorsk.
URDUrdu.
LAVLatvian.
MYABurmese.
TATTatar.
AFRAfrikaans.
OCIOccitan.
NDSLow German.
KIRKirghiz.
ASTAsturian.
TGLTagalog.
ISLIcelandic.
INAInterlingua.
SINSinhala.
GUJGujarati.
KHMCentral Khmer.
BREBreton.
BAKBashkir.
UZBUzbek.
BODTibetan.
PANPanjabi.
VOLVolapük.
ALSTosk Albanian.
NEPNepali.
CYMWelsh.
JBOLojban.
FRYWestern Frisian.
MONMongolian.
LTZLuxembourgish.
CHEChechen.
UIGUighur.
TGKTajik.
SCOScots.
SANSanskrit.
CHVChuvash.
JAVJavanese.
MINMinangkabau.
IDOIdo.
ORIOriya.
ASMAssamese.
NEWNewari.
GLEIrish.
MLGMalagasy.
ARGAragonese.
CKBCentral Kurdish.
SWASwahili.
BARBavarian.
LMOLombard.
YIDYiddish.
ARZEgyptian Arabic.
MHREastern Mari.
AZBSouth Azerbaijani.
SAHYakut.
PNBWestern Panjabi.
SUNSundanese.
BPYBishnupriya.
PMSPiemontese.
ILOIloko.
WUUWu Chinese.
KURKurdish.
PUSPushto.
ILEInterlingue.
XMFMingrelian.
YUEYue Chinese.
GOMGoan Konkani.
LIMLimburgan.
MWLMirandese.
CORCornish.
SNDSindhi.
HSBUpper Sorbian.
SCNSicilian.
GLAScottish Gaelic.
PAMPampanga.
BHOBhojpuri.
MAIMaithili.
VECVenetian.
MLTMaltese.
DIVDhivehi.
WLNWalloon.
MZNMazanderani.
AMHAmharic.
QUEQuechua.
CBKChavacano.
TUKTurkmen.
ROHRomansh.
OSSOssetian.
VLSVlaams.
YORYoruba.
LAOLao.
LEZLezghian.
SOMSomali.
MYVErzya.
DIQDimli.
MRJWestern Mari.
DSBLower Sorbian.
FRRNorthern Frisian.
HATHaitian.
GRNGuarani.
BXRRussia Buriat.
KOMKomi.
SRDSardinian.
KRCKarachay-Balkar.
BCLCentral Bikol.
NAPNeapolitan.
GLVManx.
AVAAvaric.
RUERusyn.
XALKalmyk.
PFLPfaelzisch.
DTYDotyali.
HIFFiji Hindi.
COSCorsican.
LRCNorthern Luri.
VEPVeps.
TYVTuvinian.
NOBNorwegian Bokmål.
SNAShona.
KINKinyarwanda.
IBOIgbo.
SMOSamoan.
SOTSouthern Sotho.
MRIMaori.
WOLWolof.
XHOXhosa.
HAUHausa.
HAWHawaiian.
NYANyanja.
ZULZulu.
HMNHmong.

ListSupportedLanguagesResponses object

A response with a collection of languages and the entity types supported by those languages.

ParameterTypeDescription
languagesarray of LanguageCollection of supported languages.
entitiesPerLanguagearray of SupportedEntitiesForLanguageCollection of supported entity types per language.

PredictEntitiesRequest object

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.

ParameterTypeDescription
phrasestringThe phrase to extract named entities from.
languagestring from LanguageCodeThe language of the given phrase. If you're unsure of the language of a phrase, use our Language Detection API.
entityTypesarray of string from EntityTypeA collection of entity types that can be detected. If empty, all found types are returned.
timezonestringThe 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.

PredictEntitiesResponse object

Response payload that is returned when predicting entities. Contains an empty list when no entities could be found.

ParameterTypeDescription
entitiesarray of EntityThe collection of entities that were extracted from the given phrase. The collection is empty if no entities could be found.

ProductQuantityValue object

A quantity of a product using a certain unit. Example use-cases are parsing of cooking recipes and shopping.

ParameterTypeDescription
valuestringThe amount of the unit.
unitstringThe unit describing the amount.
productstringThe extracted product.

SupportedEntitiesForLanguage object

A language and the entity types supported by that language.

ParameterTypeDescription
languageLanguageLanguage that was detected from the given phrase.
entityTypesarray of string from EntityTypeCollection of the supported entity types for this language.

UnitValues object

An amount and a unit of the amount.

ParameterTypeDescription
unitstringThe unit describing the amount.

UrlValues object

A URL and its domain.

ParameterTypeDescription
valuestringThe extracted url.
domainstringThe domain of the url.

Questions?

We’re always happy to help with code or other doubts you might have! Check out our Quickstarts, API Reference, Tutorials, SDKs, or contact our Support team.

Cookie Settings