v1p2beta1

v1p2beta1

Source:

Members

(static) BlockType :number

Type of a block (text, image etc) as identified by OCR.

Properties:
Name Type Description
UNKNOWN number

Unknown block type.

TEXT number

Regular text block.

TABLE number

Table block.

PICTURE number

Image block.

RULER number

Horizontal/vertical line box.

BARCODE number

Barcode block.

Source:

(static) BreakType :number

Enum to denote the type of break found. New line, space etc.

Properties:
Name Type Description
UNKNOWN number

Unknown break label type.

SPACE number

Regular space.

SURE_SPACE number

Sure space (very wide).

EOL_SURE_SPACE number

Line-wrapping break.

HYPHEN number

End-line hyphen that is not present in text; does not co-occur with SPACE, LEADER_SPACE, or LINE_BREAK.

LINE_BREAK number

Line break that ends a paragraph.

Source:

(static, constant) Likelihood :number

A bucketized representation of likelihood, which is intended to give clients highly stable results across model upgrades.

Properties:
Name Type Description
UNKNOWN number

Unknown likelihood.

VERY_UNLIKELY number

It is very unlikely that the image belongs to the specified vertical.

UNLIKELY number

It is unlikely that the image belongs to the specified vertical.

POSSIBLE number

It is possible that the image belongs to the specified vertical.

LIKELY number

It is likely that the image belongs to the specified vertical.

VERY_LIKELY number

It is very likely that the image belongs to the specified vertical.

Source:

(static) State :number

Batch operation states.

Properties:
Name Type Description
STATE_UNSPECIFIED number

Invalid.

CREATED number

Request is received.

RUNNING number

Request is actively being processed.

DONE number

The batch processing is done.

CANCELLED number

The batch processing was cancelled.

Source:

(static) Type :number

Type of Google Cloud Vision API feature to be extracted.

Properties:
Name Type Description
TYPE_UNSPECIFIED number

Unspecified feature type.

FACE_DETECTION number

Run face detection.

LANDMARK_DETECTION number

Run landmark detection.

LOGO_DETECTION number

Run logo detection.

LABEL_DETECTION number

Run label detection.

TEXT_DETECTION number

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.

DOCUMENT_TEXT_DETECTION number

Run dense text document OCR. Takes precedence when both DOCUMENT_TEXT_DETECTION and TEXT_DETECTION are present.

SAFE_SEARCH_DETECTION number

Run Safe Search to detect potentially unsafe or undesirable content.

IMAGE_PROPERTIES number

Compute a set of image properties, such as the image's dominant colors.

CROP_HINTS number

Run crop hints.

WEB_DETECTION number

Run web detection.

Source:

(static) Type :number

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.

Properties:
Name Type Description
UNKNOWN_LANDMARK number

Unknown face landmark detected. Should not be filled.

LEFT_EYE number

Left eye.

RIGHT_EYE number

Right eye.

LEFT_OF_LEFT_EYEBROW number

Left of left eyebrow.

RIGHT_OF_LEFT_EYEBROW number

Right of left eyebrow.

LEFT_OF_RIGHT_EYEBROW number

Left of right eyebrow.

RIGHT_OF_RIGHT_EYEBROW number

Right of right eyebrow.

MIDPOINT_BETWEEN_EYES number

Midpoint between eyes.

NOSE_TIP number

Nose tip.

UPPER_LIP number

Upper lip.

LOWER_LIP number

Lower lip.

MOUTH_LEFT number

Mouth left.

MOUTH_RIGHT number

Mouth right.

MOUTH_CENTER number

Mouth center.

NOSE_BOTTOM_RIGHT number

Nose, bottom right.

NOSE_BOTTOM_LEFT number

Nose, bottom left.

NOSE_BOTTOM_CENTER number

Nose, bottom center.

LEFT_EYE_TOP_BOUNDARY number

Left eye, top boundary.

LEFT_EYE_RIGHT_CORNER number

Left eye, right corner.

LEFT_EYE_BOTTOM_BOUNDARY number

Left eye, bottom boundary.

LEFT_EYE_LEFT_CORNER number

Left eye, left corner.

RIGHT_EYE_TOP_BOUNDARY number

Right eye, top boundary.

RIGHT_EYE_RIGHT_CORNER number

Right eye, right corner.

