Class Entity (2.21.0) 

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Entity

Implements

EntityOrBuilder

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

SALIENCE_FIELD_NUMBER

public static final int SALIENCE_FIELD_NUMBER
Field Value
Type Description
int

SENTIMENT_FIELD_NUMBER

public static final int SENTIMENT_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Entity getDefaultInstance()
Returns
Type Description
Entity

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Entity.Builder newBuilder()
Returns
Type Description
Entity.Builder

newBuilder(Entity prototype)

public static Entity.Builder newBuilder(Entity prototype)
Parameter
Name Description
prototype Entity
Returns
Type Description
Entity.Builder

parseDelimitedFrom(InputStream input)

public static Entity parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Entity
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Entity parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Entity parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Entity parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Entity parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Entity
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Entity parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Entity
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Entity parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Entity parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Entity> parser()
Returns
Type Description
Parser<Entity>

Methods

containsMetadata(String key)

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
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Entity getDefaultInstanceForType()
Returns
Type Description
Entity

getDisplayName()

public String getDisplayName()

The representative name for the entity.

string display_name = 1;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The representative name for the entity.

string display_name = 1;

Returns
Type Description
ByteString

The bytes for displayName.

getMetadata()

public Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
Map<String,String>

getMetadataCount()

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

getMetadataMap()

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;

Returns
Type Description
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

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;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getMetadataOrThrow(String key)

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
key String
Returns
Type Description
String

getParserForType()

public Parser<Entity> getParserForType()
Returns
Type Description
Parser<Entity>
Overrides

getSalience()

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.

getSentiment()

public SentimentData getSentiment()

The aggregate sentiment expressed for this entity in the conversation.

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

Returns
Type Description
SentimentData

The sentiment.

getSentimentOrBuilder()

public SentimentDataOrBuilder getSentimentOrBuilder()

The aggregate sentiment expressed for this entity in the conversation.

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

Returns
Type Description
SentimentDataOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getType()

public Entity.Type getType()

The entity type.

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

Returns
Type Description
Entity.Type

The type.

getTypeValue()

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.

hasSentiment()

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Entity.Builder newBuilderForType()
Returns
Type Description
Entity.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Entity.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Entity.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Entity.Builder toBuilder()
Returns
Type Description
Entity.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException