Cloud Document AI v1beta3 API - Namespace Google.Cloud.DocumentAI.V1Beta3 (2.0.0-beta19)

Classes

Barcode

Encodes the detailed information of a barcode.

BatchDatasetDocuments

Dataset documents that the batch operation will be applied to.

BatchDatasetDocuments.Types

Container for nested types declared in the BatchDatasetDocuments message type.

BatchDatasetDocuments.Types.IndividualDocumentIds

List of individual DocumentIds.

BatchDeleteDocumentsMetadata.Types

Container for nested types declared in the BatchDeleteDocumentsMetadata message type.

BatchDeleteDocumentsMetadata.Types.IndividualBatchDeleteStatus

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

BatchDeleteDocumentsResponse

Response of the delete documents operation.

BatchDocumentsInputConfig

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

BatchProcessMetadata

The long-running operation metadata for [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments].

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 [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments].

BatchProcessRequest.Types

Container for nested types declared in the BatchProcessRequest message type.

BatchProcessRequest.Types.BatchInputConfig

The message for input config in batch process.

BatchProcessRequest.Types.BatchOutputConfig

The output configuration in the [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments] method.

BatchProcessResponse

Response message for [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments].

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.

Request message for the [CreateProcessor][google.cloud.documentai.v1beta3.DocumentProcessorService.CreateProcessor] method. Notice this request is sent to a regionalized backend service. If the [ProcessorType][google.cloud.documentai.v1beta3.ProcessorType] isn't available in that region, the creation fails.

Dataset

A singleton resource under a [Processor][google.cloud.documentai.v1beta3.Processor] which configures a collection of documents.

Dataset.Types

Container for nested types declared in the Dataset message type.

Dataset.Types.DocumentWarehouseConfig

Configuration specific to the Document AI Warehouse-based implementation.

Dataset.Types.GCSManagedConfig

Configuration specific to the Cloud Storage-based implementation.

Dataset.Types.SpannerIndexingConfig

Configuration specific to spanner-based indexing.

Dataset.Types.UnmanagedDatasetConfig

Configuration specific to an unmanaged dataset.

DatasetName

Resource name for the Dataset resource.

DatasetSchema

Dataset Schema.

DatasetSchemaName

Resource name for the DatasetSchema resource.

DeleteProcessorMetadata

The long-running operation metadata for the [DeleteProcessor][google.cloud.documentai.v1beta3.DocumentProcessorService.DeleteProcessor] method.

DeleteProcessorRequest

Request message for the [DeleteProcessor][google.cloud.documentai.v1beta3.DocumentProcessorService.DeleteProcessor] method.

DeleteProcessorVersionMetadata

The long-running operation metadata for the [DeleteProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.DeleteProcessorVersion] method.

DeleteProcessorVersionRequest

Request message for the [DeleteProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.DeleteProcessorVersion] method.

DeployProcessorVersionMetadata

The long-running operation metadata for the [DeployProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.DeployProcessorVersion] method.

DeployProcessorVersionRequest

Request message for the [DeployProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.DeployProcessorVersion] method.

DeployProcessorVersionResponse

Response message for the [DeployProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.DeployProcessorVersion] method.

DisableProcessorMetadata

The long-running operation metadata for the [DisableProcessor][google.cloud.documentai.v1beta3.DocumentProcessorService.DisableProcessor] method.

DisableProcessorRequest

Request message for the [DisableProcessor][google.cloud.documentai.v1beta3.DocumentProcessorService.DisableProcessor] method.

DisableProcessorResponse

Response message for the [DisableProcessor][google.cloud.documentai.v1beta3.DocumentProcessorService.DisableProcessor] 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.ChunkedDocument

Represents the chunks that the document is divided into.

Document.Types.ChunkedDocument.Types

Container for nested types declared in the ChunkedDocument message type.

Document.Types.ChunkedDocument.Types.Chunk

Represents a chunk.

Document.Types.ChunkedDocument.Types.Chunk.Types

Container for nested types declared in the Chunk message type.

Document.Types.ChunkedDocument.Types.Chunk.Types.ChunkPageFooter

Represents the page footer associated with the chunk.

Document.Types.ChunkedDocument.Types.Chunk.Types.ChunkPageHeader

Represents the page header associated with the chunk.

Document.Types.ChunkedDocument.Types.Chunk.Types.ChunkPageSpan

Represents where the chunk starts and ends in the document.

Document.Types.DocumentLayout

Represents the parsed layout of a document as a collection of blocks that the document is divided into.

Document.Types.DocumentLayout.Types

Container for nested types declared in the DocumentLayout message type.

Document.Types.DocumentLayout.Types.DocumentLayoutBlock

Represents a block. A block could be one of the various types (text, table, list) supported.

Document.Types.DocumentLayout.Types.DocumentLayoutBlock.Types

Container for nested types declared in the DocumentLayoutBlock message type.

Document.Types.DocumentLayout.Types.DocumentLayoutBlock.Types.LayoutListBlock

Represents a list type block.

Document.Types.DocumentLayout.Types.DocumentLayoutBlock.Types.LayoutListEntry

Represents an entry in the list.

Document.Types.DocumentLayout.Types.DocumentLayoutBlock.Types.LayoutPageSpan

Represents where the block starts and ends in the document.

Document.Types.DocumentLayout.Types.DocumentLayoutBlock.Types.LayoutTableBlock

Represents a table type block.

Document.Types.DocumentLayout.Types.DocumentLayoutBlock.Types.LayoutTableCell

Represents a cell in a table row.

Document.Types.DocumentLayout.Types.DocumentLayoutBlock.Types.LayoutTableRow

Represents a row in a table.

Document.Types.DocumentLayout.Types.DocumentLayoutBlock.Types.LayoutTextBlock

Represents a text type block.

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.v1beta3.Document.Entity].

Document.Types.Page

A page in a [Document][google.cloud.documentai.v1beta3.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.v1beta3.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.Token.Types.StyleInfo

Font and other text style attributes.

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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.Document.ShardInfo.text_offset]

Document.Types.TextChange

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

DocumentId

Document Identifier.

DocumentId.Types

Container for nested types declared in the DocumentId message type.

DocumentId.Types.GCSManagedDocumentId

Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.

DocumentId.Types.UnmanagedDocumentId

Identifies a document uniquely within the scope of a dataset in unmanaged option.

DocumentMetadata

Metadata about a document.

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.

DocumentPageRange

Range of pages present in a document.

DocumentProcessorService

Service to call Document AI to process documents according to the processor's definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents.

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.

DocumentService

Service to call Cloud DocumentAI to manage document collection (dataset).

DocumentService.DocumentServiceBase

Base class for server-side implementations of DocumentService

DocumentService.DocumentServiceClient

Client for DocumentService

DocumentServiceClient

DocumentService client wrapper, for convenient use.

DocumentServiceClientBuilder

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

DocumentServiceClientImpl

DocumentService client wrapper implementation, for convenient use.

DocumentServiceSettings

Settings for DocumentServiceClient instances.

EnableProcessorMetadata

The long-running operation metadata for the [EnableProcessor][google.cloud.documentai.v1beta3.DocumentProcessorService.EnableProcessor] method.

EnableProcessorRequest

Request message for the [EnableProcessor][google.cloud.documentai.v1beta3.DocumentProcessorService.EnableProcessor] method.

EnableProcessorResponse

Response message for the [EnableProcessor][google.cloud.documentai.v1beta3.DocumentProcessorService.EnableProcessor] method. Intentionally empty proto for adding fields in future.

EntityTypeMetadata

Metadata about an entity type.

EvaluateProcessorVersionMetadata

Metadata of the [EvaluateProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.EvaluateProcessorVersion] method.

EvaluateProcessorVersionRequest

Evaluates the given [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion] against the supplied documents.

EvaluateProcessorVersionResponse

Response of the [EvaluateProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.EvaluateProcessorVersion] method.

Evaluation

An evaluation of a ProcessorVersion's performance.

Evaluation.Types

Container for nested types declared in the Evaluation message type.

Evaluation.Types.ConfidenceLevelMetrics

Evaluations metrics, at a specific confidence level.

Evaluation.Types.Counters

Evaluation counters for the documents that were used.

Evaluation.Types.Metrics

Evaluation metrics, either in aggregate or about a specific entity.

Evaluation.Types.MultiConfidenceMetrics

Metrics across multiple confidence levels.

Evaluation.Types.MultiConfidenceMetrics.Types

Container for nested types declared in the MultiConfidenceMetrics message type.

EvaluationName

Resource name for the Evaluation resource.

EvaluationReference

Gives a short summary of an evaluation, and links to the evaluation itself.

FetchProcessorTypesRequest

Request message for the [FetchProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.FetchProcessorTypes] method. Some processor types may require the project be added to an allowlist.

FetchProcessorTypesResponse

Response message for the [FetchProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.FetchProcessorTypes] method.

FieldExtractionMetadata

Metadata for how this field value is extracted.

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.

GetDatasetSchemaRequest

Request for GetDatasetSchema.

GetDocumentRequest

GetDocumentResponse

GetEvaluationRequest

Retrieves a specific Evaluation.

GetProcessorRequest

Request message for the [GetProcessor][google.cloud.documentai.v1beta3.DocumentProcessorService.GetProcessor] method.

GetProcessorTypeRequest

Request message for the [GetProcessorType][google.cloud.documentai.v1beta3.DocumentProcessorService.GetProcessorType] method.

GetProcessorVersionRequest

Request message for the [GetProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.GetProcessorVersion] method.

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.

ImportDocumentsMetadata

Metadata of the import document operation.

ImportDocumentsMetadata.Types

Container for nested types declared in the ImportDocumentsMetadata message type.

ImportDocumentsMetadata.Types.ImportConfigValidationResult

The validation status of each import config. Status is set to an error if there are no documents to import in the import_config, or OK if the operation will try to proceed with at least one document.

ImportDocumentsMetadata.Types.IndividualImportStatus

The status of each individual document in the import process.

ImportDocumentsRequest

ImportDocumentsRequest.Types

Container for nested types declared in the ImportDocumentsRequest message type.

ImportDocumentsRequest.Types.BatchDocumentsImportConfig

Config for importing documents. Each batch can have its own dataset split type.

ImportDocumentsRequest.Types.BatchDocumentsImportConfig.Types

Container for nested types declared in the BatchDocumentsImportConfig message type.

ImportDocumentsRequest.Types.BatchDocumentsImportConfig.Types.AutoSplitConfig

The config for auto-split.

ImportDocumentsResponse

Response of the import document operation.

ImportProcessorVersionMetadata

The long-running operation metadata for the [ImportProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.ImportProcessorVersion] method.

ImportProcessorVersionRequest

The request message for the [ImportProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.ImportProcessorVersion] method.

The Document AI Service Agent of the destination project must have Document AI Editor role on the source project.

The destination project is specified as part of the [parent][google.cloud.documentai.v1beta3.ImportProcessorVersionRequest.parent] field. The source project is specified as part of the [source][google.cloud.documentai.v1beta3.ImportProcessorVersionRequest.processor_version_source] or [external_processor_version_source][google.cloud.documentai.v1beta3.ImportProcessorVersionRequest.external_processor_version_source] field.

ImportProcessorVersionRequest.Types

Container for nested types declared in the ImportProcessorVersionRequest message type.

ImportProcessorVersionRequest.Types.ExternalProcessorVersionSource

The external source processor version.

ImportProcessorVersionResponse

The response message for the [ImportProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.ImportProcessorVersion] method.

ListDocumentsRequest

ListDocumentsResponse

ListEvaluationsRequest

Retrieves a list of evaluations for a given [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion].

ListEvaluationsResponse

The response from ListEvaluations.

ListProcessorTypesRequest

Request message for the [ListProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.ListProcessorTypes] method. Some processor types may require the project be added to an allowlist.

ListProcessorTypesResponse

Response message for the [ListProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.ListProcessorTypes] method.

ListProcessorVersionsRequest

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

ListProcessorVersionsResponse

Response message for the [ListProcessorVersions][google.cloud.documentai.v1beta3.DocumentProcessorService.ListProcessorVersions] method.

ListProcessorsRequest

Request message for list all processors belongs to a project.

ListProcessorsResponse

Response message for the [ListProcessors][google.cloud.documentai.v1beta3.DocumentProcessorService.ListProcessors] method.

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.

OcrConfig

Config for Document OCR.

OcrConfig.Types

Container for nested types declared in the OcrConfig message type.

OcrConfig.Types.Hints

Hints for OCR Engine

OcrConfig.Types.PremiumFeatures

Configurations for premium OCR features.

ProcessOptions

Options for Process API

ProcessOptions.Types

Container for nested types declared in the ProcessOptions message type.

ProcessOptions.Types.IndividualPageSelector

A list of individual page numbers.

ProcessOptions.Types.LayoutConfig

Serving config for layout parser processor.

ProcessOptions.Types.LayoutConfig.Types

Container for nested types declared in the LayoutConfig message type.

ProcessOptions.Types.LayoutConfig.Types.ChunkingConfig

Serving config for chunking.

ProcessRequest

Request message for the [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument] method.

ProcessResponse

Response message for the [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument] method.

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, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that 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.

ProcessorVersionAlias

Contains the alias and the aliased resource name of processor version.

ProcessorVersionName

