Class Entity (2.4.1) 

publicfinalclass EntityextendsGeneratedMessageV3implementsEntityOrBuilder

Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as salience and mentions, with entities.

Protobuf type google.cloud.language.v1beta2.Entity

Implements

EntityOrBuilder

Inherited Members

Static Fields

MENTIONS_FIELD_NUMBER

publicstaticfinalintMENTIONS_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

publicstaticfinalintMETADATA_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

publicstaticfinalintNAME_FIELD_NUMBER
Field Value
Type Description
int

SALIENCE_FIELD_NUMBER

publicstaticfinalintSALIENCE_FIELD_NUMBER
Field Value
Type Description
int

SENTIMENT_FIELD_NUMBER

publicstaticfinalintSENTIMENT_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

publicstaticfinalintTYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticEntitygetDefaultInstance()
Returns
Type Description
Entity

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticEntity.BuildernewBuilder()
Returns
Type Description
Entity.Builder

newBuilder(Entity prototype)

publicstaticEntity.BuildernewBuilder(Entityprototype)
Parameter
Name Description
prototype Entity
Returns
Type Description
Entity.Builder

parseDelimitedFrom(InputStream input)

publicstaticEntityparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Entity
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticEntityparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticEntityparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticEntityparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticEntityparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticEntityparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticEntityparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Entity
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticEntityparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticEntityparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Entity
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticEntityparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticEntityparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticEntityparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Entity
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<Entity>parser()
Returns
Type Description
Parser<Entity>

Methods

containsMetadata(String key)

publicbooleancontainsMetadata(Stringkey)

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)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

publicEntitygetDefaultInstanceForType()
Returns
Type Description
Entity

getMentions(int index)

publicEntityMentiongetMentions(intindex)

The mentions of this entity in the input document. The API currently supports proper noun mentions.

repeated .google.cloud.language.v1beta2.EntityMention mentions = 5;

Parameter
Name Description
index int
Returns
Type Description
EntityMention

getMentionsCount()

publicintgetMentionsCount()

The mentions of this entity in the input document. The API currently supports proper noun mentions.

repeated .google.cloud.language.v1beta2.EntityMention mentions = 5;

Returns
Type Description
int

getMentionsList()

publicList<EntityMention>getMentionsList()

The mentions of this entity in the input document. The API currently supports proper noun mentions.

repeated .google.cloud.language.v1beta2.EntityMention mentions = 5;

Returns
Type Description
List<EntityMention>

getMentionsOrBuilder(int index)

publicEntityMentionOrBuildergetMentionsOrBuilder(intindex)

The mentions of this entity in the input document. The API currently supports proper noun mentions.

repeated .google.cloud.language.v1beta2.EntityMention mentions = 5;

Parameter
Name Description
index int
Returns
Type Description
EntityMentionOrBuilder

getMentionsOrBuilderList()

publicList<?extendsEntityMentionOrBuilder>getMentionsOrBuilderList()

The mentions of this entity in the input document. The API currently supports proper noun mentions.

repeated .google.cloud.language.v1beta2.EntityMention mentions = 5;

Returns
Type Description
List<? extends com.google.cloud.language.v1beta2.EntityMentionOrBuilder>

getMetadata()

publicMap<String,String>getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
Map<String,String>

getMetadataCount()

publicintgetMetadataCount()

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()

publicMap<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)

publicStringgetMetadataOrDefault(Stringkey,StringdefaultValue)

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)

publicStringgetMetadataOrThrow(Stringkey)

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

getName()

publicStringgetName()

The representative name for the entity.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

publicByteStringgetNameBytes()

The representative name for the entity.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSalience()

publicfloatgetSalience()

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()

publicSentimentgetSentiment()

For calls to [AnalyzeEntitySentiment][] or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.

.google.cloud.language.v1beta2.Sentiment sentiment = 6;

Returns
Type Description
Sentiment

The sentiment.

getSentimentOrBuilder()

publicSentimentOrBuildergetSentimentOrBuilder()

For calls to [AnalyzeEntitySentiment][] or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.

.google.cloud.language.v1beta2.Sentiment sentiment = 6;

Returns
Type Description
SentimentOrBuilder

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getType()

publicEntity.TypegetType()

The entity type.

.google.cloud.language.v1beta2.Entity.Type type = 2;

Returns
Type Description
Entity.Type

The type.

getTypeValue()

publicintgetTypeValue()

The entity type.

.google.cloud.language.v1beta2.Entity.Type type = 2;

Returns
Type Description
int

The enum numeric value on the wire for type.

getUnknownFields()

publicfinalUnknownFieldSetgetUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hasSentiment()

publicbooleanhasSentiment()

For calls to [AnalyzeEntitySentiment][] or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.

.google.cloud.language.v1beta2.Sentiment sentiment = 6;

Returns
Type Description
boolean

Whether the sentiment field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protectedMapFieldinternalGetMapField(intnumber)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicEntity.BuildernewBuilderForType()
Returns
Type Description
Entity.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedEntity.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Entity.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicEntity.BuildertoBuilder()
Returns
Type Description
Entity.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException

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年10月30日 UTC.