Get desktop application:
View/edit binary Protocol Buffers messages
Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.
Run image detection and annotation for a batch of images.
Multiple image annotation requests are batched into a single service call.
Individual image annotation requests for this batch.
Response to a batch image annotation request.
Individual responses to image annotation requests within the batch.
Run async image detection and annotation for a list of generic files (e.g. PDF) which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).
Multiple async file annotation requests are batched into a single service call.
Individual async file annotation requests for this batch.
Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.
Information about the file for which this response is generated.
Individual responses to images found within the file.
Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features.
Used in:
The image to be processed.
Requested features.
Additional context that may accompany the image.
Response to an image annotation request.
Used in:
,If present, face detection has completed successfully.
If present, landmark detection has completed successfully.
If present, logo detection has completed successfully.
If present, label detection has completed successfully.
If present, text (OCR) detection has completed successfully.
If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text.
If present, safe-search annotation has completed successfully.
If present, image properties were extracted successfully.
If present, crop hints have completed successfully.
If present, web detection has completed successfully.
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.
If present, contextual information is needed to understand where this image comes from.
An offline file annotation request.
Used in:
Required. Information about the input file.
Required. Requested features.
Additional context that may accompany the image(s) in the file.
Required. The desired output location and metadata (e.g. format).
The response for a single offline file annotation request.
Used in:
The output location and metadata from AsyncAnnotateFileRequest.
Response to an async batch file annotation request.
The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.
Logical element on the page.
Used in:
Additional information detected for the block.
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 vertice order will still be (0, 1, 2, 3).
List of paragraphs in this block (if this blocks is of type text).
Detected block type (text, image etc) for this block.
Confidence of the OCR results on the block. Range [0, 1].
Type of a block (text, image etc) as identified by OCR.
Used in:
Unknown block type.
Regular text block.
Table block.
Image block.
Horizontal/vertical line box.
Barcode block.
A bounding polygon for the detected image annotation.
Used in:
, , , , , ,The bounding polygon vertices.
The bounding polygon normalized vertices.
Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.
Used in:
RGB components of the color.
Image-specific score for this color. Value in range [0, 1].
The fraction of pixels the color occupies in the image. Value in range [0, 1].
Single crop hint that is used to generate a new crop when serving an image.
Used in:
The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale, as returned in `ImageParams`.
Confidence of this being a salient region. Range [0, 1].
Fraction of importance of this salient region with respect to the original image.
Set of crop hints that are used to generate new crops when serving images.
Used in:
Crop hint results.
Parameters for crop hints annotation request.
Used in:
Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored.
Set of dominant colors and their corresponding scores.
Used in:
RGB color values with their score and pixel fraction.
Set of detected entity features.
Used in:
Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).
The language code for the locale in which the entity textual `description` is expressed.
Entity textual description, expressed in its `locale` language.
Overall score of the result. Range [0, 1].
**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].
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].
Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features.
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.
Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.
A face annotation object contains the results of face detection.
Used in:
The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale, as returned in `ImageParams`. 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.
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 <code>fd</code> (face detection) prefix.
Detected face landmarks.
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].
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].
Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].
Detection confidence. Range [0, 1].
Face landmarking confidence. Range [0, 1].
Joy likelihood.
Sorrow likelihood.
Anger likelihood.
Surprise likelihood.
Under-exposed likelihood.
Blurred likelihood.
Headwear likelihood.
A face-specific landmark (for example, a face feature).
Used in:
Face landmark type.
Face landmark position.
Face landmark (feature) type. Left and right are defined from the vantage of the viewer of the image without considering mirror projections typical of photos. So, `LEFT_EYE`, typically, is the person's right eye.
Used in:
Unknown face landmark detected. Should not be filled.
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.
The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list.
Used in:
,The feature type.
Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.
Model to use for the feature. Supported values: "builtin/stable" (the default if unset) and "builtin/latest".
Type of Google Cloud Vision API feature to be extracted.
Used in:
Unspecified feature type.
Run face detection.
Run landmark detection.
Run logo detection.
Run label detection.
Run text detection / optical character recognition (OCR). Text detection is optimized for areas of text within a larger image; if the image is a document, use `DOCUMENT_TEXT_DETECTION` instead.
Run dense text document OCR. Takes precedence when both `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` are present.
Run Safe Search to detect potentially unsafe or undesirable content.
Compute a set of image properties, such as the image's dominant colors.
Run crop hints.
Run web detection.
The Google Cloud Storage location where the output will be written to.
Used in:
Google Cloud Storage URI where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI. This field can either represent a single file, or a prefix for multiple outputs. Prefixes must end in a `/`. Examples: * File: gs://bucket-name/filename.json * Prefix: gs://bucket-name/prefix/here/ * File: gs://bucket-name/prefix/here If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.
The Google Cloud Storage location where the input will be read from.
Used in:
Google Cloud Storage URI for the input file. This must only be a GCS object. Wildcards are not currently supported.
Client image to perform Google Cloud Vision API tasks over.
Used in:
Image content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
Google Cloud Storage image location, or publicly-accessible image URL. If both `content` and `source` are provided for an image, `content` takes precedence and is used to perform the image annotation request.
If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.
Used in:
The URI of the file used to produce the image.
If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.
Image context and/or feature-specific parameters.
Used in:
,Not used.
List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](/vision/docs/languages).
Parameters for crop hints annotation request.
Parameters for web detection.
Stores image properties, such as dominant colors.
Used in:
If present, dominant colors completed successfully.
External image source (Google Cloud Storage or web URL image location).
Used in:
**Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.
The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence.
The desired input location and metadata.
Used in:
,The Google Cloud Storage location to read the input from.
The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported.
Rectangle determined by min and max `LatLng` pairs.
Used in:
Min lat/long pair.
Max lat/long pair.
A bucketized representation of likelihood, which is intended to give clients highly stable results across model upgrades.
Used in:
,Unknown likelihood.
It is very unlikely that the image belongs to the specified vertical.
It is unlikely that the image belongs to the specified vertical.
It is possible that the image belongs to the specified vertical.
It is likely that the image belongs to the specified vertical.
It is very likely that the image belongs to the specified vertical.
Detected entity location information.
Used in:
lat/long location coordinates.
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.
Used in:
X coordinate.
Y coordinate.
Contains metadata for the BatchAnnotateImages operation.
Current state of the batch operation.
The time when the batch request was received.
The time when the operation result was last updated.
Batch operation states.
Used in:
Invalid.
Request is received.
Request is actively being processed.
The batch processing is done.
The batch processing was cancelled.
The desired output location and metadata.
Used in:
,The Google Cloud Storage location to write the output(s) to.
The max number of response protos to put into each output JSON file on GCS. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.
Detected page from OCR.
Used in:
Additional information detected on the page.
Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.
Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.
List of blocks of text, images etc on this page.
Confidence of the OCR results on the page. Range [0, 1].
Structural unit of text representing a number of words in certain order.
Used in:
Additional information detected for the paragraph.
The bounding box for the paragraph. 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 vertice order will still be (0, 1, 2, 3).
List of words in this paragraph.
Confidence of the OCR results for the paragraph. Range [0, 1].
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.
Used in:
X coordinate.
Y coordinate.
Z coordinate (or depth).
A `Property` consists of a user-supplied name/value pair.
Used in:
Name of the property.
Value of the property.
Value of numeric properties.
Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).
Used in:
Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.
Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.
Likelihood that this is a medical image.
Likelihood that this image contains violent content.
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.
A single symbol representation.
Used in:
Additional information detected for the symbol.
The bounding box for the symbol. 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 vertice order will still be (0, 1, 2, 3).
The actual UTF-8 representation of the symbol.
Confidence of the OCR results for the symbol. Range [0, 1].
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][google.cloud.vision.v1p2beta1.TextAnnotation.TextProperty] message definition below for more detail.
Used in:
List of pages detected by OCR.
UTF-8 text detected on the pages.
Detected start or end of a structural component.
Used in:
Detected break type.
True if break prepends the element.
Enum to denote the type of break found. New line, space etc.
Used in:
Unknown break label type.
Regular space.
Sure space (very wide).
Line-wrapping break.
End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.
Line break that ends a paragraph.
Detected language for a structural component.
Used in:
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.
Confidence of detected language. Range [0, 1].
Additional information detected on the structural component.
Used in:
, , , ,A list of detected languages together with confidence.
Detected start or end of a text segment.
A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
Used in:
X coordinate.
Y coordinate.
Relevant information for the image from the Internet.
Used in:
Deduced entities from similar images on the Internet.
Fully matching images from the Internet. Can include resized copies of the query image.
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.
Web pages containing the matching images from the Internet.
The visually similar image results.
Best guess text labels for the request image.
Entity deduced from similar images on the Internet.
Used in:
Opaque entity ID.
Overall relevancy score for the entity. Not normalized and not comparable across different image queries.
Canonical description of the entity, in English.
Metadata for online images.
Used in:
,The result image URL.
(Deprecated) Overall relevancy score for the image.
Label to provide extra metadata for the web detection.
Used in:
Label for extra metadata.
The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
Metadata for web pages.
Used in:
The result web page URL.
(Deprecated) Overall relevancy score for the web page.
Title for the web page, may contain HTML markups.
Fully matching images on the page. Can include resized copies of the query image.
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.
Parameters for web detection request.
Used in:
Whether to include results derived from the geo information in the image.
A word representation.
Used in:
Additional information detected for the word.
The bounding box for the word. 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 vertice order will still be (0, 1, 2, 3).
List of symbols in the word. The order of the symbols follows the natural reading order.
Confidence of the OCR results for the word. Range [0, 1].