GETTING STARTED

Last updated: 30-Jun-2022 16:22

This document describes a session, using either HTML or command-line calls, that uses the gate service to obtain the annotations resulting from applying GATE to a newspaper article harvested from the Boston Globe on March 3, 2023.

This sequence is harvested from the tests used to confirm the expected behavior of gate and gated.

Use URlEncoder to URL-encode parameter values for each URL.

The sequence of operations is the same for both HTML and the command line:

1. Load the ANNIE plugin
2. Load a document from a file
3. Create a corpus
4. Add the loaded document to the corpus
5. Create a pipeline
6. Load the "AnnotationDeletePR" processing resource
7. Load the "DefaultTokenizer" processing resource
8. Set the corpus of the pipeline
9. Add the "AnnotationDeletePR" to the pipeline
10. Add the DefaultTokenizer" to the pipeline
11. Configure the runtime parameters of "AnnotationDeletePR"
12. Run the pipeline
13. Get the annotations from the document
14. Cleanup gate daemon (gated)
15. Reset shared state

HTML

Each numbered item is a link that will invoke the operation when clicked.

1. Load the ANNIE plugin

   • Endpoint: plugin

   • operation: mavenPlugin

   • parameters:

     • group: uk.ac.gate.plugins
     • artifact: annie
     • version: 9.1

   • URL:

     https://hoyo.zeetix.com:5101/gate/v0/plugin/mavenPlugin?group=uk.ac.gate.plugins&artifact=annie&version=9.1
     

2. Load a document from a file

   • Endpoint: document

   • operation: withPath

   • parameters:

     • path: %2Fhome%2Ftms%2Fbackend%2Ftests%2Ftest_classes%2FBackendServices%2FGateService%2FinputData%2FgatePipelineTest_sample.html

   • URL:

     https://hoyo.zeetix.com:5101/gate/v0/document/withPath?path=%2Fhome%2Ftms%2Fbackend%2Ftests%2Ftest_classes%2FBackendServices%2FGateService%2FinputData%2FgatePipelineTest_sample.html
     

3. Create a corpus

   • Endpoint: corpus

   • operation: withName

   • parameters:

     • corpusName: testCorpus1

   • URL:

     https://hoyo.zeetix.com:5101/gate/v0/corpus/withName?corpusName=testCorpus1
     

4. Add the loaded document to the corpus

   • Endpoint: corpus

   • operation: addDocument

   • parameters:

     • corpusName: testCorpus1
     • documentName: %2Fhome%2Ftms%2Fbackend%2Ftests%2Ftest_classes%2FBackendServices%2FGateService%2FinputData%2FgatePipelineTest_sample.html

   • URL:

     https://hoyo.zeetix.com:5101/gate/v0/corpus/addDocument?corpusName=testCorpus1&documentName=%2Fhome%2Ftms%2Fbackend%2Ftests%2Ftest_classes%2FBackendServices%2FGateService%2FinputData%2FgatePipelineTest_sample.html
     

5. Create a pipeline

   • Endpoint: pipeline

   • operation: withName

   • parameters:

     • pipelineName: testPipeline1

   • URL:

     https://hoyo.zeetix.com:5101/gate/v0/pipeline/withName?pipelineName=testPipeline1
     

6. Load the "AnnotationDeletePR" processing resource

   • Endpoint: pr

   • operation: withPR

   • parameters:

     • prName: anndeletePR
     • resourcePath=gate.creole.annotdelete.AnnotationDeletePR

   • URL:

     https://hoyo.zeetix.com:5101/gate/v0/pr/withPR?prName=anndeletePR&resourcePath=gate.creole.annotdelete.AnnotationDeletePR
     

7. Load the "DefaultTokenizer" processing resource

   • Endpoint: pr

   • operation: withPR

   • parameters:

     • prName: defToken
     • resourcePath=gate.creole.tokeniser.DefaultTokeniser

   • URL:

     https://hoyo.zeetix.com:5101/gate/v0/pr/withPR?prName=defToken&resourcePath=gate.creole.tokeniser.DefaultTokeniser
     

8. Set the corpus of the pipeline

   • Endpoint: pipeline

   • operation: corpusSet

   • parameters:

     • pipelineName: testPipeline1
     • corpusName: testCorpus1

   • URL:

     https://hoyo.zeetix.com:5101/gate/v0/pipeline/corpusSet?pipelineName=testPipeline1&corpusName=testCorpus1
     

