Class: Google::Apis::VisionV1::EntityAnnotation

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

Returns a new instance of EntityAnnotation



1378
1379
1380
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1378

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

Instance Attribute Details

#bounding_poly ⇒ Google::Apis::VisionV1::BoundingPoly

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

Returns:



1342
1343
1344
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1342

def bounding_poly
  @bounding_poly
end

#confidence ⇒ Float

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) 


1331
1332
1333
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1331

def confidence
  @confidence
end

#description ⇒ String

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

Returns:

  • (String) 


1347
1348
1349
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1347

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) 


1337
1338
1339
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1337

def locale
  @locale
end

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

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:



1376
1377
1378
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1376

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) 


1323
1324
1325
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1323

def mid
  @mid
end

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

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:



1362
1363
1364
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1362

def properties
  @properties
end

#score ⇒ Float

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

Returns:

  • (Float) 


1367
1368
1369
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1367

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) 


1356
1357
1358
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1356

def topicality
  @topicality
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1383

def update!(**args)
  @mid = args[:mid] if args.key?(:mid)
  @confidence = args[:confidence] if args.key?(:confidence)
  @locale = args[:locale] if args.key?(:locale)
  @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly)
  @description = args[:description] if args.key?(:description)
  @topicality = args[:topicality] if args.key?(:topicality)
  @properties = args[:properties] if args.key?(:properties)
  @score = args[:score] if args.key?(:score)
  @locations = args[:locations] if args.key?(:locations)
end