Package com.google.cloud.documentai.v1beta3 (2.2.1)

The interfaces provided are listed below, along with usage samples.

DocumentProcessorServiceClient

Service Description: Service to call Cloud DocumentAI to process documents according to the processor's definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents.

Sample for DocumentProcessorServiceClient:


 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ProcessorName name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
   ProcessResponse response = documentProcessorServiceClient.processDocument(name);
 }

Classes

BatchDocumentsInputConfig

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

Protobuf type google.cloud.documentai.v1beta3.BatchDocumentsInputConfig

BatchDocumentsInputConfig.Builder

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

Protobuf type google.cloud.documentai.v1beta3.BatchDocumentsInputConfig

BatchProcessMetadata

The long running operation metadata for batch process method.

Protobuf type google.cloud.documentai.v1beta3.BatchProcessMetadata

BatchProcessMetadata.Builder

The long running operation metadata for batch process method.

Protobuf type google.cloud.documentai.v1beta3.BatchProcessMetadata

BatchProcessMetadata.IndividualProcessStatus

The status of a each individual document in the batch process.

Protobuf type google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus

BatchProcessMetadata.IndividualProcessStatus.Builder

The status of a each individual document in the batch process.

Protobuf type google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus

BatchProcessRequest

Request message for batch process document method.

Protobuf type google.cloud.documentai.v1beta3.BatchProcessRequest

BatchProcessRequest.BatchInputConfig

The message for input config in batch process.

Protobuf type google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig

BatchProcessRequest.BatchInputConfig.Builder

The message for input config in batch process.

Protobuf type google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig

BatchProcessRequest.BatchOutputConfig

The message for output config in batch process.

Protobuf type google.cloud.documentai.v1beta3.BatchProcessRequest.BatchOutputConfig

BatchProcessRequest.BatchOutputConfig.Builder

The message for output config in batch process.

Protobuf type google.cloud.documentai.v1beta3.BatchProcessRequest.BatchOutputConfig

BatchProcessRequest.Builder

Request message for batch process document method.

Protobuf type google.cloud.documentai.v1beta3.BatchProcessRequest

BatchProcessResponse

Response message for batch process document method.

Protobuf type google.cloud.documentai.v1beta3.BatchProcessResponse

BatchProcessResponse.Builder

Response message for batch process document method.

Protobuf type google.cloud.documentai.v1beta3.BatchProcessResponse

BoundingPoly

A bounding polygon for the detected image annotation.

Protobuf type google.cloud.documentai.v1beta3.BoundingPoly

BoundingPoly.Builder

A bounding polygon for the detected image annotation.

Protobuf type google.cloud.documentai.v1beta3.BoundingPoly

CommonOperationMetadata

The common metadata for long running operations.

Protobuf type google.cloud.documentai.v1beta3.CommonOperationMetadata

CommonOperationMetadata.Builder

The common metadata for long running operations.

Protobuf type google.cloud.documentai.v1beta3.CommonOperationMetadata

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.

Protobuf type google.cloud.documentai.v1beta3.CreateProcessorRequest

CreateProcessorRequest.Builder

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.

Protobuf type google.cloud.documentai.v1beta3.CreateProcessorRequest

DeleteProcessorMetadata

The long running operation metadata for delete processor method.

Protobuf type google.cloud.documentai.v1beta3.DeleteProcessorMetadata

DeleteProcessorMetadata.Builder

The long running operation metadata for delete processor method.

Protobuf type google.cloud.documentai.v1beta3.DeleteProcessorMetadata

DeleteProcessorRequest

Request message for the delete processor method.

Protobuf type google.cloud.documentai.v1beta3.DeleteProcessorRequest

DeleteProcessorRequest.Builder

Request message for the delete processor method.

Protobuf type google.cloud.documentai.v1beta3.DeleteProcessorRequest

DisableProcessorMetadata

The long running operation metadata for disable processor method.

Protobuf type google.cloud.documentai.v1beta3.DisableProcessorMetadata

DisableProcessorMetadata.Builder

The long running operation metadata for disable processor method.

Protobuf type google.cloud.documentai.v1beta3.DisableProcessorMetadata

DisableProcessorRequest

Request message for the disable processor method.

Protobuf type google.cloud.documentai.v1beta3.DisableProcessorRequest

DisableProcessorRequest.Builder

Request message for the disable processor method.

Protobuf type google.cloud.documentai.v1beta3.DisableProcessorRequest

DisableProcessorResponse

Response message for the disable processor method.

Protobuf type google.cloud.documentai.v1beta3.DisableProcessorResponse

DisableProcessorResponse.Builder

Response message for the disable processor method.

Protobuf type google.cloud.documentai.v1beta3.DisableProcessorResponse

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.

Protobuf type google.cloud.documentai.v1beta3.Document

Document.Builder

