Zana Documentation

ER Request

Endpoint

If the ER classifier is to be invoked remotely, then one of the following endpoints should be used:

Production - https://api.zana.com/nlu/er?text=
Development - https://dev.zana.com/nlu/er?text=

In case the Service has to be invoked internally, then there is no need to do an extra http request to the endpoint. Within the NLU you can call: entityExtractionService.getEntities(text) where EntityExtractionService is Grails Service which handles the entity extraction tasks.

Input parameters

"entity_name": "stroke" 

Response

Array of entities matched


[

  {
    "confidence": 1,
    "name": "Stroke",
    "score": 8.860325,
    "id": "c1433",
    "synonymMatch": "",
    "type": "condition",
    "url": "/c/stroke.1433",
    "image": "https://assets.zana.com/medical-content/content/4565/stroke-introduction.jpg"
  },

  {
    "confidence": 0.9,
    "name": "Cerebrovascular disease",
    "score": 5.396616,
    "id": "c299",
    "synonymMatch": "stroke",
    "type": "condition",
    "url": "/c/cerebrovascular-disease.299",
    "image": ""
  },

  {
    "confidence": 0.7,
    "name": "Transient ischaemic attack (TIA)",
    "score": 3.607354,
    "id": "c980",
    "synonymMatch": "mini stroke",
    "type": "condition",
    "url": "/c/transient-ischaemic-attack-tia.980",
    "image": null
  }

]

Parameters that we use for nlu-response

[

{
"confidence": 1, 
"name": "Stroke",
"id": "c1433",
"synonymMatch": "", 
"type": "condition", 
"url": "/c/stroke.1433"},

{ "confidence": 0.9,
"name": "Cerebrovascular disease",
"id": "c299", "synonymMatch": "stroke", "type": "condition",
"url": "/c/cerebrovascular-disease.299",},

{ "confidence": 0.7, 
"name": "Transient ischaemic attack (TIA)", 
"id": "c980", 
"synonymMatch": "mini stroke", 
"type": "condition", "url": "/c/transient-ischaemic-attack-tia.980"
}

]