Interface EntityOrBuilder (2.30.0)

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
NameDescription
keyString
Returns
TypeDescription
boolean

getDisplayName()

public abstract String getDisplayName()

The representative name for the entity.

string display_name = 1;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

The representative name for the entity.

string display_name = 1;

Returns
TypeDescription
ByteString

The bytes for displayName.

getMetadata()

public abstract Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
SentimentDataOrBuilder

getType()

public abstract Entity.Type getType()

The entity type.

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

Returns
TypeDescription
Entity.Type

The type.

getTypeValue()

public abstract int getTypeValue()

The entity type.

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

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

Whether the sentiment field is set.