RIGHT_EYE_BOTTOM_BOUNDARY number

Right eye, bottom boundary.

RIGHT_EYE_LEFT_CORNER number

Right eye, left corner.

LEFT_EYEBROW_UPPER_MIDPOINT number

Left eyebrow, upper midpoint.

RIGHT_EYEBROW_UPPER_MIDPOINT number

Right eyebrow, upper midpoint.

LEFT_EAR_TRAGION number

Left ear tragion.

RIGHT_EAR_TRAGION number

Right ear tragion.

LEFT_EYE_PUPIL number

Left eye pupil.

RIGHT_EYE_PUPIL number

Right eye pupil.

FOREHEAD_GLABELLA number

Forehead glabella.

CHIN_GNATHION number

Chin gnathion.

CHIN_LEFT_GONION number

Chin left gonion.

CHIN_RIGHT_GONION number

Chin right gonion.

Source:

Type Definitions

AnnotateFileResponse

Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.

Properties:
Name Type Description
inputConfig Object

Information about the file for which this response is generated.

This object should have the same structure as InputConfig

responses Array.<Object>

Individual responses to images found within the file.

This object should have the same structure as AnnotateImageResponse

Source:
See:

AnnotateImageRequest

Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features.

Properties:
Name Type Description
image Object

The image to be processed.

This object should have the same structure as Image

features Array.<Object>

Requested features.

This object should have the same structure as Feature

imageContext Object

Additional context that may accompany the image.

This object should have the same structure as ImageContext

Source:
See:

AnnotateImageResponse

Response to an image annotation request.

Properties:
Name Type Description
faceAnnotations Array.<Object>

If present, face detection has completed successfully.

This object should have the same structure as FaceAnnotation

landmarkAnnotations Array.<Object>

If present, landmark detection has completed successfully.

This object should have the same structure as EntityAnnotation

logoAnnotations Array.<Object>

If present, logo detection has completed successfully.

This object should have the same structure as EntityAnnotation

labelAnnotations Array.<Object>

If present, label detection has completed successfully.

This object should have the same structure as EntityAnnotation

textAnnotations Array.<Object>

If present, text (OCR) detection has completed successfully.

This object should have the same structure as EntityAnnotation

fullTextAnnotation Object

If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text.

This object should have the same structure as TextAnnotation

safeSearchAnnotation Object

If present, safe-search annotation has completed successfully.

This object should have the same structure as SafeSearchAnnotation

imagePropertiesAnnotation Object

If present, image properties were extracted successfully.

This object should have the same structure as ImageProperties

cropHintsAnnotation Object

If present, crop hints have completed successfully.

This object should have the same structure as CropHintsAnnotation

webDetection Object

If present, web detection has completed successfully.

This object should have the same structure as WebDetection

error Object

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.

This object should have the same structure as Status

context Object

If present, contextual information is needed to understand where this image comes from.

This object should have the same structure as ImageAnnotationContext

Source:
See:

AsyncAnnotateFileRequest

An offline file annotation request.

Properties:
Name Type Description
inputConfig Object

Required. Information about the input file.

This object should have the same structure as InputConfig

features Array.<Object>

Required. Requested features.

This object should have the same structure as Feature

imageContext Object

Additional context that may accompany the image(s) in the file.

This object should have the same structure as ImageContext

outputConfig Object

Required. The desired output location and metadata (e.g. format).

This object should have the same structure as OutputConfig

Source:
See:

AsyncAnnotateFileResponse

The response for a single offline file annotation request.

Properties:
Name Type Description
outputConfig Object

The output location and metadata from AsyncAnnotateFileRequest.

This object should have the same structure as OutputConfig

Source:
See:

AsyncBatchAnnotateFilesRequest

Multiple async file annotation requests are batched into a single service call.

Properties:
Name Type Description
requests Array.<Object>

Individual async file annotation requests for this batch.

This object should have the same structure as AsyncAnnotateFileRequest

Source:
See:

AsyncBatchAnnotateFilesResponse

Response to an async batch file annotation request.

Properties:
Name Type Description
responses Array.<Object>

The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.

This object should have the same structure as AsyncAnnotateFileResponse

Source:
See:

BatchAnnotateImagesRequest

Multiple image annotation requests are batched into a single service call.

Properties:
Name Type Description
requests Array.<Object>

