Full name: projects.locations.processors.process
Processes a single document.
HTTP request
POST https://{endpoint}/v1beta3/{name}:process
Where {endpoint}
is one of the supported service endpoints.
Path parameters
Parameters | |
---|---|
name |
Required. The resource name of the Authorization requires one or more of the following IAM permissions on the specified resource
|
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "document": { object ( |
Fields | |
---|---|
document |
The document payload, the |
skipHumanReview |
Whether Human Review feature should be skipped for this request. Default to false. |
fieldMask |
Specifies which fields to include in the This is a comma-separated list of fully qualified names of fields. Example: |
processOptions |
Inference-time options for the process API |
Union field source . The document payload. source can be only one of the following: |
|
inlineDocument |
An inline document proto. |
rawDocument |
A raw document content (bytes). |
Response body
If successful, the response body contains an instance of ProcessResponse
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires one of the following IAM permissions on the name
resource, depending on the resource type:
documentai.processors.processOnline
documentai.processorVersions.processOnline
For more information, see the IAM documentation.