Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. 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.processOnline
documentai.processorVersions.processOnline
Request body
The request body contains data with the following structure:
JSON representation
{"skipHumanReview": boolean,"fieldMask": string,"processOptions": {object (ProcessOptions)},"labels": {string: string,...},"imagelessMode": boolean,// Union field source can be only one of the following:"inlineDocument": {object (Document)},"rawDocument": {object (RawDocument)},"gcsDocument": {object (GcsDocument)}// End of list of possible types for union field source.}
Fields
skipHumanReview
boolean
Whether human review should be skipped for this request. Default to false.
Specifies which fields to include in the ProcessResponse.document output. Only supports top-level document and pages field, so it must be in the form of {document_field_name} or pages.{page_field_name}.
This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
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.
imagelessMode
boolean
Optional. Option to remove images from the document.
Union field source. The document payload. source can be only one of the following:
[[["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 processes a single document using a specified Processor or ProcessorVersion, identified by its resource name.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request is made via a POST request to a specified endpoint, and the resource name is included in the request path.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires JSON data that contains parameters for processing, including options to skip human review, specify output fields, and include metadata labels.\u003c/p\u003e\n"],["\u003cp\u003eThe document to be processed can be provided inline, as raw content, or as a reference to a Google Cloud Storage document, via the source union field.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful requests will return a ProcessResponse, and the operation requires appropriate IAM permissions, either \u003ccode\u003edocumentai.processors.processOnline\u003c/code\u003e or \u003ccode\u003edocumentai.processorVersions.processOnline\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: processorVersions.process\n\n**Full name**: projects.locations.processors.processorVersions.process\n\nProcesses a single document.\n\n### HTTP request\n\n`POST https://{endpoint}/v1/{name}:process`\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 [ProcessResponse](/document-ai/docs/reference/rest/v1/ProcessResponse).\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.processOnline`\n- `documentai.processorVersions.processOnline`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
