Google Cloud Contact Center Insights V1 Client - Class Entity (1.6.2)

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

Namespace

Google \ Cloud \ ContactCenterInsights \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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.

Returns
TypeDescription
string

setDisplayName

The representative name for the entity.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getType

The entity type.

Returns
TypeDescription
int

setType

The entity type.

Parameter
NameDescription
var int
Returns
TypeDescription
$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.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

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.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var float
Returns
TypeDescription
$this

getSentiment

The aggregate sentiment expressed for this entity in the conversation.

Returns
TypeDescription
Google\Cloud\ContactCenterInsights\V1\SentimentData|null

hasSentiment

clearSentiment

setSentiment

The aggregate sentiment expressed for this entity in the conversation.

Parameter
NameDescription
var Google\Cloud\ContactCenterInsights\V1\SentimentData
Returns
TypeDescription
$this