Method: documents.analyzeEntities

Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.

HTTP request

POST https://language.googleapis.com/v1beta2/documents:analyzeEntities

The URL uses Google API HTTP annotation syntax.

Request body

The request body contains data with the following structure:

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

object(Document)

Input document.

encodingType

enum(EncodingType)

The encoding type used by the API to calculate offsets.

Response body

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

The entity analysis response message.

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

object(Entity)

The recognized entities in the input document.

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 Auth Guide.

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Natural Language API
Need help? Visit our support page.