Cloud Document AI v1 API - Namespace Google.Cloud.DocumentAI.V1 (3.5.0)

Stay organized with collections Save and categorize content based on your preferences.

Classes

Barcode

Encodes the detailed information of a barcode.

BatchDocumentsInputConfig

The common config to specify a set of documents used as input.

BatchProcessMetadata

The long running operation metadata for batch process method.

BatchProcessMetadata.Types

Container for nested types declared in the BatchProcessMetadata message type.

BatchProcessMetadata.Types.IndividualProcessStatus

The status of a each individual document in the batch process.

BatchProcessRequest

Request message for batch process document method.

BatchProcessResponse

Response message for batch process document method.

BoundingPoly

A bounding polygon for the detected image annotation.

CommonOperationMetadata

The common metadata for long running operations.

CommonOperationMetadata.Types

Container for nested types declared in the CommonOperationMetadata message type.

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.

DeleteProcessorMetadata

The long running operation metadata for delete processor method.

DeleteProcessorRequest

Request message for the delete processor method.

DeleteProcessorVersionMetadata

The long running operation metadata for delete processor version method.

DeleteProcessorVersionRequest

Request message for the delete processor version method.

DeployProcessorVersionMetadata

The long running operation metadata for deploy processor version method.

DeployProcessorVersionRequest

Request message for the deploy processor version method.

DeployProcessorVersionResponse

Response message for the deploy processor version method.

DisableProcessorMetadata

The long running operation metadata for disable processor method.

DisableProcessorRequest

Request message for the disable processor method.

DisableProcessorResponse

Response message for the disable processor method. Intentionally empty proto for adding fields in future.

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.

Document.Types

Container for nested types declared in the Document message type.

Document.Types.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.

Document.Types.Entity.Types

Container for nested types declared in the Entity message type.

Document.Types.Entity.Types.NormalizedValue

Parsed and normalized entity value.

Document.Types.EntityRelation

Relationship between [Entities][google.cloud.documentai.v1.Document.Entity].

Document.Types.Page

A page in a [Document][google.cloud.documentai.v1.Document].

Document.Types.Page.Types

Container for nested types declared in the Page message type.

Document.Types.Page.Types.Block

A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

Document.Types.Page.Types.DetectedBarcode

A detected barcode.

Document.Types.Page.Types.DetectedLanguage

Detected language for a structural component.

Document.Types.Page.Types.Dimension

Dimension for the page.

Document.Types.Page.Types.FormField

A form field detected on the page.

Document.Types.Page.Types.Image

Rendered image contents for this page.

Document.Types.Page.Types.ImageQualityScores

Image Quality Scores for the page image

Document.Types.Page.Types.ImageQualityScores.Types

Container for nested types declared in the ImageQualityScores message type.

Document.Types.Page.Types.ImageQualityScores.Types.DetectedDefect

Image Quality Defects

Document.Types.Page.Types.Layout

Visual element describing a layout unit on a page.

Document.Types.Page.Types.Layout.Types

Container for nested types declared in the Layout message type.

Document.Types.Page.Types.Line

A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.

Document.Types.Page.Types.Matrix

Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.

Document.Types.Page.Types.Paragraph

A collection of lines that a human would perceive as a paragraph.

Document.Types.Page.Types.Symbol

A detected symbol.

Document.Types.Page.Types.Table

A table representation similar to HTML table structure.

Document.Types.Page.Types.Table.Types

Container for nested types declared in the Table message type.

Document.Types.Page.Types.Table.Types.TableCell

A cell representation inside the table.

Document.Types.Page.Types.Table.Types.TableRow

A row of table cells.

Document.Types.Page.Types.Token

A detected token.

Document.Types.Page.Types.Token.Types

Container for nested types declared in the Token message type.

Document.Types.Page.Types.Token.Types.DetectedBreak

Detected break at the end of a [Token][google.cloud.documentai.v1.Document.Page.Token].

Document.Types.Page.Types.Token.Types.DetectedBreak.Types

Container for nested types declared in the DetectedBreak message type.

Document.Types.Page.Types.VisualElement

Detected non-text visual elements e.g. checkbox, signature etc. on the page.

Document.Types.PageAnchor

Referencing the visual context of the entity in the [Document.pages][google.cloud.documentai.v1.Document.pages]. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.

Document.Types.PageAnchor.Types

Container for nested types declared in the PageAnchor message type.

Document.Types.PageAnchor.Types.PageRef

Represents a weak reference to a page element within a document.

Document.Types.PageAnchor.Types.PageRef.Types

Container for nested types declared in the PageRef message type.

Document.Types.Provenance

Structure to identify provenance relationships between annotations in different revisions.

Document.Types.Provenance.Types

Container for nested types declared in the Provenance message type.

Document.Types.Provenance.Types.Parent

The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.

Document.Types.Revision

Contains past or forward revisions of this document.

Document.Types.Revision.Types

Container for nested types declared in the Revision message type.

Document.Types.Revision.Types.HumanReview

Human Review information of the document.

Document.Types.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.

Document.Types.Style

Annotation for common text style attributes. This adheres to CSS conventions as much as possible.

Document.Types.Style.Types

Container for nested types declared in the Style message type.

Document.Types.Style.Types.FontSize

Font size with unit.

Document.Types.TextAnchor

Text reference indexing into the [Document.text][google.cloud.documentai.v1.Document.text].

Document.Types.TextAnchor.Types

Container for nested types declared in the TextAnchor message type.

Document.Types.TextAnchor.Types.TextSegment

A text segment in the [Document.text][google.cloud.documentai.v1.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][google.cloud.documentai.v1.Document.ShardInfo.text_offset]

Document.Types.TextChange

This message is used for text changes aka. OCR corrections.

DocumentOutputConfig

Config that controls the output of documents. All documents will be written as a JSON file.

DocumentOutputConfig.Types

Container for nested types declared in the DocumentOutputConfig message type.

DocumentOutputConfig.Types.GcsOutputConfig

The configuration used when outputting documents.

DocumentOutputConfig.Types.GcsOutputConfig.Types

Container for nested types declared in the GcsOutputConfig message type.

DocumentOutputConfig.Types.GcsOutputConfig.Types.ShardingConfig

The sharding config for the output document.

DocumentProcessorService

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.

DocumentProcessorService.DocumentProcessorServiceBase

Base class for server-side implementations of DocumentProcessorService

DocumentProcessorService.DocumentProcessorServiceClient

Client for DocumentProcessorService

DocumentProcessorServiceClient

DocumentProcessorService client wrapper, for convenient use.

DocumentProcessorServiceClientBuilder

Builder class for DocumentProcessorServiceClient to provide simple configuration of credentials, endpoint etc.

DocumentProcessorServiceClientImpl

DocumentProcessorService client wrapper implementation, for convenient use.

DocumentProcessorServiceSettings

Settings for DocumentProcessorServiceClient instances.

DocumentSchema

The schema defines the output of the processed document by a processor.

DocumentSchema.Types

Container for nested types declared in the DocumentSchema message type.

DocumentSchema.Types.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.

DocumentSchema.Types.EntityType.Types

Container for nested types declared in the EntityType message type.

DocumentSchema.Types.EntityType.Types.EnumValues

Defines the a list of enum values.

DocumentSchema.Types.EntityType.Types.Property

Defines properties that can be part of the entity type.

DocumentSchema.Types.EntityType.Types.Property.Types

Container for nested types declared in the Property message type.

DocumentSchema.Types.Metadata

Metadata for global schema behavior.

EnableProcessorMetadata

The long running operation metadata for enable processor method.

EnableProcessorRequest

Request message for the enable processor method.

EnableProcessorResponse

Response message for the enable processor method. Intentionally empty proto for adding fields in future.

FetchProcessorTypesRequest

Request message for fetch processor types.

FetchProcessorTypesResponse

Response message for fetch processor types.

GcsDocument

Specifies a document stored on Cloud Storage.

GcsDocuments

Specifies a set of documents on Cloud Storage.

GcsPrefix

Specifies all documents on Cloud Storage with a common prefix.

GetProcessorRequest

Request message for get processor.

GetProcessorTypeRequest

Request message for get processor.

GetProcessorVersionRequest

Request message for get processor version.

HumanReviewConfigName

Resource name for the HumanReviewConfig resource.

HumanReviewStatus

The status of human review on a processed document.

HumanReviewStatus.Types

