Entity
(
mapping
=
None
,
*
,
ignore_unknown_fields
=
False
,
**
kwargs
)
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.
Attributes
name
str
The representative name for the entity.
type_
metadata
MutableMapping[str, str]
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.salience
float
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
MutableSequence[ google.cloud.language_v1.types.EntityMention
]
The mentions of this entity in the input document. The API currently supports proper noun mentions.
sentiment
google.cloud.language_v1.types.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.
Classes
MetadataEntry
MetadataEntry
(
mapping
=
None
,
*
,
ignore_unknown_fields
=
False
,
**
kwargs
)
The abstract base class for a message.
kwargs
dict
Keys and values corresponding to the fields of the message.
mapping
Union[dict, .Message
]
A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if mapping
is a mapping type or there are keyword parameters.
Type
Type
(
value
)
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.
Values: UNKNOWN (0): Unknown PERSON (1): Person LOCATION (2): Location ORGANIZATION (3): Organization EVENT (4): Event WORK_OF_ART (5): Artwork CONSUMER_GOOD (6): Consumer product OTHER (7): Other types of entities PHONE_NUMBER (9): 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 (10):
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 (11):
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 (12):
Number
The metadata is the number itself.
PRICE (13):
Price
The metadata identifies the `value` and `currency`.
