Documentation
Getting started with the EntityClassifier.eu is easy. Check out the documentation of the API version 1 and version 2 (recommended).
You can use our API to perform the same NER tasks as our Web application - named entity recognition, entity disambiguation and linking (using DBpedia URIs) or classification (with DBpedia and/or YAGO Ontology types).
Even more, you can use our GATE plugin to process documents in the GATE text engineering framework.
REST API version 2.0
The most recent version of the REST API.
- Entity Extraction API v2.0 - send text and get ranked list of entities linked and classified with DBpedia.
- Entity Classification API v2.0 - classify an entity recognized with a DBpedia URI.
REST API version 1.0 (deprecated)
Version 1.0 of the REST API is still available. However, we recommend migration to version 2.0.
- Entity Extraction API v1.0 - send text and get list of entities linked and classified with DBpedia.
API Rate Limits
All API requests are subject to rate limits applied to your API key. We apply rate-limits on a 24 hours basis - 1 day windows. With the FREE option you can make up to 10.000 requests per day. If you need larger quota feel free to contact us. You can check you API rate limits by submitting GET request at http://entityclassifier.eu/thd/api/v2/consumers/{apikey} and looking at the following HTTP response headers.
| Header Name | Example Value | Description |
|---|---|---|
| X-Rate-Limit-Limit | 10000 | The number of allowed requests in time window (e.g., in 1 day window). |
| X-Rate-Limit-Remaining | 2000 | The number of requests left in the time window (e.g., in 1 day window). |
| X-Rate-Limit-Reset | 600 | The remaining time until the rate limit resets (in seconds). E.g., 600 seconds (10 minutes) until the 1 day window resests. |
API Key
The REST API is secured using an API key to prevent abuse of the service. You can get an API key for FREE, just send API key request by filling the form bellow. Note that an API key is also required if you want to use the GATE plugin. If you encounter any problems, please contact Milan Dojchinovski.
cite