Method: documents.analyzeEntitySentiment

Finds entities, similar to documents.analyzeEntities in the text and analyzes sentiment associated with each entity and its mentions.

HTTP request

POST https://language.googleapis.com/v1/documents:analyzeEntitySentiment

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "document": {
    object (Document)
  },
  "encodingType": enum (EncodingType)
}
Fields
document

object (Document)

Required. Input document.
encodingType

enum (EncodingType)

The encoding type used by the API to calculate offsets.

Response body

The entity-level sentiment analysis response message.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "entities": [
    {
      object (Entity)
    }
  ],
  "language": string
}
Fields
entities[]

object (Entity)

The recognized entities in the input document with associated sentiments.
language

string

The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-language
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.