Analysis
The response of Media API NLP analysis. The object returned by Media API NLP analysis is identical to the response of General API. See the G3 Response API reference and the guide for more details.
Fields
| Property | Required | Type | Description |
|---|---|---|---|
| id | False | string | Identifier of the analyzed document, as submitted in the request |
| language | True | Language | Document and analysis language |
| paragraphs | False | List[Paragraph] | The paragraphs this document consists of. Returned when NlpRequest specifies returnMentions = true |
| entities | False | List[Entity] | Found named and unnamed entities in the document. Returned when analyses contains entities, relations or all |
| tags | False | List[Tag] | Semantic content tags relevant for the document. Returned when tags or all are among the requested analyses. |
| relations | False | List[Relation] | Relations in the document. Returned when relations or all are among the requested analyses. |
| docSentiment | False | Sentiment | Sentiment of the whole document. Returned when sentiment or all are among the requested analyses. |
| itemSentiments | False | Map[string, Sentiment] | Sentiment of entities, tags, relations, mentions, sentences, etc. by their ID. Returned when sentiment or all are among the requested analyses and returnItemSentiment = true in NlpRequest. |
| docVectors | False | List[Vector] | Vectors for the whole document. Talk to us to have this information returned. |
| itemVectors | False | Map[string, List[Vector]] | Vectors for entities, tags, relations, mentions, sentences, etc. by their ID. Talk to us to have this information returned. |
| usedChars | True | integer | The number of characters charged for the request |