A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call.
HTTP request
POST https://language.googleapis.com/v1/documents:annotateText
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. |
features |
Required. The enabled features. |
encodingType |
The encoding type used by the API to calculate offsets. |
Response body
The text annotations response message.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "sentences": [ { object ( |
Fields | |
---|---|
sentences[] |
Sentences in the input document. Populated if the user enables |
tokens[] |
Tokens, along with their syntactic information, in the input document. Populated if the user enables |
entities[] |
Entities, along with their semantic information, in the input document. Populated if the user enables |
documentSentiment |
The overall sentiment for the document. Populated if the user enables |
language |
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 |
categories[] |
Categories identified in the input document. |
moderationCategories[] |
Harmful and sensitive categories identified in the input document. |
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.
Features
All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input.
JSON representation |
---|
{
"extractSyntax": boolean,
"extractEntities": boolean,
"extractDocumentSentiment": boolean,
"extractEntitySentiment": boolean,
"classifyText": boolean,
"moderateText": boolean,
"classificationModelOptions": {
object ( |
Fields | |
---|---|
extractSyntax |
Extract syntax information. |
extractEntities |
Extract entities. |
extractDocumentSentiment |
Extract document-level sentiment. |
extractEntitySentiment |
Extract entities and their associated sentiment. |
classifyText |
Classify the full document into categories. |
moderateText |
Moderate the document for harmful and sensitive categories. |
classificationModelOptions |
The model options to use for classification. Defaults to v1 options if not specified. Only used if |