Class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p5beta1EntityAnnotation

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

Returns a new instance of GoogleCloudVisionV1p5beta1EntityAnnotation



9550
9551
9552
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 9550

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

Instance Attribute Details

#bounding_poly ⇒ Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p5beta1BoundingPoly

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

Returns:



9492
9493
9494
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 9492

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) 


9501
9502
9503
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 9501

def confidence
  @confidence
end

#description ⇒ String

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

Returns:

  • (String) 


9506
9507
9508
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 9506

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) 


9512
9513
9514
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 9512

def locale
  @locale
end

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



9521
9522
9523
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 9521

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) 


9528
9529
9530
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 9528

def mid
  @mid
end

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



9534
9535
9536
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 9534

def properties
  @properties
end

#score ⇒ Float

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

Returns:

  • (Float) 


9539
9540
9541
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 9539

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) 


9548
9549
9550
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 9548

def topicality
  @topicality
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 9555

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