- 2.59.0 (latest)
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.5
- 2.6.2
- 2.5.1
- 2.4.3
- 2.3.1
- 2.2.1
- 2.1.9
Package com.google.cloud.documentai.v1beta1 (2.55.0)
| GitHub Repository |
This package is not the recommended entry point to using this client library!
For this library, we recommend using com.google.cloud.documentai.v1 for new applications.
Prerelease Implications
This package is a prerelease version! Use with caution.
Prerelease versions are considered unstable as they may be shut down and/or subject to breaking changes when upgrading. Use them only for testing or if you specifically need their experimental features.
Client Classes
Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.
| Client | Description |
|---|---|
| com.google.cloud.documentai.v1beta1.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. |
Settings Classes
Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.
| Settings | Description |
|---|---|
| com.google.cloud.documentai.v1beta1.DocumentUnderstandingServiceSettings |
Settings class to configure an instance of DocumentUnderstandingServiceClient.
The default instance has everything set to sensible defaults: |
Classes
| Class | Description |
|---|---|
| com.google.cloud.documentai.v1beta1.BatchProcessDocumentsRequest | Request to batch process documents as an asynchronous operation. |
| com.google.cloud.documentai.v1beta1.BatchProcessDocumentsRequest.Builder | Request to batch process documents as an asynchronous operation. |
| com.google.cloud.documentai.v1beta1.BatchProcessDocumentsResponse | Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete. |
| com.google.cloud.documentai.v1beta1.BatchProcessDocumentsResponse.Builder | Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete. |
| com.google.cloud.documentai.v1beta1.BoundingPoly | A bounding polygon for the detected image annotation. |
| com.google.cloud.documentai.v1beta1.BoundingPoly.Builder | A bounding polygon for the detected image annotation. |
| com.google.cloud.documentai.v1beta1.Document | Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows |
| com.google.cloud.documentai.v1beta1.Document.Builder | Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows |
| com.google.cloud.documentai.v1beta1.Document.Entity | A phrase in the text that is a known entity type, such as a person, an organization, or location. |
| com.google.cloud.documentai.v1beta1.Document.Entity.Builder | A phrase in the text that is a known entity type, such as a person, an organization, or location. |
| com.google.cloud.documentai.v1beta1.Document.EntityRelation | Relationship between Entities. |
| com.google.cloud.documentai.v1beta1.Document.EntityRelation.Builder | Relationship between Entities. |
| com.google.cloud.documentai.v1beta1.Document.Page | A page in a Document. |
| com.google.cloud.documentai.v1beta1.Document.Page.Block | A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. |
| com.google.cloud.documentai.v1beta1.Document.Page.Block.Builder | A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. |
| com.google.cloud.documentai.v1beta1.Document.Page.Builder | A page in a Document. |
| com.google.cloud.documentai.v1beta1.Document.Page.DetectedLanguage | Detected language for a structural component. |
| com.google.cloud.documentai.v1beta1.Document.Page.DetectedLanguage.Builder | Detected language for a structural component. |
| com.google.cloud.documentai.v1beta1.Document.Page.Dimension | Dimension for the page. |
| com.google.cloud.documentai.v1beta1.Document.Page.Dimension.Builder | Dimension for the page. |
| com.google.cloud.documentai.v1beta1.Document.Page.FormField | A form field detected on the page. |
| com.google.cloud.documentai.v1beta1.Document.Page.FormField.Builder | A form field detected on the page. |
| com.google.cloud.documentai.v1beta1.Document.Page.Layout | Visual element describing a layout unit on a page. |
| com.google.cloud.documentai.v1beta1.Document.Page.Layout.Builder | Visual element describing a layout unit on a page. |
| com.google.cloud.documentai.v1beta1.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. |
| com.google.cloud.documentai.v1beta1.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. |
| com.google.cloud.documentai.v1beta1.Document.Page.Paragraph | A collection of lines that a human would perceive as a paragraph. |
| com.google.cloud.documentai.v1beta1.Document.Page.Paragraph.Builder | A collection of lines that a human would perceive as a paragraph. |
| com.google.cloud.documentai.v1beta1.Document.Page.Table | A table representation similar to HTML table structure. |
| com.google.cloud.documentai.v1beta1.Document.Page.Table.Builder | A table representation similar to HTML table structure. |
| com.google.cloud.documentai.v1beta1.Document.Page.Table.TableCell | A cell representation inside the table. |
| com.google.cloud.documentai.v1beta1.Document.Page.Table.TableCell.Builder | A cell representation inside the table. |
| com.google.cloud.documentai.v1beta1.Document.Page.Table.TableRow | A row of table cells. |
| com.google.cloud.documentai.v1beta1.Document.Page.Table.TableRow.Builder | A row of table cells. |
| com.google.cloud.documentai.v1beta1.Document.Page.Token | A detected token. |
| com.google.cloud.documentai.v1beta1.Document.Page.Token.Builder | A detected token. |
| com.google.cloud.documentai.v1beta1.Document.Page.Token.DetectedBreak | Detected break at the end of a Token. |
| com.google.cloud.documentai.v1beta1.Document.Page.Token.DetectedBreak.Builder | Detected break at the end of a Token. |
| com.google.cloud.documentai.v1beta1.Document.Page.VisualElement | Detected non-text visual elements e.g. checkbox, signature etc. on the page. |
| com.google.cloud.documentai.v1beta1.Document.Page.VisualElement.Builder | Detected non-text visual elements e.g. checkbox, signature etc. on the page. |
| com.google.cloud.documentai.v1beta1.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. |
| com.google.cloud.documentai.v1beta1.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. |
| com.google.cloud.documentai.v1beta1.Document.Style | Annotation for common text style attributes. This adheres to CSS conventions as much as possible. |
| com.google.cloud.documentai.v1beta1.Document.Style.Builder | Annotation for common text style attributes. This adheres to CSS conventions as much as possible. |
| com.google.cloud.documentai.v1beta1.Document.Style.FontSize | Font size with unit. |
| com.google.cloud.documentai.v1beta1.Document.Style.FontSize.Builder | Font size with unit. |
| com.google.cloud.documentai.v1beta1.Document.TextAnchor | Text reference indexing into the Document.text. |
| com.google.cloud.documentai.v1beta1.Document.TextAnchor.Builder | Text reference indexing into the Document.text. |
| com.google.cloud.documentai.v1beta1.Document.TextAnchor.TextSegment | A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into |
| com.google.cloud.documentai.v1beta1.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 |
| com.google.cloud.documentai.v1beta1.DocumentAiProto | |
| com.google.cloud.documentai.v1beta1.DocumentProto | |
| com.google.cloud.documentai.v1beta1.DocumentUnderstandingServiceGrpc | 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. |
| com.google.cloud.documentai.v1beta1.DocumentUnderstandingServiceGrpc.DocumentUnderstandingServiceImplBase | Base class for the server implementation of the service DocumentUnderstandingService. Service to parse structured information from unstructured or semi-structured |
| com.google.cloud.documentai.v1beta1.DocumentUnderstandingServiceSettings.Builder | Builder for DocumentUnderstandingServiceSettings. |
| com.google.cloud.documentai.v1beta1.EntityExtractionParams | Parameters to control entity extraction behavior. |
| com.google.cloud.documentai.v1beta1.EntityExtractionParams.Builder | Parameters to control entity extraction behavior. |
| com.google.cloud.documentai.v1beta1.FormExtractionParams | Parameters to control form extraction behavior. |
| com.google.cloud.documentai.v1beta1.FormExtractionParams.Builder | Parameters to control form extraction behavior. |
| com.google.cloud.documentai.v1beta1.GcsDestination | The Google Cloud Storage location where the output file will be written to. |
| com.google.cloud.documentai.v1beta1.GcsDestination.Builder | The Google Cloud Storage location where the output file will be written to. |
| com.google.cloud.documentai.v1beta1.GcsSource | The Google Cloud Storage location where the input file will be read from. |
| com.google.cloud.documentai.v1beta1.GcsSource.Builder | The Google Cloud Storage location where the input file will be read from. |
| com.google.cloud.documentai.v1beta1.GeometryProto | |
| com.google.cloud.documentai.v1beta1.InputConfig | The desired input location and metadata. |
| com.google.cloud.documentai.v1beta1.InputConfig.Builder | The desired input location and metadata. |
| com.google.cloud.documentai.v1beta1.KeyValuePairHint | User-provided hint for key value pair. |
| com.google.cloud.documentai.v1beta1.KeyValuePairHint.Builder | User-provided hint for key value pair. |
| com.google.cloud.documentai.v1beta1.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. |
| com.google.cloud.documentai.v1beta1.NormalizedVertex.Builder | 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. |
| com.google.cloud.documentai.v1beta1.OcrParams | Parameters to control Optical Character Recognition (OCR) behavior. |
| com.google.cloud.documentai.v1beta1.OcrParams.Builder | Parameters to control Optical Character Recognition (OCR) behavior. |
| com.google.cloud.documentai.v1beta1.OperationMetadata | Contains metadata for the BatchProcessDocuments operation. |
| com.google.cloud.documentai.v1beta1.OperationMetadata.Builder | Contains metadata for the BatchProcessDocuments operation. |
| com.google.cloud.documentai.v1beta1.OutputConfig | The desired output location and metadata. |
| com.google.cloud.documentai.v1beta1.OutputConfig.Builder | The desired output location and metadata. |
| com.google.cloud.documentai.v1beta1.ProcessDocumentRequest | Request to process one document. |
| com.google.cloud.documentai.v1beta1.ProcessDocumentRequest.Builder | Request to process one document. |
| com.google.cloud.documentai.v1beta1.ProcessDocumentResponse | Response to a single document processing request. |
| com.google.cloud.documentai.v1beta1.ProcessDocumentResponse.Builder | Response to a single document processing request. |
| com.google.cloud.documentai.v1beta1.TableBoundHint | A hint for a table bounding box on the page for table parsing. |
| com.google.cloud.documentai.v1beta1.TableBoundHint.Builder | A hint for a table bounding box on the page for table parsing. |
| com.google.cloud.documentai.v1beta1.TableExtractionParams | Parameters to control table extraction behavior. |
| com.google.cloud.documentai.v1beta1.TableExtractionParams.Builder | Parameters to control table extraction behavior. |
| com.google.cloud.documentai.v1beta1.Vertex | A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. |
| com.google.cloud.documentai.v1beta1.Vertex.Builder | A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. |
Interfaces
Enums
| Enum | Description |
|---|---|
| com.google.cloud.documentai.v1beta1.Document.Page.Layout.Orientation | Detected human reading orientation. |
| com.google.cloud.documentai.v1beta1.Document.Page.Token.DetectedBreak.Type | Enum to denote the type of break found. |
| com.google.cloud.documentai.v1beta1.Document.SourceCase | |
| com.google.cloud.documentai.v1beta1.InputConfig.SourceCase | |
| com.google.cloud.documentai.v1beta1.OperationMetadata.State |
Protobuf enum google.cloud.documentai.v1beta1.OperationMetadata.State |
| com.google.cloud.documentai.v1beta1.OutputConfig.DestinationCase |