Individual image annotation requests for this batch.

This object should have the same structure as AnnotateImageRequest

Source:
See:

BatchAnnotateImagesResponse

Response to a batch image annotation request.

Properties:
Name Type Description
responses Array.<Object>

Individual responses to image annotation requests within the batch.

This object should have the same structure as AnnotateImageResponse

Source:
See:

Block

Logical element on the page.

Properties:
Name Type Description
property Object

Additional information detected for the block.

This object should have the same structure as TextProperty

boundingBox Object

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).

This object should have the same structure as BoundingPoly

paragraphs Array.<Object>

List of paragraphs in this block (if this blocks is of type text).

This object should have the same structure as Paragraph

blockType number

Detected block type (text, image etc) for this block.

The number should be among the values of BlockType

confidence number

Confidence of the OCR results on the block. Range [0, 1].

Source:
See:

BoundingPoly

A bounding polygon for the detected image annotation.

Properties:
Name Type Description
vertices Array.<Object>

The bounding polygon vertices.

This object should have the same structure as Vertex

normalizedVertices Array.<Object>

The bounding polygon normalized vertices.

This object should have the same structure as NormalizedVertex

Source:
See:

ColorInfo

Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.

Properties:
Name Type Description
color Object

RGB components of the color.

This object should have the same structure as Color

score number

Image-specific score for this color. Value in range [0, 1].

pixelFraction number

The fraction of pixels the color occupies in the image. Value in range [0, 1].

Source:
See:

CropHint

Single crop hint that is used to generate a new crop when serving an image.

Properties:
Name Type Description
boundingPoly Object

The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale, as returned in ImageParams.

This object should have the same structure as BoundingPoly

confidence number

Confidence of this being a salient region. Range [0, 1].

importanceFraction number

Fraction of importance of this salient region with respect to the original image.

Source:
See:

CropHintsAnnotation

Set of crop hints that are used to generate new crops when serving images.

Properties:
Name Type Description
cropHints Array.<Object>

Crop hint results.

This object should have the same structure as CropHint

Source:
See:

CropHintsParams

Parameters for crop hints annotation request.

Properties:
Name Type Description
aspectRatios Array.<number>

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.

Source:
See:

DetectedBreak

Detected start or end of a structural component.

Properties:
Name Type Description
type number

Detected break type.

The number should be among the values of BreakType

isPrefix boolean

True if break prepends the element.

Source:
See:

DetectedLanguage

Detected language for a structural component.

Properties:
Name Type Description
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.

confidence number

Confidence of detected language. Range [0, 1].

Source:
See:

DominantColorsAnnotation

Set of dominant colors and their corresponding scores.

Properties:
Name Type Description
colors Array.<Object>

RGB color values with their score and pixel fraction.

This object should have the same structure as ColorInfo

Source:
See:

EntityAnnotation

Set of detected entity features.

Properties:
Name Type Description
mid string

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

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.

score number

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

confidence number

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].

topicality number

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].

boundingPoly Object

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

This object should have the same structure as BoundingPoly

locations Array.<Object>

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.

This object should have the same structure as LocationInfo

properties Array.<Object>

Some entities may have optional user-supplied Property (name/value) fields, such a score or string that qualifies the entity.

This object should have the same structure as Property

Source:
See:

FaceAnnotation

A face annotation object contains the results of face detection.

Properties:
Name Type Description
boundingPoly Object

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.

This object should have the same structure as BoundingPoly

fdBoundingPoly Object

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.

This object should have the same structure as BoundingPoly

landmarks Array.<Object>

Detected face landmarks.

This object should have the same structure as Landmark

rollAngle number

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 number

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].

tiltAngle number

Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].

detectionConfidence number

Detection confidence. Range [0, 1].

landmarkingConfidence number

Face landmarking confidence. Range [0, 1].

joyLikelihood number

Joy likelihood.

The number should be among the values of Likelihood

sorrowLikelihood number

Sorrow likelihood.

The number should be among the values of Likelihood

angerLikelihood number

Anger likelihood.

The number should be among the values of Likelihood

surpriseLikelihood number

Surprise likelihood.

The number should be among the values of Likelihood

underExposedLikelihood number

Under-exposed likelihood.

The number should be among the values of Likelihood

blurredLikelihood number

