This component provides access to the S4 text analytics services directly from the GATE platform. The S4 Annotator plug-in is implemented as a GATE Processing Resource (PR) and it acts as a local proxy to the remotely accessible RESTful services of S4, hiding the complexity of the underlying technologies and communication protocols. The PR can be integrated in any GATE processing pipeline regardless of the context and it does not have any requirements or assumptions about the type of pre-processing or post-processing of the textual data being annotated.
The following sections describe the procedures for downloading, configuring and running the S4 Annotator PR for GATE.
More details on acquiring S4 API keys are available in the S4 documentation.
There are two options for downloading the plug-in depending on the user preference
Step 1: Start GATE
and for the URL:
Step 7: Having completed the previous step successfully, the tab Available to Install will become enabled. Its content should contain the plug-in listed (see the figure below).
The plug-in binaries package is available at http://ontotext-ad.github.io/S4/GatePR/Annotator_S4/Annotator_S4.zip
Download the archive and extract it in the plugins directory of the GATE platform, usually at $GATE_HOME/plugins. Then (re) start the GATE developer application.
There are two ways for updating the plug-in depending on the chosen method for downloading the plugin.
Remove ANnotator S4 directory and repeate Direct plug-in download.
Prior to loading the plug-in and instantiating the PR, there is a single file which needs to be updated with the proper credentials (API keys) information. Recall the Prerequisites section where we require an API key & secret pair for accessing the carious S4 services. This information should be provided in the configuration file called S4.config located in the main directory of the plug-in ($GATE_HOME/plugins/Annotator_S4/S4.config). It is a plain text file containing two properties:
It is a regular GATE procedure for plug-in loading.
Step 1: Open the CREOLE Plugin Manager (File > Manage CREOLE plugins...)
Step 6: Close the CREOLE Plugin Manager window
Step 9: Ensure the configFileURL refers to the correct configuration file
Step 1: Load the documents you want to annotate
Now just run the pipeline and see the results.
Here follows a sample document annotated with the News annotation service. Description of the annotation results is available in the News Annotation documentation.
Here follows a sample document annotated with the Bio-medical annotation service. Description of the annotation results is available in the Semantic Biomedical Tagger documentation
The source code for the GATE plugin for S4 is available from the S4 GitHub repository.
The S4 Annotator plugin for GATE provides an easy way for GATE developers and language engineers to incorporate the S4 text analytics services within GATE pipelines. If you haven't done so already - register and start using S4 right away!
Skip to end of metadata Go to start of metadata