Named Entity Recognition API

Named Entity Recognition API extracts the important keywords from natural language texts in your domain.

API Server
​nlu-api.allganize.ai is Allganize's NLU API endpoint. If you are using on-prem, please use your API endpoint.
Getting API KEY
The NLU API uses API keys to authenticate requests that you can find in the Allganize NLU API dashboard. Go to Settings > General to find your API key. If you don't have an account yet, you can create one here.
 Provide your API KEY in the request header API-KEY.
post
Named Entity Recognition API
https://nlu-api.allganize.ai/api/inference
Request
Response
Request
Headers
API-KEY
required
string
Your API key can be found on your dashboard Settings menu, under the General tab.
Body Parameters
text
required
string
Input text you want to analyze. English, Japanese, Korean, and Chinese are supported. You can enter up to 2000 characters, after which the entered characters will be ignored.  
Response
200: OK
The response has a list of inferred results for the requested text.

startIndex: The start location of the word recognized as the named entity. Shown as a number.
endIndex: The end location of the word recognized as the named entity. Shown as a number.
tag: They type of the named entity. The types are defined in your NLU API dashboard.
token: The word recognized as the named entity.
{
  "inputText": STRING,
  "entities": [
    { 
      "startIndex": NUMBER, 
      "endIndex": NUMBER, 
      "tag": STRING,
      "token": STRING
    }, ...
  ]
}
Request Example
Please replace YOUR_API_KEY with your one in the example below. Please see getting-api-key section.
curl https://nlu-api.allganize.ai/api/inference \
-d '{"text": "I am traveling from Munich to Paris by Air France business class"}' \
-H "Content-Type: application/json" \
-H "API-KEY: YOUR_API_KEY"
Response Example
{
  "inputText": "I am traveling from Munich to Paris by Air France business class",
  "entities": [
    {"startIndex": 20, "endIndex": 26, "tag": "DEPARTURE", "token": "Munich"},
    {"startIndex": 30, "endIndex": 35, "tag": "ARRIVAL", "token": "Paris"},
    {"startIndex": 39, "endIndex": 49, "tag": "AIRLINE", "token": "Air France"},
    {"startIndex": 50, "endIndex": 64, "tag": "SEAT_CLASS", "token": "business class"}
  ]
}
Error Messages
Please read the error message you get if you don't get the response that you expected. 
Status Code
Error Code
Name
Message
Description
500
7000
API Error
Something went wrong
Default API error message for any uncategorized errors.
403
7001
Invalid API Key
API-KEY is not valid.
When the API Key requested to the header is invalid.
403
7002
Invalid JSON
Cannot decode the requested JSON body.
When the requested JSON is not decodable.
400
7003
Invalid Parameter
Requested parameters are not valid. 'text' is empty.
When the requested parameter is invalid (for example, when requesting inference with empty text).
405
-
Wrong HTTP Method
-
When the HTTP method used is not valid.
Error Response example
{
    "type": "APIError",
    "code": 7000,
    "message": "Something went wrong."
}
​

Alli API

Text Classification API

Last updated 2 months ago

Status Code	Error Code	Name	Message	Description
500	7000	API Error	Something went wrong	Default API error message for any uncategorized errors.
403	7001	Invalid API Key	API-KEY is not valid.	When the API Key requested to the header is invalid.
403	7002	Invalid JSON	Cannot decode the requested JSON body.	When the requested JSON is not decodable.
400	7003	Invalid Parameter	Requested parameters are not valid. 'text' is empty.	When the requested parameter is invalid (for example, when requesting inference with empty text).
405	-	Wrong HTTP Method	-	When the HTTP method used is not valid.

Named Entity Recognition API

API Server

Getting API KEY

Provide your API KEY in the request header API-KEY.

postNamed Entity Recognition API

Request Example

Response Example

Error Messages

Error Response example

Provide your `API KEY` in the request header `API-KEY`.

post
Named Entity Recognition API