Documentation of the keyterm extraction REST service.
| Request |
Keyterm extraction from the PDF of a scientific article |
| URL |
/processKeyTermArticlePDF |
| Request type | POST |
| Accept |
application/json (default) application/xml |
Set the output MIME type of the response result, JSON (default) or XML TEI standoff |
|
| Parameters |
| Required |
file | multipart/form-data |
Article document in PDF |
| Optional |
nerd | multipart/form-data |
If true, the extracted terms are disambiguated against Wikipedia/FreeBase (default is true) |
| Optional |
customisation |
multipart/form-data |
Name of the customisation to be used for disambiguation (default null) |
|
| Response type |
application/json application/xml |
MIME response type depending on the value indicated by the request header's Accept |
|
| Response status codes |
200 | Successful operation |
400 | Wrong request |
500 | Indicate an internal service error |
|
| Sample call |
curl --form nerd=0 --form file=@./thefile.pdf localhost:8070/processKeyTermArticlePDF
curl -H "Accept: application/xml" --form nerd=1 --form file=@./thefile.pdf localhost:8070/processKeyTermArticlePDF
|
| Request | Keyterm extraction from a scientific article encoded in a customized TEI format |
| URL | /processKeyTermArticleTEI |
| Request type | POST |
| Accept |
application/json (default) application/xml |
Set the output MIME type of the response result, JSON (default) or XML TEI standoff |
|
| Parameters |
| Required | file | multipart/form-data | Article document encoded in customized TEI |
| Optional | nerd | multipart/form-data | If true, the extracted terms are disambiguated against Wikipedia/FreeBase (default is true) |
| Optional | customisation | multipart/form-data | Name of the customisation to be used for disambiguation (default null) |
|
| Response type | application/json |
| Response status codes |
200 | Successful operation |
400 | Wrong request |
500 | Indicate an internal service error |
|
| Sample call |
curl -v -include --form nerd=0 --form file=@./thefile.tei localhost:8070/processKeyTermArticleTEI |
| Request | Keyterm extraction from a scientific article based on an archive number |
| URL | /processKeyTermArticleNumber |
| Request type | POST |
| Accept |
application/json (default) application/xml |
Set the output MIME type of the response result, JSON (default) or XML TEI standoff |
|
| Parameters |
| Required | number | string | HAL publication number, e.g. hal-00023080 |
| Optional | nerd | boolean | If true the extracted terms are disambiguated against Wikipedia/FreeBase (default is true) |
| Optional | customisation | string | Name of the customisation to be used for disambiguation (default null) |
|
| Response type | application/json |
| Response status codes |
200 | Successful operation |
400 | Wrong request |
500 | Indicate an internal service error |
|
| Sample call |
curl -X GET 'http://localhost:8070/processKeyTermArticleNumber?number=hal-00023080' |
| Request | Keyterm extraction from a patent document based on its publication number |
| URL | /processKeyTermPatentNumber |
| Request type | POST |
| Accept |
application/json (default) application/xml |
Set the output MIME type of the response result, JSON (default) or XML TEI standoff |
|
| Parameters |
| Required | number | string | Patent publication number in EPODOC format, e.g. EP1676586 |
| Optional | nerd | boolean | If true the extracted terms are disambiguated against Wikipedia/FreeBase (default is true) |
| Optional | customisation | string | Name of the customisation to be used for disambiguation (default null) |
|
| Response type | application/json |
| Response status codes |
200 | Successful operation |
400 | Wrong request |
500 | Indicate an internal service error |
|
| Sample call |
curl -X GET 'http://localhost:8070/processKeyTermPatentNumber?number=EP1676586' |
| Request | Keyterm extraction from an uploaded patent document in JSON |
| URL | /processKeyTermPatentJSON |
| Request type | POST |
| Accept |
application/json (default) application/xml |
Set the output MIME type of the response result, JSON (default) or XML TEI standoff |
|
| Parameters |
| Required | file | multipart/form-data | Patent publication document encoded in JSON |
| Optional | nerd | multipart/form-data | If true, the extracted terms are disambiguated against Wikipedia/FreeBase (default is true) |
| Optional | customisation | multipart/form-data | Name of the customisation to be used for disambiguation (default null) |
|
| Response type | application/json |
| Response status codes |
200 | Successful operation |
400 | Wrong request |
500 | Indicate an internal service error |
|
| Sample call |
curl -v -include --form nerd=0 --form file=@./thefile.json localhost:8070/processKeyTermPatentJSON |
| Request | Keyterm extraction from a patent text |
| URL | /processKeyTermPatentText |
| Request type | POST |
| Accept |
application/json (default) application/xml |
Set the output MIME type of the response result, JSON (default) or XML TEI standoff |
|
| Parameters |
| Required | text | string | Patent publication document encoded in JSON |
| Optional | nerd | boolean | If true, the extracted terms are disambiguated against Wikipedia/FreeBase (default is true) |
| Optional | customisation | string | Name of the customisation to be used for disambiguation (default null) |
|
| Response type | application/json |
| Response status codes |
200 | Successful operation |
400 | Wrong request |
500 | Indicate an internal service error |
|
| Sample call |
curl -X POST 'localhost:8070/processKeyTermPatentText' -d 'text=Natural Language Processing' |