Named Entity Recognition API

API Reference

Search…

API Reference

1.0.0

Cognitive Search API

Alli API

Named Entity Recognition API

Text Classification API

Sentiment Analysis API

Review Analysis API

Integrated api

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
https://nlu-api.allganize.ai
/api/inference
Named Entity Recognition API
Request Example
Please replace YOUR_API_KEY with your one in the example below. Please see getting-api-key section.
1
curl https://nlu-api.allganize.ai/api/inference \
2
-d '{"text": "I am traveling from Munich to Paris by Air France business class"}' \
3
-H "Content-Type: application/json" \
4
-H "API-KEY: YOUR_API_KEY"
Copied!
Response Example
1
{
2
  "inputText": "I am traveling from Munich to Paris by Air France business class",
3
  "entities": [
4
    {"startIndex": 20, "endIndex": 26, "tag": "DEPARTURE", "token": "Munich"},
5
    {"startIndex": 30, "endIndex": 35, "tag": "ARRIVAL", "token": "Paris"},
6
    {"startIndex": 39, "endIndex": 49, "tag": "AIRLINE", "token": "Air France"},
7
    {"startIndex": 50, "endIndex": 64, "tag": "SEAT_CLASS", "token": "business class"}
8
  ]
9
}
Copied!
post
https://nlu-api.allganize.ai
/api/add_phrase/<data_type>
Upload training and testing data
​
Request Example
Please replace YOUR_API_KEY with your one in the example below. Please see getting-api-key section.
1
curl https://nlu-api.allganize.ai/api/add_phrase/train \ 
2
-d '[{
3
  "text": "I am traveling from Munich to Paris by Air France business class",
4
  "entities": [
5
    {"start": 20, "end": 26, "tag": {"name": "DEPARTURE"}, "token": "Munich"},
6
    {"start": 30, "end": 35, "tag": {"name": "ARRIVAL"}, "token": "Paris"},
7
    {"start": 39, "end": 49, "tag": {"name": "AIRLINE"}, "token": "Air France"},
8
    {"start": 50, "end": 64, "tag": {"name": "SEAT_CLASS"}, "token": "business class"}
9
  ]
10
}' \ 
11
-H "Content-Type: application/json" \
12
-H "API-KEY: YOUR_API_KEY"
Copied!
Response Example
1
{"success": true}
Copied!
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).
403
7004
Payment error
billing error.
Overall payment related errors, e.g., payment is overdue
405
-
Wrong HTTP Method
-
When the HTTP method used is not valid.
Error Response example
1
{
2
    "type": "APIError",
3
    "code": 7000,
4
    "message": "Something went wrong."
5
}
Copied!
​

Alli API

Text Classification API

Last modified 3mo ago

Copy link

Contents

API Server

Getting API KEY

post

Named Entity Recognition API

Request Example

Response Example

post

Upload training and testing data

Request Example

Response Example

Error Messages

Error Response example