Web Service Method: Annotate from Text using JSON

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

POST

CASE_INSENSITIVE_ORDER

Comparator

false

hash

int

false

serialPersistentFields

Array of ObjectStreamField

false

serialVersionUID

long

false

value

Array of char

false

SC_ACCEPTED

int

false

SC_BAD_GATEWAY

int

false

SC_BAD_REQUEST

int

false

SC_CONFLICT

int

false

SC_CONTINUE

int

false

SC_CREATED

int

false

SC_EXPECTATION_FAILED

int

false

SC_FORBIDDEN

int

false

SC_FOUND

int

false

SC_GATEWAY_TIMEOUT

int

false

SC_GONE

int

false

SC_HTTP_VERSION_NOT_SUPPORTED

int

false

SC_INTERNAL_SERVER_ERROR

int

false

SC_LENGTH_REQUIRED

int

false

SC_METHOD_NOT_ALLOWED

int

false

SC_MOVED_PERMANENTLY

int

false

SC_MOVED_TEMPORARILY

int

false

SC_MULTIPLE_CHOICES

int

false

SC_NON_AUTHORITATIVE_INFORMATION

int

false

SC_NOT_ACCEPTABLE

int

false

SC_NOT_FOUND

int

false

SC_NOT_IMPLEMENTED

int

false

SC_NOT_MODIFIED

int

false

SC_NO_CONTENT

int

false

SC_OK

int

false

SC_PARTIAL_CONTENT

int

false

SC_PAYMENT_REQUIRED

int

false

SC_PRECONDITION_FAILED

int

false

SC_PROXY_AUTHENTICATION_REQUIRED

int

false

SC_REQUESTED_RANGE_NOT_SATISFIABLE

int

false

SC_REQUEST_ENTITY_TOO_LARGE

int

false

SC_REQUEST_TIMEOUT

int

false

SC_REQUEST_URI_TOO_LONG

int

false

SC_RESET_CONTENT

int

false

SC_SEE_OTHER

int

false

SC_SERVICE_UNAVAILABLE

int

false

SC_SWITCHING_PROTOCOLS

int

false

SC_TEMPORARY_REDIRECT

int

false

SC_UNAUTHORIZED

int

false

SC_UNSUPPORTED_MEDIA_TYPE

int

false

SC_USE_PROXY

int

false

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

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.

Set to all to fetch all properties.

regexFilename

String

false

File name for regex patterns

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

field

Field

false

name

String

false

offset

int

false

signature

String

false

type

Class

false

unshared

boolean

false