Web Service Method: Tag Data and Store Result (async)

22/12/2025

Supported Methods

POST

Content Type

multipart/form-data

Attribute	Type	Required	Comment
`data`	Array of Part	true	One or more data parts, where each part is a separate document to tag
`params`	TaggerRequest	true	Specifies various parameters for the tagging process
`aggregate`	String	false	Aggregate results for each data part into a single result, 'true' or 'false', 'false' by default
`categorize`	String	false	Enable categorization, 'true' or 'false', 'false' by default
`graphName`	String	false	Graph name (IRI) where the result should be stored (if not specified, the default graph will be used)
`repositoryId`	String	false	Repository ID where the result should be stored (if not specified, a predefined repository will be used

Attribute	Type	Required	Comment
`categorizationWithPpxBoost`	boolean	false	Use Extractor boosting, default: false
	boolean	false	Categorization extraction, default: false
`conceptMinimumScore`	Double	false	Minimum required score of concepts, default: 0
`conceptSchemeFilters`	Array of String	false	Concept scheme URI filters
`corpusScoring`	Array of String	false	Corpus term scoring. Enabled if corpusIds (UUID) are provided.
`customAttributeFilters`	Array of CustomProperty	false	Custom attribute (property uri and string value) filters
`customClassFilters`	Array of String	false	Custom class URI filters
`disambiguate`	boolean	false	Use thesaurus based disambiguation, default: false
`displayText`	boolean	false	Include text extracted from url in response, default: false
`documentClassifierIds`	Array of String	false	Enable document classification by giving the document classifier IDs as input
`documentId`	String	false	Internal ID of the document, taken from documentUri
`extraConceptLanguages`	Array of PPLocale	false	Additional languages used for concept extraction (en\|de\|es\|fr\|...) Also supports wildcard * for all languages
`filterNestedConcepts`	boolean	false	Remove concepts matches which are contained within other matches, default: true
`language`	PPLocale	false	Extraction language (en\|de\|es\|fr\|...)
`lemmatization`	boolean	false	Use lemmatization, default: true
`nerParameters`	Array of NERConfig	false	Array of models that are used for Named Entity Recognition
`numberOfConcepts`	Integer	false	Retrieve number of concepts, default: 25
`numberOfTerms`	Integer	false	Retrieve number of terms, default: 0
`phraseLength`	Integer	false	Phrase length, default: 4
`projectId`	Array of String	false	Thesaurus projectIds
`properties`	Array of String	false	Array of custom class attributes and relations that will be fetched by providing their property URIs as input. Furthermore it supports `http://www.w3.org/1999/02/22-rdf-syntax-ns#type`. Set to `all` to fetch all properties.
`regexFilename`	String	false	File name for regex patterns
`shadowConceptCorpusId`	Array of String	false	Shadow concepts calculation. Enabled if corpusIds (UUID) are provided.
`showMatchingDetails`	boolean	false	Shows which concept labels where found inside the text, default: false
`showMatchingPosition`	boolean	false	Shows the position of the matched text. Only shown if showMatchingDetails = true. default: false
`tfidfScoring`	boolean	false	Use TFIDF scoring, default: false
`title`	String	false	Title of the document
`useRelatedConcepts`	boolean	false	Retrieve related concepts, default: false
`useTransitiveBroaderConcepts`	boolean	false	Retrieve transitive broader concepts, default: false
`useTransitiveBroaderTopConcepts`	boolean	false	Retrieve transitive broader top concepts, default: false
`useTypes`	boolean	false	Retrieve custom types for concepts, default: false

{
  "nerParameters" : [ {
    "classUri" : "some classUri",
    "method" : "RULE_BASED",
    "type" : "https://semantic-web.com/api/type#2130"
  }, {
    "classUri" : "some classUri",
    "method" : "MAXIMUM_ENTROPY",
    "type" : "https://semantic-web.com/api/type#20921"
  } ],
  "tfidfScoring" : true,
  "useTransitiveBroaderTopConcepts" : false,
  "language" : "cz",
  "phraseLength" : 75,
  "title" : "All about Chuck Norris",
  "numberOfTerms" : 28595,
  "conceptMinimumScore" : 0.7967598370459237,
  "customAttributeFilters" : [ {
    "property" : "https://semantic-web.com/api/property#29990",
    "value" : "some value"
  }, {
    "property" : "https://semantic-web.com/api/property#10496",
    "value" : "some value"
  } ],
  "corpusScoring" : [ "some corpusScoring" ],
  "useRelatedConcepts" : true,
  "customClassFilters" : [ "some customClassFilters", "some customClassFilters" ],
  "shadowConceptCorpusId" : [ "some shadowConceptCorpusId", "some shadowConceptCorpusId" ],
  "categorize" : true,
  "filterNestedConcepts" : false,
  "extraConceptLanguages" : [ "nl" ],
  "useTransitiveBroaderConcepts" : true,
  "displayText" : true,
  "regexFilename" : "some regexFilename",
  "categorizationWithPpxBoost" : false,
  "numberOfConcepts" : 20983,
  "disambiguate" : false,
  "showMatchingPosition" : false,
  "useTypes" : true,
  "documentClassifierIds" : [ "some documentClassifierIds" ],
  "conceptSchemeFilters" : [ "https://semantic-web.com/api/conceptSchemeFilters#22125" ],
  "documentId" : "corpusDocument:0ac32384-b3c2-4e62-8bcf-7ed4fd67b630",
  "lemmatization" : true,
  "projectId" : [ "some projectId", "some projectId" ],
  "properties" : [ "https://semantic-web.com/api/properties#18083", "https://semantic-web.com/api/properties#22061", "https://semantic-web.com/api/properties#27582" ],
  "showMatchingDetails" : true
}

Custom property

Attribute	Type	Required	Comment
`property`	String	false	property name
`value`	String	false	property value

Named Entity Recognition configuration

Attribute	Type	Required	Comment
`classUri`	String	false	Class URI given to identified Named Entities
`method`	NerMethod	false	Method used for Named Entity Extraction. Options are: (default) MAXIMUM_ENTROPY, RULE_BASED. One of `RULE_BASED` \| `MAXIMUM_ENTROPY`
`type`	String	false	Type of Named Entity Model. Pre-defined models for MAXIMUM_ENTROPY: person, organization, location

Content Type

application/json

A single TagSubmitResponse

Provides the ID of a created task.

Attribute	Type	Required	Comment
`status`	int	true	indicates the success or error of the HTTP request, on the protocol layer
`message`	String	false	short descriptive message of the operation result, or an error description
`success`	boolean	false	true if the operation was successful, on the application layer
`taskId`	String	false	the ID of the created task

In this section: