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

Attributes
NameDescription
strname
The representative name for the entity.
google.cloud.language_v1beta2.types.Entity.Typetype_
The entity type.
Sequence[google.cloud.language_v1beta2.types.Entity.MetadataEntry]metadata
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.
floatsalience
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.
Sequence[google.cloud.language_v1beta2.types.EntityMention]mentions
The mentions of this entity in the input document. The API currently supports proper noun mentions.
google.cloud.language_v1beta2.types.Sentimentsentiment
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.

Inheritance

builtins.object > proto.message.Message > Entity

Classes

MetadataEntry

MetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

API documentation for language_v1beta2.types.Entity.MetadataEntry class.

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.