Skip to main content

Web Service Method: Expand a Query List of Concepts or Terms

Abstract

Web Service Method: Expand a Query List of Concepts or Terms

Description

Semantically and linguistically expands a query containing a list of terms or concepts.

URL: /extractor/api/expand

Request

Supported Methods

POST

GET

Content-Type

application/x-www-form-urlencoded

HTTP Parameters

Parameter

Type

Required

Description

concepts

Array of String

false

List of concept URIs

customProperties

Array of String

false

A list of custom properties to include in the result.

includeCustomClasses

boolean

false

Include custom classes

languages

Array of String

true

Language tags

levelsTransitiveBroaderConcepts

int

false

Levels of broader concepts

levelsTransitiveNarrowerConcepts

int

false

Levels of narrower concepts

linguisticExpansion

boolean

false

Use linguistic expansion

matchingMethod

String

false

Matching method to use for the search term (standard, ignore or exact).

projectId

String

false

ProjectId

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.

semanticExpansion

boolean

false

Use semantic expansion.

terms

Array of String

false

List of terms.

useRelatedConcepts

boolean

false

Include related concepts.

Response

This method returns execution results in JSON format.

SearchResponse

Search result

Attribute

Type

Comment

concepts

Array of SearchConceptResponse

A list of concepts that match the given search term and language.

language

String

Language off the term. Only present if there is a request without a project ID (i.e. only expansion).

linguisticExpansion

Array of String

List of terms. Only present if there is a request without a project ID (i.e. only expansion).

request

String

The URI or search term.

type

String

Type (term or concept) of the result.