requests[] OBJECT

An offline file annotation request

requests[].inputConfig OBJECT

The desired input location and metadata

requests[].inputConfig.content BINARY

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

requests[].inputConfig.gcsSource OBJECT

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

requests[].inputConfig.gcsSource.uri STRING

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

requests[].inputConfig.mimeType STRING

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

requests[].features[] OBJECT

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

requests[].features[].type ENUMERATION

The feature type

requests[].features[].maxResults INTEGER

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

requests[].features[].model STRING

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

requests[].imageContext OBJECT

Image context and/or feature-specific parameters

requests[].imageContext.cropHintsParams OBJECT

Parameters for crop hints annotation request

requests[].imageContext.cropHintsParams.aspectRatios[] FLOAT

requests[].imageContext.productSearchParams OBJECT

Parameters for a product search request

requests[].imageContext.productSearchParams.productCategories[] STRING

requests[].imageContext.productSearchParams.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 '='

requests[].imageContext.productSearchParams.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

requests[].imageContext.languageHints[] STRING

requests[].imageContext.webDetectionParams OBJECT

Parameters for web detection request

requests[].imageContext.webDetectionParams.includeGeoResults BOOLEAN

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

requests[].imageContext.latLongRect OBJECT

Rectangle determined by min and max LatLng pairs

requests[].outputConfig OBJECT

The desired output location and metadata

requests[].outputConfig.gcsDestination OBJECT

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

requests[].outputConfig.gcsDestination.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

requests[].outputConfig.batchSize INTEGER

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

done BOOLEAN

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available

response OBJECT

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse

response.customKey.value ANY

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse

name STRING

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}

error OBJECT

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the API Design Guide

error.code INTEGER

The status code, which should be an enum value of google.rpc.Code

error.message STRING

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client

error.details[] OBJECT

error.details[].customKey.value ANY

metadata OBJECT

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any

metadata.customKey.value ANY

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any