Package types (2.35.0)

API documentation for documentai_v1beta3.types package.

Classes

Barcode

Encodes the detailed information of a barcode.

BatchDatasetDocuments

Dataset documents that the batch operation will be applied to.

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

BatchDeleteDocumentsMetadata

BatchDeleteDocumentsRequest

BatchDeleteDocumentsResponse

Response of the delete documents operation.

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 BatchProcessDocuments.

BatchProcessRequest

Request message for BatchProcessDocuments.

BatchProcessResponse

Response message for BatchProcessDocuments.

BoundingPoly

A bounding polygon for the detected image annotation.

CommonOperationMetadata

The common metadata for long running operations.

CreateProcessorRequest

Request message for the CreateProcessor method. Notice this request is sent to a regionalized backend service. If the ProcessorType isn't available in that region, the creation fails.

Dataset

A singleton resource under a Processor which configures a collection of documents.

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

DatasetSchema

Dataset Schema.

DatasetSplitType

Documents belonging to a dataset will be split into different groups referred to as splits: train, test.

DeleteProcessorMetadata

The long-running operation metadata for the DeleteProcessor method.

DeleteProcessorRequest

Request message for the DeleteProcessor method.

DeleteProcessorVersionMetadata

The long-running operation metadata for the DeleteProcessorVersion method.

DeleteProcessorVersionRequest

Request message for the DeleteProcessorVersion method.

DeployProcessorVersionMetadata

The long-running operation metadata for the DeployProcessorVersion method.

DeployProcessorVersionRequest

Request message for the DeployProcessorVersion method.

DeployProcessorVersionResponse

Response message for the DeployProcessorVersion method.

DisableProcessorMetadata

The long-running operation metadata for the DisableProcessor method.

DisableProcessorRequest

Request message for the DisableProcessor method.

DisableProcessorResponse

Response message for the DisableProcessor 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

DocumentId

Document Identifier.

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

DocumentLabelingState

Describes the labeling status of a document.

DocumentMetadata

Metadata about a document.

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

DocumentPageRange

Range of pages present in a document.

DocumentSchema

The schema defines the output of the processed document by a processor.

EnableProcessorMetadata

The long-running operation metadata for the EnableProcessor method.

EnableProcessorRequest

Request message for the EnableProcessor method.

EnableProcessorResponse

Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.

EntityTypeMetadata

Metadata about an entity type.

EvaluateProcessorVersionMetadata

Metadata of the EvaluateProcessorVersion method.

EvaluateProcessorVersionRequest

Evaluates the given ProcessorVersion against the supplied documents.

EvaluateProcessorVersionResponse

Response 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 the FetchProcessorTypes method. Some processor types may require the project be added to an allowlist.

FetchProcessorTypesResponse

Response message for the FetchProcessorTypes method.

FieldExtractionMetadata

Metadata for how this field value is extracted.

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.

GetDatasetSchemaRequest

Request for GetDatasetSchema.

GetDocumentRequest

GetDocumentResponse

GetEvaluationRequest

Retrieves a specific Evaluation.

GetProcessorRequest

Request message for the GetProcessor method.

GetProcessorTypeRequest

Request message for the GetProcessorType method.

GetProcessorVersionRequest

Request message for the GetProcessorVersion method.

HumanReviewStatus

The status of human review on a processed document.

ImportDocumentsMetadata

Metadata of the import document operation.

ImportDocumentsRequest

ImportDocumentsResponse

Response of the import document operation.

ImportProcessorVersionMetadata

The long-running operation metadata for the ImportProcessorVersion method.

ImportProcessorVersionRequest

The request message for the ImportProcessorVersion method.

The Document AI Service Agent <https://cloud.google.com/iam/docs/service-agents> of the destination project must have Document AI Editor role <https://cloud.google.com/document-ai/docs/access-control/iam-roles> on the source project.

The destination project is specified as part of the parent field. The source project is specified as part of the source or external_processor_version_source field.

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

ImportProcessorVersionResponse

The response message for the ImportProcessorVersion method.

ListDocumentsRequest

ListDocumentsResponse

ListEvaluationsRequest

Retrieves a list of evaluations for a given ProcessorVersion.

ListEvaluationsResponse

The response from ListEvaluations.

ListProcessorTypesRequest

Request message for the ListProcessorTypes method. Some processor types may require the project be added to an allowlist.

ListProcessorTypesResponse

Response message for the ListProcessorTypes method.

ListProcessorVersionsRequest

Request message for list all processor versions belongs to a processor.

ListProcessorVersionsResponse

Response message for the ListProcessorVersions method.

ListProcessorsRequest

Request message for list all processors belongs to a project.

ListProcessorsResponse

Response message for the ListProcessors method.

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

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

ProcessRequest

Request message for the ProcessDocument 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 ProcessDocument 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, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.

ProcessorVersionAlias

Contains the alias and the aliased resource name of processor version.

PropertyMetadata

Metadata about a property.

RawDocument

Payload message of raw document content (bytes).

ReviewDocumentOperationMetadata

The long-running operation metadata for the ReviewDocument method.

ReviewDocumentRequest

Request message for the ReviewDocument method.

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

ReviewDocumentResponse

Response message for the ReviewDocument method.

RevisionRef

The revision reference specifies which revision on the document to read.

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

SetDefaultProcessorVersionMetadata

The long-running operation metadata for the SetDefaultProcessorVersion method.

SetDefaultProcessorVersionRequest

Request message for the SetDefaultProcessorVersion method.

SetDefaultProcessorVersionResponse

Response message for the SetDefaultProcessorVersion method.

SummaryOptions

Metadata for document summarization.

TrainProcessorVersionMetadata

The metadata that represents a processor version being created.

TrainProcessorVersionRequest

Request message for the TrainProcessorVersion 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

TrainProcessorVersionResponse

The response for TrainProcessorVersion.

UndeployProcessorVersionMetadata

The long-running operation metadata for the UndeployProcessorVersion method.

UndeployProcessorVersionRequest

Request message for the UndeployProcessorVersion method.

UndeployProcessorVersionResponse

Response message for the UndeployProcessorVersion method.

UpdateDatasetOperationMetadata

UpdateDatasetRequest

UpdateDatasetSchemaRequest

Request for UpdateDatasetSchema.

Vertex

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