OSF Tagger (scones)

From OSF Wiki
(Redirected from Scones)
Jump to: navigation, search
Scones endpoint version:
1.1
2
3
3.3

The OSF Tagger (scones) Web service is used to perform subject concepts and named entities tagging on a target document. The tagger gets its scones name from the acronym subject concepts or named entities.

Developers communicate with the OSF Tagger Web service using the HTTP POST method.

Version

This documentation page is used for the version 3.3 of this endpoint. Check at the top of this page to see the documentation pages for the other versions of this endpoint.

Usage

This Web service is intended to be used by users that wants to tag subjects concepts and named entities using the content of a target OSF Web Service instance.

Since the OSF tagger is re-using the ontologies & named entities defined on a specific OSF Web Service instance, tagging will be performed using this specific information. So, if a specific OSF Web Service instance is hosted, maintained and defined by a Health related organization, than their OSF tagger web service should be better at tagging Health related documents.

So, not all OSF tagger instances are equal, and some are expected to be better at tagging specific articles than other, depending on the domain defined on a specific node.

Web Service Endpoint Information

This section describes all the permissions you need in the WSF (Web Service Framework) to send a query to this Web service endpoint, and it describes how to access it.

To access this Web service endpoint you need the proper CRUD (Create, Read, Update and Delete) permissions on a specific graph (dataset) of the WSF. Without the proper permissions on this graph you won't be able to send any queries to the endpoint.

Needed registered CRUD permission:
  • Create: False
  • Read: True
  • Update: False
  • Delete: False

Here is the information needed to communicate with this Web service's endpoint. Descriptions of the parameters are included below.

Note: if a parameter has a default value, the requester can omit it and the default value will be used. Also, some baseline Web services may not offer other values than the default.

HTTP method:

  • POST

Possible "Accept:" HTTP header field value:

  • application/json
  • application/edn
  • application/clojure

URI:

  • http://[...]/ws/scones/ ?document=&type=&stemming=&application=&interface=&version=

URI dynamic parameters description:

Note: All parameters have to be URL-encoded

  • document. Document content to process; or URL of a document accessible on the web to extract/process
    • The document types accessible at that URL can be either:
      • a plain text document
      • a HTML document
      • a PDF document
      • a MS Word document
      • a Email document
      • a RTF document
      • a SGML document
      • a XML document
  • type. The type of tagger the requester want to use
    • "plain" (default) - specify that you want to tag all kind of words from the input document
    • "noun" - specify that you want to only consider noun words when tagging the input document
  • stemming. Use the stemmer when performing the tagging
    • "false" (default) - do not use the stemmer
    • "true" - use the stemmer
  • application.(default: defaultApplication). Application to use to tag the content of the input document. If other applications are available, these should be listed somewhere on the website of the agent that host the service.
  • interface. Source interface used for this web service query. The interface is a different way to process a query (different algorithms, different data management system, etc. The default interface is 'default'
  • version. (default: 3.0) Version of the interface to query

Available Sources Interfaces

A source interface is a way to process a web service query. Different sources interfaces can be implemented for the same OSF Web Service endpoint. Each interface will process the query differently, but all the queries to the web service endpoint will be the same, at the exception of the interface parameter. Each interface shares the same API (the one defined by the web service endpoint), but their processing may differ (like using different algorithms, using different data management systems, etc.)

This is a list of the core interfaces for this endpoint. Organizations that hosts a OSF Web Service network could create their own interface and make it available to the users. However such private source interface won't be part of this list, but should be publicized by the organization.


Source Interface Name Description
default Default source interface for this OSF Web Service endpoint. This interface implements the default behavior of this OSF Web Service endpoint.

Example of Returned XML Document

This is an example of the XML document returned by this Web service endpoint for a given document's content. This example returns GATE XML annotated document

Query:
  • http://[...]/ws/scones/ parameters: document=Poverty%20is%20widespread%20around%20the%20World...

"Accept:" HTTP header field value:

  • application/json

Result:

  1. {
  2.     "pref-labels": {
  3.         "poverty": {
  4.             "concepts": [
  5.                 "http://purl.org/ontology/peg#Poverty"
  6.             ],
  7.             "indices": [
  8.                 [
  9.                     0,
  10.                     6
  11.                 ]
  12.             ]
  13.         }
  14.     },
  15.     "alt-labels": null,
  16.     "normalized-text": "poverty is widespread around the world "
  17. }


HTTP Status Codes

Here are the possible HTTP status (error) codes returned by this Web service endpoint.

On error code and the specific error, a different message description can be issued (meaning a different error has been returned).


HTTP 200

Message Description
OK


HTTP 400

ID Level Name Description
WS-SCONES-200 Warning No documents URI specified for this request No documents URI specified for this request
WS-SCONES-300 Warning Document MIME type not supported. The MIME type of the document you feeded to Scones is not currently supported
WS-SCONES-301 Warning Document empty The content of the document you defined is empty
WS-SCONES-302 Fatal Requested source interface not existing The source interface you requested is not existing for this web service endpoint.
WS-SCONES-303 Fatal Requested incompatible Source Interface version The version of the source interface you requested is not compatible with the version of the source interface currently hosted on the system. Please make sure that your tool get upgraded for using this current version of the endpoint.
WS-SCONES-304 Fatal Source Interface's version not compatible with the web service endpoint's The version of the source interface you requested is not compatible with the one of the web service endpoint. Please contact the system administrator such that he updates the source interface to make it compatible with the new endpoint version.


HTTP 403

ID Level Name Description
WS-AUTH-VALIDATION-100 Fatal Unauthorized Request Your request cannot be authorized for this web service call
WS-AUTH-VALIDATION-101 Fatal Unauthorized Request Your request cannot be authorized for this web service call
WS-AUTH-VALIDATION-102 Fatal Couldn't authorize request An internal error occured when we tried to authorize this request
WS-AUTH-VALIDATION-103 Fatal Unauthorized Request Your request cannot be authorized for this user: "---", on this dataset: "---", using this web service endpoint: "---"


HTTP 406

Message Description
Not Acceptable Unacceptable mime type requested


HTTP 500

Message Description
Internal Error