Package com.google.cloud.vision.v1

Interface EntityAnnotationOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    EntityAnnotation, EntityAnnotation.Builder
    public interface EntityAnnotationOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getMid

        String getMid()
         Opaque entity ID. Some IDs may be available in
 [Google Knowledge Graph Search
 API](https://developers.google.com/knowledge-graph/).
        string mid = 1;
        Returns:
        The mid.

      • getMidBytes

        com.google.protobuf.ByteString getMidBytes()
         Opaque entity ID. Some IDs may be available in
 [Google Knowledge Graph Search
 API](https://developers.google.com/knowledge-graph/).
        string mid = 1;
        Returns:
        The bytes for mid.

      • getLocale

        String getLocale()
         The language code for the locale in which the entity textual
 `description` is expressed.
        string locale = 2;
        Returns:
        The locale.

      • getLocaleBytes

        com.google.protobuf.ByteString getLocaleBytes()
         The language code for the locale in which the entity textual
 `description` is expressed.
        string locale = 2;
        Returns:
        The bytes for locale.

      • getDescription

        String getDescription()
         Entity textual description, expressed in its `locale` language.
        string description = 3;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         Entity textual description, expressed in its `locale` language.
        string description = 3;
        Returns:
        The bytes for description.

      • getScore

        float getScore()
         Overall score of the result. Range [0, 1].
        float score = 4;
        Returns:
        The score.

      • getConfidence

        @Deprecated
float getConfidence()
        Deprecated.
        google.cloud.vision.v1.EntityAnnotation.confidence is deprecated. See google/cloud/vision/v1/image_annotator.proto;l=506
         **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].
        float confidence = 5 [deprecated = true];
        Returns:
        The confidence.

      • getTopicality

        float getTopicality()
         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].
        float topicality = 6;
        Returns:
        The topicality.

      • hasBoundingPoly

        boolean hasBoundingPoly()
         Image region to which this entity belongs. Not produced
 for `LABEL_DETECTION` features.
        .google.cloud.vision.v1.BoundingPoly bounding_poly = 7;
        Returns:
        Whether the boundingPoly field is set.

      • getBoundingPoly

        BoundingPoly getBoundingPoly()
         Image region to which this entity belongs. Not produced
 for `LABEL_DETECTION` features.
        .google.cloud.vision.v1.BoundingPoly bounding_poly = 7;
        Returns:
        The boundingPoly.

      • getBoundingPolyOrBuilder

        BoundingPolyOrBuilder getBoundingPolyOrBuilder()
         Image region to which this entity belongs. Not produced
 for `LABEL_DETECTION` features.
        .google.cloud.vision.v1.BoundingPoly bounding_poly = 7;

      • getLocationsList

        List<LocationInfo> getLocationsList()
         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.
        repeated .google.cloud.vision.v1.LocationInfo locations = 8;

      • getLocations

        LocationInfo getLocations​(int index)
         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.
        repeated .google.cloud.vision.v1.LocationInfo locations = 8;

      • getLocationsCount

        int getLocationsCount()
         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.
        repeated .google.cloud.vision.v1.LocationInfo locations = 8;

      • getLocationsOrBuilderList

        List<? extends LocationInfoOrBuilder> getLocationsOrBuilderList()
         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.
        repeated .google.cloud.vision.v1.LocationInfo locations = 8;

      • getLocationsOrBuilder

        LocationInfoOrBuilder getLocationsOrBuilder​(int index)
         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.
        repeated .google.cloud.vision.v1.LocationInfo locations = 8;

      • getPropertiesList

        List<Property> getPropertiesList()
         Some entities may have optional user-supplied `Property` (name/value)
 fields, such a score or string that qualifies the entity.
        repeated .google.cloud.vision.v1.Property properties = 9;

      • getProperties

        Property getProperties​(int index)
         Some entities may have optional user-supplied `Property` (name/value)
 fields, such a score or string that qualifies the entity.
        repeated .google.cloud.vision.v1.Property properties = 9;

      • getPropertiesCount

        int getPropertiesCount()
         Some entities may have optional user-supplied `Property` (name/value)
 fields, such a score or string that qualifies the entity.
        repeated .google.cloud.vision.v1.Property properties = 9;

      • getPropertiesOrBuilderList

        List<? extends PropertyOrBuilder> getPropertiesOrBuilderList()
         Some entities may have optional user-supplied `Property` (name/value)
 fields, such a score or string that qualifies the entity.
        repeated .google.cloud.vision.v1.Property properties = 9;

      • getPropertiesOrBuilder

        PropertyOrBuilder getPropertiesOrBuilder​(int index)
         Some entities may have optional user-supplied `Property` (name/value)
 fields, such a score or string that qualifies the entity.
        repeated .google.cloud.vision.v1.Property properties = 9;