Analysis

The response object returned by the Media API NLP analysis.

The response is identical to the output of the general G3 API. For a full specification, refer to the Response API reference and the G3 guide.

For a Media API-specific example, see the semantic tagging guide.

Fields

Property	Required	Type	Description
id	False	string	Identifier of the analyzed document, as submitted in the request.
language	True	Language	Detected language of the document and the language used for the analysis.
paragraphs	False	List[Paragraph]	Document's paragraphs. Returned when the NlpRequest includes returnMentions = true.
entities	False	List[Entity]	Named and unnamed entities found in the document. Returned when the requested analyses include entities, relations, or all.
tags	False	List[Tag]	Semantic content tags relevant to the document. Returned when tags or all are specified in the requested analyses.
relations	False	List[Relation]	Relations extracted from the document. Returned when relations or all are requested in analyses.
docSentiment	False	Sentiment	Overall sentiment of the document. Returned when sentiment or all is requested in analyses.
itemSentiments	False	Map[string, Sentiment]	Sentiment scores for individual items (entities, tags, relations, mentions, sentences, etc.) by ID. Returned when sentiment or all is requested and returnItemSentiment = true in the NlpRequest.
docVectors	False	List[Vector]	Vector representations for the full document. This is an optional feature—contact us to enable it.
itemVectors	False	Map[string, List[Vector]]	Vector representations for items (entities, tags, relations, mentions, sentences, etc.) by ID. This is an optional feature–contact us to enable it.
usedChars	True	integer	Number of characters charged for the request.