Container for nested types declared in the HumanReviewStatus message type.

ListProcessorsRequest

Request message for list all processors belongs to a project.

ListProcessorsResponse

Response message for list processors.

ListProcessorTypesRequest

Request message for list processor types.

ListProcessorTypesResponse

Response message for list processor types.

ListProcessorVersionsRequest

Request message for list all processor versions belongs to a processor.

ListProcessorVersionsResponse

Response message for list processors.

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.

Processor

The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.

Processor.Types

Container for nested types declared in the Processor message type.

ProcessorName

Resource name for the Processor resource.

ProcessorType

A processor type is responsible for performing a certain document understanding task on a certain type of document.

ProcessorType.Types

Container for nested types declared in the ProcessorType message type.

ProcessorType.Types.LocationInfo

The location information about where the processor is available.

ProcessorTypeName

Resource name for the ProcessorType resource.

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

ProcessorVersion.Types

Container for nested types declared in the ProcessorVersion message type.

ProcessorVersion.Types.DeprecationInfo

Information about the upcoming deprecation of this processor version.

ProcessorVersionName

Resource name for the ProcessorVersion resource.

ProcessRequest

Request message for the process document method.

ProcessResponse

Response message for the process document method.

RawDocument

Payload message of raw document content (bytes).

ReviewDocumentOperationMetadata

The long running operation metadata for review document method.

ReviewDocumentRequest

Request message for review document method.

ReviewDocumentRequest.Types

Container for nested types declared in the ReviewDocumentRequest message type.

ReviewDocumentResponse

Response message for review document method.

ReviewDocumentResponse.Types

Container for nested types declared in the ReviewDocumentResponse message type.

SetDefaultProcessorVersionMetadata

The long running operation metadata for set default processor version method.

SetDefaultProcessorVersionRequest

Request message for the set default processor version method.

SetDefaultProcessorVersionResponse

Response message for set default processor version method.

UndeployProcessorVersionMetadata

The long running operation metadata for the undeploy processor version method.

UndeployProcessorVersionRequest

Request message for the undeploy processor version method.

UndeployProcessorVersionResponse

Response message for the undeploy processor version method.

Vertex

A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

Enums

BatchDocumentsInputConfig.SourceOneofCase

Enum of possible cases for the "source" oneof.

BatchProcessMetadata.Types.State

Possible states of the batch processing operation.

CommonOperationMetadata.Types.State

State of the longrunning operation.

Document.SourceOneofCase

Enum of possible cases for the "source" oneof.

Document.Types.Entity.Types.NormalizedValue.StructuredValueOneofCase

Enum of possible cases for the "structured_value" oneof.

Document.Types.Page.Types.Layout.Types.Orientation

Detected human reading orientation.

Document.Types.Page.Types.Token.Types.DetectedBreak.Types.Type

Enum to denote the type of break found.

Document.Types.PageAnchor.Types.PageRef.Types.LayoutType

The type of layout that is being referenced.

Document.Types.Provenance.Types.OperationType

If a processor or agent does an explicit operation on existing elements.

Document.Types.Revision.SourceOneofCase

Enum of possible cases for the "source" oneof.

DocumentOutputConfig.DestinationOneofCase

Enum of possible cases for the "destination" oneof.

DocumentSchema.Types.EntityType.Types.Property.Types.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.

DocumentSchema.Types.EntityType.ValueSourceOneofCase

Enum of possible cases for the "value_source" oneof.

HumanReviewConfigName.ResourceNameType

The possible contents of HumanReviewConfigName.

HumanReviewStatus.Types.State

The final state of human review on a processed document.

Processor.Types.State

The possible states of the processor.

ProcessorName.ResourceNameType

The possible contents of ProcessorName.

ProcessorTypeName.ResourceNameType

The possible contents of ProcessorTypeName.

ProcessorVersion.Types.State

The possible states of the processor version.

ProcessorVersionName.ResourceNameType

The possible contents of ProcessorVersionName.

ProcessRequest.SourceOneofCase

Enum of possible cases for the "source" oneof.

ReviewDocumentRequest.SourceOneofCase

Enum of possible cases for the "source" oneof.

ReviewDocumentRequest.Types.Priority

The priority level of the human review task.

ReviewDocumentResponse.Types.State

Possible states of the review operation.