Interface EntityAnnotationOrBuilder (3.51.0) 

public interface EntityAnnotationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBoundingPoly()

public abstract BoundingPoly getBoundingPoly()

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

.google.cloud.vision.v1.BoundingPoly bounding_poly = 7;

Returns
Type Description
BoundingPoly

The boundingPoly.

getBoundingPolyOrBuilder()

public abstract BoundingPolyOrBuilder getBoundingPolyOrBuilder()

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

.google.cloud.vision.v1.BoundingPoly bounding_poly = 7;

Returns
Type Description
BoundingPolyOrBuilder

getConfidence() (deprecated)

public abstract float getConfidence()

Deprecated. google.cloud.vision.v1.EntityAnnotation.confidence is deprecated. See google/cloud/vision/v1/image_annotator.proto;l=510

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
Type Description
float

The confidence.

getDescription()

public abstract String getDescription()

Entity textual description, expressed in its locale language.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Entity textual description, expressed in its locale language.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getLocale()

public abstract String getLocale()

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

string locale = 2;

Returns
Type Description
String

The locale.

getLocaleBytes()

public abstract ByteString getLocaleBytes()

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

string locale = 2;

Returns
Type Description
ByteString

The bytes for locale.

getLocations(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
LocationInfo

getLocationsCount()

public abstract 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;

Returns
Type Description
int

getLocationsList()

public abstract 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;

Returns
Type Description
List<LocationInfo>

getLocationsOrBuilder(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
LocationInfoOrBuilder

getLocationsOrBuilderList()

public abstract 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;

Returns
Type Description
List<? extends com.google.cloud.vision.v1.LocationInfoOrBuilder>

getMid()

public abstract String getMid()

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

string mid = 1;

Returns
Type Description
String

The mid.

getMidBytes()

public abstract ByteString getMidBytes()

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

string mid = 1;

Returns
Type Description
ByteString

The bytes for mid.

getProperties(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
Property

getPropertiesCount()

public abstract 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;

Returns
Type Description
int

getPropertiesList()

public abstract 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;

Returns
Type Description
List<Property>

getPropertiesOrBuilder(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
PropertyOrBuilder

getPropertiesOrBuilderList()

public abstract 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;

Returns
Type Description
List<? extends com.google.cloud.vision.v1.PropertyOrBuilder>

getScore()

public abstract float getScore()

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

float score = 4;

Returns
Type Description
float

The score.

getTopicality()

public abstract 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
Type Description
float

The topicality.

hasBoundingPoly()

public abstract boolean hasBoundingPoly()

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

.google.cloud.vision.v1.BoundingPoly bounding_poly = 7;

Returns
Type Description
boolean

Whether the boundingPoly field is set.