Recommender API Schema - ExpandRequestBody

Abstract

Schemata for the Recommender API Calls

This schema contains all information required for an expansion.

searchSpaceId*[...]
concepts*[...]
    [MinimalScoredConcept]
expansionQuery*[...]
mayNumberOfConcepts*[...]

An asterisk (*) next to a parameter indicates a mandatory parameter.

All information required for an expansion call.

Parameter	Type	Description	Details
`searchSpaceId*`	string	Search space identifier used for determining the project on which the expansion query is to run.	example: 123abc4d-a123-1a2b-ab12-123a456b789
`concepts*`	list of strings	List of concepts to be inserted into the expansion query.	contains `MinimalScoredConcept` `maxItems`: 2147483647 `minItems`: 1
`expansionQuery*`	string	SPARQL query to expand the detected concepts and create a semantic footprint.	`maxLength`: 2147483647 `minLength`: 1
`maxNumberOfConcepts*`	integer	The maximum number of concepts to be returned by the expansion call; only used when the provided.	example: 25 `minimum`: 1

A concept only containing minimal information; it can be used for instance in expansion.

Parameter	Type	Description	Details
`uri*`	string	URI of the concept.	example: http://id.nlm.nih.gov/mesh/2016/D005589
`score*`	number	Relevance score of the concept.	example: 15.248

Parameter

Type

Description

Details

uri*

string

URI of the concept.

example:

http://id.nlm.nih.gov/mesh/2016/D005589

score*

number

Relevance score of the concept.

example:

15.248

In this section: