com.google.cloud.contactcenterinsights.v1

Interface EntityOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Entity, Entity.Builder

public interface EntityOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsMetadata(String key) Metadata associated with the entity.
String	getDisplayName() The representative name for the entity.
com.google.protobuf.ByteString	getDisplayNameBytes() The representative name for the entity.
Map<String,String>	getMetadata() Deprecated.
int	getMetadataCount() Metadata associated with the entity.
Map<String,String>	getMetadataMap() Metadata associated with the entity.
String	getMetadataOrDefault(String key, String defaultValue) Metadata associated with the entity.
String	getMetadataOrThrow(String key) Metadata associated with the entity.
float	getSalience() The salience score associated with the entity in the [0, 1.0] range.
SentimentData	getSentiment() The aggregate sentiment expressed for this entity in the conversation.
SentimentDataOrBuilder	getSentimentOrBuilder() The aggregate sentiment expressed for this entity in the conversation.
Entity.Type	getType() The entity type.
int	getTypeValue() The entity type.
boolean	hasSentiment() The aggregate sentiment expressed for this entity in the conversation.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getDisplayName

String getDisplayName()

 The representative name for the entity.
 

string display_name = 1;

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 The representative name for the entity.
 

string display_name = 1;

Returns:

The bytes for displayName.

getTypeValue

int getTypeValue()

 The entity type.
 

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

Returns:

The enum numeric value on the wire for type.

getType

Entity.Type getType()

 The entity type.
 

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

Returns:

The type.

getMetadataCount

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;

containsMetadata

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;

getMetadata

@Deprecated
Map<String,String> getMetadata()

Deprecated.

Use getMetadataMap() instead.

getMetadataMap

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;

getMetadataOrDefault

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;

getMetadataOrThrow

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;

getSalience

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:

The salience.

hasSentiment

boolean hasSentiment()

 The aggregate sentiment expressed for this entity in the conversation.
 

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

Returns:

Whether the sentiment field is set.

getSentiment

SentimentData getSentiment()

 The aggregate sentiment expressed for this entity in the conversation.
 

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

Returns:

The sentiment.

getSentimentOrBuilder

SentimentDataOrBuilder getSentimentOrBuilder()

 The aggregate sentiment expressed for this entity in the conversation.
 

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