Class Entity (2.79.0)

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.v1.Entity

Inheritance

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

Implements

EntityOrBuilder

Inherited Members

publicstaticfinalintMENTIONS_FIELD_NUMBER

publicstaticfinalintMETADATA_FIELD_NUMBER

publicstaticfinalintNAME_FIELD_NUMBER

publicstaticfinalintSALIENCE_FIELD_NUMBER

publicstaticfinalintSENTIMENT_FIELD_NUMBER

publicstaticfinalintTYPE_FIELD_NUMBER

publicstaticEntitygetDefaultInstance()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicstaticEntity.BuildernewBuilder()

publicstaticEntity.BuildernewBuilder(Entityprototype)

publicstaticEntityparseDelimitedFrom(InputStreaminput)

publicstaticEntityparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticEntityparseFrom(byte[]data)

publicstaticEntityparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)

publicstaticEntityparseFrom(ByteStringdata)

publicstaticEntityparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)

publicstaticEntityparseFrom(CodedInputStreaminput)

publicstaticEntityparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticEntityparseFrom(InputStreaminput)

publicstaticEntityparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticEntityparseFrom(ByteBufferdata)

publicstaticEntityparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)

publicstaticParser<Entity>parser()

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;

publicbooleanequals(Objectobj)

AbstractMessage.equals(Object other)

publicEntitygetDefaultInstanceForType()

publicEntityMentiongetMentions(intindex)

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

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

publicintgetMentionsCount()

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

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

publicList<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;

publicEntityMentionOrBuildergetMentionsOrBuilder(intindex)

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

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

publicList<?extendsEntityMentionOrBuilder>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;

publicMap<String,String>getMetadata()

Use #getMetadataMap() instead.

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;

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;

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;

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;

publicStringgetName()

The representative name for the entity.

string name = 1;

publicByteStringgetNameBytes()

The representative name for the entity.

string name = 1;

publicParser<Entity>getParserForType()

GeneratedMessageV3.getParserForType()

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;

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.v1.Sentiment sentiment = 6;

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.v1.Sentiment sentiment = 6;

publicintgetSerializedSize()

GeneratedMessageV3.getSerializedSize()

publicEntity.TypegetType()

The entity type.

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

publicintgetTypeValue()

The entity type.

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

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.v1.Sentiment sentiment = 6;

publicinthashCode()

AbstractMessage.hashCode()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.internalGetFieldAccessorTable()

protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)

publicfinalbooleanisInitialized()

GeneratedMessageV3.isInitialized()

publicEntity.BuildernewBuilderForType()

protectedEntity.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

publicEntity.BuildertoBuilder()

publicvoidwriteTo(CodedOutputStreamoutput)

GeneratedMessageV3.writeTo(CodedOutputStream output)