Class: Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1EntityAnnotation

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

Overview

Set of detected entity features.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudVisionV1p3beta1EntityAnnotation

Returns a new instance of GoogleCloudVisionV1p3beta1EntityAnnotation.



5234
5235
5236
 
# File 'lib/google/apis/vision_v1/classes.rb', line 5234

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

Instance Attribute Details

#bounding_poly ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1BoundingPoly

A bounding polygon for the detected image annotation. Corresponds to the JSON property boundingPoly

Returns:



5178
5179
5180
 
# File 'lib/google/apis/vision_v1/classes.rb', line 5178

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

Returns:

  • (Float) 


5186
5187
5188
 
# File 'lib/google/apis/vision_v1/classes.rb', line 5186

def confidence
  @confidence
end

#description ⇒ String

Entity textual description, expressed in its locale language. Corresponds to the JSON property description

Returns:

  • (String) 


5191
5192
5193
 
# File 'lib/google/apis/vision_v1/classes.rb', line 5191

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

Returns:

  • (String) 


5197
5198
5199
 
# File 'lib/google/apis/vision_v1/classes.rb', line 5197

def locale
  @locale
end

#locations ⇒ Array<Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1LocationInfo>

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

Returns:



5206
5207
5208
 
# File 'lib/google/apis/vision_v1/classes.rb', line 5206

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

Returns:

  • (String) 


5212
5213
5214
 
# File 'lib/google/apis/vision_v1/classes.rb', line 5212

def mid
  @mid
end

#properties ⇒ Array<Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1Property>

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

Returns:



5218
5219
5220
 
# File 'lib/google/apis/vision_v1/classes.rb', line 5218

def properties
  @properties
end

#score ⇒ Float

Overall score of the result. Range [0, 1]. Corresponds to the JSON property score

Returns:

  • (Float) 


5223
5224
5225
 
# File 'lib/google/apis/vision_v1/classes.rb', line 5223

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

Returns:

  • (Float) 


5232
5233
5234
 
# File 'lib/google/apis/vision_v1/classes.rb', line 5232

def topicality
  @topicality
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
 
# File 'lib/google/apis/vision_v1/classes.rb', line 5239

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