Package types (2.30.0)

API documentation fordocumentai_v1.types package.

Classes

Barcode

Encodes the detailed information of a barcode.

BatchDocumentsInputConfig

The common config to specify a set of documents used asinput.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BatchProcessMetadata

The long-running operation metadata forBatchProcessDocuments.

BatchProcessRequest

Request message forBatchProcessDocuments.

BatchProcessResponse

Response message forBatchProcessDocuments.

BoundingPoly

A bounding polygon for the detected image annotation.

CommonOperationMetadata

The common metadata for long running operations.

CreateProcessorRequest

Request message for theCreateProcessormethod. Notice this request is sent to a regionalized backendservice. If theProcessorType isn'tavailable in that region, the creation fails.

DeleteProcessorMetadata

The long-running operation metadata for theDeleteProcessormethod.

DeleteProcessorRequest

Request message for theDeleteProcessormethod.

DeleteProcessorVersionMetadata

The long-running operation metadata for theDeleteProcessorVersionmethod.

DeleteProcessorVersionRequest

Request message for theDeleteProcessorVersionmethod.

DeployProcessorVersionMetadata

The long-running operation metadata for theDeployProcessorVersionmethod.

DeployProcessorVersionRequest

Request message for theDeployProcessorVersionmethod.

DeployProcessorVersionResponse

Response message for theDeployProcessorVersionmethod.

DisableProcessorMetadata

The long-running operation metadata for theDisableProcessormethod.

DisableProcessorRequest

Request message for theDisableProcessormethod.

DisableProcessorResponse

Response message for theDisableProcessormethod. Intentionally empty proto for adding fields in future.

Document

Document represents the canonical document resource inDocument AI. It is an interchange format that provides insightsinto documents and allows for collaboration between users andDocument AI to iterate and optimize for quality.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DocumentOutputConfig

Config that controls the output of documents. All documentswill be written as a JSON file.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DocumentSchema

The schema defines the output of the processed document by aprocessor.

EnableProcessorMetadata

The long-running operation metadata for theEnableProcessormethod.

EnableProcessorRequest

Request message for theEnableProcessormethod.

EnableProcessorResponse

Response message for theEnableProcessormethod. Intentionally empty proto for adding fields in future.

EvaluateProcessorVersionMetadata

Metadata of theEvaluateProcessorVersionmethod.

EvaluateProcessorVersionRequest

Evaluates the givenProcessorVersionagainst the supplied documents.

EvaluateProcessorVersionResponse

Response of theEvaluateProcessorVersionmethod.

Evaluation

An evaluation of a ProcessorVersion's performance.

EvaluationReference

Gives a short summary of an evaluation, and links to theevaluation itself.

FetchProcessorTypesRequest

Request message for theFetchProcessorTypesmethod. Some processor types may require the project be added to anallowlist.

FetchProcessorTypesResponse

Response message for theFetchProcessorTypesmethod.

GcsDocument

Specifies a document stored on Cloud Storage.

GcsDocuments

Specifies a set of documents on Cloud Storage.

GcsPrefix

Specifies all documents on Cloud Storage with a commonprefix.

GetEvaluationRequest

Retrieves a specific Evaluation.

GetProcessorRequest

Request message for theGetProcessormethod.

GetProcessorTypeRequest

Request message for theGetProcessorTypemethod.

GetProcessorVersionRequest

Request message for theGetProcessorVersionmethod.

HumanReviewStatus

The status of human review on a processed document.

ListEvaluationsRequest

Retrieves a list of evaluations for a givenProcessorVersion.

ListEvaluationsResponse

The response fromListEvaluations.

ListProcessorTypesRequest

Request message for theListProcessorTypesmethod. Some processor types may require the project be added to anallowlist.

ListProcessorTypesResponse

Response message for theListProcessorTypesmethod.

ListProcessorVersionsRequest

Request message for list all processor versions belongs to aprocessor.

ListProcessorVersionsResponse

Response message for theListProcessorVersionsmethod.

ListProcessorsRequest

Request message for list all processors belongs to a project.

ListProcessorsResponse

Response message for theListProcessorsmethod.

NormalizedVertex

A vertex represents a 2D point in the image.NOTE: the normalized vertex coordinates are relative to theoriginal image and range from 0 to 1.

OcrConfig

Config for Document OCR.

ProcessOptions

Options for Process API

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ProcessRequest

Request message for theProcessDocumentmethod.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ProcessResponse

Response message for theProcessDocumentmethod.

Processor

The first-class citizen for Document AI. Each processordefines how to extract structural information from a document.

ProcessorType

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

ProcessorVersion

A processor version is an implementation of a processor. Eachprocessor can have multiple versions, pretrained by Googleinternally or uptrained by the customer. A processor can onlyhave one default version at a time. Its document-processingbehavior is defined by that version.

ProcessorVersionAlias

Contains the alias and the aliased resource name of processorversion.

RawDocument

Payload message of raw document content (bytes).

ReviewDocumentOperationMetadata

The long-running operation metadata for theReviewDocumentmethod.

ReviewDocumentRequest

Request message for theReviewDocumentmethod.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ReviewDocumentResponse

Response message for theReviewDocumentmethod.

SetDefaultProcessorVersionMetadata

The long-running operation metadata for theSetDefaultProcessorVersionmethod.

SetDefaultProcessorVersionRequest

Request message for theSetDefaultProcessorVersionmethod.

SetDefaultProcessorVersionResponse

Response message for theSetDefaultProcessorVersionmethod.

TrainProcessorVersionMetadata

The metadata that represents a processor version beingcreated.

TrainProcessorVersionRequest

Request message for theTrainProcessorVersionmethod.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TrainProcessorVersionResponse

The response forTrainProcessorVersion.

UndeployProcessorVersionMetadata

The long-running operation metadata for theUndeployProcessorVersionmethod.

UndeployProcessorVersionRequest

Request message for theUndeployProcessorVersionmethod.

UndeployProcessorVersionResponse

Response message for theUndeployProcessorVersionmethod.

Vertex

A vertex represents a 2D point in the image.NOTE: the vertex coordinates are in the same scale as theoriginal image.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-29 UTC.