Protobuf type google.cloud.documentai.v1beta3.Document

Document.Entity

A phrase in the text that is a known entity type, such as a person, an organization, or location.

Protobuf type google.cloud.documentai.v1beta3.Document.Entity

Document.Entity.Builder

A phrase in the text that is a known entity type, such as a person, an organization, or location.

Protobuf type google.cloud.documentai.v1beta3.Document.Entity

Document.Entity.NormalizedValue

Parsed and normalized entity value.

Protobuf type google.cloud.documentai.v1beta3.Document.Entity.NormalizedValue

Document.Entity.NormalizedValue.Builder

Parsed and normalized entity value.

Protobuf type google.cloud.documentai.v1beta3.Document.Entity.NormalizedValue

Document.EntityRelation

Relationship between Entities.

Protobuf type google.cloud.documentai.v1beta3.Document.EntityRelation

Document.EntityRelation.Builder

Relationship between Entities.

Protobuf type google.cloud.documentai.v1beta3.Document.EntityRelation

Document.Page

A page in a Document.

Protobuf type google.cloud.documentai.v1beta3.Document.Page

Document.Page.Block

A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Block

Document.Page.Block.Builder

A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Block

Document.Page.Builder

A page in a Document.

Protobuf type google.cloud.documentai.v1beta3.Document.Page

Document.Page.DetectedLanguage

Detected language for a structural component.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.DetectedLanguage

Document.Page.DetectedLanguage.Builder

Detected language for a structural component.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.DetectedLanguage

Document.Page.Dimension

Dimension for the page.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Dimension

Document.Page.Dimension.Builder

Dimension for the page.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Dimension

Document.Page.FormField

A form field detected on the page.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.FormField

Document.Page.FormField.Builder

A form field detected on the page.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.FormField

Document.Page.Image

Rendered image contents for this page.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Image

Document.Page.Image.Builder

Rendered image contents for this page.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Image

Document.Page.Layout

Visual element describing a layout unit on a page.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Layout

Document.Page.Layout.Builder

Visual element describing a layout unit on a page.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Layout

Document.Page.Line

A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Line

Document.Page.Line.Builder

A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Line

Document.Page.Matrix

Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Matrix

Document.Page.Matrix.Builder

Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Matrix

Document.Page.Paragraph

A collection of lines that a human would perceive as a paragraph.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Paragraph

Document.Page.Paragraph.Builder

A collection of lines that a human would perceive as a paragraph.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Paragraph

Document.Page.Table

A table representation similar to HTML table structure.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Table

Document.Page.Table.Builder

A table representation similar to HTML table structure.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Table

Document.Page.Table.TableCell

A cell representation inside the table.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Table.TableCell

Document.Page.Table.TableCell.Builder

A cell representation inside the table.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Table.TableCell

Document.Page.Table.TableRow

A row of table cells.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Table.TableRow

Document.Page.Table.TableRow.Builder

A row of table cells.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Table.TableRow

Document.Page.Token

A detected token.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Token

Document.Page.Token.Builder

A detected token.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Token

Document.Page.Token.DetectedBreak

Detected break at the end of a Token.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Token.DetectedBreak

Document.Page.Token.DetectedBreak.Builder

Detected break at the end of a Token.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.Token.DetectedBreak

Document.Page.VisualElement

Detected non-text visual elements e.g. checkbox, signature etc. on the page.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.VisualElement

Document.Page.VisualElement.Builder

Detected non-text visual elements e.g. checkbox, signature etc. on the page.

Protobuf type google.cloud.documentai.v1beta3.Document.Page.VisualElement

Document.PageAnchor

Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.

Protobuf type google.cloud.documentai.v1beta3.Document.PageAnchor

Document.PageAnchor.Builder

Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.

Protobuf type google.cloud.documentai.v1beta3.Document.PageAnchor

Document.PageAnchor.PageRef

Represents a weak reference to a page element within a document.

Protobuf type google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef

Document.PageAnchor.PageRef.Builder

Represents a weak reference to a page element within a document.

Protobuf type google.cloud.documentai.v1beta3.Document.PageAnchor.PageRef

Document.Provenance

Structure to identify provenance relationships between annotations in different revisions.

Protobuf type google.cloud.documentai.v1beta3.Document.Provenance

Document.Provenance.Builder

Structure to identify provenance relationships between annotations in different revisions.

Protobuf type google.cloud.documentai.v1beta3.Document.Provenance

Document.Provenance.Parent

Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced.

Protobuf type google.cloud.documentai.v1beta3.Document.Provenance.Parent

Document.Provenance.Parent.Builder

Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced.

Protobuf type google.cloud.documentai.v1beta3.Document.Provenance.Parent

Document.Revision

Contains past or forward revisions of this document.

Protobuf type google.cloud.documentai.v1beta3.Document.Revision

Document.Revision.Builder

