Class: Google::Cloud::Vision::V1::EntityAnnotation

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/vision/v1/image_annotator.rb

Overview

Set of detected entity features.

Instance Attribute Summary collapse

Instance Attribute Details

#bounding_poly ⇒ ::Google::Cloud::Vision::V1::BoundingPoly

Returns Image region to which this entity belongs. Not produced for LABEL_DETECTION features.

Returns:



410
411
412
413
 
# File 'proto_docs/google/cloud/vision/v1/image_annotator.rb', line 410

class EntityAnnotation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#confidence ⇒ ::Float

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns 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].

Returns:

  • (::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].



410
411
412
413
 
# File 'proto_docs/google/cloud/vision/v1/image_annotator.rb', line 410

class EntityAnnotation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#description ⇒ ::String

Returns Entity textual description, expressed in its locale language.

Returns:

  • (::String) —

    Entity textual description, expressed in its locale language.



410
411
412
413
 
# File 'proto_docs/google/cloud/vision/v1/image_annotator.rb', line 410

class EntityAnnotation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#locale ⇒ ::String

Returns The language code for the locale in which the entity textual description is expressed.

Returns:

  • (::String) —

    The language code for the locale in which the entity textual description is expressed.



410
411
412
413
 
# File 'proto_docs/google/cloud/vision/v1/image_annotator.rb', line 410

class EntityAnnotation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#locations ⇒ ::Array<::Google::Cloud::Vision::V1::LocationInfo>

Returns 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.

Returns:

  • (::Array<::Google::Cloud::Vision::V1::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.



410
411
412
413
 
# File 'proto_docs/google/cloud/vision/v1/image_annotator.rb', line 410

class EntityAnnotation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#mid ⇒ ::String

Returns Opaque entity ID. Some IDs may be available in Google Knowledge Graph Search API.

Returns:



410
411
412
413
 
# File 'proto_docs/google/cloud/vision/v1/image_annotator.rb', line 410

class EntityAnnotation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#properties ⇒ ::Array<::Google::Cloud::Vision::V1::Property>

Returns Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

Returns:



410
411
412
413
 
# File 'proto_docs/google/cloud/vision/v1/image_annotator.rb', line 410

class EntityAnnotation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#score ⇒ ::Float

Returns Overall score of the result. Range [0, 1].

Returns:

  • (::Float) —

    Overall score of the result. Range [0, 1].



410
411
412
413
 
# File 'proto_docs/google/cloud/vision/v1/image_annotator.rb', line 410

class EntityAnnotation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#topicality ⇒ ::Float

Returns 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].

Returns:

  • (::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].



410
411
412
413
 
# File 'proto_docs/google/cloud/vision/v1/image_annotator.rb', line 410

class EntityAnnotation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end