Skip to main content

How to Use the Extraction Service

24/03/2026

We now enter into the use of one of the main functionalities of the PoolParty Extractor, the extract service.

Note

Whenever you make changes to your PoolParty Thesaurus project, you have to first refresh the extraction model before executing the extractor again.

The method name is 'extract' and here we use these parameters:

  • 'text' to provide the text we wish to annotate.

  • 'projectId' to specify the ID of the PoolParty project we want to use for extraction.

  • 'language' to define the language that should be used for extraction. If no language is given then the language will be detected from the text and that will be used as extraction language.

  • The parameter 'numberOfTerms' defines the number of free terms we want to get back (set here to '0' to focus on the concept annotations).

Example Request

{{url}}/extractor/api/extract?text=A Spritz Veneziano also called just Spritz or just Veneziano, is an Italian wine-based cocktail, commonly served as an aperitif in northeast Italy. The drink originated in Venice while it was part of the Austrian Empire, and is based on the Austrian Spritzer, a combination of equal parts white wine and soda water.&projectId={{project}}&language=en&numberOfTerms=0

The following result will be produced: