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.
- GoogleCloudDocumentaiV1BatchDocumentsInputConfig
- The common config to specify a set of documents used as input.
- GoogleCloudDocumentaiV1BatchProcessRequest
- Request message for batch process document method.
- GoogleCloudDocumentaiV1BoundingPoly
- A bounding polygon for the detected image annotation.
- 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.
- 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.
- GoogleCloudDocumentaiV1DocumentPageFormField
- A form field detected on the page.
- GoogleCloudDocumentaiV1DocumentPageLayout
- Visual element describing a layout unit on a page.
- GoogleCloudDocumentaiV1DocumentPageLine
- A collection of tokens that a human would perceive as a line. [...]
- 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.
- GoogleCloudDocumentaiV1DocumentPageVisualElement
- Detected non-text visual elements e.g. checkbox, signature etc. [...]
- GoogleCloudDocumentaiV1DocumentProvenance
- Structure to identify provenance relationships between annotations in different revisions.
- GoogleCloudDocumentaiV1DocumentRevision
- Contains past or forward revisions of this document.
- GoogleCloudDocumentaiV1DocumentStyle
- Annotation for common text style attributes. [...]
- GoogleCloudDocumentaiV1DocumentTextAnchor
- Text reference indexing into the Document.text.
- GoogleCloudDocumentaiV1DocumentTextChange
- This message is used for text changes aka. [...]
- GoogleCloudDocumentaiV1EvaluationMetrics
- Evaluation metrics, either in aggregate or about a specific entity.
- GoogleCloudDocumentaiV1EvaluationReference
- Gives a short summary of an evaluation, and links to the evaluation itself.
- GoogleCloudDocumentaiV1FetchProcessorTypesResponse
- Response message for fetch processor types.
- 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.
- GoogleCloudDocumentaiV1ListProcessorsResponse
- Response message for list processors.
- GoogleCloudDocumentaiV1ListProcessorVersionsResponse
- Response message for list processors.
- GoogleCloudDocumentaiV1Processor
- The first-class citizen for DAI. [...]
- GoogleCloudDocumentaiV1ProcessorType
- A processor type is responsible for performing a certain document understanding task on a certain type of document. [...]
- GoogleCloudDocumentaiV1ProcessorTypeLocationInfo
- The location information about where the processor is available.
- GoogleCloudDocumentaiV1ProcessorVersion
- A processor version is an implementation of a processor. [...]
- GoogleCloudDocumentaiV1ProcessRequest
- Request message for the process document method.
- GoogleCloudDocumentaiV1ProcessResponse
- Response message for the process document method.
- GoogleCloudDocumentaiV1RawDocument
- Payload message of raw document content (bytes).
- GoogleCloudDocumentaiV1ReviewDocumentRequest
- Request message for review document method. [...]
- GoogleCloudDocumentaiV1Schema
- The schema defines the output of the processed document by a processor.
- GoogleCloudDocumentaiV1SchemaEntityType
- EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. [...]
- GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest
- Request message for the set default processor version method.
- GoogleCloudLocationListLocationsResponse
- The response message for Locations.ListLocations.
- GoogleLongrunningListOperationsResponse
- The response message for Operations.ListOperations.
- GoogleLongrunningOperation
- This resource represents a long-running operation that is the result of a network API call.
- GoogleTypeDateTime
- Represents civil time (or occasionally physical time). [...]
- OperationsResource
- ProjectsLocationsOperationsResource
- ProjectsLocationsProcessorsHumanReviewConfigResource
- ProjectsLocationsProcessorsProcessorVersionsResource
- ProjectsLocationsProcessorsResource
- ProjectsLocationsResource
- ProjectsOperationsResource
- ProjectsResource
- Uiv1beta3ProjectsLocationsOperationsResource
- Uiv1beta3ProjectsLocationsResource
- Uiv1beta3ProjectsResource
- Uiv1beta3Resource
Typedefs
- GoogleCloudDocumentaiV1DeployProcessorVersionRequest = $Empty
- Request message for the deploy processor version method.
- GoogleCloudDocumentaiV1DisableProcessorRequest = $Empty
- Request message for the disable processor method.
- GoogleCloudDocumentaiV1DocumentEntityRelation = $DocumentEntityRelation
- Relationship between Entities.
- GoogleCloudDocumentaiV1DocumentPageDetectedLanguage = $DetectedLanguage
- Detected language for a structural component.
- GoogleCloudDocumentaiV1DocumentPageDimension = $DocumentPageDimension
- Dimension for the page.
- GoogleCloudDocumentaiV1DocumentPageImage = $DocumentPageImage
- Rendered image contents for this page.
- GoogleCloudDocumentaiV1DocumentPageMatrix = $DocumentPageMatrix
- Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
- GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak = $DocumentPageTokenDetectedBreak
- Detected break at the end of a Token.
- GoogleCloudDocumentaiV1DocumentProvenanceParent = $DocumentProvenanceParent
- Structure for referencing parent provenances. [...]
- GoogleCloudDocumentaiV1DocumentRevisionHumanReview = $DocumentRevisionHumanReview
- Human Review information of the document.
- GoogleCloudDocumentaiV1DocumentShardInfo = $DocumentShardInfo
- For a large document, sharding may be performed to produce several document shards. [...]
- GoogleCloudDocumentaiV1DocumentStyleFontSize = $DocumentStyleFontSize
- Font size with unit.
- GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment = $DocumentTextAnchorTextSegment
- A text segment in the Document.text. [...]
- GoogleCloudDocumentaiV1EnableProcessorRequest = $Empty
- Request message for the enable processor method.
- GoogleCloudDocumentaiV1HumanReviewStatus = $HumanReviewStatus
- The status of human review on a processed document.
- GoogleCloudDocumentaiV1NormalizedVertex = $NormalizedVertex01
- A vertex represents a 2D point in the image. [...]
- GoogleCloudDocumentaiV1UndeployProcessorVersionRequest = $Empty
- Request message for the undeploy processor version method.
- GoogleCloudDocumentaiV1Vertex = $Vertex01
- A vertex represents a 2D point in the image. [...]
- GoogleCloudLocationLocation = $Location00
- A resource that represents Google Cloud Platform location.
- GoogleProtobufEmpty = $Empty
- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. [...]
- GoogleRpcStatus = $Status
-
The
Statustype defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. [...] - GoogleTypeColor = $Color
- Represents a color in the RGBA color space. [...]
- GoogleTypeDate = $Date
- Represents a whole or partial calendar date, such as a birthday. [...]
- GoogleTypeMoney = $Money
- Represents an amount of money with its currency type.
- GoogleTypePostalAddress = $PostalAddress
- Represents a postal address, e.g. for postal delivery or payments addresses. [...]
- GoogleTypeTimeZone = $TimeZone
- Represents a time zone from the IANA Time Zone Database.
Exceptions / Errors
- ApiRequestError
- Represents a general error reported by the API endpoint.
- DetailedApiRequestError
- Represents a specific error reported by the API endpoint.