Class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1EntityAnnotation

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) ⇒ GoogleCloudVisionV1p3beta1EntityAnnotation

Returns a new instance of GoogleCloudVisionV1p3beta1EntityAnnotation.



5762
5763
5764
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 5762

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

Instance Attribute Details

#bounding_poly ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1BoundingPoly

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

Returns:



5704
5705
5706
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 5704

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) 


5713
5714
5715
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 5713

def confidence
  @confidence
end

#description ⇒ String

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

Returns:

  • (String) 


5718
5719
5720
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 5718

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) 


5724
5725
5726
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 5724

def locale
  @locale
end

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



5733
5734
5735
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 5733

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) 


5740
5741
5742
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 5740

def mid
  @mid
end

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



5746
5747
5748
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 5746

def properties
  @properties
end

#score ⇒ Float

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

Returns:

  • (Float) 


5751
5752
5753
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 5751

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) 


5760
5761
5762
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 5760

def topicality
  @topicality
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 5767

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