Introduction

This server offers a REST API to use the Peregrine indexing service. You can use this service to add concept recognition to your software.

Using Peregrine

REST API

The following REST APIs are available

/index/intexText

Index a given text.

Parameters:

text
Required The text to tag
format
Required The format of the returned fingerprint. Possible values: xml, json
lang
Optional The language of the text, e.g. "en", or "nl". When this parameter is not given, a google language detector will be used.
disambiguate
Optional The disambiguator to use. Only "peregrine" is supported now. No disambiguation will be applied if this parameter is not given or the given value is unknow .
callback
Optional The callback function to wrap the json response in to create a JSONP response. Only valid in combination with format=json

Example:

http://peregrine.nbiceng.net/index/indexText?text=Malaria&format=xml&lang=en&disambiguate=peregrine

Ontology

The NBIC Peregrine uses a sanitize version of the ConceptWiki ontology from 2010. This ontology contains all of the ConceptWiki terms except for two letter terms or terms that are highly ambiguous.

Support for the service

This service is provided as an academic service. You are free to use the service at no charge, but we cannot guarantee availability. We would like to know if you plan to use this server intensively. If you need high availability or a service level agreement you can contact us to discuss a SLA.

Development

Documentation

Full documentation of Peregrine can be found on the NBIC trac server.

License

Peregrine is licensed under the GNU Affero General Public License.

Source code

Source code for the project is available on the NBIC trac server.

Logo Erasmus Medical Centre Logo Netherlands Bioinformatics Centre