Reference documentation and code samples for the Cloud Vision V1p3beta1 API class Google::Cloud::Vision::V1p3beta1::EntityAnnotation.
Set of detected entity features.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#bounding_poly
def bounding_poly() -> ::Google::Cloud::Vision::V1p3beta1::BoundingPoly
    Returns
    
  - 
        (::Google::Cloud::Vision::V1p3beta1::BoundingPoly) — Image region to which this entity belongs. Not produced
for LABEL_DETECTIONfeatures.
#bounding_poly=
def bounding_poly=(value) -> ::Google::Cloud::Vision::V1p3beta1::BoundingPoly
    Parameter
    
  - 
        value (::Google::Cloud::Vision::V1p3beta1::BoundingPoly) — Image region to which this entity belongs. Not produced
for LABEL_DETECTIONfeatures.
    Returns
    
  - 
        (::Google::Cloud::Vision::V1p3beta1::BoundingPoly) — Image region to which this entity belongs. Not produced
for LABEL_DETECTIONfeatures.
#confidence
def confidence() -> ::Float
    Returns
    
  - 
        (::Float) — Deprecated. Use scoreinstead. 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].
#confidence=
def confidence=(value) -> ::Float
    Parameter
    
  - 
        value (::Float) — Deprecated. Use scoreinstead. 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 scoreinstead. 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].
#description
def description() -> ::String
    Returns
    
  - 
        (::String) — Entity textual description, expressed in its localelanguage.
#description=
def description=(value) -> ::String
    Parameter
    
  - 
        value (::String) — Entity textual description, expressed in its localelanguage.
    Returns
    
  - 
        (::String) — Entity textual description, expressed in its localelanguage.
#locale
def locale() -> ::String
    Returns
    
  - 
        (::String) — The language code for the locale in which the entity textual
descriptionis expressed.
#locale=
def locale=(value) -> ::String
    Parameter
    
  - 
        value (::String) — The language code for the locale in which the entity textual
descriptionis expressed.
    Returns
    
  - 
        (::String) — The language code for the locale in which the entity textual
descriptionis expressed.
#locations
def locations() -> ::Array<::Google::Cloud::Vision::V1p3beta1::LocationInfo>
    Returns
    
  - 
        (::Array<::Google::Cloud::Vision::V1p3beta1::LocationInfo>) — The location information for the detected entity. Multiple
LocationInfoelements 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.
#locations=
def locations=(value) -> ::Array<::Google::Cloud::Vision::V1p3beta1::LocationInfo>
    Parameter
    
  - 
        value (::Array<::Google::Cloud::Vision::V1p3beta1::LocationInfo>) — The location information for the detected entity. Multiple
LocationInfoelements 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::V1p3beta1::LocationInfo>) — The location information for the detected entity. Multiple
LocationInfoelements 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.
#mid
def mid() -> ::String
    Returns
    
  - (::String) — Opaque entity ID. Some IDs may be available in Google Knowledge Graph Search API.
#mid=
def mid=(value) -> ::String
    Parameter
    
  - value (::String) — 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.
#properties
def properties() -> ::Array<::Google::Cloud::Vision::V1p3beta1::Property>
    Returns
    
  - 
        (::Array<::Google::Cloud::Vision::V1p3beta1::Property>) — Some entities may have optional user-supplied Property(name/value) fields, such a score or string that qualifies the entity.
#properties=
def properties=(value) -> ::Array<::Google::Cloud::Vision::V1p3beta1::Property>
    Parameter
    
  - 
        value (::Array<::Google::Cloud::Vision::V1p3beta1::Property>) — 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::V1p3beta1::Property>) — Some entities may have optional user-supplied Property(name/value) fields, such a score or string that qualifies the entity.
#score
def score() -> ::Float
    Returns
    
  - (::Float) — Overall score of the result. Range [0, 1].
#score=
def score=(value) -> ::Float
    Parameter
    
  - value (::Float) — Overall score of the result. Range [0, 1].
    Returns
    
  - (::Float) — Overall score of the result. Range [0, 1].
#topicality
def topicality() -> ::Float
    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].
#topicality=
def topicality=(value) -> ::Float
    Parameter
    
  - value (::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].
    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].