v1

v1

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.

UNLIKELY number

It is unlikely.

POSSIBLE number

It is possible.

LIKELY number

It is likely.

VERY_LIKELY number

It is very likely.

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) State :number

Enumerates the possible states that the batch request can be in.

Properties:
Name Type Description
STATE_UNSPECIFIED number

Invalid.

PROCESSING number

Request is actively being processed.

SUCCESSFUL number

The request is done and at least one item has been successfully processed.

FAILED number

The request is done and no item has been successfully processed.

CANCELLED number

The request is done after the longrunning.Operations.CancelOperation has been called by the user. Any records that were processed before the cancel command are output as specified in the request.

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.

PRODUCT_SEARCH number

Run Product Search.

OBJECT_LOCALIZATION number

Run localizer for object 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

AddProductToProductSetRequest

Request message for the AddProductToProductSet method.

Properties:
Name Type Description
name string

Required. The resource name for the ProductSet to modify.

Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

product string

Required. The resource name for the Product to be added to this ProductSet.

Format is: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

Source:
See:

AnnotateFileRequest

A request to annotate one single file, e.g. a PDF, TIFF or GIF file.

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

pages Array.<number>

Pages of the file to perform image annotation.

Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative.

Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page.

If the file is GIF instead of PDF or TIFF, page refers to GIF frames.

If this field is empty, by default the service performs image annotation for the first 5 pages of the file.

Source:
See:

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 field will be empty if the error field is set.

This object should have the same structure as AnnotateImageResponse

totalPages number

This field gives the total number of pages in the file.

error Object

If set, represents the error message for the failed request. The responses field will not be set in this case.

This object should have the same structure as Status

Source:
See:

AnnotateImageRequest

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

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

localizedObjectAnnotations Array.<Object>

If present, localized object detection has completed successfully. This will be sorted descending by confidence score.

This object should have the same structure as LocalizedObjectAnnotation

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

productSearchResults Object

If present, product search has completed successfully.

This object should have the same structure as ProductSearchResults

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>

Required. Individual async file annotation requests for this batch.

This object should have the same structure as AsyncAnnotateFileRequest

parent string

Optional. Target project and location to make a call.

Format: projects/{project-id}/locations/{location-id}.

If no parent is specified, a region will be chosen automatically.

Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union.

Example: projects/project-A/locations/eu.

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:

AsyncBatchAnnotateImagesRequest

Request for async image annotation for a list of images.

Properties:
Name Type Description
requests Array.<Object>

Required. Individual image annotation requests for this batch.

This object should have the same structure as AnnotateImageRequest

outputConfig Object

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

This object should have the same structure as OutputConfig

parent string

Optional. Target project and location to make a call.

Format: projects/{project-id}/locations/{location-id}.

If no parent is specified, a region will be chosen automatically.

Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union.

Example: projects/project-A/locations/eu.

Source:
See:

AsyncBatchAnnotateImagesResponse

Response to an async batch image annotation request.

Properties:
Name Type Description
outputConfig Object

The output location and metadata from AsyncBatchAnnotateImagesRequest.

This object should have the same structure as OutputConfig

Source:
See:

BatchAnnotateFilesRequest

A list of requests to annotate files using the BatchAnnotateFiles API.

Properties:
Name Type Description
requests Array.<Object>

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

This object should have the same structure as AnnotateFileRequest

parent string

Optional. Target project and location to make a call.

Format: projects/{project-id}/locations/{location-id}.

If no parent is specified, a region will be chosen automatically.

Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union.

Example: projects/project-A/locations/eu.

Source:
See:

BatchAnnotateFilesResponse

A list of file annotation responses.

Properties:
Name Type Description
responses Array.<Object>

The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest.

This object should have the same structure as AnnotateFileResponse

Source:
See:

BatchAnnotateImagesRequest

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

Properties:
Name Type Description
requests Array.<Object>

Required. Individual image annotation requests for this batch.

This object should have the same structure as AnnotateImageRequest

parent string

Optional. Target project and location to make a call.

Format: projects/{project-id}/locations/{location-id}.

If no parent is specified, a region will be chosen automatically.

Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union.

Example: projects/project-A/locations/eu.

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:

BatchOperationMetadata

Metadata for the batch operations such as the current state.

This is included in the metadata field of the Operation returned by the GetOperation call of the google::longrunning::Operations service.

Properties:
Name Type Description
state number

The current state of the batch operation.

The number should be among the values of State

submitTime Object

The time when the batch request was submitted to the server.

This object should have the same structure as Timestamp

endTime Object

The time when the batch request is finished and google.longrunning.Operation.done is set to true.

This object should have the same structure as Timestamp

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 vertex 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:

CreateProductRequest

Request message for the CreateProduct method.

Properties:
Name Type Description
parent string

Required. The project in which the Product should be created.

Format is projects/PROJECT_ID/locations/LOC_ID.

product Object

Required. The product to create.

This object should have the same structure as Product

productId string

A user-supplied resource id for this Product. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character /.

Source:
See:

CreateProductSetRequest

Request message for the CreateProductSet method.

Properties:
Name Type Description
parent string

Required. The project in which the ProductSet should be created.

Format is projects/PROJECT_ID/locations/LOC_ID.

productSet Object

Required. The ProductSet to create.

This object should have the same structure as ProductSet

productSetId string

A user-supplied resource id for this ProductSet. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character /.

Source:
See:

CreateReferenceImageRequest

Request message for the CreateReferenceImage method.

Properties:
Name Type Description
parent string

Required. Resource name of the product in which to create the reference image.

Format is projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

referenceImage Object

Required. The reference image to create. If an image ID is specified, it is ignored.

This object should have the same structure as ReferenceImage

referenceImageId string

A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character /.

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.

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:

DeleteProductRequest

Request message for the DeleteProduct method.

Properties:
Name Type Description
name string

Required. Resource name of product to delete.

Format is: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

Source:
See:

DeleteProductSetRequest

Request message for the DeleteProductSet method.

Properties:
Name Type Description
name string

Required. Resource name of the ProductSet to delete.

Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

Source:
See:

DeleteReferenceImageRequest

Request message for the DeleteReferenceImage method.

Properties:
Name Type Description
name string

Required. The resource name of the reference image to delete.

Format is:

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID

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. 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 prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide.

Examples:

  • File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix".

  • Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified.

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 Google Cloud Storage object. Wildcards are not currently supported.

Source:
See:

GetProductRequest

Request message for the GetProduct method.

Properties:
Name Type Description
name string

Required. Resource name of the Product to get.

Format is: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

Source:
See:

GetProductSetRequest

Request message for the GetProductSet method.

Properties:
Name Type Description
name string

Required. Resource name of the ProductSet to get.

Format is: projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID

Source:
See:

GetReferenceImageRequest

Request message for the GetReferenceImage method.

Properties:
Name Type Description
name string

Required. The resource name of the ReferenceImage to get.

Format is:

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID.

Source:
See:

GroupedResult

Information about the products similar to a single product in a query image.

Properties:
Name Type Description
boundingPoly Object

The bounding polygon around the product detected in the query image.

This object should have the same structure as BoundingPoly

results Array.<Object>

List of results, one for each product match.

This object should have the same structure as Result

objectAnnotations Array.<Object>

List of generic predictions for the object in the bounding box.

This object should have the same structure as ObjectAnnotation

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

productSearchParams Object

Parameters for product search.

This object should have the same structure as ProductSearchParams

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:

ImportProductSetsGcsSource

The Google Cloud Storage location for a csv file which preserves a list of ImportProductSetRequests in each line.

Properties:
Name Type Description
csvFileUri string

The Google Cloud Storage URI of the input csv file.

The URI must start with gs://.

The format of the input csv file should be one image per line. In each line, there are 8 columns.

  1. image-uri
  2. image-id
  3. product-set-id
  4. product-id
  5. product-category
  6. product-display-name
  7. labels
  8. bounding-poly

The image-uri, product-set-id, product-id, and product-category columns are required. All other columns are optional.

If the ProductSet or Product specified by the product-set-id and product-id values does not exist, then the system will create a new ProductSet or Product for the image. In this case, the product-display-name column refers to display_name, the product-category column refers to product_category, and the labels column refers to product_labels.

The image-id column is optional but must be unique if provided. If it is empty, the system will automatically assign a unique id to the image.

The product-display-name column is optional. If it is empty, the system sets the display_name field for the product to a space (" "). You can update the display_name later by using the API.

If a Product with the specified product-id already exists, then the system ignores the product-display-name, product-category, and labels columns.

The labels column (optional) is a line containing a list of comma-separated key-value pairs, in the following format:

  "key_1=value_1,key_2=value_2,...,key_n=value_n"

The bounding-poly column (optional) identifies one region of interest from the image in the same manner as CreateReferenceImage. If you do not specify the bounding-poly column, then the system will try to detect regions of interest automatically.

At most one bounding-poly column is allowed per line. If the image contains multiple regions of interest, add a line to the CSV file that includes the same product information, and the bounding-poly values for each region of interest.

The bounding-poly column must contain an even number of comma-separated numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use non-negative integers for absolute bounding polygons, and float values in [0, 1] for normalized bounding polygons.

The system will resize the image if the image resolution is too large to process (larger than 20MP).

Source:
See:

ImportProductSetsInputConfig

The input content for the ImportProductSets method.

Properties:
Name Type Description
gcsSource Object

The Google Cloud Storage location for a csv file which preserves a list of ImportProductSetRequests in each line.

This object should have the same structure as ImportProductSetsGcsSource

Source:
See:

ImportProductSetsRequest

Request message for the ImportProductSets method.

Properties:
Name Type Description
parent string

Required. The project in which the ProductSets should be imported.

Format is projects/PROJECT_ID/locations/LOC_ID.

inputConfig Object

Required. The input content for the list of requests.

This object should have the same structure as ImportProductSetsInputConfig

Source:
See:

ImportProductSetsResponse

Response message for the ImportProductSets method.

This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.

Properties:
Name Type Description
referenceImages Array.<Object>

The list of reference_images that are imported successfully.

This object should have the same structure as ReferenceImage

statuses Array.<Object>

The rpc status for each ImportProductSet request, including both successes and errors.

The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0.

This object should have the same structure as Status

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

content Buffer

File content, represented as a stream of bytes. Note: As with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64.

Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.

mimeType string

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

Source:
See:

KeyValue

A product label represented as a key-value pair.

Properties:
Name Type Description
key string

The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.

value string

The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.

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:

ListProductSetsRequest

Request message for the ListProductSets method.

Properties:
Name Type Description
parent string

Required. The project from which ProductSets should be listed.

Format is projects/PROJECT_ID/locations/LOC_ID.

pageSize number

The maximum number of items to return. Default 10, maximum 100.

pageToken string

The next_page_token returned from a previous List request, if any.

Source:
See:

ListProductSetsResponse

Response message for the ListProductSets method.

Properties:
Name Type Description
productSets Array.<Object>

List of ProductSets.

This object should have the same structure as ProductSet

nextPageToken string

Token to retrieve the next page of results, or empty if there are no more results in the list.

Source:
See:

ListProductsInProductSetRequest

Request message for the ListProductsInProductSet method.

Properties:
Name Type Description
name string

Required. The ProductSet resource for which to retrieve Products.

Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

pageSize number

The maximum number of items to return. Default 10, maximum 100.

pageToken string

The next_page_token returned from a previous List request, if any.

Source:
See:

ListProductsInProductSetResponse

Response message for the ListProductsInProductSet method.

Properties:
Name Type Description
products Array.<Object>

The list of Products.

This object should have the same structure as Product

nextPageToken string

Token to retrieve the next page of results, or empty if there are no more results in the list.

Source:
See:

ListProductsRequest

Request message for the ListProducts method.

Properties:
Name Type Description
parent string

Required. The project OR ProductSet from which Products should be listed.

Format: projects/PROJECT_ID/locations/LOC_ID

pageSize number

The maximum number of items to return. Default 10, maximum 100.

pageToken string

The next_page_token returned from a previous List request, if any.

Source:
See:

ListProductsResponse

Response message for the ListProducts method.

Properties:
Name Type Description
products Array.<Object>

List of products.

This object should have the same structure as Product

nextPageToken string

Token to retrieve the next page of results, or empty if there are no more results in the list.

Source:
See:

ListReferenceImagesRequest

Request message for the ListReferenceImages method.

Properties:
Name Type Description
parent string

Required. Resource name of the product containing the reference images.

Format is projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

pageSize number

The maximum number of items to return. Default 10, maximum 100.

pageToken string

A token identifying a page of results to be returned. This is the value of nextPageToken returned in a previous reference image list request.

Defaults to the first page if not specified.

Source:
See:

ListReferenceImagesResponse

Response message for the ListReferenceImages method.

Properties:
Name Type Description
referenceImages Array.<Object>

The list of reference images.

This object should have the same structure as ReferenceImage

pageSize number

The maximum number of items to return. Default 10, maximum 100.

nextPageToken string

The next_page_token returned from a previous List request, if any.

Source:
See:

LocalizedObjectAnnotation

Set of detected objects with bounding boxes.

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

name string

Object name, expressed in its language_code language.

score number

Score of the result. Range [0, 1].

boundingPoly Object

Image region to which this object belongs. This must be populated.

This object should have the same structure as BoundingPoly

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:

ObjectAnnotation

Prediction for what the object in the bounding box is.

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

name string

Object name, expressed in its language_code language.

score number

Score of the result. Range [0, 1].

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 Google Cloud Storage. 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 vertex order will still be (0, 1, 2, 3).

This object should have the same structure as BoundingPoly

words Array.<Object>

List of all 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:

Product

A Product contains ReferenceImages.

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

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.

productLabels Array.<Object>

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.

