Skip to main content

Web Service Method: Annotate and Store from Text

Abstract

Web Service Method: Annotate and Store from Text

Description

[text] Returns the document annotated with extracted concepts and extracted terms in RDF/XML representation.

URL: /extractor/api/annotate/store/text

Request

Supported Methods

POST

Content-Type

Content-Type: application/json

HTTP Parameter

Parameter

Type

Required

Comment

categorizationWithPpxBoost

boolean

false

Use Extractor boosting, default = false

categorize

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

documentUri

String

true

URI of annotated document, used as ID

extractorVersion

String

false

Version of PPX Extractor used

filterNestedConcepts

boolean

false

Remove concepts matches which are contained within other matches, default = true

findPersonNames

boolean

false

Deprecated (use nerParameters) - extracts person names from the given text

graphName

String

false

The name of the graph in the remote repository the PPX results gets written to

language

String

false

Extraction language (en|de|es|fr|...)

lemmatization

boolean

false

Use lemmatization, default = true

locationExtraction

boolean

false

Deprecated (use nerParameters) - extracts locations from the given text

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 = 25

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

repositoryId

String

false

handle of the target repository to access, defaults to configured property 'remote.repositoryid'

resultFilterSparql

String

false

Specify an optional SPARQL query for filtering the RDF result

sentimentAnalysis

boolean

false

Sentiment analysis, default: false

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

text

String

true

Text of the document

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

Example
{
  "nerParameters" : [ {
    "method" : "RULE_BASED",
    "type" : "https://semantic-web.com/api/type#26656"
  }, {
    "method" : "RULE_BASED",
    "type" : "https://semantic-web.com/api/type#24840"
  } ],
  "tfidfScoring" : true,
  "useTransitiveBroaderTopConcepts" : false,
  "language" : "fr",
  "title" : "All about Chuck Norris",
  "numberOfTerms" : 29907,
  "resultFilterSparql" : "some resultFilterSparql",
  "findPersonNames" : false,
  "conceptMinimumScore" : 0.6875532724352691,
  "customAttributeFilters" : [ {
    "property" : "https://semantic-web.com/api/property#14358",
    "value" : "some value"
  }, {
    "property" : "https://semantic-web.com/api/property#2572",
    "value" : "some value"
  } ],
  "corpusScoring" : [ "some corpusScoring", "some corpusScoring" ],
  "locationExtraction" : true,
  "useRelatedConcepts" : false,
  "customClassFilters" : [ "some customClassFilters", "some customClassFilters" ],
  "text" : "some text",
  "shadowConceptCorpusId" : [ "some shadowConceptCorpusId", "some shadowConceptCorpusId", "some shadowConceptCorpusId" ],
  "categorize" : false,
  "filterNestedConcepts" : false,
  "useTransitiveBroaderConcepts" : false,
  "displayText" : true,
  "regexFilename" : "some regexFilename",
  "categorizationWithPpxBoost" : false,
  "documentUri" : "some documentUri",
  "numberOfConcepts" : 32518,
  "disambiguate" : true,
  "showMatchingPosition" : true,
  "graphName" : "some graphName",
  "extractorVersion" : "6.0.1",
  "sentimentAnalysis" : false,
  "useTypes" : false,
  "documentClassifierIds" : [ "some documentClassifierIds" ],
  "repositoryId" : "1DF1343D-0570-0001-FAAF-149079206440",
  "conceptSchemeFilters" : [ "https://semantic-web.com/api/conceptSchemeFilters#29423", "https://semantic-web.com/api/conceptSchemeFilters#2556", "https://semantic-web.com/api/conceptSchemeFilters#31614" ],
  "documentId" : "corpusDocument:0ac32384-b3c2-4e62-8bcf-7ed4fd67b630",
  "lemmatization" : false,
  "projectId" : [ "some projectId" ],
  "properties" : [ "https://semantic-web.com/api/properties#5962", "https://semantic-web.com/api/properties#2227" ],
  "showMatchingDetails" : true
}
ResponseContent Type

text/plain