Recommender API Schema - RecommendResponseSuccessBody

Abstract

Schemata for the Recommender API Calls

This schema is used for the response from the recommend endpoint to a successfully completed recommend call.

message*[...]
count[...]
total[...]
result[...]
    [Recommendation]
        [Explanation]
            [MinimalScoredConcept]

Note

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

The success response from the recommend endpoint.

Parameter	Type	Description	Details
`message*`	string	A short descriptive message with the results of the operation.	example: Recommendations returned successfully
`count`	integer	Number of recommendations returned on the current page.	example: 6
`total`	integer	The total number of recommendations.	example: 457
`result`	list of Recommendation objects	A list of recommendations returned for the input text.	Contains `Recommendation` which uses `Explanation` which then uses `MinimalScoredConcept`.

A single recommendation containing the following parameters:

Parameter	Type	Description	Details
`id`	string	Identifier of the particular document.	example: https://en.wikipedia.org/wiki/Lorem_ipsum
`title`	string	Title of the recommendation.	example: Lorem ipsum
`description`	string	Text body of the recommended item.	example: Lorem ipsum is a placeholder text commonly used to demonstrate the visual form of a document or a typeface without relying on meaningful content.
`link`	string	Link to the recommended item.	example: https://en.wikipedia.org/wiki/Lorem_ipsum
`date`	string	Publication date of the document.	example: 2017-07-21T17:32:28Z
`author`	string	Author of the document.	example: Thomas Bernhard
`concepts`	lists/arrays	Concepts contained in the particular document.	example: A list [ "https://en.wikipedia.org/wiki/Lorem_ipsum", "https://en.wikipedia.org/wiki/Lorem_ipsum2" ]
`explanation`	lists/arrays	Explanation for particular recommendation.	Contains `MinimalScoredConcept`

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

The MinimalScoredConcept is required for matchingConcepts 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: