Response
Represents the output of a Media API NLP analysis. The structure is identical to the General API response. See the G3 Response API reference and the guide for 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] | Paragraphs the document consists of; returned when NlpRequest specifies returnMentions = true |
| entities | False | List[Entity] | Named and unnamed entities found in the document; returned when analyses contains entities, relations or all |
| tags | False | List[Tag] | Semantic content tags relevant to the document; returned when tags or all are among the requested analyses |
| relations | False | List[Relation] | Relations found in the document; returned when relations or all are among the requested analyses |
| docSentiment | False | Sentiment | Sentiment of the entire 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 entire document; contact us to have this information returned |
| itemVectors | False | Map[string, List[Vector]] | Vectors for entities, tags, relations, mentions, sentences, etc., by their ID; contact us to have this information returned |
| usedChars | True | integer | Number of characters charged for the request |