Class: Google::Apis::LanguageV1beta2::Entity

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/language_v1beta2/classes.rb,
generated/google/apis/language_v1beta2/representations.rb,
generated/google/apis/language_v1beta2/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Entity

Returns a new instance of Entity.


541
542
543
# File 'generated/google/apis/language_v1beta2/classes.rb', line 541

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#mentionsArray<Google::Apis::LanguageV1beta2::EntityMention>

The mentions of this entity in the input document. The API currently supports proper noun mentions. Corresponds to the JSON property mentions


507
508
509
# File 'generated/google/apis/language_v1beta2/classes.rb', line 507

def mentions
  @mentions
end

#metadataHash<String,String>

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

Returns:

  • (Hash<String,String>)

515
516
517
# File 'generated/google/apis/language_v1beta2/classes.rb', line 515

def 
  @metadata
end

#nameString

The representative name for the entity. Corresponds to the JSON property name

Returns:

  • (String)

520
521
522
# File 'generated/google/apis/language_v1beta2/classes.rb', line 520

def name
  @name
end

#salienceFloat

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

Returns:

  • (Float)

528
529
530
# File 'generated/google/apis/language_v1beta2/classes.rb', line 528

def salience
  @salience
end

#sentimentGoogle::Apis::LanguageV1beta2::Sentiment

Represents the feeling associated with the entire text or entities in the text. Next ID: 6 Corresponds to the JSON property sentiment


534
535
536
# File 'generated/google/apis/language_v1beta2/classes.rb', line 534

def sentiment
  @sentiment
end

#typeString

The entity type. Corresponds to the JSON property type

Returns:

  • (String)

539
540
541
# File 'generated/google/apis/language_v1beta2/classes.rb', line 539

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


546
547
548
549
550
551
552
553
# File 'generated/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