Resource name for the ProcessorVersion resource.

PropertyMetadata

Metadata about a property.

RawDocument

Payload message of raw document content (bytes).

ReviewDocumentOperationMetadata

The long-running operation metadata for the [ReviewDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ReviewDocument] method.

ReviewDocumentOperationMetadata.Types

Container for nested types declared in the ReviewDocumentOperationMetadata message type.

ReviewDocumentRequest

Request message for the [ReviewDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ReviewDocument] method.

ReviewDocumentRequest.Types

Container for nested types declared in the ReviewDocumentRequest message type.

ReviewDocumentResponse

Response message for the [ReviewDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ReviewDocument] method.

ReviewDocumentResponse.Types

Container for nested types declared in the ReviewDocumentResponse message type.

RevisionRef

The revision reference specifies which revision on the document to read.

RevisionRef.Types

Container for nested types declared in the RevisionRef message type.

SchemaName

Resource name for the Schema resource.

SetDefaultProcessorVersionMetadata

The long-running operation metadata for the [SetDefaultProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.SetDefaultProcessorVersion] method.

SetDefaultProcessorVersionRequest

Request message for the [SetDefaultProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.SetDefaultProcessorVersion] method.

SetDefaultProcessorVersionResponse

Response message for the [SetDefaultProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.SetDefaultProcessorVersion] method.

SummaryOptions

Metadata for document summarization.

SummaryOptions.Types

Container for nested types declared in the SummaryOptions message type.

TrainProcessorVersionMetadata

The metadata that represents a processor version being created.

TrainProcessorVersionMetadata.Types

Container for nested types declared in the TrainProcessorVersionMetadata message type.

TrainProcessorVersionMetadata.Types.DatasetValidation

The dataset validation information. This includes any and all errors with documents and the dataset.

TrainProcessorVersionRequest

Request message for the [TrainProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.TrainProcessorVersion] method.

TrainProcessorVersionRequest.Types

Container for nested types declared in the TrainProcessorVersionRequest message type.

TrainProcessorVersionRequest.Types.CustomDocumentExtractionOptions

Options to control the training of the Custom Document Extraction (CDE) Processor.

TrainProcessorVersionRequest.Types.CustomDocumentExtractionOptions.Types

Container for nested types declared in the CustomDocumentExtractionOptions message type.

TrainProcessorVersionRequest.Types.FoundationModelTuningOptions

Options to control foundation model tuning of the processor.

TrainProcessorVersionRequest.Types.InputData

The input data used to train a new [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion].

TrainProcessorVersionResponse

The response for [TrainProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.TrainProcessorVersion].

UndeployProcessorVersionMetadata

The long-running operation metadata for the [UndeployProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.UndeployProcessorVersion] method.

UndeployProcessorVersionRequest

Request message for the [UndeployProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.UndeployProcessorVersion] method.

UndeployProcessorVersionResponse

Response message for the [UndeployProcessorVersion][google.cloud.documentai.v1beta3.DocumentProcessorService.UndeployProcessorVersion] method.

UpdateDatasetOperationMetadata

UpdateDatasetRequest

UpdateDatasetSchemaRequest

Request for UpdateDatasetSchema.

Vertex

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

Enums

BatchDatasetDocuments.CriteriaOneofCase

Enum of possible cases for the "criteria" oneof.

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.

Dataset.IndexingSourceOneofCase

Enum of possible cases for the "indexing_source" oneof.

Dataset.StorageSourceOneofCase

Enum of possible cases for the "storage_source" oneof.

Dataset.Types.State

Different states of a dataset.

DatasetName.ResourceNameType

The possible contents of DatasetName.

DatasetSchemaName.ResourceNameType

The possible contents of DatasetSchemaName.

DatasetSplitType

Documents belonging to a dataset will be split into different groups referred to as splits: train, test.

Document.SourceOneofCase

Enum of possible cases for the "source" oneof.

Document.Types.DocumentLayout.Types.DocumentLayoutBlock.BlockOneofCase

Enum of possible cases for the "block" 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.

DocumentId.TypeOneofCase

Enum of possible cases for the "type" oneof.

DocumentLabelingState

Describes the labeling status of a document.

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. This represents the number of instances, not mentions, of an entity. For example, a bank statement might only have one account_number, but this account number can be mentioned in several places on the document. In this case, the account_number is considered a REQUIRED_ONCE entity type. If, on the other hand, we expect a bank statement to contain the status of multiple different accounts for the customers, the occurrence type is set to REQUIRED_MULTIPLE.