Package com.google.cloud.documentai.v1beta2 (2.1.9)

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

DocumentUnderstandingServiceClient

Service Description: Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, and translation.

Sample for DocumentUnderstandingServiceClient:


 try (DocumentUnderstandingServiceClient documentUnderstandingServiceClient =
     DocumentUnderstandingServiceClient.create()) {
   ProcessDocumentRequest request =
       ProcessDocumentRequest.newBuilder()
           .setParent("parent-995424086")
           .setInputConfig(InputConfig.newBuilder().build())
           .setOutputConfig(OutputConfig.newBuilder().build())
           .setDocumentType("documentType-1473196299")
           .setTableExtractionParams(TableExtractionParams.newBuilder().build())
           .setFormExtractionParams(FormExtractionParams.newBuilder().build())
           .setEntityExtractionParams(EntityExtractionParams.newBuilder().build())
           .setOcrParams(OcrParams.newBuilder().build())
           .setAutomlParams(AutoMlParams.newBuilder().build())
           .build();
   Document response = documentUnderstandingServiceClient.processDocument(request);
 }

Classes

AutoMlParams

Parameters to control AutoML model prediction behavior.

Protobuf type google.cloud.documentai.v1beta2.AutoMlParams

AutoMlParams.Builder

Parameters to control AutoML model prediction behavior.

Protobuf type google.cloud.documentai.v1beta2.AutoMlParams

BatchProcessDocumentsRequest

Request to batch process documents as an asynchronous operation. The output is written to Cloud Storage as JSON in the [Document] format.

Protobuf type google.cloud.documentai.v1beta2.BatchProcessDocumentsRequest

BatchProcessDocumentsRequest.Builder

Request to batch process documents as an asynchronous operation. The output is written to Cloud Storage as JSON in the [Document] format.

Protobuf type google.cloud.documentai.v1beta2.BatchProcessDocumentsRequest

BatchProcessDocumentsResponse

Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.

Protobuf type google.cloud.documentai.v1beta2.BatchProcessDocumentsResponse

BatchProcessDocumentsResponse.Builder

Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.

Protobuf type google.cloud.documentai.v1beta2.BatchProcessDocumentsResponse

BoundingPoly

A bounding polygon for the detected image annotation.

Protobuf type google.cloud.documentai.v1beta2.BoundingPoly

BoundingPoly.Builder

A bounding polygon for the detected image annotation.

Protobuf type google.cloud.documentai.v1beta2.BoundingPoly

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.v1beta2.Document

Document.Builder

Protobuf type google.cloud.documentai.v1beta2.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.v1beta2.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.v1beta2.Document.Entity

Document.EntityRelation

Relationship between Entities.

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

Document.EntityRelation.Builder

Relationship between Entities.

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

Document.Label

Label attaches schema information and/or other metadata to segments within a Document. Multiple Labels on a single field can denote either different labels, different instances of the same label created at different times, or some combination of both.

Protobuf type google.cloud.documentai.v1beta2.Document.Label

Document.Label.Builder

Protobuf type google.cloud.documentai.v1beta2.Document.Label

Document.Page

A page in a Document.

Protobuf type google.cloud.documentai.v1beta2.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.v1beta2.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.v1beta2.Document.Page.Block

Document.Page.Builder

A page in a Document.

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

Document.Page.DetectedLanguage

Detected language for a structural component.

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

Document.Page.DetectedLanguage.Builder

Detected language for a structural component.

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

Document.Page.Dimension

Dimension for the page.

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

Document.Page.Dimension.Builder

Dimension for the page.

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

Document.Page.FormField

A form field detected on the page.

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

Document.Page.FormField.Builder

A form field detected on the page.

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

Document.Page.Layout

Visual element describing a layout unit on a page.

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

Document.Page.Layout.Builder

Visual element describing a layout unit on a page.

Protobuf type google.cloud.documentai.v1beta2.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.v1beta2.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.v1beta2.Document.Page.Line

Document.Page.Paragraph

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

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

Document.Page.Paragraph.Builder

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

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

Document.Page.Table

A table representation similar to HTML table structure.

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

Document.Page.Table.Builder

A table representation similar to HTML table structure.

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

Document.Page.Table.TableCell

A cell representation inside the table.

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

Document.Page.Table.TableCell.Builder

A cell representation inside the table.

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

Document.Page.Table.TableRow

A row of table cells.

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

Document.Page.Table.TableRow.Builder

A row of table cells.

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

Document.Page.Token

A detected token.

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

Document.Page.Token.Builder

A detected token.

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

Document.Page.Token.DetectedBreak

Detected break at the end of a Token.

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

Document.Page.Token.DetectedBreak.Builder

Detected break at the end of a Token.

Protobuf type google.cloud.documentai.v1beta2.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.v1beta2.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.v1beta2.Document.Page.VisualElement

Document.PageAnchor

Referencing elements in Document.pages.

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

Document.PageAnchor.Builder

Referencing elements in Document.pages.

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

Document.PageAnchor.PageRef

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

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

Document.PageAnchor.PageRef.Builder

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

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

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.v1beta2.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.v1beta2.Document.ShardInfo

Document.Style

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

Protobuf type google.cloud.documentai.v1beta2.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.v1beta2.Document.Style

Document.Style.FontSize

Font size with unit.

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

Document.Style.FontSize.Builder

Font size with unit.

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

Document.TextAnchor

Text reference indexing into the Document.text.

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

Document.TextAnchor.Builder

Text reference indexing into the Document.text.

Protobuf type google.cloud.documentai.v1beta2.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.v1beta2.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.v1beta2.Document.TextAnchor.TextSegment

DocumentAiProto

DocumentProto

DocumentUnderstandingServiceClient

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 (DocumentUnderstandingServiceClient documentUnderstandingServiceClient =
     DocumentUnderstandingServiceClient.create()) {
   ProcessDocumentRequest request =
       ProcessDocumentRequest.newBuilder()
           .setParent("parent-995424086")
           .setInputConfig(InputConfig.newBuilder().build())
           .setOutputConfig(OutputConfig.newBuilder().build())
           .setDocumentType("documentType-1473196299")
           .setTableExtractionParams(TableExtractionParams.newBuilder().build())
           .setFormExtractionParams(FormExtractionParams.newBuilder().build())
           .setEntityExtractionParams(EntityExtractionParams.newBuilder().build())
           .setOcrParams(OcrParams.newBuilder().build())
           .setAutomlParams(AutoMlParams.newBuilder().build())
           .build();
   Document response = documentUnderstandingServiceClient.processDocument(request);
 }

Note: close() needs to be called on the DocumentUnderstandingServiceClient 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 DocumentUnderstandingServiceSettings to create(). For example:

To customize credentials:


 DocumentUnderstandingServiceSettings documentUnderstandingServiceSettings =
     DocumentUnderstandingServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DocumentUnderstandingServiceClient documentUnderstandingServiceClient =
     DocumentUnderstandingServiceClient.create(documentUnderstandingServiceSettings);

To customize the endpoint:


 DocumentUnderstandingServiceSettings documentUnderstandingServiceSettings =
     DocumentUnderstandingServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DocumentUnderstandingServiceClient documentUnderstandingServiceClient =
     DocumentUnderstandingServiceClient.create(documentUnderstandingServiceSettings);

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