Class: Google::Apis::LanguageV1::Entity
- Inherits:
-
Object
- Object
- Google::Apis::LanguageV1::Entity
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/language_v1/classes.rb,
generated/google/apis/language_v1/representations.rb,
generated/google/apis/language_v1/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::LanguageV1::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::LanguageV1::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.
533 534 535 |
# File 'generated/google/apis/language_v1/classes.rb', line 533 def initialize(**args) update!(**args) end |
Instance Attribute Details
#mentions ⇒ Array<Google::Apis::LanguageV1::EntityMention>
The mentions of this entity in the input document. The API currently
supports proper noun mentions.
Corresponds to the JSON property mentions
498 499 500 |
# File 'generated/google/apis/language_v1/classes.rb', line 498 def mentions @mentions end |
#metadata ⇒ Hash<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
506 507 508 |
# File 'generated/google/apis/language_v1/classes.rb', line 506 def @metadata end |
#name ⇒ String
The representative name for the entity.
Corresponds to the JSON property name
511 512 513 |
# File 'generated/google/apis/language_v1/classes.rb', line 511 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
520 521 522 |
# File 'generated/google/apis/language_v1/classes.rb', line 520 def salience @salience end |
#sentiment ⇒ Google::Apis::LanguageV1::Sentiment
Represents the feeling associated with the entire text or entities in
the text.
Corresponds to the JSON property sentiment
526 527 528 |
# File 'generated/google/apis/language_v1/classes.rb', line 526 def sentiment @sentiment end |
#type ⇒ String
The entity type.
Corresponds to the JSON property type
531 532 533 |
# File 'generated/google/apis/language_v1/classes.rb', line 531 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
538 539 540 541 542 543 544 545 |
# File 'generated/google/apis/language_v1/classes.rb', line 538 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 |