Class Entity (2.28.0)
2.93.0 (latest)
2.91.0
2.88.0
2.87.0
2.85.0
2.83.0
2.82.0
2.81.0
2.80.0
2.78.0
2.76.0
2.75.0
2.74.0
2.73.0
2.72.0
2.70.0
2.68.0
2.67.0
2.64.0
2.63.0
2.62.0
2.60.0
2.59.0
2.58.0
2.57.0
2.56.0
2.55.0
2.54.0
2.53.0
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 final class Entity extends GeneratedMessageV3 implements EntityOrBuilder
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.
Protobuf type google.cloud.contactcenterinsights.v1.Entity
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int
public static final int SALIENCE_FIELD_NUMBER
Field Value
Type Description
int
public static final int SENTIMENT_FIELD_NUMBER
Field Value
Type Description
int
public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static Entity getDefaultInstance ()
Returns
Type Description
Entity
public static final Descriptors . Descriptor getDescriptor ()
public static Entity . Builder newBuilder ()
public static Entity . Builder newBuilder ( Entity prototype )
Parameter
Name Description
prototypeEntity
public static Entity parseDelimitedFrom ( InputStream input )
Returns
Type Description
Entity
public static Entity parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Entity
public static Entity parseFrom ( byte [] data )
Parameter
Name Description
databyte []
Returns
Type Description
Entity
public static Entity parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Entity
public static Entity parseFrom ( ByteString data )
Returns
Type Description
Entity
public static Entity parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Entity
public static Entity parseFrom ( CodedInputStream input )
Returns
Type Description
Entity
public static Entity parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Entity
public static Entity parseFrom ( InputStream input )
Returns
Type Description
Entity
public static Entity parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Entity
public static Entity parseFrom ( ByteBuffer data )
Returns
Type Description
Entity
public static Entity parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Entity
public static Parser<Entity> parser ()
Methods
public 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
keyString
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
public Entity getDefaultInstanceForType ()
Returns
Type Description
Entity
public String getDisplayName ()
The representative name for the entity.
string display_name = 1;
Returns
Type Description
String The displayName.
public ByteString getDisplayNameBytes ()
The representative name for the entity.
string display_name = 1;
Returns
Type Description
ByteString The bytes for displayName.
public Map<String , String > getMetadata ()
public 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
public 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;
public 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;
Returns
Type Description
String
public 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
keyString
Returns
Type Description
String
public Parser<Entity> getParserForType ()
Overrides
public 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.
public SentimentData getSentiment ()
The aggregate sentiment expressed for this entity in the conversation.
.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;
public SentimentDataOrBuilder getSentimentOrBuilder ()
The aggregate sentiment expressed for this entity in the conversation.
.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;
public int getSerializedSize ()
Returns
Type Description
int
Overrides
public Entity . Type getType ()
The entity type.
.google.cloud.contactcenterinsights.v1.Entity.Type type = 2;
public 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.
public 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.
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
protected MapField internalGetMapField ( int number )
Parameter
Name Description
numberint
Overrides
public final boolean isInitialized ()
Overrides
public Entity . Builder newBuilderForType ()
protected Entity . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public Entity . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-06-19 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-06-19 UTC."],[],[]]
