Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion} It takes the form projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorversion}.
Authorization requires one or more of the following IAM permissions on the specified resource name:
documentai.processors.processBatch
documentai.processorVersions.processBatch
Request body
The request body contains data with the following structure:
Optional. The labels with user-defined metadata for the request.
Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
Response body
If successful, the response body contains an instance of Operation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-10 UTC."],[[["\u003cp\u003eThis endpoint, \u003ccode\u003eprojects.locations.processors.processorVersions.batchProcess\u003c/code\u003e, allows for batch processing of multiple documents.\u003c/p\u003e\n"],["\u003cp\u003eThe output of the batch process is stored in Cloud Storage in JSON format, specifically following the [Document] format.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a resource name (either a Processor or ProcessorVersion), and it has a required \u003ccode\u003einputDocuments\u003c/code\u003e object to define what is to be processed, and a \u003ccode\u003edocumentOutputConfig\u003c/code\u003e object to configure where to store the results.\u003c/p\u003e\n"],["\u003cp\u003eThe request body can include options to skip human review and contains a \u003ccode\u003elabels\u003c/code\u003e field for user-defined metadata.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this process requires specific IAM permissions, either \u003ccode\u003edocumentai.processors.processBatch\u003c/code\u003e or \u003ccode\u003edocumentai.processorVersions.processBatch\u003c/code\u003e, depending on the type of resource.\u003c/p\u003e\n"]]],[],null,["# Method: processorVersions.batchProcess\n\n**Full name**: projects.locations.processors.processorVersions.batchProcess\n\nLRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the \\[Document\\] format.\n\n### HTTP request\n\n`POST https://{endpoint}/v1/{name}:batchProcess`\n\nWhere `{endpoint}` is one of the [supported service endpoints](/document-ai/docs/reference/rest#rest_endpoints).\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/document-ai/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/).\n\n### IAM Permissions\n\nRequires **one of** the following [IAM](https://cloud.google.com/iam/docs) permissions on the `name` resource, depending on the resource type:\n\n- `documentai.processors.processBatch`\n- `documentai.processorVersions.processBatch`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]