Package com.google.cloud.documentai.v1 (2.47.0)

GitHub Repository

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.v1.DocumentProcessorServiceClient Service Description: Service to call Document AI 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.

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.cloud.documentai.v1.DocumentProcessorServiceSettings Settings class to configure an instance of DocumentProcessorServiceClient.

The default instance has everything set to sensible defaults:

Classes

Class Description
com.google.cloud.documentai.v1.Barcode Encodes the detailed information of a barcode.
com.google.cloud.documentai.v1.Barcode.Builder Encodes the detailed information of a barcode.
com.google.cloud.documentai.v1.BarcodeProto
com.google.cloud.documentai.v1.BatchDocumentsInputConfig The common config to specify a set of documents used as input.
com.google.cloud.documentai.v1.BatchDocumentsInputConfig.Builder The common config to specify a set of documents used as input.
com.google.cloud.documentai.v1.BatchProcessMetadata The long-running operation metadata for BatchProcessDocuments.
com.google.cloud.documentai.v1.BatchProcessMetadata.Builder The long-running operation metadata for BatchProcessDocuments.
com.google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus The status of a each individual document in the batch process.
com.google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus.Builder The status of a each individual document in the batch process.
com.google.cloud.documentai.v1.BatchProcessRequest Request message for BatchProcessDocuments.
com.google.cloud.documentai.v1.BatchProcessRequest.Builder Request message for BatchProcessDocuments.
com.google.cloud.documentai.v1.BatchProcessResponse Response message for BatchProcessDocuments.
com.google.cloud.documentai.v1.BatchProcessResponse.Builder Response message for BatchProcessDocuments.
com.google.cloud.documentai.v1.BoundingPoly A bounding polygon for the detected image annotation.
com.google.cloud.documentai.v1.BoundingPoly.Builder A bounding polygon for the detected image annotation.
com.google.cloud.documentai.v1.CommonOperationMetadata The common metadata for long running operations.
com.google.cloud.documentai.v1.CommonOperationMetadata.Builder The common metadata for long running operations.
com.google.cloud.documentai.v1.CreateProcessorRequest Request message for the CreateProcessor method. Notice this request is sent to a regionalized backend service. If the
com.google.cloud.documentai.v1.CreateProcessorRequest.Builder Request message for the CreateProcessor method. Notice this request is sent to a regionalized backend service. If the
com.google.cloud.documentai.v1.DeleteProcessorMetadata The long-running operation metadata for the DeleteProcessor method.
com.google.cloud.documentai.v1.DeleteProcessorMetadata.Builder The long-running operation metadata for the DeleteProcessor method.
com.google.cloud.documentai.v1.DeleteProcessorRequest Request message for the DeleteProcessor method.
com.google.cloud.documentai.v1.DeleteProcessorRequest.Builder Request message for the DeleteProcessor method.
com.google.cloud.documentai.v1.DeleteProcessorVersionMetadata The long-running operation metadata for the DeleteProcessorVersion method.
com.google.cloud.documentai.v1.DeleteProcessorVersionMetadata.Builder The long-running operation metadata for the DeleteProcessorVersion method.
com.google.cloud.documentai.v1.DeleteProcessorVersionRequest Request message for the DeleteProcessorVersion method.
com.google.cloud.documentai.v1.DeleteProcessorVersionRequest.Builder Request message for the DeleteProcessorVersion method.
com.google.cloud.documentai.v1.DeployProcessorVersionMetadata The long-running operation metadata for the DeployProcessorVersion method.
com.google.cloud.documentai.v1.DeployProcessorVersionMetadata.Builder The long-running operation metadata for the DeployProcessorVersion method.
com.google.cloud.documentai.v1.DeployProcessorVersionRequest Request message for the DeployProcessorVersion method.
com.google.cloud.documentai.v1.DeployProcessorVersionRequest.Builder Request message for the DeployProcessorVersion method.
com.google.cloud.documentai.v1.DeployProcessorVersionResponse Response message for the DeployProcessorVersion method.
com.google.cloud.documentai.v1.DeployProcessorVersionResponse.Builder Response message for the DeployProcessorVersion method.
com.google.cloud.documentai.v1.DisableProcessorMetadata The long-running operation metadata for the DisableProcessor method.
com.google.cloud.documentai.v1.DisableProcessorMetadata.Builder The long-running operation metadata for the DisableProcessor method.
com.google.cloud.documentai.v1.DisableProcessorRequest Request message for the DisableProcessor method.
com.google.cloud.documentai.v1.DisableProcessorRequest.Builder Request message for the DisableProcessor method.
com.google.cloud.documentai.v1.DisableProcessorResponse Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.
com.google.cloud.documentai.v1.DisableProcessorResponse.Builder Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.
com.google.cloud.documentai.v1.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.v1.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.v1.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.v1.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.v1.Document.Entity.NormalizedValue Parsed and normalized entity value.
com.google.cloud.documentai.v1.Document.Entity.NormalizedValue.Builder Parsed and normalized entity value.
com.google.cloud.documentai.v1.Document.EntityRelation Relationship between Entities.
com.google.cloud.documentai.v1.Document.EntityRelation.Builder Relationship between Entities.
com.google.cloud.documentai.v1.Document.Page A page in a Document.
com.google.cloud.documentai.v1.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.v1.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.v1.Document.Page.Builder A page in a Document.
com.google.cloud.documentai.v1.Document.Page.DetectedBarcode A detected barcode.
com.google.cloud.documentai.v1.Document.Page.DetectedBarcode.Builder A detected barcode.
com.google.cloud.documentai.v1.Document.Page.DetectedLanguage Detected language for a structural component.
com.google.cloud.documentai.v1.Document.Page.DetectedLanguage.Builder Detected language for a structural component.
com.google.cloud.documentai.v1.Document.Page.Dimension Dimension for the page.
com.google.cloud.documentai.v1.Document.Page.Dimension.Builder Dimension for the page.
com.google.cloud.documentai.v1.Document.Page.FormField A form field detected on the page.
com.google.cloud.documentai.v1.Document.Page.FormField.Builder A form field detected on the page.
com.google.cloud.documentai.v1.Document.Page.Image Rendered image contents for this page.
com.google.cloud.documentai.v1.Document.Page.Image.Builder Rendered image contents for this page.
com.google.cloud.documentai.v1.Document.Page.ImageQualityScores Image quality scores for the page image.
com.google.cloud.documentai.v1.Document.Page.ImageQualityScores.Builder Image quality scores for the page image.
com.google.cloud.documentai.v1.Document.Page.ImageQualityScores.DetectedDefect Image Quality Defects
com.google.cloud.documentai.v1.Document.Page.ImageQualityScores.DetectedDefect.Builder Image Quality Defects
com.google.cloud.documentai.v1.Document.Page.Layout Visual element describing a layout unit on a page.
com.google.cloud.documentai.v1.Document.Page.Layout.Builder Visual element describing a layout unit on a page.
com.google.cloud.documentai.v1.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.v1.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.v1.Document.Page.Matrix Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
com.google.cloud.documentai.v1.Document.Page.Matrix.Builder Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
com.google.cloud.documentai.v1.Document.Page.Paragraph A collection of lines that a human would perceive as a paragraph.
com.google.cloud.documentai.v1.Document.Page.Paragraph.Builder A collection of lines that a human would perceive as a paragraph.
com.google.cloud.documentai.v1.Document.Page.Symbol A detected symbol.
com.google.cloud.documentai.v1.Document.Page.Symbol.Builder A detected symbol.
com.google.cloud.documentai.v1.Document.Page.Table A table representation similar to HTML table structure.
com.google.cloud.documentai.v1.Document.Page.Table.Builder A table representation similar to HTML table structure.
com.google.cloud.documentai.v1.Document.Page.Table.TableCell A cell representation inside the table.
com.google.cloud.documentai.v1.Document.Page.Table.TableCell.Builder A cell representation inside the table.
com.google.cloud.documentai.v1.Document.Page.Table.TableRow A row of table cells.
com.google.cloud.documentai.v1.Document.Page.Table.TableRow.Builder A row of table cells.
com.google.cloud.documentai.v1.Document.Page.Token A detected token.
com.google.cloud.documentai.v1.Document.Page.Token.Builder A detected token.
com.google.cloud.documentai.v1.Document.Page.Token.DetectedBreak Detected break at the end of a Token.
com.google.cloud.documentai.v1.Document.Page.Token.DetectedBreak.Builder Detected break at the end of a Token.
com.google.cloud.documentai.v1.Document.Page.Token.StyleInfo Font and other text style attributes.
com.google.cloud.documentai.v1.Document.Page.Token.StyleInfo.Builder Font and other text style attributes.
com.google.cloud.documentai.v1.Document.Page.VisualElement Detected non-text visual elements e.g. checkbox, signature etc. on the page.
com.google.cloud.documentai.v1.Document.Page.VisualElement.Builder Detected non-text visual elements e.g. checkbox, signature etc. on the page.
com.google.cloud.documentai.v1.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.
com.google.cloud.documentai.v1.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.
com.google.cloud.documentai.v1.Document.PageAnchor.PageRef Represents a weak reference to a page element within a document.
com.google.cloud.documentai.v1.Document.PageAnchor.PageRef.Builder Represents a weak reference to a page element within a document.
com.google.cloud.documentai.v1.Document.Provenance Structure to identify provenance relationships between annotations in different revisions.
com.google.cloud.documentai.v1.Document.Provenance.Builder Structure to identify provenance relationships between annotations in different revisions.
com.google.cloud.documentai.v1.Document.Provenance.Parent The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
com.google.cloud.documentai.v1.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.v1.Document.Revision Contains past or forward revisions of this document.
com.google.cloud.documentai.v1.Document.Revision.Builder Contains past or forward revisions of this document.
com.google.cloud.documentai.v1.Document.Revision.HumanReview Human Review information of the document.
com.google.cloud.documentai.v1.Document.Revision.HumanReview.Builder Human Review information of the document.
com.google.cloud.documentai.v1.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.v1.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.v1.Document.Style Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
com.google.cloud.documentai.v1.Document.Style.Builder Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
com.google.cloud.documentai.v1.Document.Style.FontSize Font size with unit.
com.google.cloud.documentai.v1.Document.Style.FontSize.Builder Font size with unit.
com.google.cloud.documentai.v1.Document.TextAnchor Text reference indexing into the Document.text.
com.google.cloud.documentai.v1.Document.TextAnchor.Builder Text reference indexing into the Document.text.
com.google.cloud.documentai.v1.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
com.google.cloud.documentai.v1.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
com.google.cloud.documentai.v1.Document.TextChange This message is used for text changes aka. OCR corrections.
com.google.cloud.documentai.v1.Document.TextChange.Builder This message is used for text changes aka. OCR corrections.
com.google.cloud.documentai.v1.DocumentAiDocumentSchema
com.google.cloud.documentai.v1.DocumentAiEvaluation
com.google.cloud.documentai.v1.DocumentAiProcessor
com.google.cloud.documentai.v1.DocumentAiProcessorService
com.google.cloud.documentai.v1.DocumentAiProcessorType
com.google.cloud.documentai.v1.DocumentIoProto
com.google.cloud.documentai.v1.DocumentOutputConfig Config that controls the output of documents. All documents will be written as a JSON file.
com.google.cloud.documentai.v1.DocumentOutputConfig.Builder Config that controls the output of documents. All documents will be written as a JSON file.
com.google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig The configuration used when outputting documents.
com.google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.Builder The configuration used when outputting documents.
com.google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfig The sharding config for the output document.
com.google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfig.Builder The sharding config for the output document.
com.google.cloud.documentai.v1.DocumentProcessorServiceClient.ListEvaluationsFixedSizeCollection
com.google.cloud.documentai.v1.DocumentProcessorServiceClient.ListEvaluationsPage
com.google.cloud.documentai.v1.DocumentProcessorServiceClient.ListEvaluationsPagedResponse
com.google.cloud.documentai.v1.DocumentProcessorServiceClient.ListLocationsFixedSizeCollection
com.google.cloud.documentai.v1.DocumentProcessorServiceClient.ListLocationsPage
com.google.cloud.documentai.v1.DocumentProcessorServiceClient.ListLocationsPagedResponse
com.google.cloud.documentai.v1.DocumentProcessorServiceClient.ListProcessorTypesFixedSizeCollection
com.google.cloud.documentai.v1.DocumentProcessorServiceClient.ListProcessorTypesPage
com.google.cloud.documentai.v1.DocumentProcessorServiceClient.ListProcessorTypesPagedResponse
com.google.cloud.documentai.v1.DocumentProcessorServiceClient.ListProcessorVersionsFixedSizeCollection
com.google.cloud.documentai.v1.DocumentProcessorServiceClient.ListProcessorVersionsPage
com.google.cloud.documentai.v1.DocumentProcessorServiceClient.ListProcessorVersionsPagedResponse
com.google.cloud.documentai.v1.DocumentProcessorServiceClient.ListProcessorsFixedSizeCollection
com.google.cloud.documentai.v1.DocumentProcessorServiceClient.ListProcessorsPage
com.google.cloud.documentai.v1.DocumentProcessorServiceClient.ListProcessorsPagedResponse
com.google.cloud.documentai.v1.DocumentProcessorServiceGrpc Service to call Document AI 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
com.google.cloud.documentai.v1.DocumentProcessorServiceGrpc.DocumentProcessorServiceImplBase Base class for the server implementation of the service DocumentProcessorService. Service to call Document AI to process documents according to the
com.google.cloud.documentai.v1.DocumentProcessorServiceSettings.Builder Builder for DocumentProcessorServiceSettings.
com.google.cloud.documentai.v1.DocumentProto
com.google.cloud.documentai.v1.DocumentSchema The schema defines the output of the processed document by a processor.
com.google.cloud.documentai.v1.DocumentSchema.Builder The schema defines the output of the processed document by a processor.
com.google.cloud.documentai.v1.DocumentSchema.EntityType EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
com.google.cloud.documentai.v1.DocumentSchema.EntityType.Builder EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
com.google.cloud.documentai.v1.DocumentSchema.EntityType.EnumValues Defines the a list of enum values.
com.google.cloud.documentai.v1.DocumentSchema.EntityType.EnumValues.Builder Defines the a list of enum values.
com.google.cloud.documentai.v1.DocumentSchema.EntityType.Property Defines properties that can be part of the entity type.
com.google.cloud.documentai.v1.DocumentSchema.EntityType.Property.Builder Defines properties that can be part of the entity type.
com.google.cloud.documentai.v1.DocumentSchema.Metadata Metadata for global schema behavior.
com.google.cloud.documentai.v1.DocumentSchema.Metadata.Builder Metadata for global schema behavior.
com.google.cloud.documentai.v1.EnableProcessorMetadata The long-running operation metadata for the EnableProcessor method.
com.google.cloud.documentai.v1.EnableProcessorMetadata.Builder The long-running operation metadata for the EnableProcessor method.
com.google.cloud.documentai.v1.EnableProcessorRequest Request message for the EnableProcessor method.
com.google.cloud.documentai.v1.EnableProcessorRequest.Builder Request message for the EnableProcessor method.
com.google.cloud.documentai.v1.EnableProcessorResponse Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.
com.google.cloud.documentai.v1.EnableProcessorResponse.Builder Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.
com.google.cloud.documentai.v1.EvaluateProcessorVersionMetadata Metadata of the EvaluateProcessorVersion method.
com.google.cloud.documentai.v1.EvaluateProcessorVersionMetadata.Builder Metadata of the EvaluateProcessorVersion method.
com.google.cloud.documentai.v1.EvaluateProcessorVersionRequest Evaluates the given ProcessorVersion against the supplied documents.
com.google.cloud.documentai.v1.EvaluateProcessorVersionRequest.Builder Evaluates the given ProcessorVersion against the supplied documents.
com.google.cloud.documentai.v1.EvaluateProcessorVersionResponse Response of the EvaluateProcessorVersion method.
com.google.cloud.documentai.v1.EvaluateProcessorVersionResponse.Builder Response of the EvaluateProcessorVersion method.
com.google.cloud.documentai.v1.Evaluation An evaluation of a ProcessorVersion's performance.
com.google.cloud.documentai.v1.Evaluation.Builder An evaluation of a ProcessorVersion's performance.
com.google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetrics Evaluations metrics, at a specific confidence level.
com.google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetrics.Builder Evaluations metrics, at a specific confidence level.
com.google.cloud.documentai.v1.Evaluation.Counters Evaluation counters for the documents that were used.
com.google.cloud.documentai.v1.Evaluation.Counters.Builder Evaluation counters for the documents that were used.
com.google.cloud.documentai.v1.Evaluation.Metrics Evaluation metrics, either in aggregate or about a specific entity.
com.google.cloud.documentai.v1.Evaluation.Metrics.Builder Evaluation metrics, either in aggregate or about a specific entity.
com.google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics Metrics across multiple confidence levels.
com.google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics.Builder Metrics across multiple confidence levels.
com.google.cloud.documentai.v1.EvaluationName
com.google.cloud.documentai.v1.EvaluationName.Builder Builder for projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}.
com.google.cloud.documentai.v1.EvaluationReference Gives a short summary of an evaluation, and links to the evaluation itself.
com.google.cloud.documentai.v1.EvaluationReference.Builder Gives a short summary of an evaluation, and links to the evaluation itself.
com.google.cloud.documentai.v1.FetchProcessorTypesRequest Request message for the FetchProcessorTypes method. Some processor types may require the project be added to an allowlist.
com.google.cloud.documentai.v1.FetchProcessorTypesRequest.Builder Request message for the FetchProcessorTypes method. Some processor types may require the project be added to an allowlist.
com.google.cloud.documentai.v1.FetchProcessorTypesResponse Response message for the FetchProcessorTypes method.
com.google.cloud.documentai.v1.FetchProcessorTypesResponse.Builder Response message for the FetchProcessorTypes method.
com.google.cloud.documentai.v1.GcsDocument Specifies a document stored on Cloud Storage.
com.google.cloud.documentai.v1.GcsDocument.Builder Specifies a document stored on Cloud Storage.
com.google.cloud.documentai.v1.GcsDocuments Specifies a set of documents on Cloud Storage.
com.google.cloud.documentai.v1.GcsDocuments.Builder Specifies a set of documents on Cloud Storage.
com.google.cloud.documentai.v1.GcsPrefix Specifies all documents on Cloud Storage with a common prefix.
com.google.cloud.documentai.v1.GcsPrefix.Builder Specifies all documents on Cloud Storage with a common prefix.
com.google.cloud.documentai.v1.GeometryProto
com.google.cloud.documentai.v1.GetEvaluationRequest Retrieves a specific Evaluation.
com.google.cloud.documentai.v1.GetEvaluationRequest.Builder Retrieves a specific Evaluation.
com.google.cloud.documentai.v1.GetProcessorRequest Request message for the GetProcessor method.
com.google.cloud.documentai.v1.GetProcessorRequest.Builder Request message for the GetProcessor method.
com.google.cloud.documentai.v1.GetProcessorTypeRequest Request message for the GetProcessorType method.
com.google.cloud.documentai.v1.GetProcessorTypeRequest.Builder Request message for the GetProcessorType method.
com.google.cloud.documentai.v1.GetProcessorVersionRequest Request message for the GetProcessorVersion method.
com.google.cloud.documentai.v1.GetProcessorVersionRequest.Builder Request message for the GetProcessorVersion method.
com.google.cloud.documentai.v1.HumanReviewConfigName
com.google.cloud.documentai.v1.HumanReviewConfigName.Builder Builder for projects/{project}/locations/{location}/processors/{processor}/humanReviewConfig.
com.google.cloud.documentai.v1.HumanReviewStatus The status of human review on a processed document.
com.google.cloud.documentai.v1.HumanReviewStatus.Builder The status of human review on a processed document.
com.google.cloud.documentai.v1.ListEvaluationsRequest Retrieves a list of evaluations for a given ProcessorVersion.
com.google.cloud.documentai.v1.ListEvaluationsRequest.Builder Retrieves a list of evaluations for a given ProcessorVersion.
com.google.cloud.documentai.v1.ListEvaluationsResponse The response from ListEvaluations.
com.google.cloud.documentai.v1.ListEvaluationsResponse.Builder The response from ListEvaluations.
com.google.cloud.documentai.v1.ListProcessorTypesRequest Request message for the ListProcessorTypes method. Some processor types may require the project be added to an allowlist.
com.google.cloud.documentai.v1.ListProcessorTypesRequest.Builder Request message for the ListProcessorTypes method. Some processor types may require the project be added to an allowlist.
com.google.cloud.documentai.v1.ListProcessorTypesResponse Response message for the ListProcessorTypes method.
com.google.cloud.documentai.v1.ListProcessorTypesResponse.Builder Response message for the ListProcessorTypes method.
com.google.cloud.documentai.v1.ListProcessorVersionsRequest Request message for list all processor versions belongs to a processor.
com.google.cloud.documentai.v1.ListProcessorVersionsRequest.Builder Request message for list all processor versions belongs to a processor.
com.google.cloud.documentai.v1.ListProcessorVersionsResponse Response message for the ListProcessorVersions method.
com.google.cloud.documentai.v1.ListProcessorVersionsResponse.Builder Response message for the ListProcessorVersions method.
com.google.cloud.documentai.v1.ListProcessorsRequest Request message for list all processors belongs to a project.
com.google.cloud.documentai.v1.ListProcessorsRequest.Builder Request message for list all processors belongs to a project.
com.google.cloud.documentai.v1.ListProcessorsResponse Response message for the ListProcessors method.
com.google.cloud.documentai.v1.ListProcessorsResponse.Builder Response message for the ListProcessors method.
com.google.cloud.documentai.v1.LocationName
com.google.cloud.documentai.v1.LocationName.Builder Builder for projects/{project}/locations/{location}.
com.google.cloud.documentai.v1.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.v1.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.v1.OcrConfig Config for Document OCR.
com.google.cloud.documentai.v1.OcrConfig.Builder Config for Document OCR.
com.google.cloud.documentai.v1.OcrConfig.Hints Hints for OCR Engine
com.google.cloud.documentai.v1.OcrConfig.Hints.Builder Hints for OCR Engine
com.google.cloud.documentai.v1.OcrConfig.PremiumFeatures Configurations for premium OCR features.
com.google.cloud.documentai.v1.OcrConfig.PremiumFeatures.Builder Configurations for premium OCR features.
com.google.cloud.documentai.v1.OperationMetadataProto
com.google.cloud.documentai.v1.ProcessOptions Options for Process API
com.google.cloud.documentai.v1.ProcessOptions.Builder Options for Process API
com.google.cloud.documentai.v1.ProcessOptions.IndividualPageSelector A list of individual page numbers.
com.google.cloud.documentai.v1.ProcessOptions.IndividualPageSelector.Builder A list of individual page numbers.
com.google.cloud.documentai.v1.ProcessRequest Request message for the ProcessDocument method.
com.google.cloud.documentai.v1.ProcessRequest.Builder Request message for the ProcessDocument method.
com.google.cloud.documentai.v1.ProcessResponse Response message for the ProcessDocument method.
com.google.cloud.documentai.v1.ProcessResponse.Builder Response message for the ProcessDocument method.
com.google.cloud.documentai.v1.Processor The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
com.google.cloud.documentai.v1.Processor.Builder The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
com.google.cloud.documentai.v1.ProcessorName
com.google.cloud.documentai.v1.ProcessorName.Builder Builder for projects/{project}/locations/{location}/processors/{processor}.
com.google.cloud.documentai.v1.ProcessorType A processor type is responsible for performing a certain document understanding task on a certain type of document.
com.google.cloud.documentai.v1.ProcessorType.Builder A processor type is responsible for performing a certain document understanding task on a certain type of document.
com.google.cloud.documentai.v1.ProcessorType.LocationInfo The location information about where the processor is available.
com.google.cloud.documentai.v1.ProcessorType.LocationInfo.Builder The location information about where the processor is available.
com.google.cloud.documentai.v1.ProcessorTypeName
com.google.cloud.documentai.v1.ProcessorTypeName.Builder Builder for projects/{project}/locations/{location}/processorTypes/{processor_type}.
com.google.cloud.documentai.v1.ProcessorVersion 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.
com.google.cloud.documentai.v1.ProcessorVersion.Builder 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.
com.google.cloud.documentai.v1.ProcessorVersion.DeprecationInfo Information about the upcoming deprecation of this processor version.
com.google.cloud.documentai.v1.ProcessorVersion.DeprecationInfo.Builder Information about the upcoming deprecation of this processor version.
com.google.cloud.documentai.v1.ProcessorVersionAlias Contains the alias and the aliased resource name of processor version.
com.google.cloud.documentai.v1.ProcessorVersionAlias.Builder Contains the alias and the aliased resource name of processor version.
com.google.cloud.documentai.v1.ProcessorVersionName
com.google.cloud.documentai.v1.ProcessorVersionName.Builder Builder for projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}.
com.google.cloud.documentai.v1.RawDocument Payload message of raw document content (bytes).
com.google.cloud.documentai.v1.RawDocument.Builder Payload message of raw document content (bytes).
com.google.cloud.documentai.v1.ReviewDocumentOperationMetadata The long-running operation metadata for the ReviewDocument method.
com.google.cloud.documentai.v1.ReviewDocumentOperationMetadata.Builder The long-running operation metadata for the ReviewDocument method.
com.google.cloud.documentai.v1.ReviewDocumentRequest Request message for the ReviewDocument method.
com.google.cloud.documentai.v1.ReviewDocumentRequest.Builder Request message for the ReviewDocument method.
com.google.cloud.documentai.v1.ReviewDocumentResponse Response message for the ReviewDocument method.
com.google.cloud.documentai.v1.ReviewDocumentResponse.Builder Response message for the ReviewDocument method.
com.google.cloud.documentai.v1.SetDefaultProcessorVersionMetadata The long-running operation metadata for the SetDefaultProcessorVersion method.
com.google.cloud.documentai.v1.SetDefaultProcessorVersionMetadata.Builder The long-running operation metadata for the SetDefaultProcessorVersion method.
com.google.cloud.documentai.v1.SetDefaultProcessorVersionRequest Request message for the SetDefaultProcessorVersion method.
com.google.cloud.documentai.v1.SetDefaultProcessorVersionRequest.Builder Request message for the SetDefaultProcessorVersion method.
com.google.cloud.documentai.v1.SetDefaultProcessorVersionResponse Response message for the SetDefaultProcessorVersion method.
com.google.cloud.documentai.v1.SetDefaultProcessorVersionResponse.Builder Response message for the SetDefaultProcessorVersion method.
com.google.cloud.documentai.v1.TrainProcessorVersionMetadata The metadata that represents a processor version being created.
com.google.cloud.documentai.v1.TrainProcessorVersionMetadata.Builder The metadata that represents a processor version being created.
com.google.cloud.documentai.v1.TrainProcessorVersionMetadata.DatasetValidation The dataset validation information. This includes any and all errors with documents and the dataset.
com.google.cloud.documentai.v1.TrainProcessorVersionMetadata.DatasetValidation.Builder The dataset validation information. This includes any and all errors with documents and the dataset.
com.google.cloud.documentai.v1.TrainProcessorVersionRequest Request message for the TrainProcessorVersion method.
com.google.cloud.documentai.v1.TrainProcessorVersionRequest.Builder Request message for the TrainProcessorVersion method.
com.google.cloud.documentai.v1.TrainProcessorVersionRequest.CustomDocumentExtractionOptions Options to control the training of the Custom Document Extraction (CDE) Processor.
com.google.cloud.documentai.v1.TrainProcessorVersionRequest.CustomDocumentExtractionOptions.Builder Options to control the training of the Custom Document Extraction (CDE) Processor.
com.google.cloud.documentai.v1.TrainProcessorVersionRequest.FoundationModelTuningOptions Options to control foundation model tuning of the processor.
com.google.cloud.documentai.v1.TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder Options to control foundation model tuning of the processor.
com.google.cloud.documentai.v1.TrainProcessorVersionRequest.InputData The input data used to train a new ProcessorVersion.
com.google.cloud.documentai.v1.TrainProcessorVersionRequest.InputData.Builder The input data used to train a new ProcessorVersion.
com.google.cloud.documentai.v1.TrainProcessorVersionResponse The response for TrainProcessorVersion.
com.google.cloud.documentai.v1.TrainProcessorVersionResponse.Builder The response for TrainProcessorVersion.
com.google.cloud.documentai.v1.UndeployProcessorVersionMetadata The long-running operation metadata for the UndeployProcessorVersion method.
com.google.cloud.documentai.v1.UndeployProcessorVersionMetadata.Builder The long-running operation metadata for the UndeployProcessorVersion method.
com.google.cloud.documentai.v1.UndeployProcessorVersionRequest Request message for the UndeployProcessorVersion method.
com.google.cloud.documentai.v1.UndeployProcessorVersionRequest.Builder Request message for the UndeployProcessorVersion method.
com.google.cloud.documentai.v1.UndeployProcessorVersionResponse Response message for the UndeployProcessorVersion method.
com.google.cloud.documentai.v1.UndeployProcessorVersionResponse.Builder Response message for the UndeployProcessorVersion method.
com.google.cloud.documentai.v1.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.v1.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.v1.BarcodeOrBuilder
com.google.cloud.documentai.v1.BatchDocumentsInputConfigOrBuilder
com.google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatusOrBuilder
com.google.cloud.documentai.v1.BatchProcessMetadataOrBuilder
com.google.cloud.documentai.v1.BatchProcessRequestOrBuilder
com.google.cloud.documentai.v1.BatchProcessResponseOrBuilder
com.google.cloud.documentai.v1.BoundingPolyOrBuilder
com.google.cloud.documentai.v1.CommonOperationMetadataOrBuilder
com.google.cloud.documentai.v1.CreateProcessorRequestOrBuilder
com.google.cloud.documentai.v1.DeleteProcessorMetadataOrBuilder
com.google.cloud.documentai.v1.DeleteProcessorRequestOrBuilder
com.google.cloud.documentai.v1.DeleteProcessorVersionMetadataOrBuilder
com.google.cloud.documentai.v1.DeleteProcessorVersionRequestOrBuilder
com.google.cloud.documentai.v1.DeployProcessorVersionMetadataOrBuilder
com.google.cloud.documentai.v1.DeployProcessorVersionRequestOrBuilder
com.google.cloud.documentai.v1.DeployProcessorVersionResponseOrBuilder
com.google.cloud.documentai.v1.DisableProcessorMetadataOrBuilder
com.google.cloud.documentai.v1.DisableProcessorRequestOrBuilder
com.google.cloud.documentai.v1.DisableProcessorResponseOrBuilder
com.google.cloud.documentai.v1.Document.Entity.NormalizedValueOrBuilder
com.google.cloud.documentai.v1.Document.EntityOrBuilder
com.google.cloud.documentai.v1.Document.EntityRelationOrBuilder
com.google.cloud.documentai.v1.Document.Page.BlockOrBuilder
com.google.cloud.documentai.v1.Document.Page.DetectedBarcodeOrBuilder
com.google.cloud.documentai.v1.Document.Page.DetectedLanguageOrBuilder
com.google.cloud.documentai.v1.Document.Page.DimensionOrBuilder
com.google.cloud.documentai.v1.Document.Page.FormFieldOrBuilder
com.google.cloud.documentai.v1.Document.Page.ImageOrBuilder
com.google.cloud.documentai.v1.Document.Page.ImageQualityScores.DetectedDefectOrBuilder
com.google.cloud.documentai.v1.Document.Page.ImageQualityScoresOrBuilder
com.google.cloud.documentai.v1.Document.Page.LayoutOrBuilder
com.google.cloud.documentai.v1.Document.Page.LineOrBuilder
com.google.cloud.documentai.v1.Document.Page.MatrixOrBuilder
com.google.cloud.documentai.v1.Document.Page.ParagraphOrBuilder
com.google.cloud.documentai.v1.Document.Page.SymbolOrBuilder
com.google.cloud.documentai.v1.Document.Page.Table.TableCellOrBuilder
com.google.cloud.documentai.v1.Document.Page.Table.TableRowOrBuilder
com.google.cloud.documentai.v1.Document.Page.TableOrBuilder
com.google.cloud.documentai.v1.Document.Page.Token.DetectedBreakOrBuilder
com.google.cloud.documentai.v1.Document.Page.Token.StyleInfoOrBuilder
com.google.cloud.documentai.v1.Document.Page.TokenOrBuilder
com.google.cloud.documentai.v1.Document.Page.VisualElementOrBuilder
com.google.cloud.documentai.v1.Document.PageAnchor.PageRefOrBuilder
com.google.cloud.documentai.v1.Document.PageAnchorOrBuilder
com.google.cloud.documentai.v1.Document.PageOrBuilder
com.google.cloud.documentai.v1.Document.Provenance.ParentOrBuilder
com.google.cloud.documentai.v1.Document.ProvenanceOrBuilder
com.google.cloud.documentai.v1.Document.Revision.HumanReviewOrBuilder
com.google.cloud.documentai.v1.Document.RevisionOrBuilder
com.google.cloud.documentai.v1.Document.ShardInfoOrBuilder
com.google.cloud.documentai.v1.Document.Style.FontSizeOrBuilder
com.google.cloud.documentai.v1.Document.StyleOrBuilder
com.google.cloud.documentai.v1.Document.TextAnchor.TextSegmentOrBuilder
com.google.cloud.documentai.v1.Document.TextAnchorOrBuilder
com.google.cloud.documentai.v1.Document.TextChangeOrBuilder
com.google.cloud.documentai.v1.DocumentOrBuilder
com.google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfigOrBuilder
com.google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfigOrBuilder
com.google.cloud.documentai.v1.DocumentOutputConfigOrBuilder
com.google.cloud.documentai.v1.DocumentProcessorServiceGrpc.AsyncService Service to call Document AI 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
com.google.cloud.documentai.v1.DocumentSchema.EntityType.EnumValuesOrBuilder
com.google.cloud.documentai.v1.DocumentSchema.EntityType.PropertyOrBuilder
com.google.cloud.documentai.v1.DocumentSchema.EntityTypeOrBuilder
com.google.cloud.documentai.v1.DocumentSchema.MetadataOrBuilder
com.google.cloud.documentai.v1.DocumentSchemaOrBuilder
com.google.cloud.documentai.v1.EnableProcessorMetadataOrBuilder
com.google.cloud.documentai.v1.EnableProcessorRequestOrBuilder
com.google.cloud.documentai.v1.EnableProcessorResponseOrBuilder
com.google.cloud.documentai.v1.EvaluateProcessorVersionMetadataOrBuilder
com.google.cloud.documentai.v1.EvaluateProcessorVersionRequestOrBuilder
com.google.cloud.documentai.v1.EvaluateProcessorVersionResponseOrBuilder
com.google.cloud.documentai.v1.Evaluation.ConfidenceLevelMetricsOrBuilder
com.google.cloud.documentai.v1.Evaluation.CountersOrBuilder
com.google.cloud.documentai.v1.Evaluation.MetricsOrBuilder
com.google.cloud.documentai.v1.Evaluation.MultiConfidenceMetricsOrBuilder
com.google.cloud.documentai.v1.EvaluationOrBuilder
com.google.cloud.documentai.v1.EvaluationReferenceOrBuilder
com.google.cloud.documentai.v1.FetchProcessorTypesRequestOrBuilder
com.google.cloud.documentai.v1.FetchProcessorTypesResponseOrBuilder
com.google.cloud.documentai.v1.GcsDocumentOrBuilder
com.google.cloud.documentai.v1.GcsDocumentsOrBuilder
com.google.cloud.documentai.v1.GcsPrefixOrBuilder
com.google.cloud.documentai.v1.GetEvaluationRequestOrBuilder
com.google.cloud.documentai.v1.GetProcessorRequestOrBuilder
com.google.cloud.documentai.v1.GetProcessorTypeRequestOrBuilder
com.google.cloud.documentai.v1.GetProcessorVersionRequestOrBuilder
com.google.cloud.documentai.v1.HumanReviewStatusOrBuilder
com.google.cloud.documentai.v1.ListEvaluationsRequestOrBuilder
com.google.cloud.documentai.v1.ListEvaluationsResponseOrBuilder
com.google.cloud.documentai.v1.ListProcessorTypesRequestOrBuilder
com.google.cloud.documentai.v1.ListProcessorTypesResponseOrBuilder
com.google.cloud.documentai.v1.ListProcessorVersionsRequestOrBuilder
com.google.cloud.documentai.v1.ListProcessorVersionsResponseOrBuilder
com.google.cloud.documentai.v1.ListProcessorsRequestOrBuilder
com.google.cloud.documentai.v1.ListProcessorsResponseOrBuilder
com.google.cloud.documentai.v1.NormalizedVertexOrBuilder
com.google.cloud.documentai.v1.OcrConfig.HintsOrBuilder
com.google.cloud.documentai.v1.OcrConfig.PremiumFeaturesOrBuilder
com.google.cloud.documentai.v1.OcrConfigOrBuilder
com.google.cloud.documentai.v1.ProcessOptions.IndividualPageSelectorOrBuilder
com.google.cloud.documentai.v1.ProcessOptionsOrBuilder
com.google.cloud.documentai.v1.ProcessRequestOrBuilder
com.google.cloud.documentai.v1.ProcessResponseOrBuilder
com.google.cloud.documentai.v1.ProcessorOrBuilder
com.google.cloud.documentai.v1.ProcessorType.LocationInfoOrBuilder
com.google.cloud.documentai.v1.ProcessorTypeOrBuilder
com.google.cloud.documentai.v1.ProcessorVersion.DeprecationInfoOrBuilder
com.google.cloud.documentai.v1.ProcessorVersionAliasOrBuilder
com.google.cloud.documentai.v1.ProcessorVersionOrBuilder
com.google.cloud.documentai.v1.RawDocumentOrBuilder
com.google.cloud.documentai.v1.ReviewDocumentOperationMetadataOrBuilder
com.google.cloud.documentai.v1.ReviewDocumentRequestOrBuilder
com.google.cloud.documentai.v1.ReviewDocumentResponseOrBuilder
com.google.cloud.documentai.v1.SetDefaultProcessorVersionMetadataOrBuilder
com.google.cloud.documentai.v1.SetDefaultProcessorVersionRequestOrBuilder
com.google.cloud.documentai.v1.SetDefaultProcessorVersionResponseOrBuilder
com.google.cloud.documentai.v1.TrainProcessorVersionMetadata.DatasetValidationOrBuilder
com.google.cloud.documentai.v1.TrainProcessorVersionMetadataOrBuilder
com.google.cloud.documentai.v1.TrainProcessorVersionRequest.CustomDocumentExtractionOptionsOrBuilder
com.google.cloud.documentai.v1.TrainProcessorVersionRequest.FoundationModelTuningOptionsOrBuilder
com.google.cloud.documentai.v1.TrainProcessorVersionRequest.InputDataOrBuilder
com.google.cloud.documentai.v1.TrainProcessorVersionRequestOrBuilder
com.google.cloud.documentai.v1.TrainProcessorVersionResponseOrBuilder
com.google.cloud.documentai.v1.UndeployProcessorVersionMetadataOrBuilder
com.google.cloud.documentai.v1.UndeployProcessorVersionRequestOrBuilder
com.google.cloud.documentai.v1.UndeployProcessorVersionResponseOrBuilder
com.google.cloud.documentai.v1.VertexOrBuilder

