Package types (1.0.0)

The common config to specify a set of documents used as input.

The long running operation metadata for batch process method. .. attribute:: state

The state of the current batch processing.

:type: google.cloud.documentai_v1beta3.types.BatchProcessMetadata.State

Request message for batch process document method. .. attribute:: name

Required. The processor resource name.

:type: str

Response message for batch process document method.

A bounding polygon for the detected image annotation. .. attribute:: vertices

The bounding polygon vertices.

:type: Sequence[google.cloud.documentai_v1beta3.types.Vertex]

The common metadata for long running operations. .. attribute:: state

The state of the operation.

:type: google.cloud.documentai_v1beta3.types.CommonOperationMetadata.State

Request message for create a processor. Notice this request is sent to a regionalized backend service, and if the processor type is not available on that region, the creation will fail.

The long running operation metadata for delete processor method.

Request message for the delete processor method. .. attribute:: name

Required. The processor resource name to be deleted.

:type: str

The long running operation metadata for disable processor method.

Request message for the disable processor method. .. attribute:: name

Required. The processor resource name to be disabled.

:type: str

Response message for the disable processor method.

Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.

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

The long running operation metadata for enable processor method.

Request message for the enable processor method. .. attribute:: name

Required. The processor resource name to be enabled.

:type: str

Response message for the enable processor method.

Request message for fetch processor types. .. attribute:: parent

Required. The project of processor type to list. Format: projects/{project}/locations/{location}

:type: str

Response message for fetch processor types. .. attribute:: processor_types

The list of processor types.

:type: Sequence[google.cloud.documentai_v1beta3.types.ProcessorType]

Specifies a document stored on Cloud Storage. .. attribute:: gcs_uri

The Cloud Storage object uri.

:type: str

Specifies a set of documents on Cloud Storage. .. attribute:: documents

The list of documents.

:type: Sequence[google.cloud.documentai_v1beta3.types.GcsDocument]

Specifies all documents on Cloud Storage with a common prefix.

The status of human review on a processed document. .. attribute:: state

The state of human review on the processing request.

:type: google.cloud.documentai_v1beta3.types.HumanReviewStatus.State

Request message for list all processors belongs to a project. .. attribute:: parent

Required. The parent (project and location) which owns this collection of Processors. Format: projects/{project}/locations/{location}

:type: str

Response message for list processors. .. attribute:: processors

The list of processors.

:type: Sequence[google.cloud.documentai_v1beta3.types.Processor]

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

Request message for the process document method. .. attribute:: inline_document

An inline document proto.

:type: google.cloud.documentai_v1beta3.types.Document

Response message for the process document method. .. attribute:: document

The document payload, will populate fields based on the processor's behavior.

:type: google.cloud.documentai_v1beta3.types.Document

The first-class citizen for DocumentAI. Each processor defines how to extract structural information from a document.

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

Payload message of raw document content (bytes). .. attribute:: content

Inline document content.

:type: bytes

The long running operation metadata for review document method.

Request message for review document method. Next Id: 6.

Response message for review document method. .. attribute:: gcs_destination

The Cloud Storage uri for the human reviewed document.

:type: str

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