processor_types

Creates, updates, deletes, gets or lists a processor_types resource.

Overview

Name	processor_types
Type	Resource
Id	google.documentai.processor_types

Fields

The following fields are returned by SELECT queries:

projects_locations_processor_types_get

Successful response

Name	Datatype	Description
name	string	The resource name of the processor type. Format: projects/{project}/processorTypes/{processor_type}
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.
availableLocations	array	The locations in which this processor is available.
category	string	The processor category, used by UI to group processor types.
launchStage	string	Launch stage of the processor type
sampleDocumentUris	array	A set of Cloud Storage URIs of sample documents for this processor.
type	string	The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR.

projects_locations_fetch_processor_types

Successful response

Name	Datatype	Description
processorTypes	array	The list of processor types.

projects_locations_processor_types_list

Successful response

Name	Datatype	Description
name	string	The resource name of the processor type. Format: projects/{project}/processorTypes/{processor_type}
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.
availableLocations	array	The locations in which this processor is available.
category	string	The processor category, used by UI to group processor types.
launchStage	string	Launch stage of the processor type
sampleDocumentUris	array	A set of Cloud Storage URIs of sample documents for this processor.
type	string	The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_processor_types_get	select	projectsId, locationsId, processorTypesId		Gets a processor type detail.
projects_locations_fetch_processor_types	select	projectsId, locationsId		Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated.
projects_locations_processor_types_list	select	projectsId, locationsId	pageSize, pageToken	Lists the processor types that exist.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
processorTypesId	string
projectsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_locations_processor_types_get

Gets a processor type detail.

SELECT
name,
allowCreation,
availableLocations,
category,
launchStage,
sampleDocumentUris,
type
FROM google.documentai.processor_types
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND processorTypesId = '{{ processorTypesId }}' -- required;

projects_locations_fetch_processor_types

Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated.

SELECT
processorTypes
FROM google.documentai.processor_types
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required;

projects_locations_processor_types_list

Lists the processor types that exist.

SELECT
name,
allowCreation,
availableLocations,
category,
launchStage,
sampleDocumentUris,
type
FROM google.documentai.processor_types
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';