Method: locations.fetchProcessorTypes

Full name: projects.locations.fetchProcessorTypes

Fetches processor types. Note that we do not use ListProcessorTypes here because it is not paginated.

HTTP request

GET https://{endpoint}/v1beta3/{parent}:fetchProcessorTypes

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

Path parameters

Parameters
parent

string

Required. The project of processor type to list. The available processor types may depend on the allow-listing on projects. Format: projects/{project}/locations/{location} It takes the form projects/{project}/locations/{location}.

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

  • documentai.processorTypes.list

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for fetch processor types.

JSON representation
{
  "processorTypes": [
    {
      object (ProcessorType)
    }
  ]
}
Fields
processorTypes[]

object (ProcessorType)

The list of processor types.

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 parent resource:

  • documentai.processorTypes.list

For more information, see the IAM documentation.

ProcessorType

A processor type is responsible for performing a certain document understanding task on a certain type of document.

JSON representation
{
  "name": string,
  "type": string,
  "category": string,
  "availableLocations": [
    {
      object (LocationInfo)
    }
  ],
  "allowCreation": boolean,
  "launchStage": enum (LaunchStage)
}
Fields
name

string

The resource name of the processor type. Format: projects/{project}/processorTypes/{processor_type}

type

string

The type of the processor, e.g., "invoice_parsing".

category

string

The processor category, used by UI to group processor types.

availableLocations[]

object (LocationInfo)

The locations in which this processor is available.

allowCreation

boolean

Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.

launchStage

enum (LaunchStage)

Launch stage of the processor type

LocationInfo

The location information about where the processor is available.

JSON representation
{
  "locationId": string
}
Fields
locationId

string

The location id, currently must be one of [us, eu].