processor_versions

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

Overview

Name	processor_versions
Type	Resource
Id	google.documentai.processor_versions

Fields

Name	Datatype	Description
name	string	Identifier. The resource name of the processor version. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}
createTime	string	The time the processor version was created.
deprecationInfo	object	Information about the upcoming deprecation of this processor version.
displayName	string	The display name of the processor version.
documentSchema	object	The schema defines the output of the processed document by a processor.
genAiModelInfo	object	Information about Generative AI model-based processor versions.
googleManaged	boolean	Output only. Denotes that this ProcessorVersion is managed by Google.
kmsKeyName	string	The KMS key name used for encryption.
kmsKeyVersionName	string	The KMS key version with which data is encrypted.
latestEvaluation	object	Gives a short summary of an evaluation, and links to the evaluation itself.
modelType	string	Output only. The model type of this processor version.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
state	string	Output only. The state of the processor version.

Methods

Name	Accessible by	Required Params	Description
projects_locations_processors_processor_versions_get	SELECT	locationsId, processorVersionsId, processorsId, projectsId	Gets a processor version detail.
projects_locations_processors_processor_versions_list	SELECT	locationsId, processorsId, projectsId	Lists all versions of a processor.
projects_locations_processors_processor_versions_delete	DELETE	locationsId, processorVersionsId, processorsId, projectsId	Deletes the processor version, all artifacts under the processor version will be deleted.
projects_locations_processors_processor_versions_batch_process	EXEC	locationsId, processorVersionsId, processorsId, projectsId	LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
projects_locations_processors_processor_versions_deploy	EXEC	locationsId, processorVersionsId, processorsId, projectsId	Deploys the processor version.
projects_locations_processors_processor_versions_evaluate_processor_version	EXEC	locationsId, processorVersionsId, processorsId, projectsId	Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.
projects_locations_processors_processor_versions_process	EXEC	locationsId, processorVersionsId, processorsId, projectsId	Processes a single document.
projects_locations_processors_processor_versions_train	EXEC	locationsId, processorsId, projectsId	Trains a new processor version. Operation metadata is returned as TrainProcessorVersionMetadata.
projects_locations_processors_processor_versions_undeploy	EXEC	locationsId, processorVersionsId, processorsId, projectsId	Undeploys the processor version.

SELECT examples

Lists all versions of a processor.

SELECT
name,
createTime,
deprecationInfo,
displayName,
documentSchema,
genAiModelInfo,
googleManaged,
kmsKeyName,
kmsKeyVersionName,
latestEvaluation,
modelType,
satisfiesPzi,
satisfiesPzs,
state
FROM google.documentai.processor_versions
WHERE locationsId = '{{ locationsId }}'
AND processorsId = '{{ processorsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified processor_versions resource.

/*+ delete */
DELETE FROM google.documentai.processor_versions
WHERE locationsId = '{{ locationsId }}'
AND processorVersionsId = '{{ processorVersionsId }}'
AND processorsId = '{{ processorsId }}'
AND projectsId = '{{ projectsId }}';