Recommender API Schema - RecommendRequestBody

Abstract

Schemata for the Recommender API Calls

This schema contains all the details needed for a recommendation.

searchSpaceId*[...]
locale[...]
input[...]
concepts
    [MinimalScoredConcept]
page[...]
size[...]

Note

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

The success response from the recommend endpoint.

Parameter	Type	Description	Details
`searchSpaceId*`	string	Indentifier of the selected searchspace.	example: 123abc4d-a123-1a2b-ab12-123a456b789
`locale`	string	Locale used in the search.	`maxLength: 2` `minLength: 2` example: en
`input`	string	Input text for which you want to receive recommendations.	example: One of the ongoing puzzles of the COVID-19 pandemic is understanding the causes and risk factors for Long COVID. A study funded by several NIH institutes found that previous infection with OC43, a coronavirus that causes the common cold, may increase the risk for Long COVID.
`concepts`	lists/arrays	List of concepts used for recommendation.	Contains `MinimalScoredConcept`
`page`	integer	Page number for pagination.	`minimum: 0`
`size`	integer	Page size for pagination.	`maximum: 100` `minimum: 1`

The MinimalScoredConcept is required for concepts and is a concept only containing minimal information which 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: