OutputConfig

JSON representation
GcsDestination
- JSON representation

The desired output location and metadata.

JSON representation
{ "gcsDestination": { object (`GcsDestination`) }, "batchSize": number }

Fields

Fields
`gcsDestination`	`object (GcsDestination)` The Google Cloud Storage location to write the output(s) to.
`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 `batchSize` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcsDestination`.`uri`. Currently, batchSize only applies to GcsDestination, with potential future support for other output configurations.

gcsDestination

object (GcsDestination)

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

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 batchSize = 20, then 5 json files each containing 20 response protos will be written under the prefix gcsDestination.uri.

Currently, batchSize only applies to GcsDestination, with potential future support for other output configurations.

GcsDestination

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

JSON representation
{ "uri": string }

Fields

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

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.