Send feedback
Class Entity (2.21.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.21.0 keyboard_arrow_down
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)
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 ()
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 )
public static Entity parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static Entity parseFrom ( byte [] data )
Parameter Name Description databyte []
public static Entity parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static Entity parseFrom ( ByteString data )
public static Entity parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Entity parseFrom ( CodedInputStream input )
public static Entity parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Entity parseFrom ( InputStream input )
public static Entity parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static Entity parseFrom ( ByteBuffer data )
public static Entity parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
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 ()
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;
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
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 )
Overrides
public Entity . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
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 2025-02-14 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-14 UTC."],[],[]]
