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

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/vision/v1/doc/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 filled currently for +LABEL_DETECTION+ features. For +TEXT_DETECTION+ (OCR), +boundingPoly+s are produced for the entire text detected in an image region, followed by +boundingPoly+s for each word within the detected text.

Returns:

  • (Google::Cloud::Vision::V1::BoundingPoly) —

    Image region to which this entity belongs. Not filled currently for +LABEL_DETECTION+ features. For +TEXT_DETECTION+ (OCR), +boundingPoly+s are produced for the entire text detected in an image region, followed by +boundingPoly+s for each word within the detected text.



330
 
# File 'lib/google/cloud/vision/v1/doc/google/cloud/vision/v1/image_annotator.rb', line 330

class EntityAnnotation; end

#confidence ⇒ Float

Returns The accuracy of the entity detection in an image. For example, for an image containing 'Eiffel Tower,' this field represents the confidence that there is a tower in the query image. Range [0, 1].

Returns:

  • (Float) —

    The accuracy of the entity detection in an image. For example, for an image containing 'Eiffel Tower,' this field represents the confidence that there is a tower in the query image. Range [0, 1].



330
 
# File 'lib/google/cloud/vision/v1/doc/google/cloud/vision/v1/image_annotator.rb', line 330

class EntityAnnotation; end

#description ⇒ String

Returns Entity textual description, expressed in its locale language.

Returns:

  • (String) —

    Entity textual description, expressed in its locale language.



330
 
# File 'lib/google/cloud/vision/v1/doc/google/cloud/vision/v1/image_annotator.rb', line 330

class EntityAnnotation; end

#locale ⇒ String

Returns The language code for the locale in which the entity textual description (next field) is expressed.

Returns:

  • (String) —

    The language code for the locale in which the entity textual description (next field) is expressed.



330
 
# File 'lib/google/cloud/vision/v1/doc/google/cloud/vision/v1/image_annotator.rb', line 330

class EntityAnnotation; end

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

Returns The location information for the detected entity. Multiple LocationInfo elements can be present since one location may indicate the location of the scene in the query image, and another the location of the place where the query 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 since one location may indicate the location of the scene in the query image, and another the location of the place where the query image was taken. Location information is usually present for landmarks.



330
 
# File 'lib/google/cloud/vision/v1/doc/google/cloud/vision/v1/image_annotator.rb', line 330

class EntityAnnotation; end

#mid ⇒ String

Returns Opaque entity ID. Some IDs might be available in Knowledge Graph(KG). For more details on KG please see: https://developers.google.com/knowledge-graph/

Returns:



330
 
# File 'lib/google/cloud/vision/v1/doc/google/cloud/vision/v1/image_annotator.rb', line 330

class EntityAnnotation; end

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

Returns Some entities can have additional optional Property fields. For example a different kind of score or string that qualifies the entity.

Returns:

  • (Array<Google::Cloud::Vision::V1::Property>) —

    Some entities can have additional optional Property fields. For example a different kind of score or string that qualifies the entity.



330
 
# File 'lib/google/cloud/vision/v1/doc/google/cloud/vision/v1/image_annotator.rb', line 330

class EntityAnnotation; end

#score ⇒ Float

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

Returns:

  • (Float) —

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



330
 
# File 'lib/google/cloud/vision/v1/doc/google/cloud/vision/v1/image_annotator.rb', line 330

class EntityAnnotation; end

#topicality ⇒ Float

Returns The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of 'tower' to an image containing 'Eiffel Tower' is likely higher than an image containing a distant towering building, though the confidence that there is a tower 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' to an image containing 'Eiffel Tower' is likely higher than an image containing a distant towering building, though the confidence that there is a tower may be the same. Range [0, 1].



330
 
# File 'lib/google/cloud/vision/v1/doc/google/cloud/vision/v1/image_annotator.rb', line 330

class EntityAnnotation; end