Contact Center AI Insights v1 API - Class Entity (2.13.0)

public sealed class Entity : IMessage<Entity>, IEquatable<Entity>, IDeepCloneable<Entity>, IBufferMessage, IMessage

Reference documentation and code samples for the Contact Center AI Insights v1 API class Entity.

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.

Inheritance

object > Entity

Implements

IMessage Entity, IEquatable Entity, IDeepCloneable Entity, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.ContactCenterInsights.V1

Assembly

Google.Cloud.ContactCenterInsights.V1.dll

Constructors

Entity()

public Entity()

Entity(Entity)

public Entity(Entity other)

Parameter
Name	Description
`other`	`Entity`

Properties

DisplayName

public string DisplayName { get; set; }

The representative name for the entity.

Property Value
Type	Description
`string`

Metadata

public MapField<string, string> Metadata { get; }

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.

Property Value
Type	Description
`MapFieldstringstring`

Salience

public float Salience { get; set; }

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.

Property Value
Type	Description
`float`

Sentiment

public SentimentData Sentiment { get; set; }

The aggregate sentiment expressed for this entity in the conversation.

Property Value
Type	Description
`SentimentData`

Type

public Entity.Types.Type Type { get; set; }

The entity type.

Property Value
Type	Description
`EntityTypesType`