Contains past or forward revisions of this document.

Protobuf type google.cloud.documentai.v1beta3.Document.Revision

Document.Revision.HumanReview

Human Review information of the document.

Protobuf type google.cloud.documentai.v1beta3.Document.Revision.HumanReview

Document.Revision.HumanReview.Builder

Human Review information of the document.

Protobuf type google.cloud.documentai.v1beta3.Document.Revision.HumanReview

Document.ShardInfo

For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.

Protobuf type google.cloud.documentai.v1beta3.Document.ShardInfo

Document.ShardInfo.Builder

For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.

Protobuf type google.cloud.documentai.v1beta3.Document.ShardInfo

Document.Style

Annotation for common text style attributes. This adheres to CSS conventions as much as possible.

Protobuf type google.cloud.documentai.v1beta3.Document.Style

Document.Style.Builder

Annotation for common text style attributes. This adheres to CSS conventions as much as possible.

Protobuf type google.cloud.documentai.v1beta3.Document.Style

Document.Style.FontSize

Font size with unit.

Protobuf type google.cloud.documentai.v1beta3.Document.Style.FontSize

Document.Style.FontSize.Builder

Font size with unit.

Protobuf type google.cloud.documentai.v1beta3.Document.Style.FontSize

Document.TextAnchor

Text reference indexing into the Document.text.

Protobuf type google.cloud.documentai.v1beta3.Document.TextAnchor

Document.TextAnchor.Builder

Text reference indexing into the Document.text.

Protobuf type google.cloud.documentai.v1beta3.Document.TextAnchor

Document.TextAnchor.TextSegment

A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset

Protobuf type google.cloud.documentai.v1beta3.Document.TextAnchor.TextSegment

Document.TextAnchor.TextSegment.Builder

A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset

Protobuf type google.cloud.documentai.v1beta3.Document.TextAnchor.TextSegment

Document.TextChange

This message is used for text changes aka. OCR corrections.

Protobuf type google.cloud.documentai.v1beta3.Document.TextChange

Document.TextChange.Builder

This message is used for text changes aka. OCR corrections.

Protobuf type google.cloud.documentai.v1beta3.Document.TextChange

DocumentAiProcessor

DocumentAiProcessorService

DocumentAiProcessorType

DocumentIoProto

DocumentOutputConfig

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

Protobuf type google.cloud.documentai.v1beta3.DocumentOutputConfig

DocumentOutputConfig.Builder

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

Protobuf type google.cloud.documentai.v1beta3.DocumentOutputConfig

DocumentOutputConfig.GcsOutputConfig

The configuration used when outputting documents.

Protobuf type google.cloud.documentai.v1beta3.DocumentOutputConfig.GcsOutputConfig

DocumentOutputConfig.GcsOutputConfig.Builder

The configuration used when outputting documents.

Protobuf type google.cloud.documentai.v1beta3.DocumentOutputConfig.GcsOutputConfig

DocumentProcessorServiceClient

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 try (DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create()) {
   ProcessorName name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
   ProcessResponse response = documentProcessorServiceClient.processDocument(name);
 }

Note: close() needs to be called on the DocumentProcessorServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of DocumentProcessorServiceSettings to create(). For example:

To customize credentials:


 DocumentProcessorServiceSettings documentProcessorServiceSettings =
     DocumentProcessorServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create(documentProcessorServiceSettings);

To customize the endpoint:


 DocumentProcessorServiceSettings documentProcessorServiceSettings =
     DocumentProcessorServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DocumentProcessorServiceClient documentProcessorServiceClient =
     DocumentProcessorServiceClient.create(documentProcessorServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

DocumentProcessorServiceClient.ListProcessorsFixedSizeCollection

DocumentProcessorServiceClient.ListProcessorsPage

DocumentProcessorServiceClient.ListProcessorsPagedResponse

DocumentProcessorServiceGrpc

Service to call Cloud DocumentAI to process documents according to the processor's definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents.

DocumentProcessorServiceGrpc.DocumentProcessorServiceBlockingStub

DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub

DocumentProcessorServiceGrpc.DocumentProcessorServiceImplBase

DocumentProcessorServiceGrpc.DocumentProcessorServiceStub

DocumentProcessorServiceSettings

Settings class to configure an instance of DocumentProcessorServiceClient.

The default instance has everything set to sensible defaults:

The default service address (documentai.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of processDocument to 30 seconds:


 DocumentProcessorServiceSettings.Builder documentProcessorServiceSettingsBuilder =
     DocumentProcessorServiceSettings.newBuilder();
 documentProcessorServiceSettingsBuilder
     .processDocumentSettings()
     .setRetrySettings(
         documentProcessorServiceSettingsBuilder
             .processDocumentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DocumentProcessorServiceSettings documentProcessorServiceSettings =
     documentProcessorServiceSettingsBuilder.build();