Method: processors.setDefaultProcessorVersion

Stay organized with collections Save and categorize content based on your preferences.

Full name: projects.locations.processors.setDefaultProcessorVersion

Set the default (active) version of a Processor that will be used in processors.process and processors.batchProcess.

HTTP request

POST https://{endpoint}/v1/{processor}:setDefaultProcessorVersion

Where {endpoint} is one of the supported service endpoints.

Path parameters

Parameters
processor

string

Required. The resource name of the Processor to change default version. It takes the form projects/{project}/locations/{location}/processors/{processor}.

Authorization requires the following IAM permission on the specified resource processor:

  • documentai.processors.processBatch

Request body

The request body contains data with the following structure:

JSON representation
{
  "defaultProcessorVersion": string
}
Fields
defaultProcessorVersion

string

Required. The resource name of child ProcessorVersion to use as default. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the processor resource:

  • documentai.processors.update

For more information, see the IAM documentation.