webDetection
|
WebDetection
|
If present, web detection has completed successfully.
|
WebDetection
|
object
|
Relevant information for the image from the Internet.
|
Properties
webEntities
|
array [WebEntity]
|
Deduced entities from similar images on the Internet.
|
WebEntity
|
object
|
Entity deduced from similar images on the Internet.
|
Properties
score
|
float
|
Overall relevancy score for the entity.
Not normalized and not comparable across different image queries.
|
entityId
|
string
|
Opaque entity ID.
|
description
|
string
|
Canonical description of the entity, in English.
|
|
visuallySimilarImages
|
array [WebImage]
|
The visually similar image results.
|
WebImage
|
object
|
Metadata for online images.
|
Properties
url
|
string
|
The result image URL.
|
score
|
float
|
(Deprecated) Overall relevancy score for the image.
|
|
partialMatchingImages
|
array [WebImage]
|
Partial matching images from the Internet.
Those images are similar enough to share some key-point features. For
example an original image will likely have partial matching for its crops.
|
WebImage
|
object
|
Metadata for online images.
|
Properties
url
|
string
|
The result image URL.
|
score
|
float
|
(Deprecated) Overall relevancy score for the image.
|
|
pagesWithMatchingImages
|
array [WebPage]
|
Web pages containing the matching images from the Internet.
|
WebPage
|
object
|
Metadata for web pages.
|
Properties
url
|
string
|
The result web page URL.
|
score
|
float
|
(Deprecated) Overall relevancy score for the web page.
|
partialMatchingImages
|
array [WebImage]
|
Partial matching images on the page.
Those images are similar enough to share some key-point features. For
example an original image will likely have partial matching for its
crops.
|
WebImage
|
object
|
Metadata for online images.
|
Properties
url
|
string
|
The result image URL.
|
score
|
float
|
(Deprecated) Overall relevancy score for the image.
|
|
pageTitle
|
string
|
Title for the web page, may contain HTML markups.
|
fullMatchingImages
|
array [WebImage]
|
Fully matching images on the page.
Can include resized copies of the query image.
|
WebImage
|
object
|
Metadata for online images.
|
Properties
url
|
string
|
The result image URL.
|
score
|
float
|
(Deprecated) Overall relevancy score for the image.
|
|
|
fullMatchingImages
|
array [WebImage]
|
Fully matching images from the Internet.
Can include resized copies of the query image.
|
WebImage
|
object
|
Metadata for online images.
|
Properties
url
|
string
|
The result image URL.
|
score
|
float
|
(Deprecated) Overall relevancy score for the image.
|
|
bestGuessLabels
|
array [WebLabel]
|
The service's best guess as to the topic of the request image.
Inferred from similar images on the open web.
|
WebLabel
|
object
|
Label to provide extra metadata for the web detection.
|
Properties
|
|
textAnnotations
|
array [EntityAnnotation]
|
If present, text (OCR) detection has completed successfully.
|
EntityAnnotation
|
object
|
Set of detected entity features.
|
Properties
topicality
|
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].
|
score
|
float
|
Overall score of the result. Range [0, 1].
|
properties
|
array [Property]
|
Some entities may have optional user-supplied Property (name/value)
fields, such a score or string that qualifies the entity.
|
Property
|
object
|
A Property consists of a user-supplied name/value pair.
|
Properties
value
|
string
|
Value of the property.
|
uint64Value
|
string
|
Value of numeric properties.
|
name
|
string
|
Name of the property.
|
|
mid
|
string
|
Opaque entity ID. Some IDs may be available in
Google Knowledge Graph Search
API.
|
locations
|
array [LocationInfo]
|
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.
|
LocationInfo
|
object
|
Detected entity location information.
|
Properties
latLng
|
LatLng
|
lat/long location coordinates.
|
LatLng
|
object
|
An object representing a latitude/longitude pair. This is expressed as a pair
of doubles representing degrees latitude and degrees longitude. Unless
specified otherwise, this must conform to the
WGS84
standard. Values must be within normalized ranges.
|
Properties
longitude
|
double
|
The longitude in degrees. It must be in the range [-180.0, +180.0].
|
latitude
|
double
|
The latitude in degrees. It must be in the range [-90.0, +90.0].
|
|
|
locale
|
string
|
The language code for the locale in which the entity textual
description is expressed.
|
description
|
string
|
Entity textual description, expressed in its locale language.
|
confidence
|
float
|
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].
|
boundingPoly
|
BoundingPoly
|
Image region to which this entity belongs. Not produced
for LABEL_DETECTION features.
|
BoundingPoly
|
object
|
A bounding polygon for the detected image annotation.
|
Properties
vertices
|
array [Vertex]
|
The bounding polygon vertices.
|
Vertex
|
object
|
A vertex represents a 2D point in the image.
NOTE: the vertex coordinates are in the same scale as the original image.
|
Properties
y
|
integer
|
Y coordinate.
|
x
|
integer
|
X coordinate.
|
|
normalizedVertices
|
array [NormalizedVertex]
|
The bounding polygon normalized vertices.
|
NormalizedVertex
|
object
|
A vertex represents a 2D point in the image.
NOTE: the normalized vertex coordinates are relative to the original image
and range from 0 to 1.
|
Properties
y
|
float
|
Y coordinate.
|
x
|
float
|
X coordinate.
|
|
|
|
safeSearchAnnotation
|
SafeSearchAnnotation
|
If present, safe-search annotation has completed successfully.
|
SafeSearchAnnotation
|
object
|
Set of features pertaining to the image, computed by computer vision
methods over safe-search verticals (for example, adult, spoof, medical,
violence).
|
Properties
violence
|
string
Allowed values:
- UNKNOWN
- VERY_UNLIKELY
- UNLIKELY
- POSSIBLE
- LIKELY
- VERY_LIKELY
|
Likelihood that this image contains violent content.
|
spoof
|
string
Allowed values:
- UNKNOWN
- VERY_UNLIKELY
- UNLIKELY
- POSSIBLE
- LIKELY
- VERY_LIKELY
|
Spoof likelihood. The likelihood that an modification
was made to the image's canonical version to make it appear
funny or offensive.
|
racy
|
string
Allowed values:
- UNKNOWN
- VERY_UNLIKELY
- UNLIKELY
- POSSIBLE
- LIKELY
- VERY_LIKELY
|
Likelihood that the request image contains racy content. Racy content may
include (but is not limited to) skimpy or sheer clothing, strategically
covered nudity, lewd or provocative poses, or close-ups of sensitive
body areas.
|
medical
|
string
Allowed values:
- UNKNOWN
- VERY_UNLIKELY
- UNLIKELY
- POSSIBLE
- LIKELY
- VERY_LIKELY
|
Likelihood that this is a medical image.
|
adult
|
string
Allowed values:
- UNKNOWN
- VERY_UNLIKELY
- UNLIKELY
- POSSIBLE
- LIKELY
- VERY_LIKELY
|
Represents the adult content likelihood for the image. Adult content may
contain elements such as nudity, pornographic images or cartoons, or
sexual activities.
|
|
productSearchResults
|
ProductSearchResults
|
If present, product search has completed successfully.
|
ProductSearchResults
|
object
|
Results for a product search request.
|
Properties
results
|
array [Result]
|
List of results, one for each product match.
|
Result
|
object
|
Information about a product.
|
Properties
score
|
float
|
A confidence level on the match, ranging from 0 (no confidence) to
1 (full confidence).
|
product
|
Product
|
The Product.
|
Product
|
object
|
A Product contains ReferenceImages.
|
Properties
productLabels
|
array [KeyValue]
|
Key-value pairs that can be attached to a product. At query time,
constraints can be specified based on the product_labels.
Note that integer values can be provided as strings, e.g. "1199". Only
strings with integer values can match a range-based restriction which is
to be supported soon.
Multiple values can be assigned to the same key. One product may have up to
500 product_labels.
Notice that the total number of distinct product_labels over all products
in one ProductSet cannot exceed 1M, otherwise the product search pipeline
will refuse to work for that ProductSet.
|
productCategory
|
string
|
Immutable. The category for the product identified by the reference image. This should
be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories
"homegoods", "apparel", and "toys" are still supported, but these should
not be used for new products.
|
name
|
string
|
The resource name of the product.
Format is:
projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.
This field is ignored when creating a product.
|
displayName
|
string
|
The user-provided name for this Product. Must not be empty. Must be at most
4096 characters long.
|
description
|
string
|
User-provided metadata to be stored with this product. Must be at most 4096
characters long.
|
|
image
|
string
|
The resource name of the image from the product that is the closest match
to the query.
|
|
productGroupedResults
|
array [GroupedResult]
|
List of results grouped by products detected in the query image. Each entry
corresponds to one bounding polygon in the query image, and contains the
matching products specific to that region. There may be duplicate product
matches in the union of all the per-product results.
|
GroupedResult
|
object
|
Information about the products similar to a single product in a query
image.
|
Properties
results
|
array [Result]
|
List of results, one for each product match.
|
Result
|
object
|
Information about a product.
|
Properties
score
|
float
|
A confidence level on the match, ranging from 0 (no confidence) to
1 (full confidence).
|
product
|
Product
|
The Product.
|
image
|
string
|
The resource name of the image from the product that is the closest match
to the query.
|
|
objectAnnotations
|
array [ObjectAnnotation]
|
List of generic predictions for the object in the bounding box.
|
ObjectAnnotation
|
object
|
Prediction for what the object in the bounding box is.
|
Properties
score
|
float
|
Score of the result. Range [0, 1].
|
name
|
string
|
Object name, expressed in its language_code language.
|
mid
|
string
|
Object ID that should align with EntityAnnotation mid.
|
languageCode
|
string
|
The BCP-47 language code, such as "en-US" or "sr-Latn". For more
information, see
http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
|
|
boundingPoly
|
BoundingPoly
|
The bounding polygon around the product detected in the query image.
|
BoundingPoly
|
object
|
A bounding polygon for the detected image annotation.
|
Properties
vertices
|
array [Vertex]
|
The bounding polygon vertices.
|
normalizedVertices
|
array [NormalizedVertex]
|
The bounding polygon normalized vertices.
|
|
|
indexTime
|
string
|
Timestamp of the index which provided these results. Products added to the
product set and products removed from the product set after this time are
not reflected in the current results.
|
|
logoAnnotations
|
array [EntityAnnotation]
|
If present, logo detection has completed successfully.
|
EntityAnnotation
|
object
|
Set of detected entity features.
|
Properties
topicality
|
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].
|
score
|
float
|
Overall score of the result. Range [0, 1].
|
properties
|
array [Property]
|
Some entities may have optional user-supplied Property (name/value)
fields, such a score or string that qualifies the entity.
|
Property
|
object
|
A Property consists of a user-supplied name/value pair.
|
Properties
value
|
string
|
Value of the property.
|
uint64Value
|
string
|
Value of numeric properties.
|
name
|
string
|
Name of the property.
|
|
mid
|
string
|
Opaque entity ID. Some IDs may be available in
Google Knowledge Graph Search
API.
|
locations
|
array [LocationInfo]
|
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.
|
LocationInfo
|
object
|
Detected entity location information.
|
Properties
latLng
|
LatLng
|
lat/long location coordinates.
|
LatLng
|
object
|
An object representing a latitude/longitude pair. This is expressed as a pair
of doubles representing degrees latitude and degrees longitude. Unless
specified otherwise, this must conform to the
WGS84
standard. Values must be within normalized ranges.
|
Properties
longitude
|
double
|
The longitude in degrees. It must be in the range [-180.0, +180.0].
|
latitude
|
double
|
The latitude in degrees. It must be in the range [-90.0, +90.0].
|
|
|
locale
|
string
|
The language code for the locale in which the entity textual
description is expressed.
|
description
|
string
|
Entity textual description, expressed in its locale language.
|
confidence
|
float
|
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].
|
boundingPoly
|
BoundingPoly
|
Image region to which this entity belongs. Not produced
for LABEL_DETECTION features.
|
BoundingPoly
|
object
|
A bounding polygon for the detected image annotation.
|
Properties
vertices
|
array [Vertex]
|
The bounding polygon vertices.
|
Vertex
|
object
|
A vertex represents a 2D point in the image.
NOTE: the vertex coordinates are in the same scale as the original image.
|
Properties
y
|
integer
|
Y coordinate.
|
x
|
integer
|
X coordinate.
|
|
normalizedVertices
|
array [NormalizedVertex]
|
The bounding polygon normalized vertices.
|
NormalizedVertex
|
object
|
A vertex represents a 2D point in the image.
NOTE: the normalized vertex coordinates are relative to the original image
and range from 0 to 1.
|
Properties
y
|
float
|
Y coordinate.
|
x
|
float
|
X coordinate.
|
|
|
|
localizedObjectAnnotations
|
array [LocalizedObjectAnnotation]
|
If present, localized object detection has completed successfully.
This will be sorted descending by confidence score.
|
LocalizedObjectAnnotation
|
object
|
Set of detected objects with bounding boxes.
|
Properties
score
|
float
|
Score of the result. Range [0, 1].
|
name
|
string
|
Object name, expressed in its language_code language.
|
mid
|
string
|
Object ID that should align with EntityAnnotation mid.
|
languageCode
|
string
|
The BCP-47 language code, such as "en-US" or "sr-Latn". For more
information, see
http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
|
boundingPoly
|
BoundingPoly
|
Image region to which this object belongs. This must be populated.
|
BoundingPoly
|
object
|
A bounding polygon for the detected image annotation.
|
Properties
vertices
|
array [Vertex]
|
The bounding polygon vertices.
|
Vertex
|
object
|
A vertex represents a 2D point in the image.
NOTE: the vertex coordinates are in the same scale as the original image.
|
Properties
y
|
integer
|
Y coordinate.
|
x
|
integer
|
X coordinate.
|
|
normalizedVertices
|
array [NormalizedVertex]
|
The bounding polygon normalized vertices.
|
NormalizedVertex
|
object
|
A vertex represents a 2D point in the image.
NOTE: the normalized vertex coordinates are relative to the original image
and range from 0 to 1.
|
Properties
y
|
float
|
Y coordinate.
|
x
|
float
|
X coordinate.
|
|
|
|
landmarkAnnotations
|
array [EntityAnnotation]
|
If present, landmark detection has completed successfully.
|
EntityAnnotation
|
object
|
Set of detected entity features.
|
Properties
topicality
|
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].
|
score
|
float
|
Overall score of the result. Range [0, 1].
|
properties
|
array [Property]
|
Some entities may have optional user-supplied Property (name/value)
fields, such a score or string that qualifies the entity.
|
Property
|
object
|
A Property consists of a user-supplied name/value pair.
|
Properties
value
|
string
|
Value of the property.
|
uint64Value
|
string
|
Value of numeric properties.
|
name
|
string
|
Name of the property.
|
|
mid
|
string
|
Opaque entity ID. Some IDs may be available in
Google Knowledge Graph Search
API.
|
locations
|
array [LocationInfo]
|
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.
|
LocationInfo
|
object
|
Detected entity location information.
|
Properties
latLng
|
LatLng
|
lat/long location coordinates.
|
LatLng
|
object
|
An object representing a latitude/longitude pair. This is expressed as a pair
of doubles representing degrees latitude and degrees longitude. Unless
specified otherwise, this must conform to the
WGS84
standard. Values must be within normalized ranges.
|
Properties
longitude
|
double
|
The longitude in degrees. It must be in the range [-180.0, +180.0].
|
latitude
|
double
|
The latitude in degrees. It must be in the range [-90.0, +90.0].
|
|
|
locale
|
string
|
The language code for the locale in which the entity textual
description is expressed.
|
description
|
string
|
Entity textual description, expressed in its locale language.
|
confidence
|
float
|
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].
|
boundingPoly
|
BoundingPoly
|
Image region to which this entity belongs. Not produced
for LABEL_DETECTION features.
|
BoundingPoly
|
object
|
A bounding polygon for the detected image annotation.
|
Properties
vertices
|
array [Vertex]
|
The bounding polygon vertices.
|
Vertex
|
object
|
A vertex represents a 2D point in the image.
NOTE: the vertex coordinates are in the same scale as the original image.
|
Properties
y
|
integer
|
Y coordinate.
|
x
|
integer
|
X coordinate.
|
|
normalizedVertices
|
array [NormalizedVertex]
|
The bounding polygon normalized vertices.
|
NormalizedVertex
|
object
|
A vertex represents a 2D point in the image.
NOTE: the normalized vertex coordinates are relative to the original image
and range from 0 to 1.
|
Properties
y
|
float
|
Y coordinate.
|
x
|
float
|
X coordinate.
|
|
|
|
labelAnnotations
|
array [EntityAnnotation]
|
If present, label detection has completed successfully.
|
EntityAnnotation
|
object
|
Set of detected entity features.
|
Properties
topicality
|
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].
|
score
|
float
|
Overall score of the result. Range [0, 1].
|
properties
|
array [Property]
|
Some entities may have optional user-supplied Property (name/value)
fields, such a score or string that qualifies the entity.
|
Property
|
object
|
A Property consists of a user-supplied name/value pair.
|
Properties
value
|
string
|
Value of the property.
|
uint64Value
|
string
|
Value of numeric properties.
|
name
|
string
|
Name of the property.
|
|
mid
|
string
|
Opaque entity ID. Some IDs may be available in
Google Knowledge Graph Search
API.
|
locations
|
array [LocationInfo]
|
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.
|
LocationInfo
|
object
|
Detected entity location information.
|
Properties
latLng
|
LatLng
|
lat/long location coordinates.
|
LatLng
|
object
|
An object representing a latitude/longitude pair. This is expressed as a pair
of doubles representing degrees latitude and degrees longitude. Unless
specified otherwise, this must conform to the
WGS84
standard. Values must be within normalized ranges.
|
Properties
longitude
|
double
|
The longitude in degrees. It must be in the range [-180.0, +180.0].
|
latitude
|
double
|
The latitude in degrees. It must be in the range [-90.0, +90.0].
|
|
|
locale
|
string
|
The language code for the locale in which the entity textual
description is expressed.
|
description
|
string
|
Entity textual description, expressed in its locale language.
|
confidence
|
float
|
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].
|
boundingPoly
|
BoundingPoly
|
Image region to which this entity belongs. Not produced
for LABEL_DETECTION features.
|
BoundingPoly
|
object
|
A bounding polygon for the detected image annotation.
|
Properties
vertices
|
array [Vertex]
|
The bounding polygon vertices.
|
Vertex
|
object
|
A vertex represents a 2D point in the image.
NOTE: the vertex coordinates are in the same scale as the original image.
|
Properties
y
|
integer
|
Y coordinate.
|
x
|
integer
|
X coordinate.
|
|
normalizedVertices
|
array [NormalizedVertex]
|
The bounding polygon normalized vertices.
|
NormalizedVertex
|
object
|
A vertex represents a 2D point in the image.
NOTE: the normalized vertex coordinates are relative to the original image
and range from 0 to 1.
|
Properties
y
|
float
|
Y coordinate.
|
x
|
float
|
X coordinate.
|
|
|
|
imagePropertiesAnnotation
|
ImageProperties
|
If present, image properties were extracted successfully.
|
ImageProperties
|
object
|
Stores image properties, such as dominant colors.
|
Properties
dominantColors
|
DominantColorsAnnotation
|
If present, dominant colors completed successfully.
|
DominantColorsAnnotation
|
object
|
Set of dominant colors and their corresponding scores.
|
Properties
colors
|
array [ColorInfo]
|
RGB color values with their score and pixel fraction.
|
ColorInfo
|
object
|
Color information consists of RGB channels, score, and the fraction of
the image that the color occupies in the image.
|
Properties
score
|
float
|
Image-specific score for this color. Value in range [0, 1].
|
pixelFraction
|
float
|
The fraction of pixels the color occupies in the image.
Value in range [0, 1].
|
color
|
Color
|
RGB components of the color.
|
|
|
|
fullTextAnnotation
|
TextAnnotation
|
If present, text (OCR) detection or document (OCR) text detection has
completed successfully.
This annotation provides the structural hierarchy for the OCR detected
text.
|
TextAnnotation
|
object
|
TextAnnotation contains a structured representation of OCR extracted text.
The hierarchy of an OCR extracted text structure is like this:
TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol
Each structural component, starting from Page, may further have their own
properties. Properties describe detected languages, breaks etc.. Please refer
to the TextAnnotation.TextProperty message definition below for more
detail.
|
Properties
text
|
string
|
UTF-8 text detected on the pages.
|
pages
|
array [Page]
|
List of pages detected by OCR.
|
Page
|
object
|
Detected page from OCR.
|
Properties
width
|
integer
|
Page width. For PDFs the unit is points. For images (including
TIFFs) the unit is pixels.
|
property
|
TextProperty
|
Additional information detected on the page.
|
TextProperty
|
object
|
Additional information detected on the structural component.
|
Properties
detectedLanguages
|
array [DetectedLanguage]
|
A list of detected languages together with confidence.
|
detectedBreak
|
DetectedBreak
|
Detected start or end of a text segment.
|
|
height
|
integer
|
Page height. For PDFs the unit is points. For images (including
TIFFs) the unit is pixels.
|
confidence
|
float
|
Confidence of the OCR results on the page. Range [0, 1].
|
blocks
|
array [Block]
|
List of blocks of text, images etc on this page.
|
Block
|
object
|
Logical element on the page.
|
Properties
property
|
TextProperty
|
Additional information detected for the block.
|
paragraphs
|
array [Paragraph]
|
List of paragraphs in this block (if this blocks is of type text).
|
confidence
|
float
|
Confidence of the OCR results on the block. Range [0, 1].
|
boundingBox
|
BoundingPoly
|
The bounding box for the block.
The vertices are in the order of top-left, top-right, bottom-right,
bottom-left. When a rotation of the bounding box is detected the rotation
is represented as around the top-left corner as defined when the text is
read in the 'natural' orientation.
For example:
-
when the text is horizontal it might look like:
0----1
| |
3----2
-
when it's rotated 180 degrees around the top-left corner it becomes:
2----3
| |
1----0
and the vertex order will still be (0, 1, 2, 3).
|
blockType
|
string
Allowed values:
- UNKNOWN
- TEXT
- TABLE
- PICTURE
- RULER
- BARCODE
|
Detected block type (text, image etc) for this block.
|
|
|
|
faceAnnotations
|
array [FaceAnnotation]
|
If present, face detection has completed successfully.
|
FaceAnnotation
|
object
|
A face annotation object contains the results of face detection.
|
Properties
underExposedLikelihood
|
string
Allowed values:
- UNKNOWN
- VERY_UNLIKELY
- UNLIKELY
- POSSIBLE
- LIKELY
- VERY_LIKELY
|
Under-exposed likelihood.
|
tiltAngle
|
float
|
Pitch angle, which indicates the upwards/downwards angle that the face is
pointing relative to the image's horizontal plane. Range [-180,180].
|
surpriseLikelihood
|
string
Allowed values:
- UNKNOWN
- VERY_UNLIKELY
- UNLIKELY
- POSSIBLE
- LIKELY
- VERY_LIKELY
|
Surprise likelihood.
|
sorrowLikelihood
|
string
Allowed values:
- UNKNOWN
- VERY_UNLIKELY
- UNLIKELY
- POSSIBLE
- LIKELY
- VERY_LIKELY
|
Sorrow likelihood.
|
rollAngle
|
float
|
Roll angle, which indicates the amount of clockwise/anti-clockwise rotation
of the face relative to the image vertical about the axis perpendicular to
the face. Range [-180,180].
|
panAngle
|
float
|
Yaw angle, which indicates the leftward/rightward angle that the face is
pointing relative to the vertical plane perpendicular to the image. Range
[-180,180].
|
landmarks
|
array [Landmark]
|
Detected face landmarks.
|
Landmark
|
object
|
A face-specific landmark (for example, a face feature).
|
Properties
type
|
string
Allowed values:
- UNKNOWN_LANDMARK
- LEFT_EYE
- RIGHT_EYE
- LEFT_OF_LEFT_EYEBROW
- RIGHT_OF_LEFT_EYEBROW
- LEFT_OF_RIGHT_EYEBROW
- RIGHT_OF_RIGHT_EYEBROW
- MIDPOINT_BETWEEN_EYES
- NOSE_TIP
- UPPER_LIP
- LOWER_LIP
- MOUTH_LEFT
- MOUTH_RIGHT
- MOUTH_CENTER
- NOSE_BOTTOM_RIGHT
- NOSE_BOTTOM_LEFT
- NOSE_BOTTOM_CENTER
- LEFT_EYE_TOP_BOUNDARY
- LEFT_EYE_RIGHT_CORNER
- LEFT_EYE_BOTTOM_BOUNDARY
- LEFT_EYE_LEFT_CORNER
- RIGHT_EYE_TOP_BOUNDARY
- RIGHT_EYE_RIGHT_CORNER
- RIGHT_EYE_BOTTOM_BOUNDARY
- RIGHT_EYE_LEFT_CORNER
- LEFT_EYEBROW_UPPER_MIDPOINT
- RIGHT_EYEBROW_UPPER_MIDPOINT
- LEFT_EAR_TRAGION
- RIGHT_EAR_TRAGION
- LEFT_EYE_PUPIL
- RIGHT_EYE_PUPIL
- FOREHEAD_GLABELLA
- CHIN_GNATHION
- CHIN_LEFT_GONION
- CHIN_RIGHT_GONION
|
Face landmark type.
|
position
|
Position
|
Face landmark position.
|
Position
|
object
|
A 3D position in the image, used primarily for Face detection landmarks.
A valid Position must have both x and y coordinates.
The position coordinates are in the same scale as the original image.
|
Properties
z
|
float
|
Z coordinate (or depth).
|
y
|
float
|
Y coordinate.
|
x
|
float
|
X coordinate.
|
|
|
landmarkingConfidence
|
float
|
Face landmarking confidence. Range [0, 1].
|
joyLikelihood
|
string
Allowed values:
- UNKNOWN
- VERY_UNLIKELY
- UNLIKELY
- POSSIBLE
- LIKELY
- VERY_LIKELY
|
Joy likelihood.
|
headwearLikelihood
|
string
Allowed values:
- UNKNOWN
- VERY_UNLIKELY
- UNLIKELY
- POSSIBLE
- LIKELY
- VERY_LIKELY
|
Headwear likelihood.
|
fdBoundingPoly
|
BoundingPoly
|
The fd_bounding_poly bounding polygon is tighter than the
boundingPoly, and encloses only the skin part of the face. Typically, it
is used to eliminate the face from any image analysis that detects the
"amount of skin" visible in an image. It is not based on the
landmarker results, only on the initial face detection, hence
the fd (face detection) prefix.
|
BoundingPoly
|
object
|
A bounding polygon for the detected image annotation.
|
Properties
vertices
|
array [Vertex]
|
The bounding polygon vertices.
|
Vertex
|
object
|
A vertex represents a 2D point in the image.
NOTE: the vertex coordinates are in the same scale as the original image.
|
Properties
y
|
integer
|
Y coordinate.
|
x
|
integer
|
X coordinate.
|
|
normalizedVertices
|
array [NormalizedVertex]
|
The bounding polygon normalized vertices.
|
NormalizedVertex
|
object
|
A vertex represents a 2D point in the image.
NOTE: the normalized vertex coordinates are relative to the original image
and range from 0 to 1.
|
Properties
y
|
float
|
Y coordinate.
|
x
|
float
|
X coordinate.
|
|
|
detectionConfidence
|
float
|
Detection confidence. Range [0, 1].
|
boundingPoly
|
BoundingPoly
|
The bounding polygon around the face. The coordinates of the bounding box
are in the original image's scale.
The bounding box is computed to "frame" the face in accordance with human
expectations. It is based on the landmarker results.
Note that one or more x and/or y coordinates may not be generated in the
BoundingPoly (the polygon will be unbounded) if only a partial face
appears in the image to be annotated.
|
BoundingPoly
|
object
|
A bounding polygon for the detected image annotation.
|
Properties
vertices
|
array [Vertex]
|
The bounding polygon vertices.
|
Vertex
|
object
|
A vertex represents a 2D point in the image.
NOTE: the vertex coordinates are in the same scale as the original image.
|
Properties
y
|
integer
|
Y coordinate.
|
x
|
integer
|
X coordinate.
|
|
normalizedVertices
|
array [NormalizedVertex]
|
The bounding polygon normalized vertices.
|
NormalizedVertex
|
object
|
A vertex represents a 2D point in the image.
NOTE: the normalized vertex coordinates are relative to the original image
and range from 0 to 1.
|
Properties
y
|
float
|
Y coordinate.
|
x
|
float
|
X coordinate.
|
|
|
blurredLikelihood
|
string
Allowed values:
- UNKNOWN
- VERY_UNLIKELY
- UNLIKELY
- POSSIBLE
- LIKELY
- VERY_LIKELY
|
Blurred likelihood.
|
angerLikelihood
|
string
Allowed values:
- UNKNOWN
- VERY_UNLIKELY
- UNLIKELY
- POSSIBLE
- LIKELY
- VERY_LIKELY
|
Anger likelihood.
|
|
error
|
Status
|
If set, represents the error message for the operation.
Note that filled-in image annotations are guaranteed to be
correct, even when error is set.
|
Status
|
object
|
The Status type defines a logical error model that is suitable for
different programming environments, including REST APIs and RPC APIs. It is
used by gRPC. Each Status message contains
three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the
API Design Guide.
|
Properties
message
|
string
|
A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
google.rpc.Status.details field, or localized by the client.
|
details
|
array [object]
|
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
|
code
|
integer
|
The status code, which should be an enum value of google.rpc.Code.
|
|
cropHintsAnnotation
|
CropHintsAnnotation
|
If present, crop hints have completed successfully.
|
CropHintsAnnotation
|
object
|
Set of crop hints that are used to generate new crops when serving images.
|
Properties
cropHints
|
array [CropHint]
|
Crop hint results.
|
CropHint
|
object
|
Single crop hint that is used to generate a new crop when serving an image.
|
Properties
importanceFraction
|
float
|
Fraction of importance of this salient region with respect to the original
image.
|
confidence
|
float
|
Confidence of this being a salient region. Range [0, 1].
|
boundingPoly
|
BoundingPoly
|
The bounding polygon for the crop region. The coordinates of the bounding
box are in the original image's scale.
|
BoundingPoly
|
object
|
A bounding polygon for the detected image annotation.
|
Properties
vertices
|
array [Vertex]
|
The bounding polygon vertices.
|
normalizedVertices
|
array [NormalizedVertex]
|
The bounding polygon normalized vertices.
|
|
|
|
context
|
ImageAnnotationContext
|
If present, contextual information is needed to understand where this image
comes from.
|
ImageAnnotationContext
|
object
|
If an image was produced from a file (e.g. a PDF), this message gives
information about the source of that image.
|
Properties
uri
|
string
|
The URI of the file used to produce the image.
|
pageNumber
|
integer
|
If the file was a PDF or TIFF, this field gives the page number within
the file used to produce the image.
|
|
