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

GitHub Repository

This package is not the latest GA version!

For this library, we recommend using the package associated with API version 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. You can read more about Cloud API versioning strategy here. Each Cloud Java client library may contain multiple packages. Each package containing a version number in its name corresponds to a published version of the service. We recommend using the latest stable version for new production applications, which can be identified by the largest numeric version that does not contain a suffix. For example, if a client library has two packages: v1 and v2alpha, then the latest stable version is v1. If you use an unstable release, breaking changes may be introduced when upgrading.

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.v1beta2.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.v1beta2.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.v1beta2.AutoMlParams Parameters to control AutoML model prediction behavior.
com.google.cloud.documentai.v1beta2.AutoMlParams.Builder Parameters to control AutoML model prediction behavior.
com.google.cloud.documentai.v1beta2.Barcode Encodes the detailed information of a barcode.
com.google.cloud.documentai.v1beta2.Barcode.Builder Encodes the detailed information of a barcode.
com.google.cloud.documentai.v1beta2.BarcodeProto
com.google.cloud.documentai.v1beta2.BatchProcessDocumentsRequest Request to batch process documents as an asynchronous operation. The output is written to Cloud Storage as JSON in the [Document] format.
com.google.cloud.documentai.v1beta2.BatchProcessDocumentsRequest.Builder Request to batch process documents as an asynchronous operation. The output is written to Cloud Storage as JSON in the [Document] format.
com.google.cloud.documentai.v1beta2.BatchProcessDocumentsResponse Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.
com.google.cloud.documentai.v1beta2.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.v1beta2.BoundingPoly A bounding polygon for the detected image annotation.
com.google.cloud.documentai.v1beta2.BoundingPoly.Builder A bounding polygon for the detected image annotation.
com.google.cloud.documentai.v1beta2.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
com.google.cloud.documentai.v1beta2.Document.Builder 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
com.google.cloud.documentai.v1beta2.Document.Entity An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
com.google.cloud.documentai.v1beta2.Document.Entity.Builder An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
com.google.cloud.documentai.v1beta2.Document.Entity.NormalizedValue Parsed and normalized entity value.
com.google.cloud.documentai.v1beta2.Document.Entity.NormalizedValue.Builder Parsed and normalized entity value.
com.google.cloud.documentai.v1beta2.Document.EntityRelation Relationship between Entities.
com.google.cloud.documentai.v1beta2.Document.EntityRelation.Builder Relationship between Entities.
com.google.cloud.documentai.v1beta2.Document.Label Label attaches schema information and/or other metadata to segments within a Document. Multiple Labels on a single field
com.google.cloud.documentai.v1beta2.Document.Label.Builder Label attaches schema information and/or other metadata to segments within a Document. Multiple Labels on a single field
com.google.cloud.documentai.v1beta2.Document.Page A page in a Document.
com.google.cloud.documentai.v1beta2.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.v1beta2.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.v1beta2.Document.Page.Builder A page in a Document.
com.google.cloud.documentai.v1beta2.Document.Page.DetectedBarcode A detected barcode.
com.google.cloud.documentai.v1beta2.Document.Page.DetectedBarcode.Builder A detected barcode.
com.google.cloud.documentai.v1beta2.Document.Page.DetectedLanguage Detected language for a structural component.
com.google.cloud.documentai.v1beta2.Document.Page.DetectedLanguage.Builder Detected language for a structural component.
com.google.cloud.documentai.v1beta2.Document.Page.Dimension Dimension for the page.
com.google.cloud.documentai.v1beta2.Document.Page.Dimension.Builder Dimension for the page.
com.google.cloud.documentai.v1beta2.Document.Page.FormField A form field detected on the page.
com.google.cloud.documentai.v1beta2.Document.Page.FormField.Builder A form field detected on the page.
com.google.cloud.documentai.v1beta2.Document.Page.Image Rendered image contents for this page.
com.google.cloud.documentai.v1beta2.Document.Page.Image.Builder Rendered image contents for this page.
com.google.cloud.documentai.v1beta2.Document.Page.ImageQualityScores Image quality scores for the page image.
com.google.cloud.documentai.v1beta2.Document.Page.ImageQualityScores.Builder Image quality scores for the page image.
com.google.cloud.documentai.v1beta2.Document.Page.ImageQualityScores.DetectedDefect Image Quality Defects
com.google.cloud.documentai.v1beta2.Document.Page.ImageQualityScores.DetectedDefect.Builder Image Quality Defects
com.google.cloud.documentai.v1beta2.Document.Page.Layout Visual element describing a layout unit on a page.
com.google.cloud.documentai.v1beta2.Document.Page.Layout.Builder Visual element describing a layout unit on a page.
com.google.cloud.documentai.v1beta2.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.v1beta2.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.v1beta2.Document.Page.Matrix Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
com.google.cloud.documentai.v1beta2.Document.Page.Matrix.Builder Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
com.google.cloud.documentai.v1beta2.Document.Page.Paragraph A collection of lines that a human would perceive as a paragraph.
com.google.cloud.documentai.v1beta2.Document.Page.Paragraph.Builder A collection of lines that a human would perceive as a paragraph.
com.google.cloud.documentai.v1beta2.Document.Page.Symbol A detected symbol.
com.google.cloud.documentai.v1beta2.Document.Page.Symbol.Builder A detected symbol.
com.google.cloud.documentai.v1beta2.Document.Page.Table A table representation similar to HTML table structure.
com.google.cloud.documentai.v1beta2.Document.Page.Table.Builder A table representation similar to HTML table structure.
com.google.cloud.documentai.v1beta2.Document.Page.Table.TableCell A cell representation inside the table.
com.google.cloud.documentai.v1beta2.Document.Page.Table.TableCell.Builder A cell representation inside the table.
com.google.cloud.documentai.v1beta2.Document.Page.Table.TableRow A row of table cells.
com.google.cloud.documentai.v1beta2.Document.Page.Table.TableRow.Builder A row of table cells.
com.google.cloud.documentai.v1beta2.Document.Page.Token A detected token.
com.google.cloud.documentai.v1beta2.Document.Page.Token.Builder A detected token.
com.google.cloud.documentai.v1beta2.Document.Page.Token.DetectedBreak Detected break at the end of a Token.
com.google.cloud.documentai.v1beta2.Document.Page.Token.DetectedBreak.Builder Detected break at the end of a Token.
com.google.cloud.documentai.v1beta2.Document.Page.Token.StyleInfo Font and other text style attributes.
com.google.cloud.documentai.v1beta2.Document.Page.Token.StyleInfo.Builder Font and other text style attributes.
com.google.cloud.documentai.v1beta2.Document.Page.VisualElement Detected non-text visual elements e.g. checkbox, signature etc. on the page.
com.google.cloud.documentai.v1beta2.Document.Page.VisualElement.Builder Detected non-text visual elements e.g. checkbox, signature etc. on the page.
com.google.cloud.documentai.v1beta2.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
com.google.cloud.documentai.v1beta2.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
com.google.cloud.documentai.v1beta2.Document.PageAnchor.PageRef Represents a weak reference to a page element within a document.
com.google.cloud.documentai.v1beta2.Document.PageAnchor.PageRef.Builder Represents a weak reference to a page element within a document.
com.google.cloud.documentai.v1beta2.Document.Provenance Structure to identify provenance relationships between annotations in different revisions.
com.google.cloud.documentai.v1beta2.Document.Provenance.Builder Structure to identify provenance relationships between annotations in different revisions.
com.google.cloud.documentai.v1beta2.Document.Provenance.Parent The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
com.google.cloud.documentai.v1beta2.Document.Provenance.Parent.Builder The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
com.google.cloud.documentai.v1beta2.Document.Revision Contains past or forward revisions of this document.
com.google.cloud.documentai.v1beta2.Document.Revision.Builder Contains past or forward revisions of this document.
com.google.cloud.documentai.v1beta2.Document.Revision.HumanReview Human Review information of the document.
com.google.cloud.documentai.v1beta2.Document.Revision.HumanReview.Builder Human Review information of the document.
com.google.cloud.documentai.v1beta2.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.v1beta2.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.v1beta2.Document.Style Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
com.google.cloud.documentai.v1beta2.Document.Style.Builder Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
com.google.cloud.documentai.v1beta2.Document.Style.FontSize Font size with unit.
com.google.cloud.documentai.v1beta2.Document.Style.FontSize.Builder Font size with unit.
com.google.cloud.documentai.v1beta2.Document.TextAnchor Text reference indexing into the Document.text.
com.google.cloud.documentai.v1beta2.Document.TextAnchor.Builder Text reference indexing into the Document.text.
com.google.cloud.documentai.v1beta2.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.v1beta2.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.v1beta2.Document.TextChange This message is used for text changes aka. OCR corrections.
com.google.cloud.documentai.v1beta2.Document.TextChange.Builder This message is used for text changes aka. OCR corrections.
com.google.cloud.documentai.v1beta2.DocumentAiProto
com.google.cloud.documentai.v1beta2.DocumentProto
com.google.cloud.documentai.v1beta2.DocumentUnderstandingServiceClient.ListLocationsFixedSizeCollection
com.google.cloud.documentai.v1beta2.DocumentUnderstandingServiceClient.ListLocationsPage
com.google.cloud.documentai.v1beta2.DocumentUnderstandingServiceClient.ListLocationsPagedResponse
com.google.cloud.documentai.v1beta2.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.v1beta2.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.v1beta2.DocumentUnderstandingServiceSettings.Builder Builder for DocumentUnderstandingServiceSettings.
com.google.cloud.documentai.v1beta2.EntityExtractionParams Parameters to control entity extraction behavior.
com.google.cloud.documentai.v1beta2.EntityExtractionParams.Builder Parameters to control entity extraction behavior.
com.google.cloud.documentai.v1beta2.FormExtractionParams Parameters to control form extraction behavior.
com.google.cloud.documentai.v1beta2.FormExtractionParams.Builder Parameters to control form extraction behavior.
com.google.cloud.documentai.v1beta2.GcsDestination The Google Cloud Storage location where the output file will be written to.
com.google.cloud.documentai.v1beta2.GcsDestination.Builder The Google Cloud Storage location where the output file will be written to.
com.google.cloud.documentai.v1beta2.GcsSource The Google Cloud Storage location where the input file will be read from.
com.google.cloud.documentai.v1beta2.GcsSource.Builder The Google Cloud Storage location where the input file will be read from.
com.google.cloud.documentai.v1beta2.GeometryProto
com.google.cloud.documentai.v1beta2.InputConfig The desired input location and metadata.
com.google.cloud.documentai.v1beta2.InputConfig.Builder The desired input location and metadata.
com.google.cloud.documentai.v1beta2.KeyValuePairHint Reserved for future use.
com.google.cloud.documentai.v1beta2.KeyValuePairHint.Builder Reserved for future use.
com.google.cloud.documentai.v1beta2.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.v1beta2.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.v1beta2.OcrParams Parameters to control Optical Character Recognition (OCR) behavior.
com.google.cloud.documentai.v1beta2.OcrParams.Builder Parameters to control Optical Character Recognition (OCR) behavior.
com.google.cloud.documentai.v1beta2.OperationMetadata Contains metadata for the BatchProcessDocuments operation.
com.google.cloud.documentai.v1beta2.OperationMetadata.Builder Contains metadata for the BatchProcessDocuments operation.
com.google.cloud.documentai.v1beta2.OutputConfig The desired output location and metadata.
com.google.cloud.documentai.v1beta2.OutputConfig.Builder The desired output location and metadata.
com.google.cloud.documentai.v1beta2.ProcessDocumentRequest Request to process one document.
com.google.cloud.documentai.v1beta2.ProcessDocumentRequest.Builder Request to process one document.
com.google.cloud.documentai.v1beta2.ProcessDocumentResponse Response to a single document processing request.
com.google.cloud.documentai.v1beta2.ProcessDocumentResponse.Builder Response to a single document processing request.
com.google.cloud.documentai.v1beta2.TableBoundHint A hint for a table bounding box on the page for table parsing.
com.google.cloud.documentai.v1beta2.TableBoundHint.Builder A hint for a table bounding box on the page for table parsing.
com.google.cloud.documentai.v1beta2.TableExtractionParams Parameters to control table extraction behavior.
com.google.cloud.documentai.v1beta2.TableExtractionParams.Builder Parameters to control table extraction behavior.
com.google.cloud.documentai.v1beta2.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.v1beta2.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

