Skip to main content

Extract Concepts

POST /api/configurations/{configId}/extractConcepts 

Returns concepts extracted from an input text using the PoolParty Extractor.

Parameters

Name

In

Type

Required

Description

configId

path

integer(int23)

true

The ID of the configuration to use for concept extraction.

text

body

(raw)

string

false

The input text to extract concepts from.

Note

application/json is a mandatory content type for operations with a request body.

Example cURL Request
curl 'https://adf-dev.semantic-web.at/ADF/api/configurations/41/extractConcepts' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJfeXpPU1JLUkV5MWg2SFUyeDNYaG9EdXQyUEItRldZWmpVcTVqdF93UUpNIn0.eyJleHAiOjE3MDE5Njg1NTIsImlhdCI6MTcwMTk2ODI1MiwianRpIjoiMTgzNTQwOTktY2VjZi00NjFhLTk3ZWItMTEzMjdhMmI4OTNiIiwiaXNzIjoiaHR0cHM6Ly9sb2dpbi1pbnRlcm5hbC1ldS5wb29scGFydHkuYml6L2F1dGgvcmVhbG1zL3JkZm94LWludGVncmF0aW9uLnBvb2xwYXJ0eS5iaXoiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiMmY4N2RiZjYtZWExZC00OTc5LWE3YWYtNmEwZTExMTA0N2IyIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicHB0Iiwic2Vzc2lvbl9zdGF0ZSI6IjgzNGI2YTAzLTBmNTYtNDcwMC1hNWYyLTk5MmJhYmE0ZGMyZiIsImFsbG93ZWQtb3JpZ2lucyI6WyIqIl0sInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJvZmZsaW5lX2FjY2VzcyIsImxvY2FsLXVzZXIiLCJQb29sUGFydHlVc2VyIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLXJkZm94LWludGVncmF0aW9uLnBvb2xwYXJ0eS5iaXoiXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJzY29wZSI6Im9wZW5pZCBwcm9maWxlIGVtYWlsIiwic2lkIjoiODM0YjZhMDMtMGY1Ni00NzAwLWE1ZjItOTkyYmFiYTRkYzJmIiwiaXJpIjoiaHR0cHM6Ly9yZGZveC1pbnRlZ3JhdGlvbi5wb29scGFydHkuYml6L3VzZXIvMmY4N2RiZjYtZWExZC00OTc5LWE3YWYtNmEwZTExMTA0N2IyIiwidWlMYW5ndWFnZSI6ImVuIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJkaXNwbGF5TGFuZ3VhZ2VzIjpbIiJdLCJza29zVmlldyI6IkJBU0lDU0tPU1ZJRVciLCJuYW1lIjoiUFBJTCBUZXN0IFVzZXIiLCJncm91cHMiOlsiL3BwaWwiXSwidGltZVpvbmUiOiJFdXJvcGUvVmllbm5hIiwicHJlZmVycmVkX3VzZXJuYW1lIjoicHBpbCIsImdpdmVuX25hbWUiOiJQUElMIiwiYWNMYW5ndWFnZSI6ImVuIiwiZmFtaWx5X25hbWUiOiJUZXN0IFVzZXIifQ.n4Tj5jUGO2fa5j94GmENmyUG5AAlOk2M2G18YOok9yrTIUotx93bGrPJcWBXMN6lAoGg6e9-QUr_mogjb0rOmp4wnWsp_5Pom7xD_QJYQd0iCElanYO-OWKjJiLpvq27hA1o6ro2i-TGKTNUdlijzpWZNS0Q7wy65Eq3QcKrRC7tW4JYU3_idQpmyrQ48hz-uWZD6BcrrjGXy5-33cW-0HkxoCstzalFXTFQ5aNEEhAZw9IvDEDb3dAprz6bik9WdI7SAgfYCwNuUWN9zb3a6ojbhg4RIp1Eugss-Wgl728rz1jQK43ECD9O4wZ73un3_nA8ArFAyMTrMtc7W8QrgQ'
--data '{
"text":"General Account AUM (GA AUM) is used by MetLife to describe assets in its general account (GA) investment portfolio that are actively managed and stated at estimated fair value. GA AUM is comprised of the GA total investments, the portion of GA investment portfolio classified within assets held-for-sale, and cash and cash equivalents, excluding policy loans, contract-holder-directed equity securities, fair value option securities and certain other invested assets, as substantially all of these assets are not actively managed in MetLife’s GA investment portfolio. Mortgage loans (including commercial, agricultural and residential) and real estate and real estate joint ventures included in GA AUM (at net asset value, net of deduction for encumbering debt) have been adjusted from carrying value to estimated fair value. Classification of GA AUM by sector is based on the nature and characteristics of the underlying investments, which can vary from how they are classified under GAAP."
}'
Example Body
{"text":"General Account AUM (GA AUM) is used by MetLife to describe assets in its general account (GA) investment portfolio that are actively managed and stated at estimated fair value. GA AUM is comprised of the GA total investments, the portion of GA investment portfolio classified within assets held-for-sale, and cash and cash equivalents, excluding policy loans, contract-holder-directed equity securities, fair value option securities and certain other invested assets, as substantially all of these assets are not actively managed in MetLife’s GA investment portfolio. Mortgage loans (including commercial, agricultural and residential) and real estate and real estate joint ventures included in GA AUM (at net asset value, net of deduction for encumbering debt) have been adjusted from carrying value to estimated fair value. Classification of GA AUM by sector is based on the nature and characteristics of the underlying investments, which can vary from how they are classified under GAAP."}

Responses

Status

Meaning

Description

200

OK 

List of extracted concepts

201

Created 

Created

401

Unauthorized 

Unauthorized

403

Forbidden 

Forbidden

404

Not Found 

Not Found

200 Response Example
200 Response Schema

Name

Type

Required

Description

concepts

array

false

An array of objects, each representing a single concept extracted from the provided input text.

» id

string

false

The ID of the extracted concept.

» uri

string

false

The URI of the extracted concept.

» prefLabels

object

false

An object with preferred labels of the extracted concept by language.

» matchingLabels

array

false

An array of objects, each representing a single label of the extracted concept (preferred, alternative or hidden) that has been matched against the input text.

» » label

integer(int32)

false

The label that has been matched.

» » predicate

string

false

The predicate name of the matched label (preferred, alternative or hidden).

» » language

string

false

The language of the matched label.

» » frequency

array

false

The number of occurrences of the matched label in the input text.

» » matchedTexts

string

false

An array of objects, each representing a text fragment matching the label.

» » » matchedText

string

false

The matched text fragment.

» » » frequency

array

false

The count how many times the text fragment has been matched.

» » » position

string

false

An array of objects, each representing a single position at which the text was matched.

» » » » beginningIndex

integer(int32)

false

The index of the first character of the matched text fragment. The indexing starts at 0.

» » » » endIndex

integer(int32)

false

The index of the last character of the matched text fragment.

detectedLanguage

string

false

The language of extraction.

message

string

false

A message informing on the success of the operation.

In this section: