Package types (3.0.0)

Encodes the detailed information of a barcode.

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

The long-running operation metadata for BatchProcessDocuments.

Request message for BatchProcessDocuments.

Response message for BatchProcessDocuments.

A bounding polygon for the detected image annotation.

The common metadata for long running operations.

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.

The long-running operation metadata for the DeleteProcessor method.

Request message for the DeleteProcessor method.

The long-running operation metadata for the DeleteProcessorVersion method.

Request message for the DeleteProcessorVersion method.

The long-running operation metadata for the DeployProcessorVersion method.

Request message for the DeployProcessorVersion method.

Response message for the DeployProcessorVersion method.

The long-running operation metadata for the DisableProcessor method.

Request message for the DisableProcessor method.

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

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

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

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

The long-running operation metadata for the EnableProcessor method.

Request message for the EnableProcessor method.

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

Metadata of the EvaluateProcessorVersion method.

Evaluates the given ProcessorVersion against the supplied documents.

Response of the EvaluateProcessorVersion method.

An evaluation of a ProcessorVersion's performance.

Gives a short summary of an evaluation, and links to the evaluation itself.

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

Response message for the FetchProcessorTypes method.

Specifies a document stored on Cloud Storage.

Specifies a set of documents on Cloud Storage.

Specifies all documents on Cloud Storage with a common prefix.

Retrieves a specific Evaluation.

Request message for the GetProcessor method.

Request message for the GetProcessorType method.

Request message for the GetProcessorVersion method.

The status of human review on a processed document.

Retrieves a list of evaluations for a given ProcessorVersion.

The response from ListEvaluations.

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

Response message for the ListProcessorTypes method.

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

Response message for the ListProcessorVersions method.

Request message for list all processors belongs to a project.

Response message for the ListProcessors method.

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.

Config for Document OCR.

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

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

Response message for the ProcessDocument method.

The first-class citizen for Document AI. 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.

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.

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

Payload message of raw document content (bytes).

The long-running operation metadata for the ReviewDocument method.

Request message for the ReviewDocument method.

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

Response message for the ReviewDocument method.

The long-running operation metadata for the SetDefaultProcessorVersion method.

Request message for the SetDefaultProcessorVersion method.

Response message for the SetDefaultProcessorVersion method.

The metadata that represents a processor version being created.

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

The response for TrainProcessorVersion.

The long-running operation metadata for the UndeployProcessorVersion method.

Request message for the UndeployProcessorVersion method.

Response message for the UndeployProcessorVersion method.

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