Class: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1EntityAnnotation

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

Returns a new instance of GoogleCloudVisionV1p2beta1EntityAnnotation



3597
3598
3599
 
# File 'generated/google/apis/vision_v1/classes.rb', line 3597

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

Instance Attribute Details

#bounding_poly ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1BoundingPoly

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

Returns:



3539
3540
3541
 
# File 'generated/google/apis/vision_v1/classes.rb', line 3539

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) 


3548
3549
3550
 
# File 'generated/google/apis/vision_v1/classes.rb', line 3548

def confidence
  @confidence
end

#description ⇒ String

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

Returns:

  • (String) 


3553
3554
3555
 
# File 'generated/google/apis/vision_v1/classes.rb', line 3553

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) 


3559
3560
3561
 
# File 'generated/google/apis/vision_v1/classes.rb', line 3559

def locale
  @locale
end

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



3568
3569
3570
 
# File 'generated/google/apis/vision_v1/classes.rb', line 3568

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) 


3575
3576
3577
 
# File 'generated/google/apis/vision_v1/classes.rb', line 3575

def mid
  @mid
end

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



3581
3582
3583
 
# File 'generated/google/apis/vision_v1/classes.rb', line 3581

def properties
  @properties
end

#score ⇒ Float

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

Returns:

  • (Float) 


3586
3587
3588
 
# File 'generated/google/apis/vision_v1/classes.rb', line 3586

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) 


3595
3596
3597
 
# File 'generated/google/apis/vision_v1/classes.rb', line 3595

def topicality
  @topicality
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
 
# File 'generated/google/apis/vision_v1/classes.rb', line 3602

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