Package com.google.cloud.language.v1

Interface EntityOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Entity, Entity.Builder
@Generated public interface EntityOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsMetadata(String key)
    Metadata associated with the entity.
    EntityMention
    getMentions(int index)
    The mentions of this entity in the input document.
    int
    getMentionsCount()
    The mentions of this entity in the input document.
    List<EntityMention>
    getMentionsList()
    The mentions of this entity in the input document.
    EntityMentionOrBuilder
    getMentionsOrBuilder(int index)
    The mentions of this entity in the input document.
    List<? extends EntityMentionOrBuilder>
    getMentionsOrBuilderList()
    The mentions of this entity in the input document.
    Map<String,String>
    getMetadata()
    Deprecated.
    int
    getMetadataCount()
    Metadata associated with the entity.
    Map<String,String>
    getMetadataMap()
    Metadata associated with the entity.
    String
    getMetadataOrDefault(String key, String defaultValue)
    Metadata associated with the entity.
    String
    getMetadataOrThrow(String key)
    Metadata associated with the entity.
    String
    getName()
    The representative name for the entity.
    com.google.protobuf.ByteString
    getNameBytes()
    The representative name for the entity.
    float
    getSalience()
    The salience score associated with the entity in the [0, 1.0] range.
    Sentiment
    getSentiment()
    For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_entity_sentiment] is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.
    SentimentOrBuilder
    getSentimentOrBuilder()
    For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_entity_sentiment] is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.
    Entity.Type
    getType()
    The entity type.
    int
    getTypeValue()
    The entity type.
    boolean
    hasSentiment()
    For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_entity_sentiment] is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getName

      String getName()
       The representative name for the entity.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The representative name for the entity.
      string name = 1;
      Returns:
      The bytes for name.

    • getTypeValue

      int getTypeValue()
       The entity type.
      .google.cloud.language.v1.Entity.Type type = 2;
      Returns:
      The enum numeric value on the wire for type.

    • getType

      Entity.Type getType()
       The entity type.
      .google.cloud.language.v1.Entity.Type type = 2;
      Returns:
      The type.

    • getMetadataCount

      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;

    • containsMetadata

      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;

    • getMetadata

      @Deprecated Map<String,String> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.

    • getMetadataMap

      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;

    • getMetadataOrDefault

      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;

    • getMetadataOrThrow

      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;

    • getSalience

      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:
      The salience.

    • getMentionsList

      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;

    • getMentions

      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;

    • getMentionsCount

      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;

    • getMentionsOrBuilderList

      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;

    • getMentionsOrBuilder

      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;

    • hasSentiment

      boolean hasSentiment()
       For calls to [AnalyzeEntitySentiment][] or if
 [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.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:
      Whether the sentiment field is set.

    • getSentiment

      Sentiment getSentiment()
       For calls to [AnalyzeEntitySentiment][] or if
 [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.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:
      The sentiment.

    • getSentimentOrBuilder

      SentimentOrBuilder getSentimentOrBuilder()
       For calls to [AnalyzeEntitySentiment][] or if
 [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.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;