EntityAnnotation (Cloud Vision API v1 (Rev. 451) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.vision.v1.model.EntityAnnotation

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class EntityAnnotation
extends com.google.api.client.json.GenericJson
```
Set of detected entity features.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Vision API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

EntityAnnotation()

Constructors
Constructor and Description
`EntityAnnotation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EntityAnnotation`	`clone()`
`BoundingPoly`	`getBoundingPoly()` Image region to which this entity belongs.
`java.lang.Float`	`getConfidence()` **Deprecated.
`java.lang.String`	`getDescription()` Entity textual description, expressed in its `locale` language.
`java.lang.String`	`getLocale()` The language code for the locale in which the entity textual `description` is expressed.
`java.util.List<LocationInfo>`	`getLocations()` The location information for the detected entity.
`java.lang.String`	`getMid()` Opaque entity ID.
`java.util.List<Property>`	`getProperties()` Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.
`java.lang.Float`	`getScore()` Overall score of the result.
`java.lang.Float`	`getTopicality()` The relevancy of the ICA (Image Content Annotation) label to the image.
`EntityAnnotation`	`set(java.lang.String fieldName, java.lang.Object value)`
`EntityAnnotation`	`setBoundingPoly(BoundingPoly boundingPoly)` Image region to which this entity belongs.
`EntityAnnotation`	`setConfidence(java.lang.Float confidence)` **Deprecated.
`EntityAnnotation`	`setDescription(java.lang.String description)` Entity textual description, expressed in its `locale` language.
`EntityAnnotation`	`setLocale(java.lang.String locale)` The language code for the locale in which the entity textual `description` is expressed.
`EntityAnnotation`	`setLocations(java.util.List<LocationInfo> locations)` The location information for the detected entity.
`EntityAnnotation`	`setMid(java.lang.String mid)` Opaque entity ID.
`EntityAnnotation`	`setProperties(java.util.List<Property> properties)` Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.
`EntityAnnotation`	`setScore(java.lang.Float score)` Overall score of the result.
`EntityAnnotation`	`setTopicality(java.lang.Float topicality)` The relevancy of the ICA (Image Content Annotation) label to the image.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - EntityAnnotation
```
public EntityAnnotation()
```
- Method Detail
  - getBoundingPoly
```
public BoundingPoly getBoundingPoly()
```
    Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features.
    
    Returns:
    
    value or null for none
  - setBoundingPoly
```
public EntityAnnotation setBoundingPoly(BoundingPoly boundingPoly)
```
    Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features.
    
    Parameters:
    
    boundingPoly - boundingPoly or null for none
  - getConfidence
```
public java.lang.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].
    
    Returns:
    
    value or null for none
  - setConfidence
```
public EntityAnnotation setConfidence(java.lang.Float confidence)
```
    **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].
    
    Parameters:
    
    confidence - confidence or null for none
  - getDescription
```
public java.lang.String getDescription()
```
    Entity textual description, expressed in its `locale` language.
    
    Returns:
    
    value or null for none
  - setDescription
```
public EntityAnnotation setDescription(java.lang.String description)
```
    Entity textual description, expressed in its `locale` language.
    
    Parameters:
    
    description - description or null for none
  - getLocale
```
public java.lang.String getLocale()
```
    The language code for the locale in which the entity textual `description` is expressed.
    
    Returns:
    
    value or null for none
  - setLocale
```
public EntityAnnotation setLocale(java.lang.String locale)
```
    The language code for the locale in which the entity textual `description` is expressed.
    
    Parameters:
    
    locale - locale or null for none
  - getLocations
```
public java.util.List<LocationInfo> getLocations()
```
    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:
    
    value or null for none
  - setLocations
```
public EntityAnnotation setLocations(java.util.List<LocationInfo> locations)
```
    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.
    
    Parameters:
    
    locations - locations or null for none
  - 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/).
    
    Returns:
    
    value or null for none
  - setMid
```
public EntityAnnotation setMid(java.lang.String mid)
```
    Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).
    
    Parameters:
    
    mid - mid or null for none
  - getProperties
```
public java.util.List<Property> getProperties()
```
    Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.
    
    Returns:
    
    value or null for none
  - setProperties
```
public EntityAnnotation setProperties(java.util.List<Property> properties)
```
    Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.
    
    Parameters:
    
    properties - properties or null for none
  - getScore
```
public java.lang.Float getScore()
```
    Overall score of the result. Range [0, 1].
    
    Returns:
    
    value or null for none
  - setScore
```
public EntityAnnotation setScore(java.lang.Float score)
```
    Overall score of the result. Range [0, 1].
    
    Parameters:
    
    score - score or null for none
  - getTopicality
```
public java.lang.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].
    
    Returns:
    
    value or null for none
  - setTopicality
```
public EntityAnnotation setTopicality(java.lang.Float topicality)
```
    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].
    
    Parameters:
    
    topicality - topicality or null for none
  - set
```
public EntityAnnotation set(java.lang.String fieldName,
                            java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public EntityAnnotation clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Cloud Vision API v1 (revision 451)

Class EntityAnnotation

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

EntityAnnotation

Method Detail

getBoundingPoly

setBoundingPoly

getConfidence

setConfidence

getDescription

setDescription

getLocale

setLocale

getLocations

setLocations

getMid

setMid

getProperties

setProperties

getScore

setScore

getTopicality

setTopicality

set

clone