Recommender API Schema - ExpandResponseSuccessBody

Abstract

Schemata for the Recommender API Calls

The response from the expand endpoint.

message*[...]
expandedConcepts[...]
    [ExpandedConcept]

Note

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

The response from the expand endpoint.

Parameter	Type	Description	Details
`message*`	string	Short descriptive message informing of operation outcome.	example: Expansion successful
`expandedConcepts`	list of strings	List with expanded concepts. These concepts are the results of running an expansion query and are based on concepts extracted from the input text.

Parameter

Type

Description

Details

message*

string

Short descriptive message informing of operation outcome.

example:

Expansion successful

expandedConcepts

list of strings

List with expanded concepts. These concepts are the results of running an expansion query and are based on concepts extracted from the input text.

Expanded concepts are the outcome of running an expansion query and are based on the concepts extracted from the input text. This is the semantic footprint.

Parameter	Type	Description	Details
`label`	string	Label of the particular concept.	example: Dog
`uri`	string	URI of the particular concept.	example: http://id.nlm.nih.gov/mesh/2016/D005589
`score`	number	Relevance score calculated for the particular concept in relation to the input text.	`maximum`: 100 `exclusiveMaximum`: false `minimum`: 0 `exclusiveMinimum`: false example 13.8

Parameter

Type

Description

Details

label

string

Label of the particular concept.

example:

Dog

uri

string

URI of the particular concept.

example:

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

score

number

Relevance score calculated for the particular concept in relation to the input text.

maximum: 100

exclusiveMaximum: false

minimum: 0

exclusiveMinimum: false

example

13.8

In this section: