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

Inherits:

Object

• Object
• Google::Cloud::Vision::V1::EntityAnnotation

Defined in:

lib/google/cloud/vision/v1/doc/google/cloud/vision/v1/image_annotator.rb

Overview

Set of detected entity features.

Instance Attribute Summary

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

  Image region to which this entity belongs.

• #confidence ⇒ Float

  The accuracy of the entity detection in an image.

• #description ⇒ String

  Entity textual description, expressed in its +locale+ language.

• #locale ⇒ String

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

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

  The location information for the detected entity.

• #mid ⇒ String

  Opaque entity ID.

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

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

• #score ⇒ Float

  Overall score of the result.

• #topicality ⇒ Float

  The relevancy of the ICA (Image Content Annotation) label to the image.

Instance Attribute Details

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

Returns Image region to which this entity belongs. Currently not produced 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. Currently not produced 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.

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

class EntityAnnotation; end

#confidence ⇒ Float

Returns 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) —

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

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

class EntityAnnotation; end

#description ⇒ String

Returns Entity textual description, expressed in its +locale+ language.

Returns:

• (String) —

  Entity textual description, expressed in its +locale+ language.

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

class EntityAnnotation; 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.

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

class EntityAnnotation; 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.

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

class EntityAnnotation; end

#mid ⇒ String

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

Returns:

• (String) —

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

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

class EntityAnnotation; 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:

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

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

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

class EntityAnnotation; end

#score ⇒ Float

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

Returns:

• (Float) —

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

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

class EntityAnnotation; 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].

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

class EntityAnnotation; end