EntityAnnotation (java API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.vision.v1.EntityAnnotation

All Implemented Interfaces:

EntityAnnotationOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable
```
public final class EntityAnnotation
extends GeneratedMessageV3
implements EntityAnnotationOrBuilder
```
```
 Set of detected entity features.
 
```
Protobuf type google.cloud.vision.v1.EntityAnnotation
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class EntityAnnotation.Builder
Set of detected entity features.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Nested Classes
Modifier and Type	Class and Description
`static class`	`EntityAnnotation.Builder` Set of detected entity features.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOUNDING_POLY_FIELD_NUMBER`
`static int`	`CONFIDENCE_FIELD_NUMBER`
`static int`	`DESCRIPTION_FIELD_NUMBER`
`static int`	`LOCALE_FIELD_NUMBER`
`static int`	`LOCATIONS_FIELD_NUMBER`
`static int`	`MID_FIELD_NUMBER`
`static int`	`PROPERTIES_FIELD_NUMBER`
`static int`	`SCORE_FIELD_NUMBER`
`static int`	`TOPICALITY_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`BoundingPoly`	`getBoundingPoly()` Image region to which this entity belongs.
`BoundingPolyOrBuilder`	`getBoundingPolyOrBuilder()` Image region to which this entity belongs.
`float`	`getConfidence()` **Deprecated.
`static EntityAnnotation`	`getDefaultInstance()`
`EntityAnnotation`	`getDefaultInstanceForType()`
`java.lang.String`	`getDescription()` Entity textual description, expressed in its `locale` language.
`ByteString`	`getDescriptionBytes()` Entity textual description, expressed in its `locale` language.
`static Descriptors.Descriptor`	`getDescriptor()`
`java.lang.String`	`getLocale()` The language code for the locale in which the entity textual `description` is expressed.
`ByteString`	`getLocaleBytes()` The language code for the locale in which the entity textual `description` is expressed.
`LocationInfo`	`getLocations(int index)` The location information for the detected entity.
`int`	`getLocationsCount()` The location information for the detected entity.
`java.util.List<LocationInfo>`	`getLocationsList()` The location information for the detected entity.
`LocationInfoOrBuilder`	`getLocationsOrBuilder(int index)` The location information for the detected entity.
`java.util.List<? extends LocationInfoOrBuilder>`	`getLocationsOrBuilderList()` The location information for the detected entity.
`java.lang.String`	`getMid()` Opaque entity ID.
`ByteString`	`getMidBytes()` Opaque entity ID.
`Parser<EntityAnnotation>`	`getParserForType()`
`Property`	`getProperties(int index)` Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.
`int`	`getPropertiesCount()` Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.
`java.util.List<Property>`	`getPropertiesList()` Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.
`PropertyOrBuilder`	`getPropertiesOrBuilder(int index)` Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.
`java.util.List<? extends PropertyOrBuilder>`	`getPropertiesOrBuilderList()` Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.
`float`	`getScore()` Overall score of the result.
`int`	`getSerializedSize()`
`float`	`getTopicality()` The relevancy of the ICA (Image Content Annotation) label to the image.
`UnknownFieldSet`	`getUnknownFields()`
`boolean`	`hasBoundingPoly()` Image region to which this entity belongs.
`int`	`hashCode()`
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static EntityAnnotation.Builder`	`newBuilder()`
`static EntityAnnotation.Builder`	`newBuilder(EntityAnnotation prototype)`
`EntityAnnotation.Builder`	`newBuilderForType()`
`protected EntityAnnotation.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)`
`static EntityAnnotation`	`parseDelimitedFrom(java.io.InputStream input)`
`static EntityAnnotation`	`parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static EntityAnnotation`	`parseFrom(byte[] data)`
`static EntityAnnotation`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static EntityAnnotation`	`parseFrom(java.nio.ByteBuffer data)`
`static EntityAnnotation`	`parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static EntityAnnotation`	`parseFrom(ByteString data)`
`static EntityAnnotation`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static EntityAnnotation`	`parseFrom(CodedInputStream input)`
`static EntityAnnotation`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static EntityAnnotation`	`parseFrom(java.io.InputStream input)`
`static EntityAnnotation`	`parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<EntityAnnotation>`	`parser()`
`EntityAnnotation.Builder`	`toBuilder()`
`void`	`writeTo(CodedOutputStream output)`

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- MID_FIELD_NUMBER
```
public static final int MID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LOCALE_FIELD_NUMBER
```
public static final int LOCALE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DESCRIPTION_FIELD_NUMBER
```
public static final int DESCRIPTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SCORE_FIELD_NUMBER
```
public static final int SCORE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CONFIDENCE_FIELD_NUMBER
```
public static final int CONFIDENCE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TOPICALITY_FIELD_NUMBER
```
public static final int TOPICALITY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BOUNDING_POLY_FIELD_NUMBER
```
public static final int BOUNDING_POLY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LOCATIONS_FIELD_NUMBER
```
public static final int LOCATIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PROPERTIES_FIELD_NUMBER
```
public static final int PROPERTIES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

getUnknownFields
```
public final UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getMid

public java.lang.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;

Specified by:: getMid in interface EntityAnnotationOrBuilder

getMidBytes

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

Specified by:: getMidBytes in interface EntityAnnotationOrBuilder

getLocale

public java.lang.String getLocale()

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

string locale = 2;

Specified by:: getLocale in interface EntityAnnotationOrBuilder

getLocaleBytes

public ByteString getLocaleBytes()

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

string locale = 2;

Specified by:: getLocaleBytes in interface EntityAnnotationOrBuilder

getDescription

public java.lang.String getDescription()

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

string description = 3;

Specified by:: getDescription in interface EntityAnnotationOrBuilder

getDescriptionBytes

public ByteString getDescriptionBytes()

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

string description = 3;

Specified by:: getDescriptionBytes in interface EntityAnnotationOrBuilder

getScore
```
public float getScore()
```
```
 Overall score of the result. Range [0, 1].
 
```
float score = 4;
Specified by:

getScore in interface EntityAnnotationOrBuilder

getConfidence

public float getConfidence()

 **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;

Specified by:: getConfidence in interface EntityAnnotationOrBuilder

getTopicality

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

Specified by:: getTopicality in interface EntityAnnotationOrBuilder

hasBoundingPoly
```
public boolean hasBoundingPoly()
```
```
 Image region to which this entity belongs. Not produced
 for `LABEL_DETECTION` features.
 
```
.google.cloud.vision.v1.BoundingPoly bounding_poly = 7;
Specified by:

hasBoundingPoly in interface EntityAnnotationOrBuilder

getBoundingPoly

public BoundingPoly getBoundingPoly()

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

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

Specified by:: getBoundingPoly in interface EntityAnnotationOrBuilder

getBoundingPolyOrBuilder

public BoundingPolyOrBuilder getBoundingPolyOrBuilder()

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

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

Specified by:: getBoundingPolyOrBuilder in interface EntityAnnotationOrBuilder

getLocationsList

public java.util.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;

Specified by:: getLocationsList in interface EntityAnnotationOrBuilder

getLocationsOrBuilderList

public java.util.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;

Specified by:: getLocationsOrBuilderList in interface EntityAnnotationOrBuilder

getLocationsCount

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

Specified by:: getLocationsCount in interface EntityAnnotationOrBuilder

getLocations

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

Specified by:: getLocations in interface EntityAnnotationOrBuilder

getLocationsOrBuilder

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

Specified by:: getLocationsOrBuilder in interface EntityAnnotationOrBuilder