Enums

Enum Description
com.google.cloud.documentai.v1.BatchDocumentsInputConfig.SourceCase
com.google.cloud.documentai.v1.BatchProcessMetadata.State Possible states of the batch processing operation.
com.google.cloud.documentai.v1.CommonOperationMetadata.State State of the longrunning operation.
com.google.cloud.documentai.v1.Document.Entity.NormalizedValue.StructuredValueCase
com.google.cloud.documentai.v1.Document.Page.Layout.Orientation Detected human reading orientation.
com.google.cloud.documentai.v1.Document.Page.Token.DetectedBreak.Type Enum to denote the type of break found.
com.google.cloud.documentai.v1.Document.PageAnchor.PageRef.LayoutType The type of layout that is being referenced.
com.google.cloud.documentai.v1.Document.Provenance.OperationType If a processor or agent does an explicit operation on existing elements.
com.google.cloud.documentai.v1.Document.Revision.SourceCase
com.google.cloud.documentai.v1.Document.SourceCase
com.google.cloud.documentai.v1.DocumentOutputConfig.DestinationCase
com.google.cloud.documentai.v1.DocumentSchema.EntityType.Property.OccurrenceType Types of occurrences of the entity type in the document. This represents the number of instances, not mentions, of an entity. For example, a bank statement might only have one
com.google.cloud.documentai.v1.DocumentSchema.EntityType.ValueSourceCase
com.google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics.MetricsType A type that determines how metrics should be interpreted.
com.google.cloud.documentai.v1.HumanReviewStatus.State The final state of human review on a processed document.
com.google.cloud.documentai.v1.ProcessOptions.PageRangeCase
com.google.cloud.documentai.v1.ProcessRequest.SourceCase
com.google.cloud.documentai.v1.Processor.State The possible states of the processor.
com.google.cloud.documentai.v1.ProcessorVersion.ModelType The possible model types of the processor version.
com.google.cloud.documentai.v1.ProcessorVersion.State The possible states of the processor version.
com.google.cloud.documentai.v1.ReviewDocumentRequest.Priority The priority level of the human review task.
com.google.cloud.documentai.v1.ReviewDocumentRequest.SourceCase
com.google.cloud.documentai.v1.ReviewDocumentResponse.State Possible states of the review operation.
com.google.cloud.documentai.v1.TrainProcessorVersionRequest.CustomDocumentExtractionOptions.TrainingMethod Training Method for CDE. TRAINING_METHOD_UNSPECIFIED will fall back to MODEL_BASED.
com.google.cloud.documentai.v1.TrainProcessorVersionRequest.ProcessorFlagsCase