Recommender API Schema - ExtractRequestBody

Abstract

Schemata for the Recommender API Calls

All the information required for an extraction of concepts.

searchSpaceId*[...]
input*[...]
locale[...]
conceptSchemeFilters[...]
conceptMinScore[...]
corpusIds[...]
maxNumberOfConcepts[...]
customClassFilters[...]
filterNestedConcepts[...]
useCorpusScoring[...]
useShadowConcepts[...]
useDisambiguation[...]
showMatchingInformation[...]

Note

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

Parameter	Type	Description	Details
`searchSpaceId*`	string	Search space identifier.	maxLength: maximum string length in Java minLength: 1 example: 123abc4d-a123-1a2b-ab12-123a456b789
`input*`	string	Input text for which the recommendations are to be obtained. May not be blank (requires a minimum of one non-whitespace character).	maxLength: 2147483647 minLength: 1 example: A quick brown fox jumps over a lazy dog.
`locale`	string	Search language.	maxLength: 2 minLength: 2 example: en
`conceptSchemeFilters`	string	Concept schemes to filter for.	example: ["http://poolparty.biz/drinks/Red_Wine_and_Rose"]
`conceptMinScore`	number	The required minimum score for any matching concept to be extracted.	minimum: 0 exclusiveMinimum: false example: 10
`corpusIds`	string	List of corpora to be used. Enables corpus scoring, if provided. Note that corpus IDs require the prefix "corpus:".	example: ["corpus:45a7a28e-7b38-4af8-bbbf-67305d6e1cf7"]
`maxNumberOfConcepts`	integer	The maximum number of concepts to be returned.	minimum: 1 example: 15
`customClassFilters`	string	Custom classes to filter for.
`filterNestedConcepts`	boolean	Removes concept matches which are contained within other matches.
`useCorpusScoring`	boolean	Calculates corpus score for extracted concepts. Requires corpusIds to be specified.
`useShadowConcepts`	boolean	Calculates and includes shadow concepts. Requires corpusIds to be specified.
`useDisambiguation`	boolean	Uses thesaurus based disambiguation.
`showMatchingInformation`	boolean	Shows where concepts were found inside the input text.

In this section: