com.google.cloud.language.v1.EntityOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grpc-google-cloud-language-v1 Show documentation
GRPC library for grpc-google-cloud-language-v1
There is a newer version: 2.50.0
Show newest version
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/language/v1/language_service.proto

package com.google.cloud.language.v1;

public interface EntityOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.cloud.language.v1.Entity)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * The representative name for the entity.
   * 
   *
   * string name = 1;
   */
  java.lang.String getName();
  /**
   *    * The representative name for the entity.
   * 
   *
   * string name = 1;
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * The entity type.
   * 
   *
   * .google.cloud.language.v1.Entity.Type type = 2;
   */
  int getTypeValue();
  /**
   *    * The entity type.
   * 
   *
   * .google.cloud.language.v1.Entity.Type type = 2;
   */
  com.google.cloud.language.v1.Entity.Type getType();

  /**
   *    * Metadata associated with the entity.
   * Currently, Wikipedia URLs and Knowledge Graph MIDs are provided, if
   * available. The associated keys are "wikipedia_url" and "mid", respectively.
   * 
   *
   * map<string, string> metadata = 3;
   */
  int getMetadataCount();
  /**
   *    * Metadata associated with the entity.
   * Currently, Wikipedia URLs and Knowledge Graph MIDs are provided, if
   * available. The associated keys are "wikipedia_url" and "mid", respectively.
   * 
   *
   * map<string, string> metadata = 3;
   */
  boolean containsMetadata(
      java.lang.String key);
  /**
   * Use {@link #getMetadataMap()} instead.
   */
  @java.lang.Deprecated
  java.util.Map
  getMetadata();
  /**
   *    * Metadata associated with the entity.
   * Currently, Wikipedia URLs and Knowledge Graph MIDs are provided, if
   * available. The associated keys are "wikipedia_url" and "mid", respectively.
   * 
   *
   * map<string, string> metadata = 3;
   */
  java.util.Map
  getMetadataMap();
  /**
   *    * Metadata associated with the entity.
   * Currently, Wikipedia URLs and Knowledge Graph MIDs are provided, if
   * available. The associated keys are "wikipedia_url" and "mid", respectively.
   * 
   *
   * map<string, string> metadata = 3;
   */

  java.lang.String getMetadataOrDefault(
      java.lang.String key,
      java.lang.String defaultValue);
  /**
   *    * Metadata associated with the entity.
   * Currently, Wikipedia URLs and Knowledge Graph MIDs are provided, if
   * available. The associated keys are "wikipedia_url" and "mid", respectively.
   * 
   *
   * map<string, string> metadata = 3;
   */

  java.lang.String getMetadataOrThrow(
      java.lang.String key);

  /**
   *    * 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;
   */
  float getSalience();

  /**
   *    * The mentions of this entity in the input document. The API currently
   * supports proper noun mentions.
   * 
   *
   * repeated .google.cloud.language.v1.EntityMention mentions = 5;
   */
  java.util.List 
      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;
   */
  com.google.cloud.language.v1.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;
   */
  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;
   */
  java.util.List 
      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;
   */
  com.google.cloud.language.v1.EntityMentionOrBuilder getMentionsOrBuilder(
      int index);
}