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
Static Fields
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
public static final int METADATA_FIELD_NUMBER
Field Value
public static final int SALIENCE_FIELD_NUMBER
Field Value
public static final int SENTIMENT_FIELD_NUMBER
Field Value
public static final int TYPE_FIELD_NUMBER
Field Value
Static Methods
public static Entity getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static Entity.Builder newBuilder()
Returns
public static Entity.Builder newBuilder(Entity prototype)
Parameter
| Name | Description |
| prototype | Entity
|
Returns
public static Entity parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Entity parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Entity parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static Entity parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Entity parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static Entity parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Entity parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Entity parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Entity parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Entity parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Entity parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static Entity parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<Entity> parser()
Returns
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;
public boolean equals(Object obj)
Parameter
Returns
Overrides
public Entity getDefaultInstanceForType()
Returns
public String getDisplayName()
The representative name for the entity.
string display_name = 1;
| Type | Description |
| String | The displayName.
|
public ByteString getDisplayNameBytes()
The representative name for the entity.
string display_name = 1;
| Type | Description |
| ByteString | The bytes for displayName.
|
public Map<String,String> getMetadata()
Returns
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;
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;
public Parser<Entity> getParserForType()
Returns
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;
| 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
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;
| Type | Description |
| int | The enum numeric value on the wire for type.
|
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public boolean hasSentiment()
The aggregate sentiment expressed for this entity in the conversation.
.google.cloud.contactcenterinsights.v1.SentimentData sentiment = 5;
| Type | Description |
| boolean | Whether the sentiment field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public Entity.Builder newBuilderForType()
Returns
protected Entity.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public Entity.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
