Class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1EntityAnnotation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/vision_v1p2beta1/classes.rb,
generated/google/apis/vision_v1p2beta1/representations.rb,
generated/google/apis/vision_v1p2beta1/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



5628
5629
5630
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 5628

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

Instance Attribute Details

#bounding_poly ⇒ Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1BoundingPoly

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

Returns:



5570
5571
5572
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 5570

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) 


5579
5580
5581
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 5579

def confidence
  @confidence
end

#description ⇒ String

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

Returns:

  • (String) 


5584
5585
5586
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 5584

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) 


5590
5591
5592
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 5590

def locale
  @locale
end

#locations ⇒ Array<Google::Apis::VisionV1p2beta1::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:



5599
5600
5601
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 5599

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) 


5606
5607
5608
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 5606

def mid
  @mid
end

#properties ⇒ Array<Google::Apis::VisionV1p2beta1::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:



5612
5613
5614
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 5612

def properties
  @properties
end

#score ⇒ Float

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

Returns:

  • (Float) 


5617
5618
5619
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 5617

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) 


5626
5627
5628
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 5626

def topicality
  @topicality
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 5633

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