Method: documents.analyzeEntities

HTTP request
Request body
- JSON representation
Response body
- JSON representation
Authorization scopes
Try it!

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

HTTP request

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

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

Fields
`document`	`object ( Document )` Required. Input document.
`encoding Type`	`enum ( EncodingType )` The encoding type used by the API to calculate offsets.

document

object ( Document )

Required. Input document.

encoding  
Type

enum ( EncodingType )

The encoding type used by the API to calculate offsets.

Response body

The entity analysis response message.

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

JSON representation
{ "entities" : [ { object ( `Entity` ) } ] , "languageCode" : string , "languageSupported" : boolean }

Fields

Fields
`entities[]`	`object ( Entity )` The recognized entities in the input document.
`language Code`	`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.
`language Supported`	`boolean` 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.

entities[]

object ( Entity )

The recognized entities in the input document.

language  
Code

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.

language  
Supported

boolean

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 .