Recommender API Schema - MatchedText

Abstract

Schemata for the Recommender API Calls

Text fragments matching the label along with their positions.

message*[...]
matchedText[...]
frequency[...]
positions[...]
  [TokenPosition]

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

The response from the extract endpoint containing all concepts found on the basis of the input text and parameters.

Parameter	Type	Description	Details
`matchedText`	string	Text which was matched.	example: fox
`frequency`	integer	Frequency how often the particular text fragment was matched in the text.	example: 3
`positions`	list of TokenPosition objects	All positions where this fragment of text was matched in the input text.	contains `TokenPosition`

Parameter

Type

Description

Details

matchedText

string

Text which was matched.

example:

fox

frequency

integer

Frequency how often the particular text fragment was matched in the text.

example:

positions

list of TokenPosition objects

All positions where this fragment of text was matched in the input text.

contains TokenPosition

All positions where the particular fragment of text was matched in the input text.

Parameter	Type	Description	Details
`beginIndex`	integer	Begin index of the particular match.	example: 15
`endIndex`	integer	End index of the particular match.	example: 18

Parameter

Type

Description

Details

beginIndex

integer

Begin index of the particular match.

example:

endIndex

integer

End index of the particular match.

example:

In this section: