https://github.com/ximdex/xowl-service-api
Description of the API for the Xowl semantic service (named entity recognition via dbpedia, watson, etc.)
https://github.com/ximdex/xowl-service-api
cms drupal-module entity json-ld linked-data linked-open-data semantic semantic-entities semantic-web stanbol wordpress-client wordpress-plugin ximdex-cms
Last synced: 3 months ago
JSON representation
Description of the API for the Xowl semantic service (named entity recognition via dbpedia, watson, etc.)
- Host: GitHub
- URL: https://github.com/ximdex/xowl-service-api
- Owner: XIMDEX
- Created: 2015-07-03T08:44:49.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-07-03T10:36:29.000Z (almost 11 years ago)
- Last Synced: 2025-10-30T10:06:45.571Z (7 months ago)
- Topics: cms, drupal-module, entity, json-ld, linked-data, linked-open-data, semantic, semantic-entities, semantic-web, stanbol, wordpress-client, wordpress-plugin, ximdex-cms
- Homepage: http://demo.ximdex.com/xowl
- Size: 418 KB
- Stars: 1
- Watchers: 16
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# xowl-service-api
Xowl service is a product owned by Open Ximdex Evolution. It's a API service that enhance your content with semantic links. To be able to use the service follow the steps below:
1. Register in ximdex platform: http://xowl.ximdex.net/register/signup
2. Confirm your email an access the platform to grab your token.
3. At this point you are ready to query the service, you can get a response using the following data:
- endpoint: service url
- token: is a string of character
- content: text to be enhancer
4. So if to make a low level request you can use curl: curl _URL_ -d 'token=_TOKEN_&content=_TEXTUAL CONTENT_'
Example:
```bash
curl http://xowl.ximdex.net/api/v1/enhance -d 'token=TOKEN&content=This is a very important text that talks about Albert Einstein'
```
At this moment the api service support both GET and POST request, but depending on the tool you use, you may have to manually url-encode the parameters to make a correct query.
The response is always a json object with the following structure:
```javascript
{
"semantic": [LabelWithEntities, ...],
"text": "This is a very important text<\/a> that talks about Albert Einstein<\/a>"
}
```
The *semantic* key is an array with objects. Each of them represents a portion of the original text that have been recognized as an entity. In semantic world a string could refer to many entities, so each *LabelWithEntities* has an array called **entities**.
It's up to the user/developer how to manage this information, depending on the editor, the cms/dms, the visual editor used...
Check [drupal 7 client](https://github.com/XIMDEX/drupal7-xowl-client), [drupal 8 client](https://github.com/XIMDEX/drupal8-xowl-client) and [wordpress 3.x client](https://github.com/XIMDEX/wp-xowl-client), these are plugins that integrates with those cms.
# Screenshots
>*[Wordpress Xowl client](https://github.com/XIMDEX/wp-xowl-client)*
>*[Drupal Xowl client](https://github.com/XIMDEX/drupal7-xowl-client)*
>*[Xowl inside Ximdex CMS](https://github.com/XIMDEX/ximdex)*
>*[Xowl Demo](http://demo.ximdex.com/xowl/)*
