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
Description
name
str
The representative name for the entity.
type_
metadata
Sequence[ google.cloud.language_v1.types.Entity.MetadataEntry
]
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
Sequence[ 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.
Parameters
Name
Description
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.
