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 ( |
Fields | |
---|---|
name |
The representative name for the entity. |
type |
The entity type. |
metadata |
Metadata associated with the entity. For the metadata associated with other entity types, see the Type table below. An object containing a list of |
mentions[] |
The mentions of this entity in the input document. The API currently supports proper noun mentions. |
sentiment |
For calls to [AnalyzeEntitySentiment][] or if |
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:
|
ADDRESS |
Address The metadata identifies the street number and locality plus whichever additional elements appear in the text:
|
DATE |
Date The metadata identifies the components of the date:
|
NUMBER |
Number The metadata is the number itself. |
PRICE |
Price The metadata identifies the |
EntityMention
Represents a mention for an entity in the text. Currently, proper noun mentions are supported.
JSON representation |
---|
{ "text": { object ( |
Fields | |
---|---|
text |
The mention text. |
type |
The type of the entity mention. |
sentiment |
For calls to [AnalyzeEntitySentiment][] or if |
probability |
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) |