Class Entity (2.5.1)

Version 2.5.1

• 2.13.3 (latest)
• 2.13.2
• 2.12.0
• 2.11.0
• 2.10.1
• 2.9.1
• 2.8.1
• 2.7.0
• 2.6.1
• 2.5.2
• 2.4.3
• 2.3.2
• 2.2.2
• 2.1.0
• 2.0.0
• 1.3.2

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_	google.cloud.language_v1beta2.types.Entity.Type The entity type.
metadata	Mapping[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	Sequence[google.cloud.language_v1beta2.types.EntityMention] The mentions of this entity in the input document. The API currently supports proper noun mentions.
sentiment	google.cloud.language_v1beta2.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.

Inheritance

builtins.object > proto.message.Message > Entity

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.