- 2.52.0 (latest)
- 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
A client to Cloud Document AI API
The interfaces provided are listed below, along with usage samples.
DocumentProcessorServiceClient
Service Description: Service to call Cloud DocumentAI to process documents according to the processor's definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents.
Sample for DocumentProcessorServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ResourceName name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
ProcessResponse response = documentProcessorServiceClient.processDocument(name);
}
Classes
Barcode
Encodes the detailed information of a barcode.
Protobuf type google.cloud.documentai.v1.Barcode
Barcode.Builder
Encodes the detailed information of a barcode.
Protobuf type google.cloud.documentai.v1.Barcode
BarcodeProto
BatchDocumentsInputConfig
The common config to specify a set of documents used as input.
Protobuf type google.cloud.documentai.v1.BatchDocumentsInputConfig
BatchDocumentsInputConfig.Builder
The common config to specify a set of documents used as input.
Protobuf type google.cloud.documentai.v1.BatchDocumentsInputConfig
BatchProcessMetadata
The long running operation metadata for batch process method.
Protobuf type google.cloud.documentai.v1.BatchProcessMetadata
BatchProcessMetadata.Builder
The long running operation metadata for batch process method.
Protobuf type google.cloud.documentai.v1.BatchProcessMetadata
BatchProcessMetadata.IndividualProcessStatus
The status of a each individual document in the batch process.
Protobuf type google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus
BatchProcessMetadata.IndividualProcessStatus.Builder
The status of a each individual document in the batch process.
Protobuf type google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus
BatchProcessRequest
Request message for batch process document method.
Protobuf type google.cloud.documentai.v1.BatchProcessRequest
BatchProcessRequest.Builder
Request message for batch process document method.
Protobuf type google.cloud.documentai.v1.BatchProcessRequest
BatchProcessResponse
Response message for batch process document method.
Protobuf type google.cloud.documentai.v1.BatchProcessResponse
BatchProcessResponse.Builder
Response message for batch process document method.
Protobuf type google.cloud.documentai.v1.BatchProcessResponse
BoundingPoly
A bounding polygon for the detected image annotation.
Protobuf type google.cloud.documentai.v1.BoundingPoly
BoundingPoly.Builder
A bounding polygon for the detected image annotation.
Protobuf type google.cloud.documentai.v1.BoundingPoly
CommonOperationMetadata
The common metadata for long running operations.
Protobuf type google.cloud.documentai.v1.CommonOperationMetadata
CommonOperationMetadata.Builder
The common metadata for long running operations.
Protobuf type google.cloud.documentai.v1.CommonOperationMetadata
CreateProcessorRequest
Request message for create a processor. Notice this request is sent to a regionalized backend service, and if the processor type is not available on that region, the creation will fail.
Protobuf type google.cloud.documentai.v1.CreateProcessorRequest
CreateProcessorRequest.Builder
Request message for create a processor. Notice this request is sent to a regionalized backend service, and if the processor type is not available on that region, the creation will fail.
Protobuf type google.cloud.documentai.v1.CreateProcessorRequest
DeleteProcessorMetadata
The long running operation metadata for delete processor method.
Protobuf type google.cloud.documentai.v1.DeleteProcessorMetadata
DeleteProcessorMetadata.Builder
The long running operation metadata for delete processor method.
Protobuf type google.cloud.documentai.v1.DeleteProcessorMetadata
DeleteProcessorRequest
Request message for the delete processor method.
Protobuf type google.cloud.documentai.v1.DeleteProcessorRequest
DeleteProcessorRequest.Builder
Request message for the delete processor method.
Protobuf type google.cloud.documentai.v1.DeleteProcessorRequest
DeleteProcessorVersionMetadata
The long running operation metadata for delete processor version method.
Protobuf type google.cloud.documentai.v1.DeleteProcessorVersionMetadata
DeleteProcessorVersionMetadata.Builder
The long running operation metadata for delete processor version method.
Protobuf type google.cloud.documentai.v1.DeleteProcessorVersionMetadata
DeleteProcessorVersionRequest
Request message for the delete processor version method.
Protobuf type google.cloud.documentai.v1.DeleteProcessorVersionRequest
DeleteProcessorVersionRequest.Builder
Request message for the delete processor version method.
Protobuf type google.cloud.documentai.v1.DeleteProcessorVersionRequest
DeployProcessorVersionMetadata
The long running operation metadata for deploy processor version method.
Protobuf type google.cloud.documentai.v1.DeployProcessorVersionMetadata
DeployProcessorVersionMetadata.Builder
The long running operation metadata for deploy processor version method.
Protobuf type google.cloud.documentai.v1.DeployProcessorVersionMetadata
DeployProcessorVersionRequest
Request message for the deploy processor version method.
Protobuf type google.cloud.documentai.v1.DeployProcessorVersionRequest
DeployProcessorVersionRequest.Builder
Request message for the deploy processor version method.
Protobuf type google.cloud.documentai.v1.DeployProcessorVersionRequest
DeployProcessorVersionResponse
Response message for the deploy processor version method.
Protobuf type google.cloud.documentai.v1.DeployProcessorVersionResponse
DeployProcessorVersionResponse.Builder
Response message for the deploy processor version method.
Protobuf type google.cloud.documentai.v1.DeployProcessorVersionResponse
DisableProcessorMetadata
The long running operation metadata for disable processor method.
Protobuf type google.cloud.documentai.v1.DisableProcessorMetadata
DisableProcessorMetadata.Builder
The long running operation metadata for disable processor method.
Protobuf type google.cloud.documentai.v1.DisableProcessorMetadata
DisableProcessorRequest
Request message for the disable processor method.
Protobuf type google.cloud.documentai.v1.DisableProcessorRequest
DisableProcessorRequest.Builder
Request message for the disable processor method.
Protobuf type google.cloud.documentai.v1.DisableProcessorRequest
DisableProcessorResponse
Response message for the disable processor method. Intentionally empty proto for adding fields in future.
Protobuf type google.cloud.documentai.v1.DisableProcessorResponse
DisableProcessorResponse.Builder
Response message for the disable processor method. Intentionally empty proto for adding fields in future.
Protobuf type google.cloud.documentai.v1.DisableProcessorResponse
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 quality.
Protobuf type google.cloud.documentai.v1.Document
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 quality.
Protobuf type google.cloud.documentai.v1.Document
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.
Protobuf type google.cloud.documentai.v1.Document.Entity
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.
Protobuf type google.cloud.documentai.v1.Document.Entity
Document.Entity.NormalizedValue
Parsed and normalized entity value.
Protobuf type google.cloud.documentai.v1.Document.Entity.NormalizedValue
Document.Entity.NormalizedValue.Builder
Parsed and normalized entity value.
Protobuf type google.cloud.documentai.v1.Document.Entity.NormalizedValue
Document.EntityRelation
Relationship between Entities.
Protobuf type google.cloud.documentai.v1.Document.EntityRelation
Document.EntityRelation.Builder
Relationship between Entities.
Protobuf type google.cloud.documentai.v1.Document.EntityRelation
Document.Page
A page in a Document.
Protobuf type google.cloud.documentai.v1.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.v1.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.v1.Document.Page.Block
Document.Page.Builder
A page in a Document.
Protobuf type google.cloud.documentai.v1.Document.Page
Document.Page.DetectedBarcode
A detected barcode.
Protobuf type google.cloud.documentai.v1.Document.Page.DetectedBarcode
Document.Page.DetectedBarcode.Builder
A detected barcode.
Protobuf type google.cloud.documentai.v1.Document.Page.DetectedBarcode
Document.Page.DetectedLanguage
Detected language for a structural component.
Protobuf type google.cloud.documentai.v1.Document.Page.DetectedLanguage
Document.Page.DetectedLanguage.Builder
Detected language for a structural component.
Protobuf type google.cloud.documentai.v1.Document.Page.DetectedLanguage
Document.Page.Dimension
Dimension for the page.
Protobuf type google.cloud.documentai.v1.Document.Page.Dimension
Document.Page.Dimension.Builder
Dimension for the page.
Protobuf type google.cloud.documentai.v1.Document.Page.Dimension
Document.Page.FormField
A form field detected on the page.
Protobuf type google.cloud.documentai.v1.Document.Page.FormField
Document.Page.FormField.Builder
A form field detected on the page.
Protobuf type google.cloud.documentai.v1.Document.Page.FormField
Document.Page.Image
Rendered image contents for this page.
Protobuf type google.cloud.documentai.v1.Document.Page.Image
Document.Page.Image.Builder
Rendered image contents for this page.
Protobuf type google.cloud.documentai.v1.Document.Page.Image
Document.Page.ImageQualityScores
Image Quality Scores for the page image
Protobuf type google.cloud.documentai.v1.Document.Page.ImageQualityScores
Document.Page.ImageQualityScores.Builder
Image Quality Scores for the page image
Protobuf type google.cloud.documentai.v1.Document.Page.ImageQualityScores
Document.Page.ImageQualityScores.DetectedDefect
Image Quality Defects
Protobuf type
google.cloud.documentai.v1.Document.Page.ImageQualityScores.DetectedDefect
Document.Page.ImageQualityScores.DetectedDefect.Builder
Image Quality Defects
Protobuf type
google.cloud.documentai.v1.Document.Page.ImageQualityScores.DetectedDefect
Document.Page.Layout
Visual element describing a layout unit on a page.
Protobuf type google.cloud.documentai.v1.Document.Page.Layout
Document.Page.Layout.Builder
Visual element describing a layout unit on a page.
Protobuf type google.cloud.documentai.v1.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.v1.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.v1.Document.Page.Line
Document.Page.Matrix
Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
Protobuf type google.cloud.documentai.v1.Document.Page.Matrix
Document.Page.Matrix.Builder
Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
Protobuf type google.cloud.documentai.v1.Document.Page.Matrix
Document.Page.Paragraph
A collection of lines that a human would perceive as a paragraph.
Protobuf type google.cloud.documentai.v1.Document.Page.Paragraph
Document.Page.Paragraph.Builder
A collection of lines that a human would perceive as a paragraph.
Protobuf type google.cloud.documentai.v1.Document.Page.Paragraph
Document.Page.Symbol
A detected symbol.
Protobuf type google.cloud.documentai.v1.Document.Page.Symbol
Document.Page.Symbol.Builder
A detected symbol.
Protobuf type google.cloud.documentai.v1.Document.Page.Symbol
Document.Page.Table
A table representation similar to HTML table structure.
Protobuf type google.cloud.documentai.v1.Document.Page.Table
Document.Page.Table.Builder
A table representation similar to HTML table structure.
Protobuf type google.cloud.documentai.v1.Document.Page.Table
Document.Page.Table.TableCell
A cell representation inside the table.
Protobuf type google.cloud.documentai.v1.Document.Page.Table.TableCell
Document.Page.Table.TableCell.Builder
A cell representation inside the table.
Protobuf type google.cloud.documentai.v1.Document.Page.Table.TableCell
Document.Page.Table.TableRow
A row of table cells.
Protobuf type google.cloud.documentai.v1.Document.Page.Table.TableRow
Document.Page.Table.TableRow.Builder
A row of table cells.
Protobuf type google.cloud.documentai.v1.Document.Page.Table.TableRow
Document.Page.Token
A detected token.
Protobuf type google.cloud.documentai.v1.Document.Page.Token
Document.Page.Token.Builder
A detected token.
Protobuf type google.cloud.documentai.v1.Document.Page.Token
Document.Page.Token.DetectedBreak
Detected break at the end of a Token.
Protobuf type google.cloud.documentai.v1.Document.Page.Token.DetectedBreak
Document.Page.Token.DetectedBreak.Builder
Detected break at the end of a Token.
Protobuf type google.cloud.documentai.v1.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.v1.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.v1.Document.Page.VisualElement
Document.PageAnchor
Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.
Protobuf type google.cloud.documentai.v1.Document.PageAnchor
Document.PageAnchor.Builder
Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.
Protobuf type google.cloud.documentai.v1.Document.PageAnchor
Document.PageAnchor.PageRef
Represents a weak reference to a page element within a document.
Protobuf type google.cloud.documentai.v1.Document.PageAnchor.PageRef
Document.PageAnchor.PageRef.Builder
Represents a weak reference to a page element within a document.
Protobuf type google.cloud.documentai.v1.Document.PageAnchor.PageRef
Document.Provenance
Structure to identify provenance relationships between annotations in different revisions.
Protobuf type google.cloud.documentai.v1.Document.Provenance
Document.Provenance.Builder
Structure to identify provenance relationships between annotations in different revisions.
Protobuf type google.cloud.documentai.v1.Document.Provenance
Document.Provenance.Parent
The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
Protobuf type google.cloud.documentai.v1.Document.Provenance.Parent
Document.Provenance.Parent.Builder
The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
Protobuf type google.cloud.documentai.v1.Document.Provenance.Parent
Document.Revision
Contains past or forward revisions of this document.
Protobuf type google.cloud.documentai.v1.Document.Revision
Document.Revision.Builder
Contains past or forward revisions of this document.
Protobuf type google.cloud.documentai.v1.Document.Revision
Document.Revision.HumanReview
Human Review information of the document.
Protobuf type google.cloud.documentai.v1.Document.Revision.HumanReview
Document.Revision.HumanReview.Builder
Human Review information of the document.
Protobuf type google.cloud.documentai.v1.Document.Revision.HumanReview
Document.ShardInfo
For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.
Protobuf type google.cloud.documentai.v1.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.v1.Document.ShardInfo
Document.Style
Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
Protobuf type google.cloud.documentai.v1.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.v1.Document.Style
Document.Style.FontSize
Font size with unit.
Protobuf type google.cloud.documentai.v1.Document.Style.FontSize
Document.Style.FontSize.Builder
Font size with unit.
Protobuf type google.cloud.documentai.v1.Document.Style.FontSize
Document.TextAnchor
Text reference indexing into the Document.text.
Protobuf type google.cloud.documentai.v1.Document.TextAnchor
Document.TextAnchor.Builder
Text reference indexing into the Document.text.
Protobuf type google.cloud.documentai.v1.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.v1.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.v1.Document.TextAnchor.TextSegment
Document.TextChange
This message is used for text changes aka. OCR corrections.
Protobuf type google.cloud.documentai.v1.Document.TextChange
Document.TextChange.Builder
This message is used for text changes aka. OCR corrections.
Protobuf type google.cloud.documentai.v1.Document.TextChange
DocumentAiDocumentSchema
DocumentAiProcessor
DocumentAiProcessorService
DocumentAiProcessorType
DocumentIoProto
DocumentOutputConfig
Config that controls the output of documents. All documents will be written as a JSON file.
Protobuf type google.cloud.documentai.v1.DocumentOutputConfig
DocumentOutputConfig.Builder
Config that controls the output of documents. All documents will be written as a JSON file.
Protobuf type google.cloud.documentai.v1.DocumentOutputConfig
DocumentOutputConfig.GcsOutputConfig
The configuration used when outputting documents.
Protobuf type google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig
DocumentOutputConfig.GcsOutputConfig.Builder
The configuration used when outputting documents.
Protobuf type google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig
DocumentOutputConfig.GcsOutputConfig.ShardingConfig
The sharding config for the output document.
Protobuf type
google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfig
DocumentOutputConfig.GcsOutputConfig.ShardingConfig.Builder
The sharding config for the output document.
Protobuf type
google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfig
DocumentProcessorServiceClient
Service Description: Service to call Cloud DocumentAI to process documents according to the processor's definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents.
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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create()) {
ResourceName name = ProcessorName.of("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
ProcessResponse response = documentProcessorServiceClient.processDocument(name);
}
Note: close() needs to be called on the DocumentProcessorServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of DocumentProcessorServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DocumentProcessorServiceSettings documentProcessorServiceSettings =
DocumentProcessorServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create(documentProcessorServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DocumentProcessorServiceSettings documentProcessorServiceSettings =
DocumentProcessorServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create(documentProcessorServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DocumentProcessorServiceSettings documentProcessorServiceSettings =
DocumentProcessorServiceSettings.newHttpJsonBuilder().build();
DocumentProcessorServiceClient documentProcessorServiceClient =
DocumentProcessorServiceClient.create(documentProcessorServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
DocumentProcessorServiceClient.ListLocationsFixedSizeCollection
DocumentProcessorServiceClient.ListLocationsPage
DocumentProcessorServiceClient.ListLocationsPagedResponse
DocumentProcessorServiceClient.ListProcessorTypesFixedSizeCollection
DocumentProcessorServiceClient.ListProcessorTypesPage
DocumentProcessorServiceClient.ListProcessorTypesPagedResponse
DocumentProcessorServiceClient.ListProcessorVersionsFixedSizeCollection
DocumentProcessorServiceClient.ListProcessorVersionsPage
DocumentProcessorServiceClient.ListProcessorVersionsPagedResponse
DocumentProcessorServiceClient.ListProcessorsFixedSizeCollection
DocumentProcessorServiceClient.ListProcessorsPage
DocumentProcessorServiceClient.ListProcessorsPagedResponse
DocumentProcessorServiceGrpc
Service to call Cloud DocumentAI to process documents according to the processor's definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents.
DocumentProcessorServiceGrpc.DocumentProcessorServiceBlockingStub
Service to call Cloud DocumentAI to process documents according to the processor's definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents.
DocumentProcessorServiceGrpc.DocumentProcessorServiceFutureStub
Service to call Cloud DocumentAI to process documents according to the processor's definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents.
DocumentProcessorServiceGrpc.DocumentProcessorServiceImplBase
Service to call Cloud DocumentAI to process documents according to the processor's definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents.
DocumentProcessorServiceGrpc.DocumentProcessorServiceStub
Service to call Cloud DocumentAI to process documents according to the processor's definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents.
DocumentProcessorServiceSettings
Settings class to configure an instance of DocumentProcessorServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (documentai.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of processDocument to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DocumentProcessorServiceSettings.Builder documentProcessorServiceSettingsBuilder =
DocumentProcessorServiceSettings.newBuilder();
documentProcessorServiceSettingsBuilder
.processDocumentSettings()
.setRetrySettings(
documentProcessorServiceSettingsBuilder
.processDocumentSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
DocumentProcessorServiceSettings documentProcessorServiceSettings =
documentProcessorServiceSettingsBuilder.build();
DocumentProcessorServiceSettings.Builder
Builder for DocumentProcessorServiceSettings.
DocumentProto
DocumentSchema
The schema defines the output of the processed document by a processor.
Protobuf type google.cloud.documentai.v1.DocumentSchema
DocumentSchema.Builder
The schema defines the output of the processed document by a processor.
Protobuf type google.cloud.documentai.v1.DocumentSchema
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.
Protobuf type google.cloud.documentai.v1.DocumentSchema.EntityType
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.
Protobuf type google.cloud.documentai.v1.DocumentSchema.EntityType
DocumentSchema.EntityType.EnumValues
Defines the a list of enum values.
Protobuf type google.cloud.documentai.v1.DocumentSchema.EntityType.EnumValues
DocumentSchema.EntityType.EnumValues.Builder
Defines the a list of enum values.
Protobuf type google.cloud.documentai.v1.DocumentSchema.EntityType.EnumValues
DocumentSchema.EntityType.Property
Defines properties that can be part of the entity type.
Protobuf type google.cloud.documentai.v1.DocumentSchema.EntityType.Property
DocumentSchema.EntityType.Property.Builder
Defines properties that can be part of the entity type.
Protobuf type google.cloud.documentai.v1.DocumentSchema.EntityType.Property
DocumentSchema.Metadata
Metadata for global schema behavior.
Protobuf type google.cloud.documentai.v1.DocumentSchema.Metadata
DocumentSchema.Metadata.Builder
Metadata for global schema behavior.
Protobuf type google.cloud.documentai.v1.DocumentSchema.Metadata
EnableProcessorMetadata
The long running operation metadata for enable processor method.
Protobuf type google.cloud.documentai.v1.EnableProcessorMetadata
EnableProcessorMetadata.Builder
The long running operation metadata for enable processor method.
Protobuf type google.cloud.documentai.v1.EnableProcessorMetadata
EnableProcessorRequest
Request message for the enable processor method.
Protobuf type google.cloud.documentai.v1.EnableProcessorRequest
EnableProcessorRequest.Builder
Request message for the enable processor method.
Protobuf type google.cloud.documentai.v1.EnableProcessorRequest
EnableProcessorResponse
Response message for the enable processor method. Intentionally empty proto for adding fields in future.
Protobuf type google.cloud.documentai.v1.EnableProcessorResponse
EnableProcessorResponse.Builder
Response message for the enable processor method. Intentionally empty proto for adding fields in future.
Protobuf type google.cloud.documentai.v1.EnableProcessorResponse
FetchProcessorTypesRequest
Request message for fetch processor types.
Protobuf type google.cloud.documentai.v1.FetchProcessorTypesRequest
FetchProcessorTypesRequest.Builder
Request message for fetch processor types.
Protobuf type google.cloud.documentai.v1.FetchProcessorTypesRequest
FetchProcessorTypesResponse
Response message for fetch processor types.
Protobuf type google.cloud.documentai.v1.FetchProcessorTypesResponse
FetchProcessorTypesResponse.Builder
Response message for fetch processor types.
Protobuf type google.cloud.documentai.v1.FetchProcessorTypesResponse
GcsDocument
Specifies a document stored on Cloud Storage.
Protobuf type google.cloud.documentai.v1.GcsDocument
GcsDocument.Builder
Specifies a document stored on Cloud Storage.
Protobuf type google.cloud.documentai.v1.GcsDocument
GcsDocuments
Specifies a set of documents on Cloud Storage.
Protobuf type google.cloud.documentai.v1.GcsDocuments
GcsDocuments.Builder
Specifies a set of documents on Cloud Storage.
Protobuf type google.cloud.documentai.v1.GcsDocuments
GcsPrefix
Specifies all documents on Cloud Storage with a common prefix.
Protobuf type google.cloud.documentai.v1.GcsPrefix
GcsPrefix.Builder
Specifies all documents on Cloud Storage with a common prefix.
Protobuf type google.cloud.documentai.v1.GcsPrefix
GeometryProto
GetProcessorRequest
Request message for get processor.
Protobuf type google.cloud.documentai.v1.GetProcessorRequest
GetProcessorRequest.Builder
Request message for get processor.
Protobuf type google.cloud.documentai.v1.GetProcessorRequest
GetProcessorTypeRequest
Request message for get processor.
Protobuf type google.cloud.documentai.v1.GetProcessorTypeRequest
GetProcessorTypeRequest.Builder
Request message for get processor.
Protobuf type google.cloud.documentai.v1.GetProcessorTypeRequest
GetProcessorVersionRequest
Request message for get processor version.
Protobuf type google.cloud.documentai.v1.GetProcessorVersionRequest
GetProcessorVersionRequest.Builder
Request message for get processor version.
Protobuf type google.cloud.documentai.v1.GetProcessorVersionRequest
HumanReviewConfigName
HumanReviewConfigName.Builder
Builder for projects/{project}/locations/{location}/processors/{processor}/humanReviewConfig.
HumanReviewStatus
The status of human review on a processed document.
Protobuf type google.cloud.documentai.v1.HumanReviewStatus
HumanReviewStatus.Builder
The status of human review on a processed document.
Protobuf type google.cloud.documentai.v1.HumanReviewStatus
ListProcessorTypesRequest
Request message for list processor types.
Protobuf type google.cloud.documentai.v1.ListProcessorTypesRequest
ListProcessorTypesRequest.Builder
Request message for list processor types.
Protobuf type google.cloud.documentai.v1.ListProcessorTypesRequest
ListProcessorTypesResponse
Response message for list processor types.
Protobuf type google.cloud.documentai.v1.ListProcessorTypesResponse
ListProcessorTypesResponse.Builder
Response message for list processor types.
Protobuf type google.cloud.documentai.v1.ListProcessorTypesResponse
ListProcessorVersionsRequest
Request message for list all processor versions belongs to a processor.
Protobuf type google.cloud.documentai.v1.ListProcessorVersionsRequest
ListProcessorVersionsRequest.Builder
Request message for list all processor versions belongs to a processor.
Protobuf type google.cloud.documentai.v1.ListProcessorVersionsRequest
ListProcessorVersionsResponse
Response message for list processors.
Protobuf type google.cloud.documentai.v1.ListProcessorVersionsResponse
ListProcessorVersionsResponse.Builder
Response message for list processors.
Protobuf type google.cloud.documentai.v1.ListProcessorVersionsResponse
ListProcessorsRequest
Request message for list all processors belongs to a project.
Protobuf type google.cloud.documentai.v1.ListProcessorsRequest
ListProcessorsRequest.Builder
Request message for list all processors belongs to a project.
Protobuf type google.cloud.documentai.v1.ListProcessorsRequest
ListProcessorsResponse
Response message for list processors.
Protobuf type google.cloud.documentai.v1.ListProcessorsResponse
ListProcessorsResponse.Builder
Response message for list processors.
Protobuf type google.cloud.documentai.v1.ListProcessorsResponse
LocationName
LocationName.Builder
Builder for projects/{project}/locations/{location}.
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.
Protobuf type google.cloud.documentai.v1.NormalizedVertex
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.
Protobuf type google.cloud.documentai.v1.NormalizedVertex
OperationMetadataProto
ProcessRequest
Request message for the process document method.
Protobuf type google.cloud.documentai.v1.ProcessRequest
ProcessRequest.Builder
Request message for the process document method.
Protobuf type google.cloud.documentai.v1.ProcessRequest
ProcessResponse
Response message for the process document method.
Protobuf type google.cloud.documentai.v1.ProcessResponse
ProcessResponse.Builder
Response message for the process document method.
Protobuf type google.cloud.documentai.v1.ProcessResponse
Processor
The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
Protobuf type google.cloud.documentai.v1.Processor
Processor.Builder
The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
Protobuf type google.cloud.documentai.v1.Processor
ProcessorName
ProcessorName.Builder
Builder for projects/{project}/locations/{location}/processors/{processor}.
ProcessorType
A processor type is responsible for performing a certain document understanding task on a certain type of document.
Protobuf type google.cloud.documentai.v1.ProcessorType
ProcessorType.Builder
A processor type is responsible for performing a certain document understanding task on a certain type of document.
Protobuf type google.cloud.documentai.v1.ProcessorType
ProcessorType.LocationInfo
The location information about where the processor is available.
Protobuf type google.cloud.documentai.v1.ProcessorType.LocationInfo
ProcessorType.LocationInfo.Builder
The location information about where the processor is available.
Protobuf type google.cloud.documentai.v1.ProcessorType.LocationInfo
ProcessorTypeName
ProcessorTypeName.Builder
Builder for projects/{project}/locations/{location}/processorTypes/{processor_type}.
ProcessorVersion
A processor version is an implementation of a processor. Each processor can have multiple versions, pre-trained by Google internally or up-trained by the customer. At a time, a processor can only have one default version version. So the processor's behavior (when processing documents) is defined by a default version
Protobuf type google.cloud.documentai.v1.ProcessorVersion
ProcessorVersion.Builder
A processor version is an implementation of a processor. Each processor can have multiple versions, pre-trained by Google internally or up-trained by the customer. At a time, a processor can only have one default version version. So the processor's behavior (when processing documents) is defined by a default version
Protobuf type google.cloud.documentai.v1.ProcessorVersion
ProcessorVersion.DeprecationInfo
Information about the upcoming deprecation of this processor version.
Protobuf type google.cloud.documentai.v1.ProcessorVersion.DeprecationInfo
ProcessorVersion.DeprecationInfo.Builder
Information about the upcoming deprecation of this processor version.
Protobuf type google.cloud.documentai.v1.ProcessorVersion.DeprecationInfo
ProcessorVersionName
ProcessorVersionName.Builder
Builder for projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}.
RawDocument
Payload message of raw document content (bytes).
Protobuf type google.cloud.documentai.v1.RawDocument
RawDocument.Builder
Payload message of raw document content (bytes).
Protobuf type google.cloud.documentai.v1.RawDocument
ReviewDocumentOperationMetadata
The long running operation metadata for review document method.
Protobuf type google.cloud.documentai.v1.ReviewDocumentOperationMetadata
ReviewDocumentOperationMetadata.Builder
The long running operation metadata for review document method.
Protobuf type google.cloud.documentai.v1.ReviewDocumentOperationMetadata
ReviewDocumentRequest
Request message for review document method.
Protobuf type google.cloud.documentai.v1.ReviewDocumentRequest
ReviewDocumentRequest.Builder
Request message for review document method.
Protobuf type google.cloud.documentai.v1.ReviewDocumentRequest
ReviewDocumentResponse
Response message for review document method.
Protobuf type google.cloud.documentai.v1.ReviewDocumentResponse
ReviewDocumentResponse.Builder
Response message for review document method.
Protobuf type google.cloud.documentai.v1.ReviewDocumentResponse
SetDefaultProcessorVersionMetadata
The long running operation metadata for set default processor version method.
Protobuf type google.cloud.documentai.v1.SetDefaultProcessorVersionMetadata
SetDefaultProcessorVersionMetadata.Builder
The long running operation metadata for set default processor version method.
Protobuf type google.cloud.documentai.v1.SetDefaultProcessorVersionMetadata
SetDefaultProcessorVersionRequest
Request message for the set default processor version method.
Protobuf type google.cloud.documentai.v1.SetDefaultProcessorVersionRequest
SetDefaultProcessorVersionRequest.Builder
Request message for the set default processor version method.
Protobuf type google.cloud.documentai.v1.SetDefaultProcessorVersionRequest
SetDefaultProcessorVersionResponse
Response message for set default processor version method.
Protobuf type google.cloud.documentai.v1.SetDefaultProcessorVersionResponse
SetDefaultProcessorVersionResponse.Builder
Response message for set default processor version method.
Protobuf type google.cloud.documentai.v1.SetDefaultProcessorVersionResponse
UndeployProcessorVersionMetadata
The long running operation metadata for the undeploy processor version method.
Protobuf type google.cloud.documentai.v1.UndeployProcessorVersionMetadata
UndeployProcessorVersionMetadata.Builder
The long running operation metadata for the undeploy processor version method.
Protobuf type google.cloud.documentai.v1.UndeployProcessorVersionMetadata
UndeployProcessorVersionRequest
Request message for the undeploy processor version method.
Protobuf type google.cloud.documentai.v1.UndeployProcessorVersionRequest
UndeployProcessorVersionRequest.Builder
Request message for the undeploy processor version method.
Protobuf type google.cloud.documentai.v1.UndeployProcessorVersionRequest
UndeployProcessorVersionResponse
Response message for the undeploy processor version method.
Protobuf type google.cloud.documentai.v1.UndeployProcessorVersionResponse
UndeployProcessorVersionResponse.Builder
Response message for the undeploy processor version method.
Protobuf type google.cloud.documentai.v1.UndeployProcessorVersionResponse
Vertex
A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
Protobuf type google.cloud.documentai.v1.Vertex
Vertex.Builder
A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
Protobuf type google.cloud.documentai.v1.Vertex
Interfaces
BarcodeOrBuilder
BatchDocumentsInputConfigOrBuilder
BatchProcessMetadata.IndividualProcessStatusOrBuilder
BatchProcessMetadataOrBuilder
BatchProcessRequestOrBuilder
BatchProcessResponseOrBuilder
BoundingPolyOrBuilder
CommonOperationMetadataOrBuilder
CreateProcessorRequestOrBuilder
DeleteProcessorMetadataOrBuilder
DeleteProcessorRequestOrBuilder
DeleteProcessorVersionMetadataOrBuilder
DeleteProcessorVersionRequestOrBuilder
DeployProcessorVersionMetadataOrBuilder
DeployProcessorVersionRequestOrBuilder
DeployProcessorVersionResponseOrBuilder
DisableProcessorMetadataOrBuilder
DisableProcessorRequestOrBuilder
DisableProcessorResponseOrBuilder
Document.Entity.NormalizedValueOrBuilder
Document.EntityOrBuilder
Document.EntityRelationOrBuilder
Document.Page.BlockOrBuilder
Document.Page.DetectedBarcodeOrBuilder
Document.Page.DetectedLanguageOrBuilder
Document.Page.DimensionOrBuilder
Document.Page.FormFieldOrBuilder
Document.Page.ImageOrBuilder
Document.Page.ImageQualityScores.DetectedDefectOrBuilder
Document.Page.ImageQualityScoresOrBuilder
Document.Page.LayoutOrBuilder
Document.Page.LineOrBuilder
Document.Page.MatrixOrBuilder
Document.Page.ParagraphOrBuilder
Document.Page.SymbolOrBuilder
Document.Page.Table.TableCellOrBuilder
Document.Page.Table.TableRowOrBuilder
Document.Page.TableOrBuilder
Document.Page.Token.DetectedBreakOrBuilder
Document.Page.TokenOrBuilder
Document.Page.VisualElementOrBuilder
Document.PageAnchor.PageRefOrBuilder
Document.PageAnchorOrBuilder
Document.PageOrBuilder
Document.Provenance.ParentOrBuilder
Document.ProvenanceOrBuilder
Document.Revision.HumanReviewOrBuilder
Document.RevisionOrBuilder
Document.ShardInfoOrBuilder
Document.Style.FontSizeOrBuilder
Document.StyleOrBuilder
Document.TextAnchor.TextSegmentOrBuilder
Document.TextAnchorOrBuilder
Document.TextChangeOrBuilder
DocumentOrBuilder
DocumentOutputConfig.GcsOutputConfig.ShardingConfigOrBuilder
DocumentOutputConfig.GcsOutputConfigOrBuilder
DocumentOutputConfigOrBuilder
DocumentSchema.EntityType.EnumValuesOrBuilder
DocumentSchema.EntityType.PropertyOrBuilder
DocumentSchema.EntityTypeOrBuilder
DocumentSchema.MetadataOrBuilder
DocumentSchemaOrBuilder
EnableProcessorMetadataOrBuilder
EnableProcessorRequestOrBuilder
EnableProcessorResponseOrBuilder
FetchProcessorTypesRequestOrBuilder
FetchProcessorTypesResponseOrBuilder
GcsDocumentOrBuilder
GcsDocumentsOrBuilder
GcsPrefixOrBuilder
GetProcessorRequestOrBuilder
GetProcessorTypeRequestOrBuilder
GetProcessorVersionRequestOrBuilder
HumanReviewStatusOrBuilder
ListProcessorTypesRequestOrBuilder
ListProcessorTypesResponseOrBuilder
ListProcessorVersionsRequestOrBuilder
ListProcessorVersionsResponseOrBuilder
ListProcessorsRequestOrBuilder
ListProcessorsResponseOrBuilder
NormalizedVertexOrBuilder
ProcessRequestOrBuilder
ProcessResponseOrBuilder
ProcessorOrBuilder
ProcessorType.LocationInfoOrBuilder
ProcessorTypeOrBuilder
ProcessorVersion.DeprecationInfoOrBuilder
ProcessorVersionOrBuilder
RawDocumentOrBuilder
ReviewDocumentOperationMetadataOrBuilder
ReviewDocumentRequestOrBuilder
ReviewDocumentResponseOrBuilder
SetDefaultProcessorVersionMetadataOrBuilder
SetDefaultProcessorVersionRequestOrBuilder
SetDefaultProcessorVersionResponseOrBuilder
UndeployProcessorVersionMetadataOrBuilder
UndeployProcessorVersionRequestOrBuilder
UndeployProcessorVersionResponseOrBuilder
VertexOrBuilder
Enums
BatchDocumentsInputConfig.SourceCase
BatchProcessMetadata.State
Possible states of the batch processing operation.
Protobuf enum google.cloud.documentai.v1.BatchProcessMetadata.State
CommonOperationMetadata.State
State of the longrunning operation.
Protobuf enum google.cloud.documentai.v1.CommonOperationMetadata.State
Document.Entity.NormalizedValue.StructuredValueCase
Document.Page.Layout.Orientation
Detected human reading orientation.
Protobuf enum google.cloud.documentai.v1.Document.Page.Layout.Orientation
Document.Page.Token.DetectedBreak.Type
Enum to denote the type of break found.
Protobuf enum google.cloud.documentai.v1.Document.Page.Token.DetectedBreak.Type
Document.PageAnchor.PageRef.LayoutType
The type of layout that is being referenced.
Protobuf enum google.cloud.documentai.v1.Document.PageAnchor.PageRef.LayoutType
Document.Provenance.OperationType
If a processor or agent does an explicit operation on existing elements.
Protobuf enum google.cloud.documentai.v1.Document.Provenance.OperationType
Document.Revision.SourceCase
Document.SourceCase
DocumentOutputConfig.DestinationCase
DocumentSchema.EntityType.Property.OccurrenceType
Types of occurrences of the entity type in the document. Note: this represents the number of instances of an entity types, not number of mentions of a given entity instance.
Protobuf enum
google.cloud.documentai.v1.DocumentSchema.EntityType.Property.OccurrenceType
DocumentSchema.EntityType.ValueSourceCase
HumanReviewStatus.State
The final state of human review on a processed document.
Protobuf enum google.cloud.documentai.v1.HumanReviewStatus.State
ProcessRequest.SourceCase
Processor.State
The possible states of the processor.
Protobuf enum google.cloud.documentai.v1.Processor.State
ProcessorVersion.State
The possible states of the processor version.
Protobuf enum google.cloud.documentai.v1.ProcessorVersion.State
ReviewDocumentRequest.Priority
The priority level of the human review task.
Protobuf enum google.cloud.documentai.v1.ReviewDocumentRequest.Priority
ReviewDocumentRequest.SourceCase
ReviewDocumentResponse.State
Possible states of the review operation.
Protobuf enum google.cloud.documentai.v1.ReviewDocumentResponse.State