Class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1EntityAnnotation
- Inherits:
-
Object
- Object
- Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1EntityAnnotation
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/vision_v1p1beta1/classes.rb,
generated/google/apis/vision_v1p1beta1/representations.rb,
generated/google/apis/vision_v1p1beta1/representations.rb
Overview
Set of detected entity features.
Instance Attribute Summary collapse
-
#bounding_poly ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly
A bounding polygon for the detected image annotation.
-
#confidence ⇒ Float
**Deprecated.
-
#description ⇒ String
Entity textual description, expressed in its
locale
language. -
#locale ⇒ String
The language code for the locale in which the entity textual
description
is expressed. -
#locations ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1LocationInfo>
The location information for the detected entity.
-
#mid ⇒ String
Opaque entity ID.
-
#properties ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Property>
Some entities may have optional user-supplied
Property
(name/value) fields, such a score or string that qualifies the entity. -
#score ⇒ Float
Overall score of the result.
-
#topicality ⇒ Float
The relevancy of the ICA (Image Content Annotation) label to the image.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudVisionV1p1beta1EntityAnnotation
constructor
A new instance of GoogleCloudVisionV1p1beta1EntityAnnotation.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleCloudVisionV1p1beta1EntityAnnotation
Returns a new instance of GoogleCloudVisionV1p1beta1EntityAnnotation
715 716 717 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 715 def initialize(**args) update!(**args) end |
Instance Attribute Details
#bounding_poly ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly
A bounding polygon for the detected image annotation.
Corresponds to the JSON property boundingPoly
657 658 659 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 657 def bounding_poly @bounding_poly end |
#confidence ⇒ Float
Deprecated. Use score
instead.
The accuracy of the entity detection in an image.
For example, for an image in which the "Eiffel Tower" entity is detected,
this field represents the confidence that there is a tower in the query
image. Range [0, 1].
Corresponds to the JSON property confidence
666 667 668 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 666 def confidence @confidence end |
#description ⇒ String
Entity textual description, expressed in its locale
language.
Corresponds to the JSON property description
671 672 673 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 671 def description @description end |
#locale ⇒ String
The language code for the locale in which the entity textual
description
is expressed.
Corresponds to the JSON property locale
677 678 679 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 677 def locale @locale end |
#locations ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1LocationInfo>
The location information for the detected entity. Multiple
LocationInfo
elements can be present because one location may
indicate the location of the scene in the image, and another location
may indicate the location of the place where the image was taken.
Location information is usually present for landmarks.
Corresponds to the JSON property locations
686 687 688 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 686 def locations @locations end |
#mid ⇒ String
Opaque entity ID. Some IDs may be available in
Google Knowledge Graph Search
API.
Corresponds to the JSON property mid
693 694 695 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 693 def mid @mid end |
#properties ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Property>
Some entities may have optional user-supplied Property
(name/value)
fields, such a score or string that qualifies the entity.
Corresponds to the JSON property properties
699 700 701 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 699 def properties @properties end |
#score ⇒ Float
Overall score of the result. Range [0, 1].
Corresponds to the JSON property score
704 705 706 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 704 def score @score end |
#topicality ⇒ Float
The relevancy of the ICA (Image Content Annotation) label to the
image. For example, the relevancy of "tower" is likely higher to an image
containing the detected "Eiffel Tower" than to an image containing a
detected distant towering building, even though the confidence that
there is a tower in each image may be the same. Range [0, 1].
Corresponds to the JSON property topicality
713 714 715 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 713 def topicality @topicality end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
720 721 722 723 724 725 726 727 728 729 730 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 720 def update!(**args) @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) @confidence = args[:confidence] if args.key?(:confidence) @description = args[:description] if args.key?(:description) @locale = args[:locale] if args.key?(:locale) @locations = args[:locations] if args.key?(:locations) @mid = args[:mid] if args.key?(:mid) @properties = args[:properties] if args.key?(:properties) @score = args[:score] if args.key?(:score) @topicality = args[:topicality] if args.key?(:topicality) end |