Reference documentation and code samples for the Google Cloud Contact Center Insights V1 Client 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.
Generated from protobuf message google.cloud.contactcenterinsights.v1.Entity
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ display_name
string
The representative name for the entity.
↳ type
int
The entity type.
↳ metadata
array| Google\Protobuf\Internal\MapField
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\ContactCenterInsights\V1\SentimentData
The aggregate sentiment expressed for this entity in the conversation.
getDisplayName
The representative name for the entity.
string
setDisplayName
The representative name for the entity.
var
string
$this
getType
The entity type.
int
setType
The entity type.
var
int
$this
getMetadata
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.
setMetadata
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.
$this
getSalience
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.
float
setSalience
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.
var
float
$this
getSentiment
The aggregate sentiment expressed for this entity in the conversation.
hasSentiment
clearSentiment
setSentiment
The aggregate sentiment expressed for this entity in the conversation.
$this
