public final class Entity extends GeneratedMessageV3 implements EntityOrBuilder
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.v1.Entity
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
MENTIONS_FIELD_NUMBER
public static final int MENTIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int METADATA_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Entity.Builder newBuilder()
newBuilder(Entity prototype)
public static Entity.Builder newBuilder(Entity prototype)
| Parameter |
|---|
| Name | Description |
prototype | Entity
|
public static Entity parseDelimitedFrom(InputStream input)
public static Entity parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Entity parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Entity parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Entity parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
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)
parseFrom(ByteBuffer data)
public static Entity parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Entity parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
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 |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public Entity getDefaultInstanceForType()
getMentions(int index)
public EntityMention getMentions(int index)
The mentions of this entity in the input document. The API currently
supports proper noun mentions.
repeated .google.cloud.language.v1.EntityMention mentions = 5;
| Parameter |
|---|
| Name | Description |
index | int
|
getMentionsCount()
public int getMentionsCount()
The mentions of this entity in the input document. The API currently
supports proper noun mentions.
repeated .google.cloud.language.v1.EntityMention mentions = 5;
| Returns |
|---|
| Type | Description |
int | |
getMentionsList()
public List<EntityMention> getMentionsList()
The mentions of this entity in the input document. The API currently
supports proper noun mentions.
repeated .google.cloud.language.v1.EntityMention mentions = 5;
getMentionsOrBuilder(int index)
public EntityMentionOrBuilder getMentionsOrBuilder(int index)
The mentions of this entity in the input document. The API currently
supports proper noun mentions.
repeated .google.cloud.language.v1.EntityMention mentions = 5;
| Parameter |
|---|
| Name | Description |
index | int
|
getMentionsOrBuilderList()
public List<? extends EntityMentionOrBuilder> getMentionsOrBuilderList()
The mentions of this entity in the input document. The API currently
supports proper noun mentions.
repeated .google.cloud.language.v1.EntityMention mentions = 5;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.language.v1.EntityMentionOrBuilder> | |
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 |
key | String
|
getName()
The representative name for the entity.
string name = 1;
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
The representative name for the entity.
string name = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Entity> getParserForType()
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 Sentiment getSentiment()
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.v1.Sentiment sentiment = 6;
| Returns |
|---|
| Type | Description |
Sentiment | The sentiment.
|
getSentimentOrBuilder()
public SentimentOrBuilder getSentimentOrBuilder()
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.v1.Sentiment sentiment = 6;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getType()
public Entity.Type getType()
The entity type.
.google.cloud.language.v1.Entity.Type type = 2;
getTypeValue()
public int getTypeValue()
The entity type.
.google.cloud.language.v1.Entity.Type type = 2;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for type.
|
hasSentiment()
public boolean hasSentiment()
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.v1.Sentiment sentiment = 6;
| Returns |
|---|
| Type | Description |
boolean | Whether the sentiment field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Entity.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Entity.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Entity.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
