- 3.0.0 (latest)
- 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_v1beta3.types package.
Classes
BatchDocumentsInputConfig
The common config to specify a set of documents used as input.
This message has oneof_ 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 other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BatchProcessMetadata
The long running operation metadata for batch process method.
BatchProcessRequest
Request message for batch process document method.
BatchProcessResponse
Response message for batch process document method.
BoundingPoly
A bounding polygon for the detected image annotation.
CommonOperationMetadata
The common metadata for long running operations.
CreateProcessorRequest
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.
DeleteProcessorMetadata
The long running operation metadata for delete processor method.
DeleteProcessorRequest
Request message for the delete processor method.
DisableProcessorMetadata
The long running operation metadata for disable processor method.
DisableProcessorRequest
Request message for the disable processor method.
DisableProcessorResponse
Response message for the disable processor method.
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.
This message has oneof_ 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 other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
DocumentOutputConfig
Config that controls the output of documents. All documents will be written as a JSON file.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
EnableProcessorMetadata
The long running operation metadata for enable processor method.
EnableProcessorRequest
Request message for the enable processor method.
EnableProcessorResponse
Response message for the enable processor method.
FetchProcessorTypesRequest
Request message for fetch processor types.
FetchProcessorTypesResponse
Response message for fetch processor types.
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 common prefix.
HumanReviewStatus
The status of human review on a processed document.
ListProcessorsRequest
Request message for list all processors belongs to a project.
ListProcessorsResponse
Response message for list processors.
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.
This message has oneof_ 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 other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ProcessResponse
Response message for the process document method.
Processor
The first-class citizen for DocumentAI. Each processor defines how to extract structural information from a document.
ProcessorType
A processor type is responsible for performing a certain document understanding task on a certain type of document.
RawDocument
Payload message of raw document content (bytes).
ReviewDocumentOperationMetadata
The long running operation metadata for review document method.
ReviewDocumentRequest
Request message for review document method. Next Id: 6.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ReviewDocumentResponse
Response message for review document method.
Vertex
A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.