Class: Google::Apis::VisionV1::EntityAnnotation
- Inherits:
-
Object
- Object
- Google::Apis::VisionV1::EntityAnnotation
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/vision_v1/classes.rb,
generated/google/apis/vision_v1/representations.rb,
generated/google/apis/vision_v1/representations.rb
Overview
Set of detected entity features.
Instance Attribute Summary collapse
-
#bounding_poly ⇒ Google::Apis::VisionV1::BoundingPoly
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::VisionV1::LocationInfo>
The location information for the detected entity.
-
#mid ⇒ String
Opaque entity ID.
-
#properties ⇒ Array<Google::Apis::VisionV1::Property>
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) ⇒ EntityAnnotation
constructor
A new instance of EntityAnnotation.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ EntityAnnotation
Returns a new instance of EntityAnnotation
1003 1004 1005 |
# File 'generated/google/apis/vision_v1/classes.rb', line 1003 def initialize(**args) update!(**args) end |
Instance Attribute Details
#bounding_poly ⇒ Google::Apis::VisionV1::BoundingPoly
A bounding polygon for the detected image annotation.
Corresponds to the JSON property boundingPoly
945 946 947 |
# File 'generated/google/apis/vision_v1/classes.rb', line 945 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
954 955 956 |
# File 'generated/google/apis/vision_v1/classes.rb', line 954 def confidence @confidence end |
#description ⇒ String
Entity textual description, expressed in its locale
language.
Corresponds to the JSON property description
959 960 961 |
# File 'generated/google/apis/vision_v1/classes.rb', line 959 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
965 966 967 |
# File 'generated/google/apis/vision_v1/classes.rb', line 965 def locale @locale end |
#locations ⇒ Array<Google::Apis::VisionV1::LocationInfo>
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
974 975 976 |
# File 'generated/google/apis/vision_v1/classes.rb', line 974 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
981 982 983 |
# File 'generated/google/apis/vision_v1/classes.rb', line 981 def mid @mid end |
#properties ⇒ Array<Google::Apis::VisionV1::Property>
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
987 988 989 |
# File 'generated/google/apis/vision_v1/classes.rb', line 987 def properties @properties end |
#score ⇒ Float
Overall score of the result. Range [0, 1].
Corresponds to the JSON property score
992 993 994 |
# File 'generated/google/apis/vision_v1/classes.rb', line 992 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
1001 1002 1003 |
# File 'generated/google/apis/vision_v1/classes.rb', line 1001 def topicality @topicality end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 |
# File 'generated/google/apis/vision_v1/classes.rb', line 1008 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 |