9. Add the "AnnotationDeletePR" to the pipeline

   • Endpoint: pipeline

   • operation: prAdd

   • parameters:

     • pipelineName: testPipeline1
     • prName: anndeletePR

   • URL:

     https://hoyo.zeetix.com:5101/gate/v0/pipeline/prAdd?pipelineName=testPipeline1&prName=anndeletePR
     

10. Add the DefaultTokenizer" to the pipeline

    • Endpoint: pipeline

    • operation: prAdd

    • parameters:

      • pipelineName: testPipeline1
      • prName: defToken

    • URL:

      https://hoyo.zeetix.com:5101/gate/v0/pipeline/prAdd?pipelineName=testPipeline1&prName=defToken
      

11. Configure the setsToKeep parameter of "AnnotationDeletePR"

    • Endpoint: pipeline

    • operation: parameterValueSet

    • parameters:

      • pipelineName: testPipeline1
      • prName: anndeletePR
      • parameterName: setsToKeep
      • parameterValue: Key%2CTarget
      • parameterType: List%3CString%3E

    • URL:

      https://hoyo.zeetix.com:5101/gate/v0/pipeline/parameterValueSet?pipelineName=testPipeline1&prName=anndeletePR&parameterName=setsToKeep&parameterValue=Key%2CTarget&parameterType=List%3CString%3E
      

12. Run the pipeline

    • Endpoint: pipeline

    • operation: run

    • parameters:

      • pipelineName: testPipeline1

    • URL:

      https://hoyo.zeetix.com:5101/gate/v0/pipeline/run?pipelineName=testPipeline1
      

13. Get the annotations from the document

    • Endpoint: document

    • operation: annotations

    • parameters:

      • documentName: %2Fhome%2Ftms%2Fbackend%2Ftests%2Ftest_classes%2FBackendServices%2FGateService%2FinputData%2FgatePipelineTest_sample.html

    • URL:

      https://hoyo.zeetix.com:5101/gate/v0/document/annotations?documentName=%2Fhome%2Ftms%2Fbackend%2Ftests%2Ftest_classes%2FBackendServices%2FGateService%2FinputData%2FgatePipelineTest_sample.html
      

14. Cleanup gate daemon (gated)

    • Endpoint: cleanup

    • operation: na

    • parameters: na

    • URL:

      https://hoyo.zeetix.com:5101/gate/v0/cleanup
      

15. Reset shared state

    • Endpoint: resetSharedState

    • operation: na

    • parameters: na

    • URL:

      https://hoyo.zeetix.com:5101/gate/v0/resetSharedState
      

Command Line

1. Load the ANNIE plugin

   • Endpoint: plugin

   • operation: mavenPlugin

   • parameters:

     • group: uk.ac.gate.plugins
     • artifact: annie
     • version: 9.1

   • URL:

     wget "https://hoyo.zeetix.com:5101/gate/v0/plugin/mavenPlugin?group=uk.ac.gate.plugins&artifact=annie&version=9.1"
     

2. Load a document from a file

   • Endpoint: document

   • operation: withPath

   • parameters:

     • path: %2Fhome%2Ftms%2Fbackend%2Ftests%2Ftest_classes%2FBackendServices%2FGateService%2FinputData%2FgatePipelineTest_sample.html

   • URL:

     wget "https://hoyo.zeetix.com:5101/gate/v0/document/withPath?path=%2Fhome%2Ftms%2Fbackend%2Ftests%2Ftest_classes%2FBackendServices%2FGateService%2FinputData%2FgatePipelineTest_sample.html"
     

3. Create a corpus

   • Endpoint: corpus

   • operation: withName

   • parameters:

     • corpusName: testCorpus1

   • URL:

     wget "https://hoyo.zeetix.com:5101/gate/v0/corpus/withName?corpusName=testCorpus1"
     

4. Add the loaded document to the corpus

   • Endpoint: corpus

   • operation: addDocument

   • parameters:

     • corpusName: testCorpus1
     • documentName: %2Fhome%2Ftms%2Fbackend%2Ftests%2Ftest_classes%2FBackendServices%2FGateService%2FinputData%2FgatePipelineTest_sample.html

   • URL:

     wget "https://hoyo.zeetix.com:5101/gate/v0/corpus/addDocument?corpusName=testCorpus1&documentName=%2Fhome%2Ftms%2Fbackend%2Ftests%2Ftest_classes%2FBackendServices%2FGateService%2FinputData%2FgatePipelineTest_sample.html"
     

