Class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1EntityAnnotation

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

Overview

Set of detected entity features.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudVisionV1p2beta1EntityAnnotation

Returns a new instance of GoogleCloudVisionV1p2beta1EntityAnnotation.



3663
3664
3665
 
# File 'lib/google/apis/vision_v1p1beta1/classes.rb', line 3663

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

Instance Attribute Details

#bounding_poly ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1BoundingPoly

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

Returns:



3607
3608
3609
 
# File 'lib/google/apis/vision_v1p1beta1/classes.rb', line 3607

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) 


3615
3616
3617
 
# File 'lib/google/apis/vision_v1p1beta1/classes.rb', line 3615

def confidence
  @confidence
end

#description ⇒ String

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

Returns:

  • (String) 


3620
3621
3622
 
# File 'lib/google/apis/vision_v1p1beta1/classes.rb', line 3620

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) 


3626
3627
3628
 
# File 'lib/google/apis/vision_v1p1beta1/classes.rb', line 3626

def locale
  @locale
end

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

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:



3635
3636
3637
 
# File 'lib/google/apis/vision_v1p1beta1/classes.rb', line 3635

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) 


3641
3642
3643
 
# File 'lib/google/apis/vision_v1p1beta1/classes.rb', line 3641

def mid
  @mid
end

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

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:



3647
3648
3649
 
# File 'lib/google/apis/vision_v1p1beta1/classes.rb', line 3647

def properties
  @properties
end

#score ⇒ Float

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

Returns:

  • (Float) 


3652
3653
3654
 
# File 'lib/google/apis/vision_v1p1beta1/classes.rb', line 3652

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) 


3661
3662
3663
 
# File 'lib/google/apis/vision_v1p1beta1/classes.rb', line 3661

def topicality
  @topicality
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
 
# File 'lib/google/apis/vision_v1p1beta1/classes.rb', line 3668

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