Method: documents.annotateText

A convenience method that provides all features in one call.

HTTP request

POST https://language.googleapis.com/v2/documents:annotateText

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

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

object (Document)

Required. Input document.
features

object (Features)

Required. The enabled features.
encodingType

enum (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 (Sentence)
    }
  ],
  "entities": [
    {
      object (Entity)
    }
  ],
  "documentSentiment": {
    object (Sentiment)
  },
  "languageCode": string,
  "categories": [
    {
      object (ClassificationCategory)
    }
  ],
  "moderationCategories": [
    {
      object (ClassificationCategory)
    }
  ],
  "languageSupported": boolean
}
Fields
sentences[]

object (Sentence)

Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.
entities[]

object (Entity)

Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities or AnnotateTextRequest.Features.extract_entity_sentiment.
documentSentiment

object (Sentiment)

The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.
languageCode

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.
categories[]

object (ClassificationCategory)

Categories identified in the input document.
moderationCategories[]

object (ClassificationCategory)

Harmful and sensitive categories identified in the input document.
languageSupported

boolean

Whether the language is officially supported by all requested features. 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.

Features

All available features. Setting each one to true will enable that specific analysis for the input.

JSON representation 
{
  "extractEntities": boolean,
  "extractDocumentSentiment": boolean,
  "classifyText": boolean,
  "moderateText": boolean
}
Fields
extractEntities

boolean

Optional. Extract entities.
extractDocumentSentiment

boolean

Optional. Extract document-level sentiment.
classifyText

boolean

Optional. Classify the full document into categories.
moderateText

boolean

Optional. Moderate the document for harmful and sensitive categories.