Class: Google::Apis::LanguageV1beta2::Entity
- Inherits:
-
Object
- Object
- Google::Apis::LanguageV1beta2::Entity
- 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
-
#mentions ⇒ Array<Google::Apis::LanguageV1beta2::EntityMention>
The mentions of this entity in the input document.
-
#metadata ⇒ Hash<String,String>
Metadata associated with the entity.
-
#name ⇒ String
The representative name for the entity.
-
#salience ⇒ Float
The salience score associated with the entity in the [0, 1.0] range.
-
#sentiment ⇒ Google::Apis::LanguageV1beta2::Sentiment
Represents the feeling associated with the entire text or entities in the text.
-
#type ⇒ String
The entity type.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Entity
constructor
A new instance of Entity.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Entity
Returns a new instance of Entity
535 536 537 |
# File 'generated/google/apis/language_v1beta2/classes.rb', line 535 def initialize(**args) update!(**args) end |
Instance Attribute Details
#mentions ⇒ Array<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
500 501 502 |
# File 'generated/google/apis/language_v1beta2/classes.rb', line 500 def mentions @mentions end |
#metadata ⇒ Hash<String,String>
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.
Corresponds to the JSON property metadata
507 508 509 |
# File 'generated/google/apis/language_v1beta2/classes.rb', line 507 def @metadata end |
#name ⇒ String
The representative name for the entity.
Corresponds to the JSON property name
512 513 514 |
# File 'generated/google/apis/language_v1beta2/classes.rb', line 512 def name @name end |
#salience ⇒ Float
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
521 522 523 |
# File 'generated/google/apis/language_v1beta2/classes.rb', line 521 def salience @salience end |
#sentiment ⇒ Google::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
528 529 530 |
# File 'generated/google/apis/language_v1beta2/classes.rb', line 528 def sentiment @sentiment end |
#type ⇒ String
The entity type.
Corresponds to the JSON property type
533 534 535 |
# File 'generated/google/apis/language_v1beta2/classes.rb', line 533 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
540 541 542 543 544 545 546 547 |
# File 'generated/google/apis/language_v1beta2/classes.rb', line 540 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 |