5. Create a pipeline

   • Endpoint: pipeline

   • operation: withName

   • parameters:

     • pipelineName: testPipeline1

   • URL:

     wget "https://hoyo.zeetix.com:5101/gate/v0/pipeline/withName?pipelineName=testPipeline1"
     

6. Load the "AnnotationDeletePR" processing resource

   • Endpoint: pr

   • operation: withPR

   • parameters:

     • prName: anndeletePR
     • resourcePath=gate.creole.annotdelete.AnnotationDeletePR

   • URL:

     wget "https://hoyo.zeetix.com:5101/gate/v0/pr/withPR?prName=anndeletePR&resourcePath=gate.creole.annotdelete.AnnotationDeletePR"
     

7. Load the "DefaultTokenizer" processing resource

   • Endpoint: pr

   • operation: withPR

   • parameters:

     • prName: defToken
     • resourcePath=gate.creole.tokeniser.DefaultTokeniser

   • URL:

     wget "https://hoyo.zeetix.com:5101/gate/v0/pr/withPR?prName=defToken&resourcePath=gate.creole.tokeniser.DefaultTokeniser"
     

8. Set the corpus of the pipeline

   • Endpoint: pipeline

   • operation: corpusSet

   • parameters:

     • pipelineName: testPipeline1
     • corpusName: testCorpus1

   • URL:

     wget "https://hoyo.zeetix.com:5101/gate/v0/pipeline/corpusSet?pipelineName=testPipeline1&corpusName=testCorpus1"
     

9. Add the "AnnotationDeletePR" to the pipeline

   • Endpoint: pipeline

   • operation: prAdd

   • parameters:

     • pipelineName: testPipeline1
     • prName: anndeletePR

   • URL:

     wget "https://hoyo.zeetix.com:5101/gate/v0/pipeline/prAdd?pipelineName=testPipeline1&prName=anndeletePR"
     

10. Add the DefaultTokenizer" to the pipeline

    • Endpoint: pipeline

    • operation: prAdd

    • parameters:

      • pipelineName: testPipeline1
      • prName: defToken

    • URL:

      wget "https://hoyo.zeetix.com:5101/gate/v0/pipeline/prAdd?pipelineName=testPipeline1&prName=defToken"
      

11. Configure the setsToKeep parameter of "AnnotationDeletePR"

    • Endpoint: pipeline

    • operation: parameterValueSet

    • parameters:

      • pipelineName: testPipeline1
      • prName: anndeletePR
      • parameterName: setsToKeep
      • parameterValue: Key%2CTarget
      • parameterType: List%3CString%3E

    • URL:

      wget "https://hoyo.zeetix.com:5101/gate/v0/pipeline/parameterValueSet?pipelineName=testPipeline1&prName=anndeletePR&parameterName=setsToKeep&parameterValue=Key%2CTarget&parameterType=List%3CString%3E"
      

12. Run the pipeline

    • Endpoint: pipeline

    • operation: run

    • parameters:

      • pipelineName: testPipeline1

    • URL:

      wget "https://hoyo.zeetix.com:5101/gate/v0/pipeline/run?pipelineName=testPipeline1"
      

13. Get the annotations from the document

    • Endpoint: document

    • operation: annotations

    • parameters:

      • documentName: %2Fhome%2Ftms%2Fbackend%2Ftests%2Ftest_classes%2FBackendServices%2FGateService%2FinputData%2FgatePipelineTest_sample.html

    • URL:

      wget "https://hoyo.zeetix.com:5101/gate/v0/document/annotations?documentName=%2Fhome%2Ftms%2Fbackend%2Ftests%2Ftest_classes%2FBackendServices%2FGateService%2FinputData%2FgatePipelineTest_sample.html"
      

14. Cleanup gate daemon (gated)

    • Endpoint: cleanup

    • operation: na

    • parameters: na

    • URL:

      wget "https://hoyo.zeetix.com:5101/gate/v0/cleanup"
      

15. Reset shared state

    • Endpoint: resetSharedState

    • operation: na

    • parameters: na

    • URL:

      wget "https://hoyo.zeetix.com:5101/gate/v0/resetSharedState"