Entity

Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as probability and mentions, with entities.

JSON representation 
{
  "name": string,
  "type": enum (Type),
  "metadata": {
    string: string,
    ...
  },
  "mentions": [
    {
      object (EntityMention)
    }
  ],
  "sentiment": {
    object (Sentiment)
  }
}
Fields
name

string

The representative name for the entity.
type

enum (Type)

The entity type.
metadata

map (key: string, value: string)

Metadata associated with the entity.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
mentions[]

object (EntityMention)

The mentions of this entity in the input document. The API currently supports proper noun mentions.
sentiment

object (Sentiment)

For calls to [AnalyzeEntitySentiment][] or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.

Type

The type of the entity. The table below lists the associated fields for entities that have different metadata.

Enums
UNKNOWN Unknown
PERSON Person
LOCATION Location
ORGANIZATION Organization
EVENT Event
WORK_OF_ART Artwork
CONSUMER_GOOD Consumer product
OTHER Other types of entities
PHONE_NUMBER

Phone number

The metadata lists the phone number, formatted according to local convention, plus whichever additional elements appear in the text:

  • number - the actual number, broken down into sections as per local convention
  • national_prefix - country code, if detected
  • area_code - region or area code, if detected
  • extension - phone extension (to be dialed after connection), if detected
ADDRESS

Address

The metadata identifies the street number and locality plus whichever additional elements appear in the text:

  • street_number - street number
  • locality - city or town
  • street_name - street/route name, if detected
  • postal_code - postal code, if detected
  • country - country, if detected
  • broad_region - administrative area, such as the state, if detected
  • narrow_region - smaller administrative area, such as county, if detected
  • sublocality - used in Asian addresses to demark a district within a city, if detected
DATE

Date

The metadata identifies the components of the date:

  • year - four digit year, if detected
  • month - two digit month number, if detected
  • day - two digit day number, if detected
NUMBER

Number

The metadata is the number itself.
PRICE

Price

The metadata identifies the value and currency.

EntityMention

Represents a mention for an entity in the text. Currently, proper noun mentions are supported.

JSON representation 
{
  "text": {
    object (TextSpan)
  },
  "type": enum (Type),
  "sentiment": {
    object (Sentiment)
  },
  "probability": number
}
Fields
text

object (TextSpan)

The mention text.
type

enum (Type)

The type of the entity mention.
sentiment

object (Sentiment)

For calls to [AnalyzeEntitySentiment][] or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document.
probability

number

Probability score associated with the entity.

The score shows the probability of the entity mention being the entity type. The score is in (0, 1] range.

Type

The supported types of mentions.

Enums
TYPE_UNKNOWN Unknown
PROPER Proper name
COMMON Common noun (or noun compound)