Class Entity (1.4.3)

Version 1.4.3

• 1.17.3 (latest)
• 1.17.2
• 1.16.0
• 1.15.0
• 1.14.1
• 1.13.0
• 1.12.0
• 1.11.1
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.0
• 1.4.5
• 1.3.2
• 1.2.1
• 1.1.0
• 1.0.0
• 0.6.1
• 0.5.0
• 0.4.0
• 0.3.1
• 0.2.0
• 0.1.1

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

The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.

Attributes

Name	Description
display_name	str The representative name for the entity.
type_	google.cloud.contact_center_insights_v1.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.
sentiment	google.cloud.contact_center_insights_v1.types.SentimentData The aggregate sentiment expressed for this entity in the conversation.

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.