API documentation

ADEL

Overview

Move your app forward with the ADEL API

Version information

Version : 0.1.0

Contact information

Contact : Julien Plu

URI scheme

Host : adel.eurecom.fr
BasePath : /v1
Schemes : HTTP

Paths

POST /extract

Description

Extract and type entities from a document

Parameters

Type	Name	Description	Schema
Body	document required	The document or URL (pointing to a HTML document) to process	ExtractDocument

Responses

HTTP Code	Description	Schema
200	Successful response in the given output format	No Content
default	Unexpected error	Error

Consumes

• application/json;charset=utf-8

• text/turtle;charset=utf-8

Produces

• text/turtle;charset=utf-8

• application/json;charset=utf-8

• text/plain;charset=utf-8

Tags

• Extract

POST /link

Description

Link entities from a document that has already been annotated with known surface forms

Parameters

Type	Name	Description	Schema
Body	document required	The document you want to process	LinkDocument

Responses

HTTP Code	Description	Schema
200	Successful response in the given output format	No Content
default	Unexpected error	Error

Consumes

• application/json;charset=utf-8

• text/turtle;charset=utf-8

Produces

• text/turtle;charset=utf-8

• application/json;charset=utf-8

• text/plain;charset=utf-8

Tags

• Link

POST /nerd

Description

Extract, type and link entities from a document

Parameters

Type	Name	Description	Schema
Body	document required	The document or URL (pointing to a HTML document) to process	NerdDocument

Responses

HTTP Code	Description	Schema
200	Successful response in the given output format	No Content
default	Unexpected error	Error

Consumes

• application/json;charset=utf-8

• text/turtle;charset=utf-8

Produces

• text/turtle;charset=utf-8

• application/json;charset=utf-8

• text/plain;charset=utf-8

Tags

• Nerd

Definitions

Error

Name	Schema
code optional	integer(int32)
message optional	string

ExtractDocument

Name	Description	Schema
content optional	Content of the processed document (content XOR URL must be specified)	string
input optional	The content must respect one of these format. If "raw" the content is a raw text; if "nif" the content is in Turtle respecting the NIF vocabulary; if "html" the content is regularly marked up; if "ttml" or "srt" the content correspond to subtitles in their respecting format Default : "raw"	enum (raw, nif, html, ttml, srt)
output optional	The response can only be in one of the format. "nif", "conll", "brat", or "naf" Default : "nif"	enum (nif, conll, brat, naf)
url optional	Valid URL of a HTML document (content XOR URL must be specified)	string

LinkDocument

Name	Description	Schema
content optional	Content of the processed document	string
input optional	The content must respect one of these format. If "raw" the content is a raw text, if "nif" the content is in Turtle repecting the NIF vocabulary. Default : "raw"	enum (raw, nif)
output optional	The response can only be in one of the format. "nif", "tac", "brat", or "naf" Default : "nif"	enum (nif, tac, brat, naf)

NerdDocument

Name	Description	Schema
content optional	Content of the processed document (content XOR URL must be specified)	string
input optional	The content must respect one of these format. If "raw" the content is a raw text; if "nif" the content is in Turtle respecting the NIF vocabulary; if "html" the content is regularly marked up; if "ttml" or "srt" the content correspond to subtitles in their respecting format Default : "raw"	enum (raw, nif, html, srt, ttml)
output optional	The response can only be in one of the format. "nif", "conll", "brat", or "naf" Default : "nif"	enum (nif, conll, brat, naf)
url optional	Valid URL of a HTML document (content XOR URL must be specified)	string