GetEntities

Definition

Returns a list of all the names identified from the text along with its relatedness score to the overall context of the text and its type.

Parameter	Description
calk	A string containing the api key
text	A string representing the text to process. (use either text or url)
lang optional	A string representing the text language (ISO 639-1 language codes). If not specified, the system will detect the language. (see supported languages document)
format optional	The format of the response. The supported formats are “xml” and “json”. Default: “xml”
timestamp generated	A datetime added automatically by the API client helper. This parameter is added automatically by the API client helper.
signature generated	The request signed using the secret key. This parameter is added automatically by the API client helper.

Attribute	Description
method	Indicates the method name
status	Indicates the status of the response. Possible values “OK” and “ERROR”
error	Indicates an error if one occurred
errorNo	Indicates the error number if error occurred
errorMessage	Indicates the error message if error occurred
quota	Indicates the number of remaining calls for this CALK for Today
lang	Indicates the language of the text (ISO 639-1 language codes)
entities
token	Entity text ex: Hudson River
origToken	Entity text in original language
type	Entity type text ex: Location and Natural Formation
entityID	Entity reference number in Magnet’s semantic network
conceptID	Entity/Concept reference number in Magnet’s semantic network
wikiID	Wikipedia URL (if available)
score	Entity score in the document
rank	Entity rank with respect to document (VR: Very Related, R: Related, SR: Somewhat Related, NR: Not Related)