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

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudVisionV1p3beta1EntityAnnotation

Returns a new instance of GoogleCloudVisionV1p3beta1EntityAnnotation



5375
5376
5377
 
# File 'generated/google/apis/vision_v1/classes.rb', line 5375

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:



5317
5318
5319
 
# File 'generated/google/apis/vision_v1/classes.rb', line 5317

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) 


5326
5327
5328
 
# File 'generated/google/apis/vision_v1/classes.rb', line 5326

def confidence
  @confidence
end

#description ⇒ String

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

Returns:

  • (String) 


5331
5332
5333
 
# File 'generated/google/apis/vision_v1/classes.rb', line 5331

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) 


5337
5338
5339
 
# File 'generated/google/apis/vision_v1/classes.rb', line 5337

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:



5346
5347
5348
 
# File 'generated/google/apis/vision_v1/classes.rb', line 5346

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) 


5353
5354
5355
 
# File 'generated/google/apis/vision_v1/classes.rb', line 5353

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:



5359
5360
5361
 
# File 'generated/google/apis/vision_v1/classes.rb', line 5359

def properties
  @properties
end

#score ⇒ Float

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

Returns:

  • (Float) 


5364
5365
5366
 
# File 'generated/google/apis/vision_v1/classes.rb', line 5364

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) 


5373
5374
5375
 
# File 'generated/google/apis/vision_v1/classes.rb', line 5373

def topicality
  @topicality
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
 
# File 'generated/google/apis/vision_v1/classes.rb', line 5380

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