Blurred likelihood.

The number should be among the values of Likelihood

headwearLikelihood number

Headwear likelihood.

The number should be among the values of Likelihood

Source:
See:

Feature

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.

Properties:
Name Type Description
type number

The feature type.

The number should be among the values of Type

maxResults number

Maximum number of results of this type. Does not apply to TEXT_DETECTION, DOCUMENT_TEXT_DETECTION, or CROP_HINTS.

model string

Model to use for the feature. Supported values: "builtin/stable" (the default if unset) and "builtin/latest".

Source:
See:

GcsDestination

The Google Cloud Storage location where the output will be written to.

Properties:
Name Type Description
uri string

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.

Source:
See:

GcsSource

The Google Cloud Storage location where the input will be read from.

Properties:
Name Type Description
uri string

Google Cloud Storage URI for the input file. This must only be a GCS object. Wildcards are not currently supported.

Source:
See:

Image

Client image to perform Google Cloud Vision API tasks over.

Properties:
Name Type Description
content Buffer

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.

source Object

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.

This object should have the same structure as ImageSource

Source:
See:

ImageAnnotationContext

If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.

Properties:
Name Type Description
uri string

The URI of the file used to produce the image.

pageNumber number

If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.

Source:
See:

ImageContext

Image context and/or feature-specific parameters.

Properties:
Name Type Description
latLongRect Object

Not used.

This object should have the same structure as LatLongRect

languageHints Array.<string>

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.

cropHintsParams Object

Parameters for crop hints annotation request.

This object should have the same structure as CropHintsParams

webDetectionParams Object

Parameters for web detection.

This object should have the same structure as WebDetectionParams

Source:
See:

ImageProperties

Stores image properties, such as dominant colors.

Properties:
Name Type Description
dominantColors Object

If present, dominant colors completed successfully.

This object should have the same structure as DominantColorsAnnotation

Source:
See:

ImageSource

External image source (Google Cloud Storage or web URL image location).

Properties:
Name Type Description
gcsImageUri string

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 for more info.

imageUri string

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 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.

Source:
See:

InputConfig

The desired input location and metadata.

Properties:
Name Type Description
gcsSource Object

The Google Cloud Storage location to read the input from.

This object should have the same structure as GcsSource

mimeType string

The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported.

Source:
See:

Landmark

A face-specific landmark (for example, a face feature).

Properties:
Name Type Description
type number

Face landmark type.

The number should be among the values of Type

position Object

Face landmark position.

This object should have the same structure as Position

Source:
See:

LatLongRect

Rectangle determined by min and max LatLng pairs.

Properties:
Name Type Description
minLatLng Object

Min lat/long pair.

This object should have the same structure as LatLng

maxLatLng Object

Max lat/long pair.

This object should have the same structure as LatLng

Source:
See:

LocationInfo

Detected entity location information.

Properties:
Name Type Description
latLng Object

lat/long location coordinates.

This object should have the same structure as LatLng

Source:
See:

NormalizedVertex

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:
Name Type Description
x number

X coordinate.

y number

Y coordinate.

Source:
See:

OperationMetadata

Contains metadata for the BatchAnnotateImages operation.

Properties:
Name Type Description
state number

Current state of the batch operation.

The number should be among the values of State

createTime Object

The time when the batch request was received.

This object should have the same structure as Timestamp

updateTime Object

The time when the operation result was last updated.

This object should have the same structure as Timestamp

Source:
See:

OutputConfig

The desired output location and metadata.

Properties:
Name Type Description
gcsDestination Object

The Google Cloud Storage location to write the output(s) to.

This object should have the same structure as GcsDestination

batchSize number

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.

Source:
See:

Page

Detected page from OCR.

Properties:
Name Type Description
property Object

Additional information detected on the page.

This object should have the same structure as TextProperty

width number

Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.

height number

Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.

blocks Array.<Object>

List of blocks of text, images etc on this page.

This object should have the same structure as Block

confidence number

Confidence of the OCR results on the page. Range [0, 1].

Source:
See:

Paragraph

Structural unit of text representing a number of words in certain order.

Properties:
Name Type Description
property Object

Additional information detected for the paragraph.

This object should have the same structure as TextProperty

boundingBox Object

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).

This object should have the same structure as BoundingPoly

words Array.<Object>

