NlpRequest

NLP request for Media Assistant v2, based on the General API request.

See the semantic tagging guide for an example of using an NLP request to obtain tags.

The API is intended for analysis of typical newspaper articles, not books.
Requests larger than 500 KB are rejected.
Even smaller documents may time out if they contain many entities.
If your use case involves large articles, please contact us.

Fields

Property	Required	Type	Description
id	True	string	Unique identifier of the article
title	False	string	Title or subject of the article; mutually exclusive with paraSpecs
lead	False	string	Lead or abstract of the article; mutually exclusive with paraSpecs
text	False	string	Main text or body of the article; mutually exclusive with paraSpecs
paraSpecs	False	List[ParaSpec]	Paragraph specifications; mutually exclusive with title, lead, and text
domicile	False	string	Location part of the dateline indicating the origin, e.g., Paris, France
analyses	False	List[string]	[option] Analyses to return; default: all
language	False	string	[option] ISO 639-1 language code of the article; auto-detection is used if omitted. See supported languages.
langDetectPrior	False	string	[option] Language detection prior, e.g., de,en. See supported priors.
presentationLanguage	False	string	[option] Presentation language of the results in ISO 639-1 format, e.g., fr. See details.
categories	False	List[Category]	[option] Categories (and entities) of the article
referenceDate	False	string	[option] Reference date/time for the analysis; accepts: NOW – current date and time yyyy-mm-dd – date only, GMT timezone, e.g., 2024-06-21 ISO date-time – as accepted by java.time.format.DateTimeFormatter.ISO_DATE_TIME's parse method, e.g., 2024-06-21T10:15:30 or 2024-06-21T10:15:30+01:00 Any other or invalid value is treated as NOW.
returnMentions	False	boolean	[option] Whether to return entity/tag/relation mentions; default: false. See the mentions guide.
returnItemSentiment	False	boolean	[option] Whether to return sentiment for entities, mentions, tags, relations, etc.; default: false
returnGkbProperties	False	boolean	[option] Whether to return GKB properties for entities/tags; default: false
metadata	False	Map[string, string]	Additional metadata as key-value pairs, e.g., {"author": "John Smith", "url": "https://example.com/abc" }
recommendation	False	Recommendation	Recommendation info for the article.