Class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p5beta1EntityAnnotation

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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudVisionV1p5beta1EntityAnnotation

Returns a new instance of GoogleCloudVisionV1p5beta1EntityAnnotation



9447
9448
9449
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9447

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

Instance Attribute Details

#bounding_poly ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p5beta1BoundingPoly

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

Returns:



9389
9390
9391
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9389

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) 


9398
9399
9400
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9398

def confidence
  @confidence
end

#description ⇒ String

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

Returns:

  • (String) 


9403
9404
9405
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9403

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) 


9409
9410
9411
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9409

def locale
  @locale
end

#locations ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p5beta1LocationInfo>

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:



9418
9419
9420
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9418

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) 


9425
9426
9427
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9425

def mid
  @mid
end

#properties ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p5beta1Property>

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:



9431
9432
9433
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9431

def properties
  @properties
end

#score ⇒ Float

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

Returns:

  • (Float) 


9436
9437
9438
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9436

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) 


9445
9446
9447
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9445

def topicality
  @topicality
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9452

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