This component provides access to the S4 text analytics services directly from the UIMA platform. The S4 Annotator for UIMA is implemented as an Annotator type component which can be used within the UIMA GUI tools (such as the UIMA Document Analyser and the CAS Visual Debugger) for processing documents and it also acts as a local proxy to the remotely accessible RESTful services of S4, hiding the complexity of the underlying technologies and communication protocols. For portability we have packaged this component as a UIMA PEAR package. The PEAR can be installed and integrated into any UIMA 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. It can be used as a standalone component or as part of a Collection Processing Engine (CPE) pipeline.
The following sections describe the steps for downloading, configuring and running the S4 UIMA Annotator component
Details on acquiring S4 API keys are available in the S4 Management Console documentation section.
After downloading the PEAR package, follow the steps:
On Windows start $UIMA_HOME/bin/runPearInstaller.bat file. A GUI like this will pop up:
If the PEAR has been installed successfully you should see a message like "Component S4 Document UIMA Annonator installation completed":
After successfully installing the PEAR package for the S4 Annotator component, several additional parameters need to be specified.
This is the xml fragment you are interested in:
Follow the steps:
On Windows start $UIMA_HOME/bin/cvd.bat file. A GUI like this will pop up:
The text should appear in the big text box of the GUI:
Go to the PEAR installation directory and you will find there a file called S4DocumentUIMAAnnotator_pear.xml which you have to open:
After successfully loading the S4 Annotator from the PEAR you should see the option "Run com.ontotext.s4.api.annotator.S4DocumentUimaAnnotator" in the Run menu highlighted:
Click on that button and wait for the results.
Follow the steps:
On Windows start $UIMA_HOME/bin/documentAnalyzer.bat file. A GUI like this will pop up:
The text boxes to fill in are:
The S4 Annotator plugin for UIMA provides an easy way for UIMA developers and language engineers to incorporate the S4 text analytics services within UIMA text analytics applications. If you haven't done so already - register and start using S4 right away!
Skip to end of metadata Go to start of metadata