API documentation for documentai_v1beta3.types
package.
Classes
Barcode
Encodes the detailed information of a barcode.
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.
DeleteProcessorVersionMetadata
The long running operation metadata for delete processor version method.
DeleteProcessorVersionRequest
Request message for the delete processor version method.
DeployProcessorVersionMetadata
The long running operation metadata for deploy processor version method.
DeployProcessorVersionRequest
Request message for the deploy processor version method.
DeployProcessorVersionResponse
Response message for the deploy processor version 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. Intentionally empty proto for adding fields in future.
Document
Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document 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
DocumentSchema
The schema defines the output of the processed document by a processor.
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. Intentionally empty proto for adding fields in future.
EvaluateProcessorVersionMetadata
Metadata of the EvaluateProcessorVersion method.
EvaluateProcessorVersionRequest
Evaluates the given ProcessorVersion against the supplied documents.
EvaluateProcessorVersionResponse
Metadata of the EvaluateProcessorVersion method.
Evaluation
An evaluation of a ProcessorVersion's performance.
EvaluationReference
Gives a short summary of an evaluation, and links to the evaluation itself.
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.
GetEvaluationRequest
Retrieves a specific Evaluation.
GetProcessorRequest
Request message for get processor.
GetProcessorTypeRequest
Request message for get processor.
GetProcessorVersionRequest
Request message for get processor version.
HumanReviewStatus
The status of human review on a processed document.
ListEvaluationsRequest
Retrieves a list of evaluations for a given ProcessorVersion.
ListEvaluationsResponse
The response from ListEvaluations.
ListProcessorTypesRequest
Request message for list processor types.
ListProcessorTypesResponse
Response message for list processor types.
ListProcessorVersionsRequest
Request message for list all processor versions belongs to a processor.
ListProcessorVersionsResponse
Response message for list processors.
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.
OcrConfig
Config for Document OCR.
ProcessOptions
Options for Process API
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 Document AI. 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.
ProcessorVersion
A processor version is an implementation of a processor. Each processor can have multiple versions, pre-trained by Google internally or up-trained by the customer. At a time, a processor can only have one default version version. So the processor's behavior (when processing documents) is defined by a default version
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ReviewDocumentResponse
Response message for review document method.
SetDefaultProcessorVersionMetadata
The long running operation metadata for set default processor version method.
SetDefaultProcessorVersionRequest
Request message for the set default processor version method.
SetDefaultProcessorVersionResponse
Response message for set default processor version method.
TrainProcessorVersionMetadata
The metadata that represents a processor version being created.
TrainProcessorVersionRequest
Request message for the create processor version method.
TrainProcessorVersionResponse
The response for the TrainProcessorVersion method.
UndeployProcessorVersionMetadata
The long running operation metadata for the undeploy processor version method.
UndeployProcessorVersionRequest
Request message for the undeploy processor version method.
UndeployProcessorVersionResponse
Response message for the undeploy processor version method.
Vertex
A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.