This object should have the same structure as KeyValue

Source:
See:

ProductSearchParams

Parameters for a product search request.

Properties:
Name Type Description
boundingPoly Object

The bounding polygon around the area of interest in the image. Optional. If it is not specified, system discretion will be applied.

This object should have the same structure as BoundingPoly

productSet string

The resource name of a ProductSet to be searched for similar images.

Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

productCategories Array.<string>

The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1", or "general-v1" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well.

filter string

The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value.

For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is not acceptable. "color: red" is not acceptable because it uses a ':' instead of an '='.

Source:
See:

ProductSearchResults

Results for a product search request.

Properties:
Name Type Description
indexTime Object

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.

This object should have the same structure as Timestamp

results Array.<Object>

List of results, one for each product match.

This object should have the same structure as Result

productGroupedResults Array.<Object>

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.

This object should have the same structure as GroupedResult

Source:
See:

ProductSet

A ProductSet contains Products. A ProductSet can contain a maximum of 1 million reference images. If the limit is exceeded, periodic indexing will fail.

Properties:
Name Type Description
name string

The resource name of the ProductSet.

Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

This field is ignored when creating a ProductSet.

displayName string

The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long.

indexTime Object

Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z".

This field is ignored when creating a ProductSet.

This object should have the same structure as Timestamp

indexError Object

Output only. If there was an error with indexing the product set, the field is populated.

This field is ignored when creating a ProductSet.

This object should have the same structure as Status

Source:
See:

ProductSetPurgeConfig

Config to control which ProductSet contains the Products to be deleted.

Properties:
Name Type Description
productSetId string

The ProductSet that contains the Products to delete. If a Product is a member of product_set_id in addition to other ProductSets, the Product will still be deleted.

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:

PurgeProductsRequest

Request message for the PurgeProducts method.

Properties:
Name Type Description
productSetPurgeConfig Object

Specify which ProductSet contains the Products to be deleted.

This object should have the same structure as ProductSetPurgeConfig

deleteOrphanProducts boolean

If delete_orphan_products is true, all Products that are not in any ProductSet will be deleted.

parent string

Required. The project and location in which the Products should be deleted.

Format is projects/PROJECT_ID/locations/LOC_ID.

force boolean

The default value is false. Override this value to true to actually perform the purge.

Source:
See:

ReferenceImage

A ReferenceImage represents a product image and its associated metadata, such as bounding boxes.

Properties:
Name Type Description
name string

The resource name of the reference image.

Format is:

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID.

This field is ignored when creating a reference image.

uri string

Required. The Google Cloud Storage URI of the reference image.

The URI must start with gs://.

boundingPolys Array.<Object>

Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used.

The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).

This object should have the same structure as BoundingPoly

Source:
See:

RemoveProductFromProductSetRequest

Request message for the RemoveProductFromProductSet method.

Properties:
Name Type Description
name string

Required. The resource name for the ProductSet to modify.

Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

product string

Required. The resource name for the Product to be removed from this ProductSet.

Format is: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

Source:
See:

Result

Information about a product.

Properties:
Name Type Description
product Object

The Product.

This object should have the same structure as Product

score number

A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).

image string

The resource name of the image from the product that is the closest match to the query.

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

adultConfidence number

Confidence of adult_score. Range [0, 1]. 0 means not confident, 1 means very confident.

spoofConfidence number

Confidence of spoof_score. Range [0, 1]. 0 means not confident, 1 means very confident.

medicalConfidence number

Confidence of medical_score. Range [0, 1]. 0 means not confident, 1 means very confident.

violenceConfidence number

Confidence of violence_score. Range [0, 1]. 0 means not confident, 1 means very confident.

racyConfidence number

Confidence of racy_score. Range [0, 1]. 0 means not confident, 1 means very confident.

nsfwConfidence number

Confidence of nsfw_score. Range [0, 1]. 0 means not confident, 1 means very confident.

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 vertex 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:

UpdateProductRequest

Request message for the UpdateProduct method.

Properties:
Name Type Description
product Object

Required. The Product resource which replaces the one on the server. product.name is immutable.

This object should have the same structure as Product

updateMask Object

The FieldMask that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask paths include product_labels, display_name, and description.

This object should have the same structure as FieldMask

Source:
See:

UpdateProductSetRequest

Request message for the UpdateProductSet method.

Properties:
Name Type Description
productSet Object

Required. The ProductSet resource which replaces the one on the server.

This object should have the same structure as ProductSet

updateMask Object

The FieldMask that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask path is display_name.

This object should have the same structure as FieldMask

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>

The service's best guess as to the topic of the request image. Inferred from similar images on the open web.

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 vertex 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: