documentai.v1 library Null safety

Cloud Document AI API - v1

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

For more information, see cloud.google.com/document-ai/docs/

Create an instance of DocumentApi to access these resources:

Classes

DocumentApi
Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML.
GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata
GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse
Response of the delete documents operation.
GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata
GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse
Response of the batch move documents operation.
GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata
The common metadata for long running operations.
GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata
The long running operation metadata for CreateLabelerPool.
GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata
The long running operation metadata for DeleteLabelerPool.
GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata
The long running operation metadata for delete processor method.
GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata
The long running operation metadata for delete processor version method.
GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata
The long running operation metadata for deploy processor version method.
GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse
Response message for the deploy processor version method.
GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata
The long running operation metadata for disable processor method.
GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse
Response message for the disable processor method. [...]
GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata
The long running operation metadata for enable processor method.
GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse
Response message for the enable processor method. [...]
GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata
Metadata of the EvaluateProcessorVersion method.
GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse
Metadata of the EvaluateProcessorVersion method.
GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata
Metadata message associated with the ExportProcessorVersion operation.
GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse
Response message associated with the ExportProcessorVersion operation.
GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata
Metadata of the import document operation.
GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse
Response of the import document operation.
GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata
The long running operation metadata for set default processor version method.
GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse
Response message for set default processor version method.
GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata
The metadata that represents a processor version being created.
GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation
The dataset validation information. [...]
GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse
The response for the TrainProcessorVersion method.
GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata
The long running operation metadata for the undeploy processor version method.
GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse
Response message for the undeploy processor version method.
GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata
GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata
The long running operation metadata for updating the human review configuration.
GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata
The long running operation metadata for UpdateLabelerPool.
GoogleCloudDocumentaiV1BatchDocumentsInputConfig
The common config to specify a set of documents used as input.
GoogleCloudDocumentaiV1BatchProcessMetadata
The long running operation metadata for batch process method.
GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus
The status of a each individual document in the batch process.
GoogleCloudDocumentaiV1BatchProcessRequest
Request message for batch process document method.
GoogleCloudDocumentaiV1BatchProcessResponse
Response message for batch process document method.
GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse
Response to an batch document processing request. [...]
GoogleCloudDocumentaiV1beta1BoundingPoly
A bounding polygon for the detected image annotation.
GoogleCloudDocumentaiV1beta1Document
Document represents the canonical document resource in Document Understanding AI. [...]
GoogleCloudDocumentaiV1beta1DocumentEntity
An entity that could be a phrase in the text or a property belongs to the document. [...]
GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue
Parsed and normalized entity value.
GoogleCloudDocumentaiV1beta1DocumentEntityRelation
Relationship between Entities.
GoogleCloudDocumentaiV1beta1DocumentPage
A page in a Document.
GoogleCloudDocumentaiV1beta1DocumentPageAnchor
Referencing the visual context of the entity in the Document.pages. [...]
GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef
Represents a weak reference to a page element within a document.
GoogleCloudDocumentaiV1beta1DocumentPageBlock
A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage
Detected language for a structural component.
GoogleCloudDocumentaiV1beta1DocumentPageDimension
Dimension for the page.
GoogleCloudDocumentaiV1beta1DocumentPageFormField
A form field detected on the page.
GoogleCloudDocumentaiV1beta1DocumentPageImage
Rendered image contents for this page.
GoogleCloudDocumentaiV1beta1DocumentPageLayout
Visual element describing a layout unit on a page.
GoogleCloudDocumentaiV1beta1DocumentPageLine
A collection of tokens that a human would perceive as a line. [...]
GoogleCloudDocumentaiV1beta1DocumentPageMatrix
Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
GoogleCloudDocumentaiV1beta1DocumentPageParagraph
A collection of lines that a human would perceive as a paragraph.
GoogleCloudDocumentaiV1beta1DocumentPageTable
A table representation similar to HTML table structure.
GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell
A cell representation inside the table.
GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow
A row of table cells.
GoogleCloudDocumentaiV1beta1DocumentPageToken
A detected token.
GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak
Detected break at the end of a Token.
GoogleCloudDocumentaiV1beta1DocumentPageVisualElement
Detected non-text visual elements e.g. checkbox, signature etc. [...]
GoogleCloudDocumentaiV1beta1DocumentProvenance
Structure to identify provenance relationships between annotations in different revisions.
GoogleCloudDocumentaiV1beta1DocumentProvenanceParent
Structure for referencing parent provenances. [...]
GoogleCloudDocumentaiV1beta1DocumentRevision
Contains past or forward revisions of this document.
GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview
Human Review information of the document.
GoogleCloudDocumentaiV1beta1DocumentShardInfo
For a large document, sharding may be performed to produce several document shards. [...]
GoogleCloudDocumentaiV1beta1DocumentStyle
Annotation for common text style attributes. [...]
GoogleCloudDocumentaiV1beta1DocumentStyleFontSize
Font size with unit.
GoogleCloudDocumentaiV1beta1DocumentTextAnchor
Text reference indexing into the Document.text.
GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment
A text segment in the Document.text. [...]
GoogleCloudDocumentaiV1beta1DocumentTextChange
This message is used for text changes aka. [...]
GoogleCloudDocumentaiV1beta1GcsDestination
The Google Cloud Storage location where the output file will be written to.
GoogleCloudDocumentaiV1beta1GcsSource
The Google Cloud Storage location where the input file will be read from.
GoogleCloudDocumentaiV1beta1InputConfig
The desired input location and metadata.
GoogleCloudDocumentaiV1beta1NormalizedVertex
A vertex represents a 2D point in the image. [...]
GoogleCloudDocumentaiV1beta1OperationMetadata
Contains metadata for the BatchProcessDocuments operation.
GoogleCloudDocumentaiV1beta1OutputConfig
The desired output location and metadata.
GoogleCloudDocumentaiV1beta1ProcessDocumentResponse
Response to a single document processing request.
GoogleCloudDocumentaiV1beta1Vertex
A vertex represents a 2D point in the image. [...]
GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse
Response to an batch document processing request. [...]
GoogleCloudDocumentaiV1beta2BoundingPoly
A bounding polygon for the detected image annotation.
GoogleCloudDocumentaiV1beta2Document
Document represents the canonical document resource in Document Understanding AI. [...]
GoogleCloudDocumentaiV1beta2DocumentEntity
An entity that could be a phrase in the text or a property belongs to the document. [...]
GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue
Parsed and normalized entity value.
GoogleCloudDocumentaiV1beta2DocumentEntityRelation
Relationship between Entities.
GoogleCloudDocumentaiV1beta2DocumentLabel
Label attaches schema information and/or other metadata to segments within a Document. [...]
GoogleCloudDocumentaiV1beta2DocumentPage
A page in a Document.
GoogleCloudDocumentaiV1beta2DocumentPageAnchor
Referencing the visual context of the entity in the Document.pages. [...]
GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef
Represents a weak reference to a page element within a document.
GoogleCloudDocumentaiV1beta2DocumentPageBlock
A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage
Detected language for a structural component.
GoogleCloudDocumentaiV1beta2DocumentPageDimension
Dimension for the page.
GoogleCloudDocumentaiV1beta2DocumentPageFormField
A form field detected on the page.
GoogleCloudDocumentaiV1beta2DocumentPageImage
Rendered image contents for this page.
GoogleCloudDocumentaiV1beta2DocumentPageLayout
Visual element describing a layout unit on a page.
GoogleCloudDocumentaiV1beta2DocumentPageLine
A collection of tokens that a human would perceive as a line. [...]
GoogleCloudDocumentaiV1beta2DocumentPageMatrix
Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
GoogleCloudDocumentaiV1beta2DocumentPageParagraph
A collection of lines that a human would perceive as a paragraph.
GoogleCloudDocumentaiV1beta2DocumentPageTable
A table representation similar to HTML table structure.
GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell
A cell representation inside the table.
GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow
A row of table cells.
GoogleCloudDocumentaiV1beta2DocumentPageToken
A detected token.
GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak
Detected break at the end of a Token.
GoogleCloudDocumentaiV1beta2DocumentPageVisualElement
Detected non-text visual elements e.g. checkbox, signature etc. [...]
GoogleCloudDocumentaiV1beta2DocumentProvenance
Structure to identify provenance relationships between annotations in different revisions.
GoogleCloudDocumentaiV1beta2DocumentProvenanceParent
Structure for referencing parent provenances. [...]
GoogleCloudDocumentaiV1beta2DocumentRevision
Contains past or forward revisions of this document.
GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview
Human Review information of the document.
GoogleCloudDocumentaiV1beta2DocumentShardInfo
For a large document, sharding may be performed to produce several document shards. [...]
GoogleCloudDocumentaiV1beta2DocumentStyle
Annotation for common text style attributes. [...]
GoogleCloudDocumentaiV1beta2DocumentStyleFontSize
Font size with unit.
GoogleCloudDocumentaiV1beta2DocumentTextAnchor
Text reference indexing into the Document.text.
GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment
A text segment in the Document.text. [...]
GoogleCloudDocumentaiV1beta2DocumentTextChange
This message is used for text changes aka. [...]
GoogleCloudDocumentaiV1beta2GcsDestination
The Google Cloud Storage location where the output file will be written to.
GoogleCloudDocumentaiV1beta2GcsSource
The Google Cloud Storage location where the input file will be read from.
GoogleCloudDocumentaiV1beta2InputConfig
The desired input location and metadata.
GoogleCloudDocumentaiV1beta2NormalizedVertex
A vertex represents a 2D point in the image. [...]
GoogleCloudDocumentaiV1beta2OperationMetadata
Contains metadata for the BatchProcessDocuments operation.
GoogleCloudDocumentaiV1beta2OutputConfig
The desired output location and metadata.
GoogleCloudDocumentaiV1beta2ProcessDocumentResponse
Response to a single document processing request.
GoogleCloudDocumentaiV1beta2Vertex
A vertex represents a 2D point in the image. [...]
GoogleCloudDocumentaiV1beta3BatchProcessMetadata
The long running operation metadata for batch process method.
GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus
The status of a each individual document in the batch process.
GoogleCloudDocumentaiV1beta3BatchProcessResponse
Response message for batch process document method.
GoogleCloudDocumentaiV1beta3CommonOperationMetadata
The common metadata for long running operations.
GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata
The long running operation metadata for delete processor method.
GoogleCloudDocumentaiV1beta3DisableProcessorMetadata
The long running operation metadata for disable processor method.
GoogleCloudDocumentaiV1beta3DisableProcessorResponse
Response message for the disable processor method. [...]
GoogleCloudDocumentaiV1beta3EnableProcessorMetadata
The long running operation metadata for enable processor method.
GoogleCloudDocumentaiV1beta3EnableProcessorResponse
Response message for the enable processor method. [...]
GoogleCloudDocumentaiV1beta3HumanReviewStatus
The status of human review on a processed document.
GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata
The long running operation metadata for review document method.
GoogleCloudDocumentaiV1beta3ReviewDocumentResponse
Response message for review document method.
GoogleCloudDocumentaiV1BoundingPoly
A bounding polygon for the detected image annotation.
GoogleCloudDocumentaiV1CommonOperationMetadata
The common metadata for long running operations.
GoogleCloudDocumentaiV1Document
Document represents the canonical document resource in Document Understanding AI. [...]
GoogleCloudDocumentaiV1DocumentEntity
An entity that could be a phrase in the text or a property belongs to the document. [...]
GoogleCloudDocumentaiV1DocumentEntityNormalizedValue
Parsed and normalized entity value.
GoogleCloudDocumentaiV1DocumentEntityRelation
Relationship between Entities.
GoogleCloudDocumentaiV1DocumentOutputConfig
Config that controls the output of documents. [...]
GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig
The configuration used when outputting documents.
GoogleCloudDocumentaiV1DocumentPage
A page in a Document.
GoogleCloudDocumentaiV1DocumentPageAnchor
Referencing the visual context of the entity in the Document.pages. [...]
GoogleCloudDocumentaiV1DocumentPageAnchorPageRef
Represents a weak reference to a page element within a document.
GoogleCloudDocumentaiV1DocumentPageBlock
A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
GoogleCloudDocumentaiV1DocumentPageDetectedLanguage
Detected language for a structural component.
GoogleCloudDocumentaiV1DocumentPageDimension
Dimension for the page.
GoogleCloudDocumentaiV1DocumentPageFormField
A form field detected on the page.
GoogleCloudDocumentaiV1DocumentPageImage
Rendered image contents for this page.
GoogleCloudDocumentaiV1DocumentPageLayout
Visual element describing a layout unit on a page.
GoogleCloudDocumentaiV1DocumentPageLine
A collection of tokens that a human would perceive as a line. [...]
GoogleCloudDocumentaiV1DocumentPageMatrix
Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
GoogleCloudDocumentaiV1DocumentPageParagraph
A collection of lines that a human would perceive as a paragraph.
GoogleCloudDocumentaiV1DocumentPageTable
A table representation similar to HTML table structure.
GoogleCloudDocumentaiV1DocumentPageTableTableCell
A cell representation inside the table.
GoogleCloudDocumentaiV1DocumentPageTableTableRow
A row of table cells.
GoogleCloudDocumentaiV1DocumentPageToken
A detected token.
GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak
Detected break at the end of a Token.
GoogleCloudDocumentaiV1DocumentPageVisualElement
Detected non-text visual elements e.g. checkbox, signature etc. [...]
GoogleCloudDocumentaiV1DocumentProvenance
Structure to identify provenance relationships between annotations in different revisions.
GoogleCloudDocumentaiV1DocumentProvenanceParent
Structure for referencing parent provenances. [...]
GoogleCloudDocumentaiV1DocumentRevision
Contains past or forward revisions of this document.
GoogleCloudDocumentaiV1DocumentRevisionHumanReview
Human Review information of the document.
GoogleCloudDocumentaiV1DocumentShardInfo
For a large document, sharding may be performed to produce several document shards. [...]
GoogleCloudDocumentaiV1DocumentStyle
Annotation for common text style attributes. [...]
GoogleCloudDocumentaiV1DocumentStyleFontSize
Font size with unit.
GoogleCloudDocumentaiV1DocumentTextAnchor
Text reference indexing into the Document.text.
GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment
A text segment in the Document.text. [...]
GoogleCloudDocumentaiV1DocumentTextChange
This message is used for text changes aka. [...]
GoogleCloudDocumentaiV1GcsDocument
Specifies a document stored on Cloud Storage.
GoogleCloudDocumentaiV1GcsDocuments
Specifies a set of documents on Cloud Storage.
GoogleCloudDocumentaiV1GcsPrefix
Specifies all documents on Cloud Storage with a common prefix.
GoogleCloudDocumentaiV1HumanReviewStatus
The status of human review on a processed document.
GoogleCloudDocumentaiV1NormalizedVertex
A vertex represents a 2D point in the image. [...]
GoogleCloudDocumentaiV1ProcessRequest
Request message for the process document method.
GoogleCloudDocumentaiV1ProcessResponse
Response message for the process document method.
GoogleCloudDocumentaiV1RawDocument
Payload message of raw document content (bytes).
GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata
The long running operation metadata for review document method.
GoogleCloudDocumentaiV1ReviewDocumentRequest
Request message for review document method. [...]
GoogleCloudDocumentaiV1ReviewDocumentResponse
Response message for review document method.
GoogleCloudDocumentaiV1Vertex
A vertex represents a 2D point in the image. [...]
GoogleCloudLocationListLocationsResponse
The response message for Locations.ListLocations.
GoogleCloudLocationLocation
A resource that represents Google Cloud Platform location.
GoogleLongrunningListOperationsResponse
The response message for Operations.ListOperations.
GoogleLongrunningOperation
This resource represents a long-running operation that is the result of a network API call.
GoogleProtobufEmpty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. [...]
GoogleRpcStatus
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. [...]
GoogleTypeColor
Represents a color in the RGBA color space. [...]
GoogleTypeDate
Represents a whole or partial calendar date, such as a birthday. [...]
GoogleTypeDateTime
Represents civil time (or occasionally physical time). [...]
GoogleTypeMoney
Represents an amount of money with its currency type.
GoogleTypePostalAddress
Represents a postal address, e.g. for postal delivery or payments addresses. [...]
GoogleTypeTimeZone
Represents a time zone from the IANA Time Zone Database.
OperationsResource
ProjectsLocationsOperationsResource
ProjectsLocationsProcessorsHumanReviewConfigResource
ProjectsLocationsProcessorsProcessorVersionsResource
ProjectsLocationsProcessorsResource
ProjectsLocationsResource
ProjectsOperationsResource
ProjectsResource
Uiv1beta3ProjectsLocationsOperationsResource
Uiv1beta3ProjectsLocationsResource
Uiv1beta3ProjectsResource
Uiv1beta3Resource

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.