Interface EntityOrBuilder (2.5.0)

Version 2.5.0

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.10
• 2.2.7

public interface EntityOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsMetadata(String key)

public abstract boolean containsMetadata(String key)

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.

map<string, string> metadata = 3;

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

getDisplayName()

public abstract String getDisplayName()

The representative name for the entity.

string display_name = 1;

Returns

Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

The representative name for the entity.

string display_name = 1;

Returns

Type	Description
ByteString	The bytes for displayName.

getMetadata()

public abstract Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns

Type	Description
Map<String,String>

getMetadataCount()

public abstract int getMetadataCount()

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.

map<string, string> metadata = 3;

Returns

Type	Description
int

getMetadataMap()

public abstract Map<String,String> getMetadataMap()

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.

map<string, string> metadata = 3;

Returns

Type	Description
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public abstract String getMetadataOrDefault(String key, String defaultValue)

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.

map<string, string> metadata = 3;

Parameters

Name	Description
key	String
defaultValue	String

Returns

Type	Description
String

getMetadataOrThrow(String key)

public abstract String getMetadataOrThrow(String key)

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.

map<string, string> metadata = 3;

Parameter

Name	Description
key	String

Returns

Type	Description
String

getSalience()

public abstract float 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 salience = 4;

Returns

Type	Description
float	The salience.

getSentiment()

public abstract SentimentData getSentiment()

The aggregate sentiment expressed for this entity in the conversation.

.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;

Returns

Type	Description
SentimentData	The sentiment.

getSentimentOrBuilder()

public abstract SentimentDataOrBuilder getSentimentOrBuilder()

The aggregate sentiment expressed for this entity in the conversation.

.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;

Returns

Type	Description
SentimentDataOrBuilder

getType()

public abstract Entity.Type getType()

The entity type.

.google.cloud.contactcenterinsights.v1.Entity.Type type = 2;

Returns

Type	Description
Entity.Type	The type.

getTypeValue()

public abstract int getTypeValue()

The entity type.

.google.cloud.contactcenterinsights.v1.Entity.Type type = 2;

Returns

Type	Description
int	The enum numeric value on the wire for type.

hasSentiment()

public abstract boolean hasSentiment()

The aggregate sentiment expressed for this entity in the conversation.

.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;

Returns

Type	Description
boolean	Whether the sentiment field is set.