Namespace Google.Apis.Document.v1beta3.Data
Classes
CloudAiDocumentaiLabHifiaToolsValidationValidatorInput
Definition of the validation rules. Those are the input to the validator logic and they are used to validate a document. Next ID: 3
CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule
Next ID: 9
CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule
A rule for checking field alignment. Horizontal alignment checks if fields are on the same row by comparing y-coordinates of bounding box centers, while vertical alignment checks if fields are on the same column by comparing x-coordinates of bounding box centers.
CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule
A rule that aligns specified child fields with a parent field.
CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant
The constant value used in the validation rules.
CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule
A rule that aligns specified fields with each other.
CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField
CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences
CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegex
CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation
CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidationOperation
GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata
Metadata of the auto-labeling documents operation.
GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus
The status of individual documents in the auto-labeling process.
GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse
The response proto of AutoLabelDocuments method.
GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata
GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus
The status of each individual document in the batch delete process.
GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse
Response of the delete documents operation.
GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata
GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus
The status of each individual document in the batch move process.
GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse
Response of the batch move documents operation.
GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata
GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus
The status of each individual document in the batch update process.
GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse
Response of the batch update documents operation.
GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata
The common metadata for long running operations.
GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata
The long-running operation metadata for the CreateLabelerPool method.
GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata
The long-running operation metadata for DeleteLabelerPool.
GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata
The long-running operation metadata for the DeleteProcessor method.
GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata
The long-running operation metadata for the DeleteProcessorVersion method.
GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata
The long-running operation metadata for the DeployProcessorVersion method.
GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse
Response message for the DeployProcessorVersion method.
GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata
The long-running operation metadata for the DisableProcessor method.
GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse
Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.
GoogleCloudDocumentaiUiv1beta3DocumentId
Document Identifier.
GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId
Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.
GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId
Identifies a document uniquely within the scope of a dataset in unmanaged option.
GoogleCloudDocumentaiUiv1beta3DocumentSchema
The schema defines the output of the processed document by a processor.
GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType
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.
GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues
Defines the a list of enum values.
GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty
Defines properties that can be part of the entity type.
GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata
Metadata for global schema behavior.
GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata
The long-running operation metadata for the EnableProcessor method.
GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse
Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.
GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata
Metadata about an entity type.
GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata
Metadata of the EvaluateProcessorVersion method.
GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse
Response of the EvaluateProcessorVersion method.
GoogleCloudDocumentaiUiv1beta3EvaluationMetrics
Evaluation metrics, either in aggregate or about a specific entity.
GoogleCloudDocumentaiUiv1beta3EvaluationReference
Gives a short summary of an evaluation, and links to the evaluation itself.
GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata
Metadata of the batch export documents operation.
GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus
The status of each individual document in the export process.
GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat
The statistic representing a dataset split type for this export.
GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse
The response proto of ExportDocuments method.
GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata
Metadata message associated with the ExportProcessorVersion operation.
GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse
Response message associated with the ExportProcessorVersion operation.
GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata
Metadata for how this field value is extracted.
GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery
Message for entity query.
GoogleCloudDocumentaiUiv1beta3FieldTierMetadata
Metadata for the field tier of a property.
GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata
Metadata for human review labeling config.
GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata
Metadata for Human Review config.
GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata
Metadata of the import document operation.
GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult
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.
GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus
The status of each individual document in the import process.
GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse
Response of the import document operation.
GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata
The long-running operation metadata for the ImportProcessorVersion method.
GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse
The response message for the ImportProcessorVersion method.
GoogleCloudDocumentaiUiv1beta3Processor
The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
GoogleCloudDocumentaiUiv1beta3ProcessorVersion
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.
GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias
Contains the alias and the aliased resource name of processor version.
GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo
Information about the upcoming deprecation of this processor version.
GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo
Information about Generative AI model-based processor versions.
GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo
Information for a custom Generative AI model created by the user. These are created with Create New Version in
either the Call foundation model or Fine tuning tabs.
GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo
Information for a pretrained Google-managed foundation model.
GoogleCloudDocumentaiUiv1beta3PropertyMetadata
Metadata about a property.
GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata
The metadata proto of ResyncDataset method.
GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus
Resync status against inconsistency types on the dataset level.
GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus
Resync status for each document per inconsistency type.
GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse
The response proto of ResyncDataset method.
GoogleCloudDocumentaiUiv1beta3RevisionRef
The revision reference specifies which revision on the document to read.
GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata
Metadata of the sample documents operation.
GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse
Response of the sample documents operation.
GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument
GoogleCloudDocumentaiUiv1beta3Schema
The schema defines the output of the processed document by a processor.
GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata
Metadata that specifies whether a label is editable and reasons why. These fields are read-only. Changing these fields has no impact on the backend.
GoogleCloudDocumentaiUiv1beta3SchemaEntityType
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.
GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata
Metadata for schema inference. Only used on dataset.schema for schema inference, can be safely ignored elsewhere.
GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata
The long-running operation metadata for the SetDefaultProcessorVersion method.
GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse
Response message for the SetDefaultProcessorVersion method.
GoogleCloudDocumentaiUiv1beta3SummaryOptions
Metadata for document summarization.
GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata
The metadata that represents a processor version being created.
GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation
The dataset validation information. This includes any and all errors with documents and the dataset.
GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse
The response for TrainProcessorVersion.
GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata
The long-running operation metadata for the UndeployProcessorVersion method.
GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse
Response message for the UndeployProcessorVersion method.
GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata
GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata
The long-running operation metadata for updating the human review configuration.
GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata
The long-running operation metadata for UpdateLabelerPool.
GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata
The long-running operation metadata for the UpdateProcessorVersion method.
GoogleCloudDocumentaiV1BatchProcessMetadata
The long-running operation metadata for BatchProcessDocuments.
GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus
The status of a each individual document in the batch process.
GoogleCloudDocumentaiV1BatchProcessResponse
Response message for BatchProcessDocuments.
GoogleCloudDocumentaiV1CommonOperationMetadata
The common metadata for long running operations.
GoogleCloudDocumentaiV1DeleteProcessorMetadata
The long-running operation metadata for the DeleteProcessor method.
GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata
The long-running operation metadata for the DeleteProcessorVersion method.
GoogleCloudDocumentaiV1DeployProcessorVersionMetadata
The long-running operation metadata for the DeployProcessorVersion method.
GoogleCloudDocumentaiV1DeployProcessorVersionResponse
Response message for the DeployProcessorVersion method.
GoogleCloudDocumentaiV1DisableProcessorMetadata
The long-running operation metadata for the DisableProcessor method.
GoogleCloudDocumentaiV1DisableProcessorResponse
Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.
GoogleCloudDocumentaiV1EnableProcessorMetadata
The long-running operation metadata for the EnableProcessor method.
GoogleCloudDocumentaiV1EnableProcessorResponse
Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.
GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata
Metadata of the EvaluateProcessorVersion method.
GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse
Response of the EvaluateProcessorVersion method.
GoogleCloudDocumentaiV1HumanReviewStatus
The status of human review on a processed document.
GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata
The long-running operation metadata for the ReviewDocument method.
GoogleCloudDocumentaiV1ReviewDocumentResponse
Response message for the ReviewDocument method.
GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata
The long-running operation metadata for the SetDefaultProcessorVersion method.
GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse
Response message for the SetDefaultProcessorVersion method.
GoogleCloudDocumentaiV1TrainProcessorVersionMetadata
The metadata that represents a processor version being created.
GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation
The dataset validation information. This includes any and all errors with documents and the dataset.
GoogleCloudDocumentaiV1TrainProcessorVersionResponse
The response for TrainProcessorVersion.
GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata
The long-running operation metadata for the UndeployProcessorVersion method.
GoogleCloudDocumentaiV1UndeployProcessorVersionResponse
Response message for the UndeployProcessorVersion method.
GoogleCloudDocumentaiV1beta3Barcode
Encodes the detailed information of a barcode.
GoogleCloudDocumentaiV1beta3BatchDatasetDocuments
Dataset documents that the batch operation will be applied to.
GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds
List of individual DocumentIds.
GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata
GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus
The status of each individual document in the batch delete process.
GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest
GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse
Response of the delete documents operation.
GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig
The common config to specify a set of documents used as input.
GoogleCloudDocumentaiV1beta3BatchProcessMetadata
The long-running operation metadata for BatchProcessDocuments.
GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus
The status of a each individual document in the batch process.
GoogleCloudDocumentaiV1beta3BatchProcessRequest
Request message for BatchProcessDocuments.
GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig
The message for input config in batch process.
GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig
The output configuration in the BatchProcessDocuments method.
GoogleCloudDocumentaiV1beta3BatchProcessResponse
Response message for BatchProcessDocuments.
GoogleCloudDocumentaiV1beta3BoundingPoly
A bounding polygon for the detected image annotation.
GoogleCloudDocumentaiV1beta3CommonOperationMetadata
The common metadata for long running operations.
GoogleCloudDocumentaiV1beta3Dataset
A singleton resource under a Processor which configures a collection of documents.
GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig
Configuration specific to the Document AI Warehouse-based implementation.
GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig
Configuration specific to the Cloud Storage-based implementation.
GoogleCloudDocumentaiV1beta3DatasetSchema
Dataset Schema.
GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig
Configuration specific to spanner-based indexing.
GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig
Configuration specific to an unmanaged dataset.
GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata
The long-running operation metadata for the DeleteProcessor method.
GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata
The long-running operation metadata for the DeleteProcessorVersion method.
GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata
The long-running operation metadata for the DeployProcessorVersion method.
GoogleCloudDocumentaiV1beta3DeployProcessorVersionRequest
Request message for the DeployProcessorVersion method.
GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse
Response message for the DeployProcessorVersion method.
GoogleCloudDocumentaiV1beta3DisableProcessorMetadata
The long-running operation metadata for the DisableProcessor method.
GoogleCloudDocumentaiV1beta3DisableProcessorRequest
Request message for the DisableProcessor method.
GoogleCloudDocumentaiV1beta3DisableProcessorResponse
Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.
GoogleCloudDocumentaiV1beta3Document
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.
GoogleCloudDocumentaiV1beta3DocumentAnnotations
Represents the annotation of a block or a chunk.
GoogleCloudDocumentaiV1beta3DocumentBlobAsset
Represents a blob asset. It's used to store the content of the inline blob in this document, e.g. image bytes, such that it can be referenced by other fields in the document via asset id.
GoogleCloudDocumentaiV1beta3DocumentChunkedDocument
Represents the chunks that the document is divided into.
GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunk
Represents a chunk.
GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkField
The chunk field in the chunk. A chunk field could be one of the various types (e.g. image, table) supported.
GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageFooter
Represents the page footer associated with the chunk.
GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageHeader
Represents the page header associated with the chunk.
GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageSpan
Represents where the chunk starts and ends in the document.
GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkImageChunkField
The image chunk field in the chunk.
GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkTableChunkField
The table chunk field in the chunk.
GoogleCloudDocumentaiV1beta3DocumentDocumentLayout
Represents the parsed layout of a document as a collection of blocks that the document is divided into.
GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock
Represents a block. A block could be one of the various types (text, table, list) supported.
GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock
Represents an image type block.
GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock
Represents a list type block.
GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry
Represents an entry in the list.
GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan
Represents where the block starts and ends in the document.
GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock
Represents a table type block.
GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell
Represents a cell in a table row.
GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow
Represents a row in a table.
GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock
Represents a text type block.
GoogleCloudDocumentaiV1beta3DocumentEntitiesRevision
Entity revision.
GoogleCloudDocumentaiV1beta3DocumentEntity
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.
GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue
Parsed and normalized entity value.
GoogleCloudDocumentaiV1beta3DocumentEntityRelation
Relationship between Entities.
GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutput
The output of the validation given the document and the validation rules.
GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult
Validation result for a single validation rule.
GoogleCloudDocumentaiV1beta3DocumentId
Document Identifier.
GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId
Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.
GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId
Identifies a document uniquely within the scope of a dataset in unmanaged option.
GoogleCloudDocumentaiV1beta3DocumentMetadata
Metadata about a document.
GoogleCloudDocumentaiV1beta3DocumentOutputConfig
Config that controls the output of documents. All documents will be written as a JSON file.
GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig
The configuration used when outputting documents.
GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig
The sharding config for the output document.
GoogleCloudDocumentaiV1beta3DocumentPage
A page in a Document.
GoogleCloudDocumentaiV1beta3DocumentPageAnchor
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.
GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef
Represents a weak reference to a page element within a document.
GoogleCloudDocumentaiV1beta3DocumentPageBlock
A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
GoogleCloudDocumentaiV1beta3DocumentPageDetectedBarcode
A detected barcode.
GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage
Detected language for a structural component.
GoogleCloudDocumentaiV1beta3DocumentPageDimension
Dimension for the page.
GoogleCloudDocumentaiV1beta3DocumentPageFormField
A form field detected on the page.
GoogleCloudDocumentaiV1beta3DocumentPageImage
Rendered image contents for this page.
GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScores
Image quality scores for the page image.
GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScoresDetectedDefect
Image Quality Defects
GoogleCloudDocumentaiV1beta3DocumentPageLayout
Visual element describing a layout unit on a page.
GoogleCloudDocumentaiV1beta3DocumentPageLine
A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
GoogleCloudDocumentaiV1beta3DocumentPageMatrix
Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
GoogleCloudDocumentaiV1beta3DocumentPageParagraph
A collection of lines that a human would perceive as a paragraph.
GoogleCloudDocumentaiV1beta3DocumentPageSymbol
A detected symbol.
GoogleCloudDocumentaiV1beta3DocumentPageTable
A table representation similar to HTML table structure.
GoogleCloudDocumentaiV1beta3DocumentPageTableTableCell
A cell representation inside the table.
GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow
A row of table cells.
GoogleCloudDocumentaiV1beta3DocumentPageToken
A detected token.
GoogleCloudDocumentaiV1beta3DocumentPageTokenDetectedBreak
Detected break at the end of a Token.
GoogleCloudDocumentaiV1beta3DocumentPageTokenStyleInfo
Font and other text style attributes.
GoogleCloudDocumentaiV1beta3DocumentPageVisualElement
Detected non-text visual elements e.g. checkbox, signature etc. on the page.
GoogleCloudDocumentaiV1beta3DocumentProvenance
Structure to identify provenance relationships between annotations in different revisions.
GoogleCloudDocumentaiV1beta3DocumentProvenanceParent
The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
GoogleCloudDocumentaiV1beta3DocumentRevision
Contains past or forward revisions of this document.
GoogleCloudDocumentaiV1beta3DocumentRevisionHumanReview
Human Review information of the document.
GoogleCloudDocumentaiV1beta3DocumentSchema
The schema defines the output of the processed document by a processor.
GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType
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.
GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues
Defines the a list of enum values.
GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty
Defines properties that can be part of the entity type.
GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata
Metadata for global schema behavior.
GoogleCloudDocumentaiV1beta3DocumentShardInfo
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.
GoogleCloudDocumentaiV1beta3DocumentStyle
Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
GoogleCloudDocumentaiV1beta3DocumentStyleFontSize
Font size with unit.
GoogleCloudDocumentaiV1beta3DocumentTextAnchor
Text reference indexing into the Document.text.
GoogleCloudDocumentaiV1beta3DocumentTextAnchorTextSegment
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
GoogleCloudDocumentaiV1beta3DocumentTextChange
This message is used for text changes aka. OCR corrections.
GoogleCloudDocumentaiV1beta3Documents
A set of inline documents.
GoogleCloudDocumentaiV1beta3EnableProcessorMetadata
The long-running operation metadata for the EnableProcessor method.
GoogleCloudDocumentaiV1beta3EnableProcessorRequest
Request message for the EnableProcessor method.
GoogleCloudDocumentaiV1beta3EnableProcessorResponse
Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.
GoogleCloudDocumentaiV1beta3EntityTypeMetadata
Metadata about an entity type.
GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata
Metadata of the EvaluateProcessorVersion method.
GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionRequest
Evaluates the given ProcessorVersion against the supplied documents.
GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse
Response of the EvaluateProcessorVersion method.
GoogleCloudDocumentaiV1beta3Evaluation
An evaluation of a ProcessorVersion's performance.
GoogleCloudDocumentaiV1beta3EvaluationConfidenceLevelMetrics
Evaluations metrics, at a specific confidence level.
GoogleCloudDocumentaiV1beta3EvaluationCounters
Evaluation counters for the documents that were used.
GoogleCloudDocumentaiV1beta3EvaluationMetrics
Evaluation metrics, either in aggregate or about a specific entity.
GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics
Metrics across multiple confidence levels.
GoogleCloudDocumentaiV1beta3EvaluationReference
Gives a short summary of an evaluation, and links to the evaluation itself.
GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse
Response message for the FetchProcessorTypes method.
GoogleCloudDocumentaiV1beta3FieldExtractionMetadata
Metadata for how this field value is extracted.
GoogleCloudDocumentaiV1beta3GcsDocument
Specifies a document stored on Cloud Storage.
GoogleCloudDocumentaiV1beta3GcsDocuments
Specifies a set of documents on Cloud Storage.
GoogleCloudDocumentaiV1beta3GcsPrefix
Specifies all documents on Cloud Storage with a common prefix.
GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest
Request message for GenerateSchemaVersion.
GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams
The parameters for the schema generation.
GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse
Response message for GenerateSchemaVersion.
GoogleCloudDocumentaiV1beta3GetDocumentResponse
GoogleCloudDocumentaiV1beta3HumanReviewStatus
The status of human review on a processed document.
GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata
Metadata of the import document operation.
GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult
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.
GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus
The status of each individual document in the import process.
GoogleCloudDocumentaiV1beta3ImportDocumentsRequest
GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig
Config for importing documents. Each batch can have its own dataset split type.
GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig
The config for auto-split.
GoogleCloudDocumentaiV1beta3ImportDocumentsResponse
Response of the import document operation.
GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata
The long-running operation metadata for the ImportProcessorVersion method.
GoogleCloudDocumentaiV1beta3ImportProcessorVersionRequest
The request message for the 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 field. The source project is specified as part of the source or external_processor_version_source field.
GoogleCloudDocumentaiV1beta3ImportProcessorVersionRequestExternalProcessorVersionSource
The external source processor version.
GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse
The response message for the ImportProcessorVersion method.
GoogleCloudDocumentaiV1beta3ListDocumentsRequest
GoogleCloudDocumentaiV1beta3ListDocumentsResponse
GoogleCloudDocumentaiV1beta3ListEvaluationsResponse
The response from ListEvaluations.
GoogleCloudDocumentaiV1beta3ListProcessorTypesResponse
Response message for the ListProcessorTypes method.
GoogleCloudDocumentaiV1beta3ListProcessorVersionsResponse
Response message for the ListProcessorVersions method.
GoogleCloudDocumentaiV1beta3ListProcessorsResponse
Response message for the ListProcessors method.
GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse
Response message for ListSchemaVersions.
GoogleCloudDocumentaiV1beta3ListSchemasResponse
Response message for ListSchemas.
GoogleCloudDocumentaiV1beta3NextSchema
NextSchema is a collection of SchemaVersions.
GoogleCloudDocumentaiV1beta3NormalizedVertex
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.
GoogleCloudDocumentaiV1beta3OcrConfig
Config for Document OCR.
GoogleCloudDocumentaiV1beta3OcrConfigHints
Hints for OCR Engine
GoogleCloudDocumentaiV1beta3OcrConfigPremiumFeatures
Configurations for premium OCR features.
GoogleCloudDocumentaiV1beta3ProcessOptions
Options for Process API
GoogleCloudDocumentaiV1beta3ProcessOptionsIndividualPageSelector
A list of individual page numbers.
GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfig
Serving config for layout parser processor.
GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfigChunkingConfig
Serving config for chunking.
GoogleCloudDocumentaiV1beta3ProcessRequest
Request message for the ProcessDocument method.
GoogleCloudDocumentaiV1beta3ProcessResponse
Response message for the ProcessDocument method.
GoogleCloudDocumentaiV1beta3Processor
The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
GoogleCloudDocumentaiV1beta3ProcessorType
A processor type is responsible for performing a certain document understanding task on a certain type of document.
GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo
The location information about where the processor is available.
GoogleCloudDocumentaiV1beta3ProcessorVersion
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.
GoogleCloudDocumentaiV1beta3ProcessorVersionAlias
Contains the alias and the aliased resource name of processor version.
GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo
Information about the upcoming deprecation of this processor version.
GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo
Information about Generative AI model-based processor versions.
GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo
Information for a custom Generative AI model created by the user. These are created with Create New Version in
either the Call foundation model or Fine tuning tabs.
GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo
Information for a pretrained Google-managed foundation model.
GoogleCloudDocumentaiV1beta3PropertyMetadata
Metadata about a property.
GoogleCloudDocumentaiV1beta3RawDocument
Payload message of raw document content (bytes).
GoogleCloudDocumentaiV1beta3RawDocuments
Specifies a set of raw documents.
GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata
The long-running operation metadata for the ReviewDocument method.
GoogleCloudDocumentaiV1beta3ReviewDocumentRequest
Request message for the ReviewDocument method.
GoogleCloudDocumentaiV1beta3ReviewDocumentResponse
Response message for the ReviewDocument method.
GoogleCloudDocumentaiV1beta3RevisionRef
The revision reference specifies which revision on the document to read.
GoogleCloudDocumentaiV1beta3SchemaGenerationHistory
The history of schema generation iterations.
GoogleCloudDocumentaiV1beta3SchemaGenerationIteration
A single iteration of the schema generation.
GoogleCloudDocumentaiV1beta3SchemaVersion
SchemaVersion is a version of the Schema which is created in SchemaGroup.
GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata
The long-running operation metadata for the SetDefaultProcessorVersion method.
GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionRequest
Request message for the SetDefaultProcessorVersion method.
GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse
Response message for the SetDefaultProcessorVersion method.
GoogleCloudDocumentaiV1beta3SummaryOptions
Metadata for document summarization.
GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata
The metadata that represents a processor version being created.
GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation
The dataset validation information. This includes any and all errors with documents and the dataset.
GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequest
Request message for the TrainProcessorVersion method.
GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestCustomDocumentExtractionOptions
Options to control the training of the Custom Document Extraction (CDE) Processor.
GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestFoundationModelTuningOptions
Options to control foundation model tuning of the processor.
GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestInputData
The input data used to train a new ProcessorVersion.
GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse
The response for TrainProcessorVersion.
GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata
The long-running operation metadata for the UndeployProcessorVersion method.
GoogleCloudDocumentaiV1beta3UndeployProcessorVersionRequest
Request message for the UndeployProcessorVersion method.
GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse
Response message for the UndeployProcessorVersion method.
GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata
GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata
The long-running operation metadata for the UpdateProcessorVersion method.
GoogleCloudDocumentaiV1beta3Vertex
A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
GoogleCloudLocationListLocationsResponse
The response message for Locations.ListLocations.
GoogleCloudLocationLocation
A resource that represents a Google Cloud 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. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
GoogleRpcStatus
The Status type defines a logical error model that is suitable for different programming environments,
including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains
three pieces of data: error code, error message, and error details. You can find out more about this error model
and how to work with it in the API Design Guide.
GoogleTypeColor
Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and
from color representations in various languages over compactness. For example, the fields of this representation
can be trivially provided to the constructor of java.awt.Color in Java; it can also be trivially provided to
UIColor's +colorWithRed:green:blue:alpha method in iOS; and, with just a little work, it can be easily
formatted into a CSS rgba() string in JavaScript. This reference page doesn't have information about the
absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and
BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided,
implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha
values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static
java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ?
protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(),
protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float)
color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator
= 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green /
denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha(
FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); }
// ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor
red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor
alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor
colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red,
green, blue, alpha; if (![color getRed:&red green:&green blue:&blue
alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result
setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result
setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): //
... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac =
rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green =
Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return
rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green,
blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red,
green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var
hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var
i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return
resultBuilder.join(''); }; // ...
GoogleTypeDate
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
GoogleTypeDateTime
Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few
possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular
offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular
time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The
date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered
not to have a specific year, month, or day respectively. This type may also be used to represent a physical time
if all the date and time fields are set and either case of the time_offset oneof is set. Consider using
Timestamp message for physical time instead. If your use case also would like to store the user's timezone,
that can be done in another field. This type is more flexible than some applications may want. Make sure to
document and validate your application's limitations.
GoogleTypeMoney
Represents an amount of money with its currency type.
GoogleTypePostalAddress
Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.
GoogleTypeTimeZone
Represents a time zone from the IANA Time Zone Database.