Skip to main content
Version: 2.0

Detail

The API output is divided into three levels. The third level of return is the Detail level. Within the Detail Object you will find the following return below.

Check out the Sentence and Details level to see the full list of objects.

Detail Object

KeyTypeDescriptionContraints
lemmastringlemma
source_purestringthe TRUE source
sourcestringthe work source
indexintegerabsolute token index at inputindex >= 0
tagstringpos tag
depstringsee list of dependency tags
refintegerindex of the parent dependence1 for root, else >= 0
meaninglist of Category ObjectsKnown meanings for the itemCan be empty
lemmatizerLemmatizer Objectlemmatizer details
type_entityentity typesentity type or null
valueentitiesReturn entity or other

Detail Format


input: 'The package was delivered on Tuesday.'

output :
‘detail’ : [{
‘lemma’ : "the",
‘source_pure’ : "The"
'source': "The"
‘index’ : [0, 3]
‘tag’ : "D" ‘dep’ : "det",
‘ref’ : 1,
‘meaning’ : []
‘lemmatizer’ : {"possessing": -1, "mode": "define", "gender": {"female": false, "plural": false},
‘type_entity’ : null
‘value’ : {}
},
{...}, {},.]

Lemma

KEYTYPEDESCRIPTION
lemmastringlemmatized version of the source

source_pure

KeyTypeDescription
source_purestringthe TRUE source

Source

KeyTypeDescription
sourcestringthe work source

Index

KeyTypeDescriptionConstraints
indexintbase index of the token, links the APIs togetherindex >= 0

Tag

POS Tagger Object

INDEXTYPEDESCRIPTION
0stringWord token
1stringSee list of possible tags

POS Tags

VALUEDESCRIPTION
Cconjunction
CCco-ordinating conjunction
CDnumber
CLOpronoun object
CLSpronoun
Ddeterminer
JJadjective
Ncommon noun
NPproper noun
PUNCTpunctuation
Ppreposition
PDpronom define
PRORELpronom relative
RBadverb
RB_WHadverb question
SYMsymbols
UHinterjection
Vverb
VINFinfinitive verb
VPverb participe past

For a demo of POS tag check out our tutorial 👨🏻‍💻

Dep

Dependency Object

Dependence objects combine the results from the dependency parser with the understanding from the NLU api.

KEYTYPEDESCRIPTIONCONSTRAINTS
depstringsee list of dependency tags-

Dependency Tags

We use the universal dependencies for our dependency parser.

Ref

KEYTYPEDESCRIPTIONCONSTRAINTS
refintegerindex of the parent dependence1 for root, else >= 0

For a demo of dependency parser check out our tutorial 👨🏻‍💻

Meaning

KEYTYPEDESCRIPTIONCONSTRAINTS
meaninglist of Category ObjectsKnown meanings for the itemCan be empty.

For a demo of meaning check out our tutorial 👨🏻‍💻

Lemmatizer

The content of the lemmatizer object is different for each tag. The table bellow references all the keys that are available, and lists the tags that will return them (see POS Tagger and list of tags).

KEYTYPEDESCRIPTIONCONSTRAINTSTAGS
conjugatelist of Conjugate ObjectsList possible conjugationssee ConjugationsV
confidencefloatlevel of confidence in the results (higher is better)0 <= confidence <= 1(all)
genderGender Objectdescribes the gender and plurality-VP, JJ, N, D, PD
lemmastringlemmatized version of the source-C, CC, CLO, CLS, D, JJ, N, NP, PUNCT, P, PD, PROREL, RB, RB_WH, SYM, UH
infinitlist of stringlist of possible verb infinitives-V, VP
numberfloatvalue-CD
modestring--D, PD
possessingintsee Possessive determiners-D, PD
pronomintsee Pronouns-CLS
designationlist of stringsee Categories-CLO
categorystringsee Adverb Categories-RB
sourcestring--RB, P
senslist of Preposition sens object--P

For a demo of lemmatizer check out our tutorial 👨🏻‍💻

type_entity

KEYTYPEDESCRIPTIONCONSTRAINTS
type_entitystringDescribes the type of entity foundFor proper nouns, can either be LOCATION or PERSON. For other entities, see Entity types

Value

A value object can either be a numeric value for some adjectives, an entity value for entities, or a 'null' value for names.