List of words in this paragraph.

This object should have the same structure as Word

confidence number

Confidence of the OCR results for the paragraph. Range [0, 1].

Source:
See:

Position

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:
Name Type Description
x number

X coordinate.

y number

Y coordinate.

z number

Z coordinate (or depth).

Source:
See:

Property

A Property consists of a user-supplied name/value pair.

Properties:
Name Type Description
name string

Name of the property.

value string

Value of the property.

uint64Value number

Value of numeric properties.

Source:
See:

SafeSearchAnnotation

Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).

Properties:
Name Type Description
adult number

Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.

The number should be among the values of Likelihood

spoof number

Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.

The number should be among the values of Likelihood

medical number

Likelihood that this is a medical image.

The number should be among the values of Likelihood

violence number

Likelihood that this image contains violent content.

The number should be among the values of Likelihood

racy number

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.

The number should be among the values of Likelihood

Source:
See:

Symbol

A single symbol representation.

Properties:
Name Type Description
property Object

Additional information detected for the symbol.

This object should have the same structure as TextProperty

boundingBox Object

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).

This object should have the same structure as BoundingPoly

text string

The actual UTF-8 representation of the symbol.

confidence number

Confidence of the OCR results for the symbol. Range [0, 1].

Source:
See:

TextAnnotation

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:
Name Type Description
pages Array.<Object>

List of pages detected by OCR.

This object should have the same structure as Page

text string

UTF-8 text detected on the pages.

Source:
See:

TextProperty

Additional information detected on the structural component.

Properties:
Name Type Description
detectedLanguages Array.<Object>

A list of detected languages together with confidence.

This object should have the same structure as DetectedLanguage

detectedBreak Object

Detected start or end of a text segment.

This object should have the same structure as DetectedBreak

Source:
See:

Vertex

A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

Properties:
Name Type Description
x number

X coordinate.

y number

Y coordinate.

Source:
See:

WebDetection

Relevant information for the image from the Internet.

Properties:
Name Type Description
webEntities Array.<Object>

Deduced entities from similar images on the Internet.

This object should have the same structure as WebEntity

fullMatchingImages Array.<Object>

Fully matching images from the Internet. Can include resized copies of the query image.

This object should have the same structure as WebImage

partialMatchingImages Array.<Object>

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.

This object should have the same structure as WebImage

pagesWithMatchingImages Array.<Object>

Web pages containing the matching images from the Internet.

This object should have the same structure as WebPage

visuallySimilarImages Array.<Object>

The visually similar image results.

This object should have the same structure as WebImage

bestGuessLabels Array.<Object>

Best guess text labels for the request image.

This object should have the same structure as WebLabel

Source:
See:

WebDetectionParams

Parameters for web detection request.

Properties:
Name Type Description
includeGeoResults boolean

Whether to include results derived from the geo information in the image.

Source:
See:

WebEntity

Entity deduced from similar images on the Internet.

Properties:
Name Type Description
entityId string

Opaque entity ID.

score number

Overall relevancy score for the entity. Not normalized and not comparable across different image queries.

description string

Canonical description of the entity, in English.

Source:
See:

WebImage

Metadata for online images.

Properties:
Name Type Description
url string

The result image URL.

score number

(Deprecated) Overall relevancy score for the image.

Source:
See:

WebLabel

Label to provide extra metadata for the web detection.

Properties:
Name Type Description
label string

Label for extra metadata.

languageCode string

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.

Source:
See:

WebPage

Metadata for web pages.

Properties:
Name Type Description
url string

The result web page URL.

score number

(Deprecated) Overall relevancy score for the web page.

pageTitle string

Title for the web page, may contain HTML markups.

fullMatchingImages Array.<Object>

Fully matching images on the page. Can include resized copies of the query image.

This object should have the same structure as WebImage

partialMatchingImages Array.<Object>

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.

This object should have the same structure as WebImage

Source:
See:

Word

A word representation.

Properties:
Name Type Description
property Object

Additional information detected for the word.

This object should have the same structure as TextProperty

boundingBox Object

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).

This object should have the same structure as BoundingPoly

symbols Array.<Object>

List of symbols in the word. The order of the symbols follows the natural reading order.

This object should have the same structure as Symbol

confidence number

Confidence of the OCR results for the word. Range [0, 1].

Source:
See: