NlpRequest

NLP request for Media Assistant v2, based on Geneea API v3

The API is intended for analysis of typical newspapers articles, not books. The API will reject any request larger than 500 KB. However, even analysis of smaller documents might time-out if they contain many entities. Please, get in touch with us, if your use case requires analysis of large articles.

Fields

Property	Required	Type	Description
id	True	string	Unique identifier of the document
title	False	string	The title or subject of the document, when available; mutually exclusive with the paraSpecs parameter
lead	False	string	The lead or abstract of the document, when available; mutually exclusive with the paraSpecs parameter
text	False	string	The main text or body of the document; mutually exclusive with the paraSpecs parameter
paraSpecs	False	List[ParaSpec]	The document paragraphs; mutually exclusive with title and text parameters
domicile	False	string	A domicile indicating the origin location of the document
analyses	False	List[string]	[option] What analysis to return. Default: all
language	False	string	[option] The language of the document as ISO 639-1; auto-detection will be used if omitted
langDetectPrior	False	string	[option] The language detection prior; e.g. de,en
presentationLanguage	False	string	[option] The presentation language of the results
categories	False	List[Category]	[option] The categories of the article
referenceDate	False	string	[option] Date to be used for the analysis as a reference, optionally with time; values: “NOW” or in ISO format
returnMentions	False	boolean	[option] Should entity/tag/relation mentions be returned? Default: false
returnItemSentiment	False	boolean	[option] Should entity/mention/tag/relation etc. sentiment be returned? Default: false
returnGkbProperties	False	boolean	[option] Should entity/tag GKB properties be returned? Default: false
metadata	False	object	Any additional metadata for the document, e.g. domicile or URL
recommendation	False	Recommendation	Recommendation info for the document