Class: Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1EntityAnnotation

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

Returns a new instance of GoogleCloudVisionV1p4beta1EntityAnnotation



7268
7269
7270
 
# File 'generated/google/apis/vision_v1/classes.rb', line 7268

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

Instance Attribute Details

#bounding_poly ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1BoundingPoly

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

Returns:



7210
7211
7212
 
# File 'generated/google/apis/vision_v1/classes.rb', line 7210

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) 


7219
7220
7221
 
# File 'generated/google/apis/vision_v1/classes.rb', line 7219

def confidence
  @confidence
end

#description ⇒ String

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

Returns:

  • (String) 


7224
7225
7226
 
# File 'generated/google/apis/vision_v1/classes.rb', line 7224

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) 


7230
7231
7232
 
# File 'generated/google/apis/vision_v1/classes.rb', line 7230

def locale
  @locale
end

#locations ⇒ Array<Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1LocationInfo>

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:



7239
7240
7241
 
# File 'generated/google/apis/vision_v1/classes.rb', line 7239

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) 


7246
7247
7248
 
# File 'generated/google/apis/vision_v1/classes.rb', line 7246

def mid
  @mid
end

#properties ⇒ Array<Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1Property>

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:



7252
7253
7254
 
# File 'generated/google/apis/vision_v1/classes.rb', line 7252

def properties
  @properties
end

#score ⇒ Float

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

Returns:

  • (Float) 


7257
7258
7259
 
# File 'generated/google/apis/vision_v1/classes.rb', line 7257

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) 


7266
7267
7268
 
# File 'generated/google/apis/vision_v1/classes.rb', line 7266

def topicality
  @topicality
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
 
# File 'generated/google/apis/vision_v1/classes.rb', line 7273

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