Recommender API Schema - Explanation

Abstract

Schemata for the Recommender API Calls

This schema is required for the explanation of a provided recommendation. The following parameters are used

totalScore[...]
matchingConcepts[...]
    [MinimalScoredConcept]

Note

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

Parameter	Type	Description	Details
`totalScore`	number	Score of the recommendation.	example: 44.5
`matchingConcepts`	lists/arrays	Matching concepts with score value.	Contains `MinimalScoredConcept`

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