Analyzes the sentiment of the provided text.
HTTP request
POST https://language.googleapis.com/v2/documents:analyzeSentiment
The URL uses gRPC Transcoding syntax.
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "document": { object ( |
Fields | |
---|---|
document |
Required. Input document. |
encodingType |
The encoding type used by the API to calculate sentence offsets. |
Response body
The sentiment analysis response message.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "documentSentiment": { object ( |
Fields | |
---|---|
documentSentiment |
The overall sentiment of the input document. |
languageCode |
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 |
sentences[] |
The sentiment for all the sentences in the document. |
languageSupported |
Whether the language is officially supported. The API may still return a response when the language is not supported, but it is on a best effort basis. |
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.