Interface Description
com.google.cloud.documentai.v1beta2.AutoMlParamsOrBuilder
com.google.cloud.documentai.v1beta2.BarcodeOrBuilder
com.google.cloud.documentai.v1beta2.BatchProcessDocumentsRequestOrBuilder
com.google.cloud.documentai.v1beta2.BatchProcessDocumentsResponseOrBuilder
com.google.cloud.documentai.v1beta2.BoundingPolyOrBuilder
com.google.cloud.documentai.v1beta2.Document.Entity.NormalizedValueOrBuilder
com.google.cloud.documentai.v1beta2.Document.EntityOrBuilder
com.google.cloud.documentai.v1beta2.Document.EntityRelationOrBuilder
com.google.cloud.documentai.v1beta2.Document.LabelOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.BlockOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.DetectedBarcodeOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.DetectedLanguageOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.DimensionOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.FormFieldOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.ImageOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.ImageQualityScores.DetectedDefectOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.ImageQualityScoresOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.LayoutOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.LineOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.MatrixOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.ParagraphOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.SymbolOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.Table.TableCellOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.Table.TableRowOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.TableOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.Token.DetectedBreakOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.Token.StyleInfoOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.TokenOrBuilder
com.google.cloud.documentai.v1beta2.Document.Page.VisualElementOrBuilder
com.google.cloud.documentai.v1beta2.Document.PageAnchor.PageRefOrBuilder
com.google.cloud.documentai.v1beta2.Document.PageAnchorOrBuilder
com.google.cloud.documentai.v1beta2.Document.PageOrBuilder
com.google.cloud.documentai.v1beta2.Document.Provenance.ParentOrBuilder
com.google.cloud.documentai.v1beta2.Document.ProvenanceOrBuilder
com.google.cloud.documentai.v1beta2.Document.Revision.HumanReviewOrBuilder
com.google.cloud.documentai.v1beta2.Document.RevisionOrBuilder
com.google.cloud.documentai.v1beta2.Document.ShardInfoOrBuilder
com.google.cloud.documentai.v1beta2.Document.Style.FontSizeOrBuilder
com.google.cloud.documentai.v1beta2.Document.StyleOrBuilder
com.google.cloud.documentai.v1beta2.Document.TextAnchor.TextSegmentOrBuilder
com.google.cloud.documentai.v1beta2.Document.TextAnchorOrBuilder
com.google.cloud.documentai.v1beta2.Document.TextChangeOrBuilder
com.google.cloud.documentai.v1beta2.DocumentOrBuilder
com.google.cloud.documentai.v1beta2.DocumentUnderstandingServiceGrpc.AsyncService 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.v1beta2.EntityExtractionParamsOrBuilder
com.google.cloud.documentai.v1beta2.FormExtractionParamsOrBuilder
com.google.cloud.documentai.v1beta2.GcsDestinationOrBuilder
com.google.cloud.documentai.v1beta2.GcsSourceOrBuilder
com.google.cloud.documentai.v1beta2.InputConfigOrBuilder
com.google.cloud.documentai.v1beta2.KeyValuePairHintOrBuilder
com.google.cloud.documentai.v1beta2.NormalizedVertexOrBuilder
com.google.cloud.documentai.v1beta2.OcrParamsOrBuilder
com.google.cloud.documentai.v1beta2.OperationMetadataOrBuilder
com.google.cloud.documentai.v1beta2.OutputConfigOrBuilder
com.google.cloud.documentai.v1beta2.ProcessDocumentRequestOrBuilder
com.google.cloud.documentai.v1beta2.ProcessDocumentResponseOrBuilder
com.google.cloud.documentai.v1beta2.TableBoundHintOrBuilder
com.google.cloud.documentai.v1beta2.TableExtractionParamsOrBuilder
com.google.cloud.documentai.v1beta2.VertexOrBuilder

Enums

Enum Description
com.google.cloud.documentai.v1beta2.Document.Entity.NormalizedValue.StructuredValueCase
com.google.cloud.documentai.v1beta2.Document.Label.SourceCase
com.google.cloud.documentai.v1beta2.Document.Page.Layout.Orientation Detected human reading orientation.
com.google.cloud.documentai.v1beta2.Document.Page.Token.DetectedBreak.Type Enum to denote the type of break found.
com.google.cloud.documentai.v1beta2.Document.PageAnchor.PageRef.LayoutType The type of layout that is being referenced.
com.google.cloud.documentai.v1beta2.Document.Provenance.OperationType If a processor or agent does an explicit operation on existing elements.
com.google.cloud.documentai.v1beta2.Document.Revision.SourceCase
com.google.cloud.documentai.v1beta2.Document.SourceCase
com.google.cloud.documentai.v1beta2.InputConfig.SourceCase
com.google.cloud.documentai.v1beta2.OperationMetadata.State Protobuf enum google.cloud.documentai.v1beta2.OperationMetadata.State
com.google.cloud.documentai.v1beta2.OutputConfig.DestinationCase