Skip to main content

Web Service Method: Annotate and Store from URL

Abstract

Web Service Method: Annotate and Store from URL

Description

[url] Annotates the document from the url with extracted concepts and stores it in the remote repository.

URL: /extractor/api/annotate/store

Request

Supported Methods

POST

Content-Type

Content-Type: application/json

Response

This method returns execution results in JSON format.

HTTP Parameters

Parameter

Description

Type

Required

url

Url to document be annotated

String

true

language

Language of text (en|de|es|fr|...)

String

false

documentUri

Internal ID of the document

String

true

graphName

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

String

false

projectIds

Thesaurus projectIds

String

false

conceptSchemeFilters

Concept scheme filters

String

false

customClassFilters

Custom class filters

String

false

numberOfTerms

Number of terms to return

Integer

false

numberOfConcepts

Number of concepts to return

Integer

false

conceptMinimumScore

Minimum required score of concepts, default = 0

Double

false

useTransitiveBroaderConcepts

Retrieve transitive broader concepts of the extracted concepts, default = false

Boolean

false

useTransitiveBroaderTopConcepts

Retrieve transitive broader top concepts of the extracted concepts, default = false

Boolean

false

useRelatedConcepts

Retrieve related concepts of the extracted concepts, default = false

Boolean

false

disambiguate

Use thesaurus based disambiguation, default = false

boolean

false

useTypes

Retrieve the custom types for concepts, default = false

boolean

false

tfidfScoring

Use tfidf scoring, default = false

boolean

false

corpusScoring

Adapt the document scores with the corpus analysis. Enabled if corpusId (uuid) is provided, default = disabled

String

false

properties

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.

String

false

phraseLength

Phrase length, default = 4

Integer

false