# Entity

- [JSON representation](https://docs.cloud.google.com/natural-language/docs/reference/rest/v1beta2/Entity#SCHEMA_REPRESENTATION)
- [Type](https://docs.cloud.google.com/natural-language/docs/reference/rest/v1beta2/Entity#Type)
- [EntityMention](https://docs.cloud.google.com/natural-language/docs/reference/rest/v1beta2/Entity#EntityMention)
  - [JSON representation](https://docs.cloud.google.com/natural-language/docs/reference/rest/v1beta2/Entity#EntityMention.SCHEMA_REPRESENTATION)
- [Type](https://docs.cloud.google.com/natural-language/docs/reference/rest/v1beta2/Entity#Type_1)

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 salience and mentions, with entities.

| JSON representation |
|---|
| ``` { "name": string, "type": enum (`https://docs.cloud.google.com/natural-language/docs/reference/rest/v1beta2/Entity#Type`), "metadata": { string: string, ... }, "salience": number, "mentions": [ { object (`https://docs.cloud.google.com/natural-language/docs/reference/rest/v1beta2/Entity#EntityMention`) } ], "sentiment": { object (`https://docs.cloud.google.com/natural-language/docs/reference/rest/v1beta2/Sentiment`) } } ``` |

| Fields ||
|---|---|
| `name` | `string` The representative name for the entity. |
| `type` | ``enum (`https://docs.cloud.google.com/natural-language/docs/reference/rest/v1beta2/Entity#Type`)`` The entity type. |
| `metadata` | `map (key: string, value: string)` Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. |
| `salience` | `number` The salience score associated with the entity in the \[0, 1.0\] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. |
| `mentions[]` | ``object (`https://docs.cloud.google.com/natural-language/docs/reference/rest/v1beta2/Entity#EntityMention`)`` The mentions of this entity in the input document. The API currently supports proper noun mentions. |
| `sentiment` | ``object (`https://docs.cloud.google.com/natural-language/docs/reference/rest/v1beta2/Sentiment`)`` For calls to `AnalyzeEntitySentimentRequest` or if `https://docs.cloud.google.com/natural-language/docs/reference/rest/v1beta2/documents/annotateText#Features.FIELDS.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. For most entity types, the associated metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`). 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 (`https://docs.cloud.google.com/natural-language/docs/reference/rest/v1beta2/TextSpan`) }, "type": enum (`https://docs.cloud.google.com/natural-language/docs/reference/rest/v1beta2/Entity#Type_1`), "sentiment": { object (`https://docs.cloud.google.com/natural-language/docs/reference/rest/v1beta2/Sentiment`) } } ``` |

| Fields ||
|---|---|
| `text` | ``object (`https://docs.cloud.google.com/natural-language/docs/reference/rest/v1beta2/TextSpan`)`` The mention text. |
| `type` | ``enum (`https://docs.cloud.google.com/natural-language/docs/reference/rest/v1beta2/Entity#Type_1`)`` The type of the entity mention. |
| `sentiment` | ``object (`https://docs.cloud.google.com/natural-language/docs/reference/rest/v1beta2/Sentiment`)`` For calls to `AnalyzeEntitySentimentRequest` or if `https://docs.cloud.google.com/natural-language/docs/reference/rest/v1beta2/documents/annotateText#Features.FIELDS.extract_entity_sentiment` is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document. |

## Type

The supported types of mentions.

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