class Google::Apis::LanguageV1beta2::Entity

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.

Attributes

mentions[RW]

The mentions of this entity in the input document. The API currently supports proper noun mentions. Corresponds to the JSON property `mentions` @return [Array<Google::Apis::LanguageV1beta2::EntityMention>]

metadata[RW]

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. Corresponds to the JSON property `metadata` @return [Hash<String,String>]

name[RW]

The representative name for the entity. Corresponds to the JSON property `name` @return [String]

salience[RW]

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. Corresponds to the JSON property `salience` @return [Float]

sentiment[RW]

Represents the feeling associated with the entire text or entities in the text. Next ID: 6 Corresponds to the JSON property `sentiment` @return [Google::Apis::LanguageV1beta2::Sentiment]

type[RW]

The entity type. Corresponds to the JSON property `type` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/language_v1beta2/classes.rb, line 541
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/language_v1beta2/classes.rb, line 546
def update!(**args)
  @mentions = args[:mentions] if args.key?(:mentions)
  @metadata = args[:metadata] if args.key?(:metadata)
  @name = args[:name] if args.key?(:name)
  @salience = args[:salience] if args.key?(:salience)
  @sentiment = args[:sentiment] if args.key?(:sentiment)
  @type = args[:type] if args.key?(:type)
end