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
{"document": {object (Document)},"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.}
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 \u003ccode\u003eprojects.locations.processors.processorVersions.process\u003c/code\u003e is used to process a single document.\u003c/p\u003e\n"],["\u003cp\u003eThe request uses an HTTP POST method to a specific endpoint, requiring a \u003ccode\u003ename\u003c/code\u003e parameter specifying the Processor or ProcessorVersion.\u003c/p\u003e\n"],["\u003cp\u003eThe request body can contain data related to the document, such as its content, whether to skip human review, and options for the processing, including \u003ccode\u003efieldMask\u003c/code\u003e, \u003ccode\u003eprocessOptions\u003c/code\u003e, and various labels.\u003c/p\u003e\n"],["\u003cp\u003eThe document payload (\u003ccode\u003esource\u003c/code\u003e) can be provided inline, as raw content, or as a reference to a document stored in Google Cloud Storage.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this request requires specific IAM permissions, either \u003ccode\u003edocumentai.processors.processOnline\u003c/code\u003e or \u003ccode\u003edocumentai.processorVersions.processOnline\u003c/code\u003e, on the specified resource name.\u003c/p\u003e\n"]]],[],null,[]]
