Interface EntityOrBuilder (2.29.0)

public interface EntityOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsMetadata(String key)

public abstract 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
NameDescription
keyString
Returns
TypeDescription
boolean

getMentions(int index)

public abstract EntityMention getMentions(int index)

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
NameDescription
indexint
Returns
TypeDescription
EntityMention

getMentionsCount()

public abstract int getMentionsCount()

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
TypeDescription
int

getMentionsList()

public abstract List<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
TypeDescription
List<EntityMention>

getMentionsOrBuilder(int index)

public abstract EntityMentionOrBuilder getMentionsOrBuilder(int index)

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
NameDescription
indexint
Returns
TypeDescription
EntityMentionOrBuilder

getMentionsOrBuilderList()

public abstract List<? extends EntityMentionOrBuilder> 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
TypeDescription
List<? extends com.google.cloud.language.v1beta2.EntityMentionOrBuilder>

getMetadata()

public abstract Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
TypeDescription
Map<String,String>

getMetadataCount()

public abstract 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
TypeDescription
int

getMetadataMap()

public abstract 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
TypeDescription
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public abstract 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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getMetadataOrThrow(String key)

public abstract 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
NameDescription
keyString
Returns
TypeDescription
String

getName()

public abstract String getName()

The representative name for the entity.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

The representative name for the entity.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getSalience()

public abstract 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
TypeDescription
float

The salience.

getSentiment()

public abstract 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.v1beta2.Sentiment sentiment = 6;

Returns
TypeDescription
Sentiment

The sentiment.

getSentimentOrBuilder()

public abstract 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.v1beta2.Sentiment sentiment = 6;

Returns
TypeDescription
SentimentOrBuilder

getType()

public abstract Entity.Type getType()

The entity type.

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

Returns
TypeDescription
Entity.Type

The type.

getTypeValue()

public abstract int getTypeValue()

The entity type.

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

Returns
TypeDescription
int

The enum numeric value on the wire for type.

hasSentiment()

public abstract 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.v1beta2.Sentiment sentiment = 6;

Returns
TypeDescription
boolean

Whether the sentiment field is set.