Package types (1.0.0)

Version 1.0.0

• 3.0.1 (latest)
• 3.0.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.3
• 2.28.0
• 2.27.1
• 2.26.0
• 2.25.0
• 2.24.2
• 2.23.0
• 2.22.0
• 2.21.1
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.1
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.1
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.3
• 1.5.1
• 1.4.2
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.0
• 0.5.2
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

API documentation for documentai_v1.types package.

Classes

BatchDocumentsInputConfig

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

BatchProcessMetadata

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

The state of the current batch processing.

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

BatchProcessRequest

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

Required. The processor resource name.

:type: str

BatchProcessResponse

Response message for batch process document method.

BoundingPoly

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

The bounding polygon vertices.

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

CommonOperationMetadata

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

The state of the operation.

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

Document

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.

DocumentOutputConfig

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

GcsDocument

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

The Cloud Storage object uri.

:type: str

GcsDocuments

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

The list of documents.

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

GcsPrefix

Specifies all documents on Cloud Storage with a common prefix.

HumanReviewStatus

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

The state of human review on the processing request.

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

NormalizedVertex

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.

ProcessRequest

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

An inline document proto.

:type: google.cloud.documentai_v1.types.Document

ProcessResponse

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_v1.types.Document

RawDocument

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

Inline document content.

:type: bytes

ReviewDocumentOperationMetadata

The long running operation metadata for review document method.

ReviewDocumentRequest

Request message for review document method. .. attribute:: inline_document

An inline document proto.

:type: google.cloud.documentai_v1.types.Document

ReviewDocumentResponse

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

The Cloud Storage uri for the human reviewed document.

:type: str

Vertex

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