ProcessDocument Method

ProcessDocument

Definition

Is a shortcut method that returns all of the results from the main 4 methods (GetSummary, GetCategories, GetKeyTopics, GetEntities) in a single transaction call. Please note that this call = 4 calls x number of MGQs.

Request Parameters

POST https://nlp.klangoo.com/Service.svc/ProcessDocument

Parameter	Description
calk	A string containing the api key
text	A string representing the text to process
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.

 

Response

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
document
properties
lang	Indicates the language of the text (ISO 639-1 language codes)
summary	Generated summary for the text provided
keyTopics	Generated key topics for the text provided
text	The text of each topic
score	The score of this topic in the provided text
words	The words in the topic
token	The word text
conceptID	The word concept reference number in Magnet’s semantic network
entities
token	Entity text in English 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)
categories	Categories of the document as identified by Magnet
name	Magnet category text: General, Business, Law Enforcement, Entertainment, Health, Politics, Science, Sports, Technology

Try it in the Code Generator