{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
},
"basePath": "",
"baseUrl": "https://documentai.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Document",
"description": "Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/document-ai/docs/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "documentai:v1beta2",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://documentai.mtls.googleapis.com/",
"name": "documentai",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"documents": {
"methods": {
"batchProcess": {
"description": "LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.",
"flatPath": "v1beta2/projects/{projectsId}/documents:batchProcess",
"httpMethod": "POST",
"id": "documentai.projects.documents.batchProcess",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta2/{+parent}/documents:batchProcess",
"request": {
"$ref": "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"process": {
"description": "Processes a single document.",
"flatPath": "v1beta2/projects/{projectsId}/documents:process",
"httpMethod": "POST",
"id": "documentai.projects.documents.process",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. This field is only populated when used in ProcessDocument method.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta2/{+parent}/documents:process",
"request": {
"$ref": "GoogleCloudDocumentaiV1beta2ProcessDocumentRequest"
},
"response": {
"$ref": "GoogleCloudDocumentaiV1beta2Document"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"locations": {
"resources": {
"documents": {
"methods": {
"batchProcess": {
"description": "LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/documents:batchProcess",
"httpMethod": "POST",
"id": "documentai.projects.locations.documents.batchProcess",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta2/{+parent}/documents:batchProcess",
"request": {
"$ref": "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"process": {
"description": "Processes a single document.",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/documents:process",
"httpMethod": "POST",
"id": "documentai.projects.locations.documents.process",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. This field is only populated when used in ProcessDocument method.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta2/{+parent}/documents:process",
"request": {
"$ref": "GoogleCloudDocumentaiV1beta2ProcessDocumentRequest"
},
"response": {
"$ref": "GoogleCloudDocumentaiV1beta2Document"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "documentai.projects.locations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta2/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta2/projects/{projectsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "documentai.projects.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta2/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
},
"revision": "20240703",
"rootUrl": "https://documentai.googleapis.com/",
"schemas": {
"GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": {
"description": "Metadata of the auto-labeling documents operation.",
"id": "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"individualAutoLabelStatuses": {
"description": "The list of individual auto-labeling statuses of the dataset documents.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus"
},
"type": "array"
},
"totalDocumentCount": {
"description": "Total number of the auto-labeling documents.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus": {
"description": "The status of individual documents in the auto-labeling process.",
"id": "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus",
"properties": {
"documentId": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
"description": "The document id of the auto-labeled document. This will replace the gcs_uri."
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of the document auto-labeling."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse": {
"description": "The response proto of AutoLabelDocuments method.",
"id": "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata": {
"id": "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"errorDocumentCount": {
"description": "Total number of documents that failed to be deleted in storage.",
"format": "int32",
"type": "integer"
},
"individualBatchDeleteStatuses": {
"description": "The list of response details of each document.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus"
},
"type": "array"
},
"totalDocumentCount": {
"description": "Total number of documents deleting from dataset.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus": {
"description": "The status of each individual document in the batch delete process.",
"id": "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus",
"properties": {
"documentId": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
"description": "The document id of the document."
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of deleting the document in storage."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse": {
"description": "Response of the delete documents operation.",
"id": "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata": {
"id": "GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"destDatasetType": {
"deprecated": true,
"description": "The destination dataset split type.",
"enum": [
"DATASET_SPLIT_TYPE_UNSPECIFIED",
"DATASET_SPLIT_TRAIN",
"DATASET_SPLIT_TEST",
"DATASET_SPLIT_UNASSIGNED"
],
"enumDescriptions": [
"Default value if the enum is not set.",
"Identifies the train documents.",
"Identifies the test documents.",
"Identifies the unassigned documents."
],
"type": "string"
},
"destSplitType": {
"description": "The destination dataset split type.",
"enum": [
"DATASET_SPLIT_TYPE_UNSPECIFIED",
"DATASET_SPLIT_TRAIN",
"DATASET_SPLIT_TEST",
"DATASET_SPLIT_UNASSIGNED"
],
"enumDescriptions": [
"Default value if the enum is not set.",
"Identifies the train documents.",
"Identifies the test documents.",
"Identifies the unassigned documents."
],
"type": "string"
},
"individualBatchMoveStatuses": {
"description": "The list of response details of each document.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus": {
"description": "The status of each individual document in the batch move process.",
"id": "GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus",
"properties": {
"documentId": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
"description": "The document id of the document."
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of moving the document."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse": {
"description": "Response of the batch move documents operation.",
"id": "GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata": {
"id": "GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"individualBatchUpdateStatuses": {
"description": "The list of response details of each document.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus": {
"description": "The status of each individual document in the batch update process.",
"id": "GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus",
"properties": {
"documentId": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
"description": "The document id of the document."
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of updating the document in storage."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse": {
"description": "Response of the batch update documents operation.",
"id": "GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata": {
"description": "The common metadata for long running operations.",
"id": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"properties": {
"createTime": {
"description": "The creation time of the operation.",
"format": "google-datetime",
"type": "string"
},
"resource": {
"description": "A related resource to this operation.",
"type": "string"
},
"state": {
"description": "The state of the operation.",
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",
"CANCELLING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
],
"enumDescriptions": [
"Unspecified state.",
"Operation is still running.",
"Operation is being cancelled.",
"Operation succeeded.",
"Operation failed.",
"Operation is cancelled."
],
"type": "string"
},
"stateMessage": {
"description": "A message providing more details about the current state of processing.",
"type": "string"
},
"updateTime": {
"description": "The last update time of the operation.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata": {
"description": "The long-running operation metadata for the CreateLabelerPool method.",
"id": "GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata": {
"description": "The long-running operation metadata for DeleteLabelerPool.",
"id": "GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata": {
"description": "The long-running operation metadata for the DeleteProcessor method.",
"id": "GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata": {
"description": "The long-running operation metadata for the DeleteProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata": {
"description": "The long-running operation metadata for the DeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse": {
"description": "Response message for the DeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata": {
"description": "The long-running operation metadata for the DisableProcessor method.",
"id": "GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse": {
"description": "Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.",
"id": "GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DocumentId": {
"description": "Document Identifier.",
"id": "GoogleCloudDocumentaiUiv1beta3DocumentId",
"properties": {
"gcsManagedDocId": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId",
"description": "A document id within user-managed Cloud Storage."
},
"revisionRef": {
"$ref": "GoogleCloudDocumentaiUiv1beta3RevisionRef",
"description": "Points to a specific revision of the document if set."
},
"unmanagedDocId": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId",
"description": "A document id within unmanaged dataset."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId": {
"description": "Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.",
"id": "GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId",
"properties": {
"cwDocId": {
"deprecated": true,
"description": "Id of the document (indexed) managed by Content Warehouse.",
"type": "string"
},
"gcsUri": {
"description": "Required. The Cloud Storage URI where the actual document is stored.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId": {
"description": "Identifies a document uniquely within the scope of a dataset in unmanaged option.",
"id": "GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId",
"properties": {
"docId": {
"description": "Required. The id of the document.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata": {
"description": "The long-running operation metadata for the EnableProcessor method.",
"id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse": {
"description": "Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.",
"id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata": {
"description": "Metadata of the EvaluateProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse": {
"description": "Response of the EvaluateProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse",
"properties": {
"evaluation": {
"description": "The resource name of the created evaluation.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata": {
"description": "Metadata of the batch export documents operation.",
"id": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"individualExportStatuses": {
"description": "The list of response details of each document.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus"
},
"type": "array"
},
"splitExportStats": {
"description": "The list of statistics for each dataset split type.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus": {
"description": "The status of each individual document in the export process.",
"id": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus",
"properties": {
"documentId": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
"description": "The path to source docproto of the document."
},
"outputGcsDestination": {
"description": "The output_gcs_destination of the exported document if it was successful, otherwise empty.",
"type": "string"
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of the exporting of the document."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat": {
"description": "The statistic representing a dataset split type for this export.",
"id": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat",
"properties": {
"splitType": {
"description": "The dataset split type.",
"enum": [
"DATASET_SPLIT_TYPE_UNSPECIFIED",
"DATASET_SPLIT_TRAIN",
"DATASET_SPLIT_TEST",
"DATASET_SPLIT_UNASSIGNED"
],
"enumDescriptions": [
"Default value if the enum is not set.",
"Identifies the train documents.",
"Identifies the test documents.",
"Identifies the unassigned documents."
],
"type": "string"
},
"totalDocumentCount": {
"description": "Total number of documents with the given dataset split type to be exported.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse": {
"description": "The response proto of ExportDocuments method.",
"id": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata": {
"description": "Metadata message associated with the ExportProcessorVersion operation.",
"id": "GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The common metadata about the operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse": {
"description": "Response message associated with the ExportProcessorVersion operation.",
"id": "GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse",
"properties": {
"gcsUri": {
"description": "The Cloud Storage URI containing the output artifacts.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata": {
"description": "Metadata of the import document operation.",
"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"importConfigValidationResults": {
"description": "Validation statuses of the batch documents import config.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult"
},
"type": "array"
},
"individualImportStatuses": {
"description": "The list of response details of each document.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus"
},
"type": "array"
},
"totalDocumentCount": {
"description": "Total number of the documents that are qualified for importing.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult": {
"description": "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.",
"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult",
"properties": {
"inputGcsSource": {
"description": "The source Cloud Storage URI specified in the import config.",
"type": "string"
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The validation status of import config."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus": {
"description": "The status of each individual document in the import process.",
"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus",
"properties": {
"inputGcsSource": {
"description": "The source Cloud Storage URI of the document.",
"type": "string"
},
"outputDocumentId": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
"description": "The document id of imported document if it was successful, otherwise empty."
},
"outputGcsDestination": {
"description": "The output_gcs_destination of the processed document if it was successful, otherwise empty.",
"type": "string"
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of the importing of the document."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse": {
"description": "Response of the import document operation.",
"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata": {
"description": "The long-running operation metadata for the ImportProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata for the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse": {
"description": "The response message for the ImportProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse",
"properties": {
"processorVersion": {
"description": "The destination processor version name.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata": {
"description": "The metadata proto of `ResyncDataset` method.",
"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"datasetResyncStatuses": {
"description": "The list of dataset resync statuses. Not checked when ResyncDatasetRequest.dataset_documents is specified.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus"
},
"type": "array"
},
"individualDocumentResyncStatuses": {
"description": "The list of document resync statuses. The same document could have multiple `individual_document_resync_statuses` if it has multiple inconsistencies.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus": {
"description": "Resync status against inconsistency types on the dataset level.",
"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus",
"properties": {
"datasetInconsistencyType": {
"description": "The type of the inconsistency of the dataset.",
"enum": [
"DATASET_INCONSISTENCY_TYPE_UNSPECIFIED",
"DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER"
],
"enumDescriptions": [
"Default value.",
"The marker file under the dataset folder is not found."
],
"type": "string"
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of resyncing the dataset with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus": {
"description": "Resync status for each document per inconsistency type.",
"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus",
"properties": {
"documentId": {
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
"description": "The document identifier."
},
"documentInconsistencyType": {
"description": "The type of document inconsistency.",
"enum": [
"DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED",
"DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO",
"DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA",
"DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE"
],
"enumDescriptions": [
"Default value.",
"The document proto is invalid.",
"Indexed docproto metadata is mismatched.",
"The page image or thumbnails are missing."
],
"type": "string"
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of resyncing the document with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse": {
"description": "The response proto of ResyncDataset method.",
"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3RevisionRef": {
"description": "The revision reference specifies which revision on the document to read.",
"id": "GoogleCloudDocumentaiUiv1beta3RevisionRef",
"properties": {
"latestProcessorVersion": {
"description": "Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`",
"type": "string"
},
"revisionCase": {
"description": "Reads the revision by the predefined case.",
"enum": [
"REVISION_CASE_UNSPECIFIED",
"LATEST_HUMAN_REVIEW",
"LATEST_TIMESTAMP",
"BASE_OCR_REVISION"
],
"enumDescriptions": [
"Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`.",
"The latest revision made by a human.",
"The latest revision based on timestamp.",
"The first (OCR) revision."
],
"type": "string"
},
"revisionId": {
"description": "Reads the revision given by the id.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata": {
"description": "Metadata of the sample documents operation.",
"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse": {
"description": "Response of the sample documents operation.",
"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse",
"properties": {
"sampleTestStatus": {
"$ref": "GoogleRpcStatus",
"description": "The status of sampling documents in test split."
},
"sampleTrainingStatus": {
"$ref": "GoogleRpcStatus",
"description": "The status of sampling documents in training split."
},
"selectedDocuments": {
"description": "The result of the sampling process.",
"items": {
"$ref": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument": {
"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument",
"properties": {
"documentId": {
"description": "An internal identifier for document.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata": {
"description": "The long-running operation metadata for the SetDefaultProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse": {
"description": "Response message for the SetDefaultProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata": {
"description": "The metadata that represents a processor version being created.",
"id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"testDatasetValidation": {
"$ref": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation",
"description": "The test dataset validation information."
},
"trainingDatasetValidation": {
"$ref": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation",
"description": "The training dataset validation information."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation": {
"description": "The dataset validation information. This includes any and all errors with documents and the dataset.",
"id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation",
"properties": {
"datasetErrorCount": {
"description": "The total number of dataset errors.",
"format": "int32",
"type": "integer"
},
"datasetErrors": {
"description": "Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"documentErrorCount": {
"description": "The total number of document errors.",
"format": "int32",
"type": "integer"
},
"documentErrors": {
"description": "Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse": {
"description": "The response for TrainProcessorVersion.",
"id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse",
"properties": {
"processorVersion": {
"description": "The resource name of the processor version produced by training.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata": {
"description": "The long-running operation metadata for the UndeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse": {
"description": "Response message for the UndeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata": {
"id": "GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata": {
"description": "The long-running operation metadata for updating the human review configuration.",
"id": "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata": {
"description": "The long-running operation metadata for UpdateLabelerPool.",
"id": "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1BatchProcessMetadata": {
"description": "The long-running operation metadata for BatchProcessDocuments.",
"id": "GoogleCloudDocumentaiV1BatchProcessMetadata",
"properties": {
"createTime": {
"description": "The creation time of the operation.",
"format": "google-datetime",
"type": "string"
},
"individualProcessStatuses": {
"description": "The list of response details of each document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus"
},
"type": "array"
},
"state": {
"description": "The state of the current batch processing.",
"enum": [
"STATE_UNSPECIFIED",
"WAITING",
"RUNNING",
"SUCCEEDED",
"CANCELLING",
"CANCELLED",
"FAILED"
],
"enumDescriptions": [
"The default value. This value is used if the state is omitted.",
"Request operation is waiting for scheduling.",
"Request is being processed.",
"The batch processing completed successfully.",
"The batch processing was being cancelled.",
"The batch processing was cancelled.",
"The batch processing has failed."
],
"type": "string"
},
"stateMessage": {
"description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed.",
"type": "string"
},
"updateTime": {
"description": "The last update time of the operation.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus": {
"description": "The status of a each individual document in the batch process.",
"id": "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus",
"properties": {
"humanReviewStatus": {
"$ref": "GoogleCloudDocumentaiV1HumanReviewStatus",
"description": "The status of human review on the processed document."
},
"inputGcsSource": {
"description": "The source of the document, same as the input_gcs_source field in the request when the batch process started.",
"type": "string"
},
"outputGcsDestination": {
"description": "The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty.",
"type": "string"
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status processing the document."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1BatchProcessResponse": {
"description": "Response message for BatchProcessDocuments.",
"id": "GoogleCloudDocumentaiV1BatchProcessResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1CommonOperationMetadata": {
"description": "The common metadata for long running operations.",
"id": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"properties": {
"createTime": {
"description": "The creation time of the operation.",
"format": "google-datetime",
"type": "string"
},
"resource": {
"description": "A related resource to this operation.",
"type": "string"
},
"state": {
"description": "The state of the operation.",
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",
"CANCELLING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
],
"enumDescriptions": [
"Unspecified state.",
"Operation is still running.",
"Operation is being cancelled.",
"Operation succeeded.",
"Operation failed.",
"Operation is cancelled."
],
"type": "string"
},
"stateMessage": {
"description": "A message providing more details about the current state of processing.",
"type": "string"
},
"updateTime": {
"description": "The last update time of the operation.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DeleteProcessorMetadata": {
"description": "The long-running operation metadata for the DeleteProcessor method.",
"id": "GoogleCloudDocumentaiV1DeleteProcessorMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata": {
"description": "The long-running operation metadata for the DeleteProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DeployProcessorVersionMetadata": {
"description": "The long-running operation metadata for the DeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1DeployProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DeployProcessorVersionResponse": {
"description": "Response message for the DeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1DeployProcessorVersionResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1DisableProcessorMetadata": {
"description": "The long-running operation metadata for the DisableProcessor method.",
"id": "GoogleCloudDocumentaiV1DisableProcessorMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1DisableProcessorResponse": {
"description": "Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.",
"id": "GoogleCloudDocumentaiV1DisableProcessorResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1EnableProcessorMetadata": {
"description": "The long-running operation metadata for the EnableProcessor method.",
"id": "GoogleCloudDocumentaiV1EnableProcessorMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1EnableProcessorResponse": {
"description": "Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.",
"id": "GoogleCloudDocumentaiV1EnableProcessorResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata": {
"description": "Metadata of the EvaluateProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse": {
"description": "Response of the EvaluateProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse",
"properties": {
"evaluation": {
"description": "The resource name of the created evaluation.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1HumanReviewStatus": {
"description": "The status of human review on a processed document.",
"id": "GoogleCloudDocumentaiV1HumanReviewStatus",
"properties": {
"humanReviewOperation": {
"description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.",
"type": "string"
},
"state": {
"description": "The state of human review on the processing request.",
"enum": [
"STATE_UNSPECIFIED",
"SKIPPED",
"VALIDATION_PASSED",
"IN_PROGRESS",
"ERROR"
],
"enumDescriptions": [
"Human review state is unspecified. Most likely due to an internal error.",
"Human review is skipped for the document. This can happen because human review isn't enabled on the processor or the processing request has been set to skip this document.",
"Human review validation is triggered and passed, so no review is needed.",
"Human review validation is triggered and the document is under review.",
"Some error happened during triggering human review, see the state_message for details."
],
"type": "string"
},
"stateMessage": {
"description": "A message providing more details about the human review state.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata": {
"description": "The long-running operation metadata for the ReviewDocument method.",
"id": "GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"questionId": {
"description": "The Crowd Compute question ID.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1ReviewDocumentResponse": {
"description": "Response message for the ReviewDocument method.",
"id": "GoogleCloudDocumentaiV1ReviewDocumentResponse",
"properties": {
"gcsDestination": {
"description": "The Cloud Storage uri for the human reviewed document if the review is succeeded.",
"type": "string"
},
"rejectionReason": {
"description": "The reason why the review is rejected by reviewer.",
"type": "string"
},
"state": {
"description": "The state of the review operation.",
"enum": [
"STATE_UNSPECIFIED",
"REJECTED",
"SUCCEEDED"
],
"enumDescriptions": [
"The default value. This value is used if the state is omitted.",
"The review operation is rejected by the reviewer.",
"The review operation is succeeded."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata": {
"description": "The long-running operation metadata for the SetDefaultProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse": {
"description": "Response message for the SetDefaultProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1TrainProcessorVersionMetadata": {
"description": "The metadata that represents a processor version being created.",
"id": "GoogleCloudDocumentaiV1TrainProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"testDatasetValidation": {
"$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation",
"description": "The test dataset validation information."
},
"trainingDatasetValidation": {
"$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation",
"description": "The training dataset validation information."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation": {
"description": "The dataset validation information. This includes any and all errors with documents and the dataset.",
"id": "GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation",
"properties": {
"datasetErrorCount": {
"description": "The total number of dataset errors.",
"format": "int32",
"type": "integer"
},
"datasetErrors": {
"description": "Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"documentErrorCount": {
"description": "The total number of document errors.",
"format": "int32",
"type": "integer"
},
"documentErrors": {
"description": "Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1TrainProcessorVersionResponse": {
"description": "The response for TrainProcessorVersion.",
"id": "GoogleCloudDocumentaiV1TrainProcessorVersionResponse",
"properties": {
"processorVersion": {
"description": "The resource name of the processor version produced by training.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata": {
"description": "The long-running operation metadata for the UndeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1UndeployProcessorVersionResponse": {
"description": "Response message for the UndeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1UndeployProcessorVersionResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1Barcode": {
"description": "Encodes the detailed information of a barcode.",
"id": "GoogleCloudDocumentaiV1beta1Barcode",
"properties": {
"format": {
"description": "Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type.",
"type": "string"
},
"rawValue": {
"description": "Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.",
"type": "string"
},
"valueFormat": {
"description": "Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse": {
"description": "Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.",
"id": "GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse",
"properties": {
"responses": {
"description": "Responses for each individual document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1ProcessDocumentResponse"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1BoundingPoly": {
"description": "A bounding polygon for the detected image annotation.",
"id": "GoogleCloudDocumentaiV1beta1BoundingPoly",
"properties": {
"normalizedVertices": {
"description": "The bounding polygon normalized vertices.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1NormalizedVertex"
},
"type": "array"
},
"vertices": {
"description": "The bounding polygon vertices.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1Vertex"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1Document": {
"description": "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.",
"id": "GoogleCloudDocumentaiV1beta1Document",
"properties": {
"chunkedDocument": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocument",
"description": "Document chunked based on chunking config."
},
"content": {
"description": "Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.",
"format": "byte",
"type": "string"
},
"documentLayout": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayout",
"description": "Parsed layout of the document."
},
"entities": {
"description": "A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentEntity"
},
"type": "array"
},
"entityRelations": {
"description": "Placeholder. Relationship among Document.entities.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentEntityRelation"
},
"type": "array"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "Any error that occurred while processing this document."
},
"mimeType": {
"description": "An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).",
"type": "string"
},
"pages": {
"description": "Visual page layout for the Document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPage"
},
"type": "array"
},
"revisions": {
"description": "Placeholder. Revision history of this document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentRevision"
},
"type": "array"
},
"shardInfo": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentShardInfo",
"description": "Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified."
},
"text": {
"description": "Optional. UTF-8 encoded text in reading order from the document.",
"type": "string"
},
"textChanges": {
"description": "Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentTextChange"
},
"type": "array"
},
"textStyles": {
"deprecated": true,
"description": "Styles for the Document.text.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentStyle"
},
"type": "array"
},
"uri": {
"description": "Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentChunkedDocument": {
"description": "Represents the chunks that the document is divided into.",
"id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocument",
"properties": {
"chunks": {
"description": "List of chunks.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunk"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunk": {
"description": "Represents a chunk.",
"id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunk",
"properties": {
"chunkId": {
"description": "ID of the chunk.",
"type": "string"
},
"content": {
"description": "Text content of the chunk.",
"type": "string"
},
"pageFooters": {
"description": "Page footers associated with the chunk.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageFooter"
},
"type": "array"
},
"pageHeaders": {
"description": "Page headers associated with the chunk.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageHeader"
},
"type": "array"
},
"pageSpan": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan",
"description": "Page span of the chunk."
},
"sourceBlockIds": {
"description": "Unused.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageFooter": {
"description": "Represents the page footer associated with the chunk.",
"id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageFooter",
"properties": {
"pageSpan": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan",
"description": "Page span of the footer."
},
"text": {
"description": "Footer in text format.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageHeader": {
"description": "Represents the page header associated with the chunk.",
"id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageHeader",
"properties": {
"pageSpan": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan",
"description": "Page span of the header."
},
"text": {
"description": "Header in text format.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan": {
"description": "Represents where the chunk starts and ends in the document.",
"id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan",
"properties": {
"pageEnd": {
"description": "Page where chunk ends in the document.",
"format": "int32",
"type": "integer"
},
"pageStart": {
"description": "Page where chunk starts in the document.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentDocumentLayout": {
"description": "Represents the parsed layout of a document as a collection of blocks that the document is divided into.",
"id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayout",
"properties": {
"blocks": {
"description": "List of blocks in the document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock": {
"description": "Represents a block. A block could be one of the various types (text, table, list) supported.",
"id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock",
"properties": {
"blockId": {
"description": "ID of the block.",
"type": "string"
},
"listBlock": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock",
"description": "Block consisting of list content/structure."
},
"pageSpan": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan",
"description": "Page span of the block."
},
"tableBlock": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock",
"description": "Block consisting of table content/structure."
},
"textBlock": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock",
"description": "Block consisting of text content."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock": {
"description": "Represents a list type block.",
"id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock",
"properties": {
"listEntries": {
"description": "List entries that constitute a list block.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry"
},
"type": "array"
},
"type": {
"description": "Type of the list_entries (if exist). Available options are `ordered` and `unordered`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry": {
"description": "Represents an entry in the list.",
"id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry",
"properties": {
"blocks": {
"description": "A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan": {
"description": "Represents where the block starts and ends in the document.",
"id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan",
"properties": {
"pageEnd": {
"description": "Page where block ends in the document.",
"format": "int32",
"type": "integer"
},
"pageStart": {
"description": "Page where block starts in the document.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock": {
"description": "Represents a table type block.",
"id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock",
"properties": {
"bodyRows": {
"description": "Body rows containing main table content.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow"
},
"type": "array"
},
"caption": {
"description": "Table caption/title.",
"type": "string"
},
"headerRows": {
"description": "Header rows at the top of the table.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell": {
"description": "Represents a cell in a table row.",
"id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell",
"properties": {
"blocks": {
"description": "A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock"
},
"type": "array"
},
"colSpan": {
"description": "How many columns this cell spans.",
"format": "int32",
"type": "integer"
},
"rowSpan": {
"description": "How many rows this cell spans.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow": {
"description": "Represents a row in a table.",
"id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow",
"properties": {
"cells": {
"description": "A table row is a list of table cells.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock": {
"description": "Represents a text type block.",
"id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock",
"properties": {
"blocks": {
"description": "A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock"
},
"type": "array"
},
"text": {
"description": "Text content stored in the block.",
"type": "string"
},
"type": {
"description": "Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentEntity": {
"description": "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.",
"id": "GoogleCloudDocumentaiV1beta1DocumentEntity",
"properties": {
"confidence": {
"description": "Optional. Confidence of detected Schema entity. Range `[0, 1]`.",
"format": "float",
"type": "number"
},
"id": {
"description": "Optional. Canonical id. This will be a unique value in the entity list for this document.",
"type": "string"
},
"mentionId": {
"description": "Optional. Deprecated. Use `id` field instead.",
"type": "string"
},
"mentionText": {
"description": "Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.",
"type": "string"
},
"normalizedValue": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue",
"description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types."
},
"pageAnchor": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageAnchor",
"description": "Optional. Represents the provenance of this entity wrt. the location on the page where it was found."
},
"properties": {
"description": "Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentEntity"
},
"type": "array"
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
"description": "Optional. The history of this annotation."
},
"redacted": {
"description": "Optional. Whether the entity will be redacted for de-identification purposes.",
"type": "boolean"
},
"textAnchor": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor",
"description": "Optional. Provenance of the entity. Text anchor indexing into the Document.text."
},
"type": {
"description": "Required. Entity type from a schema e.g. `Address`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue": {
"description": "Parsed and normalized entity value.",
"id": "GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue",
"properties": {
"addressValue": {
"$ref": "GoogleTypePostalAddress",
"description": "Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto"
},
"booleanValue": {
"description": "Boolean value. Can be used for entities with binary values, or for checkboxes.",
"type": "boolean"
},
"dateValue": {
"$ref": "GoogleTypeDate",
"description": "Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto"
},
"datetimeValue": {
"$ref": "GoogleTypeDateTime",
"description": "DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto"
},
"floatValue": {
"description": "Float value.",
"format": "float",
"type": "number"
},
"integerValue": {
"description": "Integer value.",
"format": "int32",
"type": "integer"
},
"moneyValue": {
"$ref": "GoogleTypeMoney",
"description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto"
},
"text": {
"description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentEntityRelation": {
"description": "Relationship between Entities.",
"id": "GoogleCloudDocumentaiV1beta1DocumentEntityRelation",
"properties": {
"objectId": {
"description": "Object entity id.",
"type": "string"
},
"relation": {
"description": "Relationship description.",
"type": "string"
},
"subjectId": {
"description": "Subject entity id.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPage": {
"description": "A page in a Document.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPage",
"properties": {
"blocks": {
"description": "A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageBlock"
},
"type": "array"
},
"detectedBarcodes": {
"description": "A list of detected barcodes.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode"
},
"type": "array"
},
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
},
"type": "array"
},
"dimension": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDimension",
"description": "Physical dimension of the page."
},
"formFields": {
"description": "A list of visually detected form fields on the page.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageFormField"
},
"type": "array"
},
"image": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageImage",
"description": "Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned."
},
"imageQualityScores": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores",
"description": "Image quality scores."
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
"description": "Layout for the page."
},
"lines": {
"description": "A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLine"
},
"type": "array"
},
"pageNumber": {
"description": "1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.",
"format": "int32",
"type": "integer"
},
"paragraphs": {
"description": "A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageParagraph"
},
"type": "array"
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
"deprecated": true,
"description": "The history of this page."
},
"symbols": {
"description": "A list of visually detected symbols on the page.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageSymbol"
},
"type": "array"
},
"tables": {
"description": "A list of visually detected tables on the page.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTable"
},
"type": "array"
},
"tokens": {
"description": "A list of visually detected tokens on the page.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageToken"
},
"type": "array"
},
"transforms": {
"description": "Transformation matrices that were applied to the original document image to produce Page.image.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageMatrix"
},
"type": "array"
},
"visualElements": {
"description": "A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageVisualElement"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageAnchor": {
"description": "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.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageAnchor",
"properties": {
"pageRefs": {
"description": "One or more references to visual page elements",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef": {
"description": "Represents a weak reference to a page element within a document.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef",
"properties": {
"boundingPoly": {
"$ref": "GoogleCloudDocumentaiV1beta1BoundingPoly",
"description": "Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to."
},
"confidence": {
"description": "Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.",
"format": "float",
"type": "number"
},
"layoutId": {
"deprecated": true,
"description": "Optional. Deprecated. Use PageRef.bounding_poly instead.",
"type": "string"
},
"layoutType": {
"description": "Optional. The type of the layout element that is being referenced if any.",
"enum": [
"LAYOUT_TYPE_UNSPECIFIED",
"BLOCK",
"PARAGRAPH",
"LINE",
"TOKEN",
"VISUAL_ELEMENT",
"TABLE",
"FORM_FIELD"
],
"enumDescriptions": [
"Layout Unspecified.",
"References a Page.blocks element.",
"References a Page.paragraphs element.",
"References a Page.lines element.",
"References a Page.tokens element.",
"References a Page.visual_elements element.",
"Refrrences a Page.tables element.",
"References a Page.form_fields element."
],
"type": "string"
},
"page": {
"description": "Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageBlock": {
"description": "A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageBlock",
"properties": {
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
"description": "Layout for Block."
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
"deprecated": true,
"description": "The history of this annotation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode": {
"description": "A detected barcode.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode",
"properties": {
"barcode": {
"$ref": "GoogleCloudDocumentaiV1beta1Barcode",
"description": "Detailed barcode information of the DetectedBarcode."
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
"description": "Layout for DetectedBarcode."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage": {
"description": "Detected language for a structural component.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage",
"properties": {
"confidence": {
"description": "Confidence of detected language. Range `[0, 1]`.",
"format": "float",
"type": "number"
},
"languageCode": {
"description": "The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageDimension": {
"description": "Dimension for the page.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageDimension",
"properties": {
"height": {
"description": "Page height.",
"format": "float",
"type": "number"
},
"unit": {
"description": "Dimension unit.",
"type": "string"
},
"width": {
"description": "Page width.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageFormField": {
"description": "A form field detected on the page.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageFormField",
"properties": {
"correctedKeyText": {
"description": "Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction.",
"type": "string"
},
"correctedValueText": {
"description": "Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction.",
"type": "string"
},
"fieldName": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
"description": "Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc."
},
"fieldValue": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
"description": "Layout for the FormField value."
},
"nameDetectedLanguages": {
"description": "A list of detected languages for name together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
},
"type": "array"
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
"description": "The history of this annotation."
},
"valueDetectedLanguages": {
"description": "A list of detected languages for value together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
},
"type": "array"
},
"valueType": {
"description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageImage": {
"description": "Rendered image contents for this page.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageImage",
"properties": {
"content": {
"description": "Raw byte content of the image.",
"format": "byte",
"type": "string"
},
"height": {
"description": "Height of the image in pixels.",
"format": "int32",
"type": "integer"
},
"mimeType": {
"description": "Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.",
"type": "string"
},
"width": {
"description": "Width of the image in pixels.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores": {
"description": "Image quality scores for the page image.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores",
"properties": {
"detectedDefects": {
"description": "A list of detected defects.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect"
},
"type": "array"
},
"qualityScore": {
"description": "The overall quality score. Range `[0, 1]` where `1` is perfect quality.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect": {
"description": "Image Quality Defects",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect",
"properties": {
"confidence": {
"description": "Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.",
"format": "float",
"type": "number"
},
"type": {
"description": "Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageLayout": {
"description": "Visual element describing a layout unit on a page.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
"properties": {
"boundingPoly": {
"$ref": "GoogleCloudDocumentaiV1beta1BoundingPoly",
"description": "The bounding polygon for the Layout."
},
"confidence": {
"description": "Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.",
"format": "float",
"type": "number"
},
"orientation": {
"description": "Detected orientation for the Layout.",
"enum": [
"ORIENTATION_UNSPECIFIED",
"PAGE_UP",
"PAGE_RIGHT",
"PAGE_DOWN",
"PAGE_LEFT"
],
"enumDescriptions": [
"Unspecified orientation.",
"Orientation is aligned with page up.",
"Orientation is aligned with page right. Turn the head 90 degrees clockwise from upright to read.",
"Orientation is aligned with page down. Turn the head 180 degrees from upright to read.",
"Orientation is aligned with page left. Turn the head 90 degrees counterclockwise from upright to read."
],
"type": "string"
},
"textAnchor": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor",
"description": "Text anchor indexing into the Document.text."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageLine": {
"description": "A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageLine",
"properties": {
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
"description": "Layout for Line."
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
"deprecated": true,
"description": "The history of this annotation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageMatrix": {
"description": "Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageMatrix",
"properties": {
"cols": {
"description": "Number of columns in the matrix.",
"format": "int32",
"type": "integer"
},
"data": {
"description": "The matrix data.",
"format": "byte",
"type": "string"
},
"rows": {
"description": "Number of rows in the matrix.",
"format": "int32",
"type": "integer"
},
"type": {
"description": "This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageParagraph": {
"description": "A collection of lines that a human would perceive as a paragraph.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageParagraph",
"properties": {
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
"description": "Layout for Paragraph."
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
"deprecated": true,
"description": "The history of this annotation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageSymbol": {
"description": "A detected symbol.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageSymbol",
"properties": {
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
"description": "Layout for Symbol."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageTable": {
"description": "A table representation similar to HTML table structure.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageTable",
"properties": {
"bodyRows": {
"description": "Body rows of the table.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow"
},
"type": "array"
},
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
},
"type": "array"
},
"headerRows": {
"description": "Header rows of the table.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
"description": "Layout for Table."
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
"deprecated": true,
"description": "The history of this table."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell": {
"description": "A cell representation inside the table.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell",
"properties": {
"colSpan": {
"description": "How many columns this cell spans.",
"format": "int32",
"type": "integer"
},
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
"description": "Layout for TableCell."
},
"rowSpan": {
"description": "How many rows this cell spans.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow": {
"description": "A row of table cells.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow",
"properties": {
"cells": {
"description": "Cells that make up this row.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageToken": {
"description": "A detected token.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageToken",
"properties": {
"detectedBreak": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak",
"description": "Detected break at the end of a Token."
},
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
"description": "Layout for Token."
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
"deprecated": true,
"description": "The history of this annotation."
},
"styleInfo": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo",
"description": "Text style attributes."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak": {
"description": "Detected break at the end of a Token.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak",
"properties": {
"type": {
"description": "Detected break type.",
"enum": [
"TYPE_UNSPECIFIED",
"SPACE",
"WIDE_SPACE",
"HYPHEN"
],
"enumDescriptions": [
"Unspecified break type.",
"A single whitespace.",
"A wider whitespace.",
"A hyphen that indicates that a token has been split across lines."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo": {
"description": "Font and other text style attributes.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo",
"properties": {
"backgroundColor": {
"$ref": "GoogleTypeColor",
"description": "Color of the background."
},
"bold": {
"description": "Whether the text is bold (equivalent to font_weight is at least `700`).",
"type": "boolean"
},
"fontSize": {
"description": "Font size in points (`1` point is `\u00b9\u2044\u2087\u2082` inches).",
"format": "int32",
"type": "integer"
},
"fontType": {
"description": "Name or style of the font.",
"type": "string"
},
"fontWeight": {
"description": "TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.",
"format": "int32",
"type": "integer"
},
"handwritten": {
"description": "Whether the text is handwritten.",
"type": "boolean"
},
"italic": {
"description": "Whether the text is italic.",
"type": "boolean"
},
"letterSpacing": {
"description": "Letter spacing in points.",
"format": "double",
"type": "number"
},
"pixelFontSize": {
"description": "Font size in pixels, equal to _unrounded font_size_ * _resolution_ \u00f7 `72.0`.",
"format": "double",
"type": "number"
},
"smallcaps": {
"description": "Whether the text is in small caps. This feature is not supported yet.",
"type": "boolean"
},
"strikeout": {
"description": "Whether the text is strikethrough. This feature is not supported yet.",
"type": "boolean"
},
"subscript": {
"description": "Whether the text is a subscript. This feature is not supported yet.",
"type": "boolean"
},
"superscript": {
"description": "Whether the text is a superscript. This feature is not supported yet.",
"type": "boolean"
},
"textColor": {
"$ref": "GoogleTypeColor",
"description": "Color of the text."
},
"underlined": {
"description": "Whether the text is underlined.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentPageVisualElement": {
"description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.",
"id": "GoogleCloudDocumentaiV1beta1DocumentPageVisualElement",
"properties": {
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout",
"description": "Layout for VisualElement."
},
"type": {
"description": "Type of the VisualElement.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentProvenance": {
"description": "Structure to identify provenance relationships between annotations in different revisions.",
"id": "GoogleCloudDocumentaiV1beta1DocumentProvenance",
"properties": {
"id": {
"deprecated": true,
"description": "The Id of this operation. Needs to be unique within the scope of the revision.",
"format": "int32",
"type": "integer"
},
"parents": {
"description": "References to the original elements that are replaced.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent"
},
"type": "array"
},
"revision": {
"deprecated": true,
"description": "The index of the revision that produced this element.",
"format": "int32",
"type": "integer"
},
"type": {
"description": "The type of provenance operation.",
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
"ADD",
"REMOVE",
"UPDATE",
"REPLACE",
"EVAL_REQUESTED",
"EVAL_APPROVED",
"EVAL_SKIPPED"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
true,
true,
true
],
"enumDescriptions": [
"Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.",
"Add an element.",
"Remove an element identified by `parent`.",
"Updates any fields within the given provenance scope of the message. It overwrites the fields rather than replacing them. Use this when you want to update a field value of an entity without also updating all the child properties.",
"Currently unused. Replace an element identified by `parent`.",
"Deprecated. Request human review for the element identified by `parent`.",
"Deprecated. Element is reviewed and approved at human review, confidence will be set to 1.0.",
"Deprecated. Element is skipped in the validation process."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentProvenanceParent": {
"description": "The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.",
"id": "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent",
"properties": {
"id": {
"deprecated": true,
"description": "The id of the parent provenance.",
"format": "int32",
"type": "integer"
},
"index": {
"description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.",
"format": "int32",
"type": "integer"
},
"revision": {
"description": "The index of the index into current revision's parent_ids list.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentRevision": {
"description": "Contains past or forward revisions of this document.",
"id": "GoogleCloudDocumentaiV1beta1DocumentRevision",
"properties": {
"agent": {
"description": "If the change was made by a person specify the name or id of that person.",
"type": "string"
},
"createTime": {
"description": "The time that the revision was created, internally generated by doc proto storage at the time of create.",
"format": "google-datetime",
"type": "string"
},
"humanReview": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview",
"description": "Human Review information of this revision."
},
"id": {
"description": "Id of the revision, internally generated by doc proto storage. Unique within the context of the document.",
"type": "string"
},
"parent": {
"deprecated": true,
"description": "The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.",
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"parentIds": {
"description": "The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.",
"items": {
"type": "string"
},
"type": "array"
},
"processor": {
"description": "If the annotation was made by processor identify the processor by its resource name.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview": {
"description": "Human Review information of the document.",
"id": "GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview",
"properties": {
"state": {
"description": "Human review state. e.g. `requested`, `succeeded`, `rejected`.",
"type": "string"
},
"stateMessage": {
"description": "A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentShardInfo": {
"description": "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.",
"id": "GoogleCloudDocumentaiV1beta1DocumentShardInfo",
"properties": {
"shardCount": {
"description": "Total number of shards.",
"format": "int64",
"type": "string"
},
"shardIndex": {
"description": "The 0-based index of this shard.",
"format": "int64",
"type": "string"
},
"textOffset": {
"description": "The index of the first character in Document.text in the overall document global text.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentStyle": {
"description": "Annotation for common text style attributes. This adheres to CSS conventions as much as possible.",
"id": "GoogleCloudDocumentaiV1beta1DocumentStyle",
"properties": {
"backgroundColor": {
"$ref": "GoogleTypeColor",
"description": "Text background color."
},
"color": {
"$ref": "GoogleTypeColor",
"description": "Text color."
},
"fontFamily": {
"description": "Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp",
"type": "string"
},
"fontSize": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentStyleFontSize",
"description": "Font size."
},
"fontWeight": {
"description": "[Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.",
"type": "string"
},
"textAnchor": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor",
"description": "Text anchor indexing into the Document.text."
},
"textDecoration": {
"description": "[Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. ",
"type": "string"
},
"textStyle": {
"description": "[Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentStyleFontSize": {
"description": "Font size with unit.",
"id": "GoogleCloudDocumentaiV1beta1DocumentStyleFontSize",
"properties": {
"size": {
"description": "Font size for the text.",
"format": "float",
"type": "number"
},
"unit": {
"description": "Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentTextAnchor": {
"description": "Text reference indexing into the Document.text.",
"id": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor",
"properties": {
"content": {
"description": "Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.",
"type": "string"
},
"textSegments": {
"description": "The text segments from the Document.text.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment": {
"description": "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",
"id": "GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment",
"properties": {
"endIndex": {
"description": "TextSegment half open end UTF-8 char index in the Document.text.",
"format": "int64",
"type": "string"
},
"startIndex": {
"description": "TextSegment start UTF-8 char index in the Document.text.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1DocumentTextChange": {
"description": "This message is used for text changes aka. OCR corrections.",
"id": "GoogleCloudDocumentaiV1beta1DocumentTextChange",
"properties": {
"changedText": {
"description": "The text that replaces the text identified in the `text_anchor`.",
"type": "string"
},
"provenance": {
"deprecated": true,
"description": "The history of this annotation.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance"
},
"type": "array"
},
"textAnchor": {
"$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor",
"description": "Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1GcsDestination": {
"description": "The Google Cloud Storage location where the output file will be written to.",
"id": "GoogleCloudDocumentaiV1beta1GcsDestination",
"properties": {
"uri": {
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1GcsSource": {
"description": "The Google Cloud Storage location where the input file will be read from.",
"id": "GoogleCloudDocumentaiV1beta1GcsSource",
"properties": {
"uri": {
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1InputConfig": {
"description": "The desired input location and metadata.",
"id": "GoogleCloudDocumentaiV1beta1InputConfig",
"properties": {
"gcsSource": {
"$ref": "GoogleCloudDocumentaiV1beta1GcsSource",
"description": "The Google Cloud Storage location to read the input from. This must be a single file."
},
"mimeType": {
"description": "Required. Mimetype of the input. Current supported mimetypes are application/pdf, image/tiff, and image/gif. In addition, application/json type is supported for requests with ProcessDocumentRequest.automl_params field set. The JSON file needs to be in Document format.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1NormalizedVertex": {
"description": "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.",
"id": "GoogleCloudDocumentaiV1beta1NormalizedVertex",
"properties": {
"x": {
"description": "X coordinate.",
"format": "float",
"type": "number"
},
"y": {
"description": "Y coordinate (starts from the top of the image).",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1OperationMetadata": {
"description": "Contains metadata for the BatchProcessDocuments operation.",
"id": "GoogleCloudDocumentaiV1beta1OperationMetadata",
"properties": {
"createTime": {
"description": "The creation time of the operation.",
"format": "google-datetime",
"type": "string"
},
"state": {
"description": "The state of the current batch processing.",
"enum": [
"STATE_UNSPECIFIED",
"ACCEPTED",
"WAITING",
"RUNNING",
"SUCCEEDED",
"CANCELLED",
"FAILED"
],
"enumDescriptions": [
"The default value. This value is used if the state is omitted.",
"Request is received.",
"Request operation is waiting for scheduling.",
"Request is being processed.",
"The batch processing completed successfully.",
"The batch processing was cancelled.",
"The batch processing has failed."
],
"type": "string"
},
"stateMessage": {
"description": "A message providing more details about the current state of processing.",
"type": "string"
},
"updateTime": {
"description": "The last update time of the operation.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1OutputConfig": {
"description": "The desired output location and metadata.",
"id": "GoogleCloudDocumentaiV1beta1OutputConfig",
"properties": {
"gcsDestination": {
"$ref": "GoogleCloudDocumentaiV1beta1GcsDestination",
"description": "The Google Cloud Storage location to write the output to."
},
"pagesPerShard": {
"description": "The max number of pages to include into each output Document shard JSON on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 parsed pages will be produced. If `pages_per_shard` = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under the prefix OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where x and y are 1-indexed page numbers. Example GCS outputs with 157 pages and pages_per_shard = 50: pages-001-to-050.json pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1ProcessDocumentResponse": {
"description": "Response to a single document processing request.",
"id": "GoogleCloudDocumentaiV1beta1ProcessDocumentResponse",
"properties": {
"inputConfig": {
"$ref": "GoogleCloudDocumentaiV1beta1InputConfig",
"description": "Information about the input file. This is the same as the corresponding input config in the request."
},
"outputConfig": {
"$ref": "GoogleCloudDocumentaiV1beta1OutputConfig",
"description": "The output location of the parsed responses. The responses are written to this location as JSON-serialized `Document` objects."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta1Vertex": {
"description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.",
"id": "GoogleCloudDocumentaiV1beta1Vertex",
"properties": {
"x": {
"description": "X coordinate.",
"format": "int32",
"type": "integer"
},
"y": {
"description": "Y coordinate (starts from the top of the image).",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2AutoMlParams": {
"description": "Parameters to control AutoML model prediction behavior.",
"id": "GoogleCloudDocumentaiV1beta2AutoMlParams",
"properties": {
"model": {
"description": "Resource name of the AutoML model. Format: `projects/{project-id}/locations/{location-id}/models/{model-id}`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2Barcode": {
"description": "Encodes the detailed information of a barcode.",
"id": "GoogleCloudDocumentaiV1beta2Barcode",
"properties": {
"format": {
"description": "Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type.",
"type": "string"
},
"rawValue": {
"description": "Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.",
"type": "string"
},
"valueFormat": {
"description": "Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest": {
"description": "Request to batch process documents as an asynchronous operation. The output is written to Cloud Storage as JSON in the [Document] format.",
"id": "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest",
"properties": {
"requests": {
"description": "Required. Individual requests for each document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2ProcessDocumentRequest"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse": {
"description": "Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.",
"id": "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse",
"properties": {
"responses": {
"description": "Responses for each individual document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2ProcessDocumentResponse"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2BoundingPoly": {
"description": "A bounding polygon for the detected image annotation.",
"id": "GoogleCloudDocumentaiV1beta2BoundingPoly",
"properties": {
"normalizedVertices": {
"description": "The bounding polygon normalized vertices.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2NormalizedVertex"
},
"type": "array"
},
"vertices": {
"description": "The bounding polygon vertices.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2Vertex"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2Document": {
"description": "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.",
"id": "GoogleCloudDocumentaiV1beta2Document",
"properties": {
"chunkedDocument": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocument",
"description": "Document chunked based on chunking config."
},
"content": {
"description": "Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.",
"format": "byte",
"type": "string"
},
"documentLayout": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayout",
"description": "Parsed layout of the document."
},
"entities": {
"description": "A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentEntity"
},
"type": "array"
},
"entityRelations": {
"description": "Placeholder. Relationship among Document.entities.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentEntityRelation"
},
"type": "array"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "Any error that occurred while processing this document."
},
"labels": {
"description": "Labels for this document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentLabel"
},
"type": "array"
},
"mimeType": {
"description": "An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).",
"type": "string"
},
"pages": {
"description": "Visual page layout for the Document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPage"
},
"type": "array"
},
"revisions": {
"description": "Placeholder. Revision history of this document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentRevision"
},
"type": "array"
},
"shardInfo": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentShardInfo",
"description": "Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified."
},
"text": {
"description": "Optional. UTF-8 encoded text in reading order from the document.",
"type": "string"
},
"textChanges": {
"description": "Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentTextChange"
},
"type": "array"
},
"textStyles": {
"deprecated": true,
"description": "Styles for the Document.text.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentStyle"
},
"type": "array"
},
"uri": {
"description": "Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentChunkedDocument": {
"description": "Represents the chunks that the document is divided into.",
"id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocument",
"properties": {
"chunks": {
"description": "List of chunks.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunk"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunk": {
"description": "Represents a chunk.",
"id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunk",
"properties": {
"chunkId": {
"description": "ID of the chunk.",
"type": "string"
},
"content": {
"description": "Text content of the chunk.",
"type": "string"
},
"pageFooters": {
"description": "Page footers associated with the chunk.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageFooter"
},
"type": "array"
},
"pageHeaders": {
"description": "Page headers associated with the chunk.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageHeader"
},
"type": "array"
},
"pageSpan": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan",
"description": "Page span of the chunk."
},
"sourceBlockIds": {
"description": "Unused.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageFooter": {
"description": "Represents the page footer associated with the chunk.",
"id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageFooter",
"properties": {
"pageSpan": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan",
"description": "Page span of the footer."
},
"text": {
"description": "Footer in text format.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageHeader": {
"description": "Represents the page header associated with the chunk.",
"id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageHeader",
"properties": {
"pageSpan": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan",
"description": "Page span of the header."
},
"text": {
"description": "Header in text format.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan": {
"description": "Represents where the chunk starts and ends in the document.",
"id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan",
"properties": {
"pageEnd": {
"description": "Page where chunk ends in the document.",
"format": "int32",
"type": "integer"
},
"pageStart": {
"description": "Page where chunk starts in the document.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentDocumentLayout": {
"description": "Represents the parsed layout of a document as a collection of blocks that the document is divided into.",
"id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayout",
"properties": {
"blocks": {
"description": "List of blocks in the document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock": {
"description": "Represents a block. A block could be one of the various types (text, table, list) supported.",
"id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock",
"properties": {
"blockId": {
"description": "ID of the block.",
"type": "string"
},
"listBlock": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock",
"description": "Block consisting of list content/structure."
},
"pageSpan": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan",
"description": "Page span of the block."
},
"tableBlock": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock",
"description": "Block consisting of table content/structure."
},
"textBlock": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock",
"description": "Block consisting of text content."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock": {
"description": "Represents a list type block.",
"id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock",
"properties": {
"listEntries": {
"description": "List entries that constitute a list block.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry"
},
"type": "array"
},
"type": {
"description": "Type of the list_entries (if exist). Available options are `ordered` and `unordered`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry": {
"description": "Represents an entry in the list.",
"id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry",
"properties": {
"blocks": {
"description": "A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan": {
"description": "Represents where the block starts and ends in the document.",
"id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan",
"properties": {
"pageEnd": {
"description": "Page where block ends in the document.",
"format": "int32",
"type": "integer"
},
"pageStart": {
"description": "Page where block starts in the document.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock": {
"description": "Represents a table type block.",
"id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock",
"properties": {
"bodyRows": {
"description": "Body rows containing main table content.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow"
},
"type": "array"
},
"caption": {
"description": "Table caption/title.",
"type": "string"
},
"headerRows": {
"description": "Header rows at the top of the table.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell": {
"description": "Represents a cell in a table row.",
"id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell",
"properties": {
"blocks": {
"description": "A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock"
},
"type": "array"
},
"colSpan": {
"description": "How many columns this cell spans.",
"format": "int32",
"type": "integer"
},
"rowSpan": {
"description": "How many rows this cell spans.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow": {
"description": "Represents a row in a table.",
"id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow",
"properties": {
"cells": {
"description": "A table row is a list of table cells.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock": {
"description": "Represents a text type block.",
"id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock",
"properties": {
"blocks": {
"description": "A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock"
},
"type": "array"
},
"text": {
"description": "Text content stored in the block.",
"type": "string"
},
"type": {
"description": "Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentEntity": {
"description": "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.",
"id": "GoogleCloudDocumentaiV1beta2DocumentEntity",
"properties": {
"confidence": {
"description": "Optional. Confidence of detected Schema entity. Range `[0, 1]`.",
"format": "float",
"type": "number"
},
"id": {
"description": "Optional. Canonical id. This will be a unique value in the entity list for this document.",
"type": "string"
},
"mentionId": {
"description": "Optional. Deprecated. Use `id` field instead.",
"type": "string"
},
"mentionText": {
"description": "Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.",
"type": "string"
},
"normalizedValue": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue",
"description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types."
},
"pageAnchor": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageAnchor",
"description": "Optional. Represents the provenance of this entity wrt. the location on the page where it was found."
},
"properties": {
"description": "Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentEntity"
},
"type": "array"
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
"description": "Optional. The history of this annotation."
},
"redacted": {
"description": "Optional. Whether the entity will be redacted for de-identification purposes.",
"type": "boolean"
},
"textAnchor": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor",
"description": "Optional. Provenance of the entity. Text anchor indexing into the Document.text."
},
"type": {
"description": "Required. Entity type from a schema e.g. `Address`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue": {
"description": "Parsed and normalized entity value.",
"id": "GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue",
"properties": {
"addressValue": {
"$ref": "GoogleTypePostalAddress",
"description": "Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto"
},
"booleanValue": {
"description": "Boolean value. Can be used for entities with binary values, or for checkboxes.",
"type": "boolean"
},
"dateValue": {
"$ref": "GoogleTypeDate",
"description": "Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto"
},
"datetimeValue": {
"$ref": "GoogleTypeDateTime",
"description": "DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto"
},
"floatValue": {
"description": "Float value.",
"format": "float",
"type": "number"
},
"integerValue": {
"description": "Integer value.",
"format": "int32",
"type": "integer"
},
"moneyValue": {
"$ref": "GoogleTypeMoney",
"description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto"
},
"text": {
"description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentEntityRelation": {
"description": "Relationship between Entities.",
"id": "GoogleCloudDocumentaiV1beta2DocumentEntityRelation",
"properties": {
"objectId": {
"description": "Object entity id.",
"type": "string"
},
"relation": {
"description": "Relationship description.",
"type": "string"
},
"subjectId": {
"description": "Subject entity id.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentLabel": {
"description": "Label attaches schema information and/or other metadata to segments within a Document. Multiple Labels on a single field can denote either different labels, different instances of the same label created at different times, or some combination of both.",
"id": "GoogleCloudDocumentaiV1beta2DocumentLabel",
"properties": {
"automlModel": {
"description": "Label is generated AutoML model. This field stores the full resource name of the AutoML model. Format: `projects/{project-id}/locations/{location-id}/models/{model-id}`",
"type": "string"
},
"confidence": {
"description": "Confidence score between 0 and 1 for label assignment.",
"format": "float",
"type": "number"
},
"name": {
"description": "Name of the label. When the label is generated from AutoML Text Classification model, this field represents the name of the category.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPage": {
"description": "A page in a Document.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPage",
"properties": {
"blocks": {
"description": "A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageBlock"
},
"type": "array"
},
"detectedBarcodes": {
"description": "A list of detected barcodes.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode"
},
"type": "array"
},
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
},
"type": "array"
},
"dimension": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDimension",
"description": "Physical dimension of the page."
},
"formFields": {
"description": "A list of visually detected form fields on the page.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageFormField"
},
"type": "array"
},
"image": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageImage",
"description": "Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned."
},
"imageQualityScores": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores",
"description": "Image quality scores."
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
"description": "Layout for the page."
},
"lines": {
"description": "A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLine"
},
"type": "array"
},
"pageNumber": {
"description": "1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.",
"format": "int32",
"type": "integer"
},
"paragraphs": {
"description": "A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageParagraph"
},
"type": "array"
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
"deprecated": true,
"description": "The history of this page."
},
"symbols": {
"description": "A list of visually detected symbols on the page.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageSymbol"
},
"type": "array"
},
"tables": {
"description": "A list of visually detected tables on the page.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTable"
},
"type": "array"
},
"tokens": {
"description": "A list of visually detected tokens on the page.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageToken"
},
"type": "array"
},
"transforms": {
"description": "Transformation matrices that were applied to the original document image to produce Page.image.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageMatrix"
},
"type": "array"
},
"visualElements": {
"description": "A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageVisualElement"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageAnchor": {
"description": "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.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageAnchor",
"properties": {
"pageRefs": {
"description": "One or more references to visual page elements",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef": {
"description": "Represents a weak reference to a page element within a document.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef",
"properties": {
"boundingPoly": {
"$ref": "GoogleCloudDocumentaiV1beta2BoundingPoly",
"description": "Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to."
},
"confidence": {
"description": "Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.",
"format": "float",
"type": "number"
},
"layoutId": {
"deprecated": true,
"description": "Optional. Deprecated. Use PageRef.bounding_poly instead.",
"type": "string"
},
"layoutType": {
"description": "Optional. The type of the layout element that is being referenced if any.",
"enum": [
"LAYOUT_TYPE_UNSPECIFIED",
"BLOCK",
"PARAGRAPH",
"LINE",
"TOKEN",
"VISUAL_ELEMENT",
"TABLE",
"FORM_FIELD"
],
"enumDescriptions": [
"Layout Unspecified.",
"References a Page.blocks element.",
"References a Page.paragraphs element.",
"References a Page.lines element.",
"References a Page.tokens element.",
"References a Page.visual_elements element.",
"Refrrences a Page.tables element.",
"References a Page.form_fields element."
],
"type": "string"
},
"page": {
"description": "Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageBlock": {
"description": "A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageBlock",
"properties": {
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
"description": "Layout for Block."
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
"deprecated": true,
"description": "The history of this annotation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode": {
"description": "A detected barcode.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode",
"properties": {
"barcode": {
"$ref": "GoogleCloudDocumentaiV1beta2Barcode",
"description": "Detailed barcode information of the DetectedBarcode."
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
"description": "Layout for DetectedBarcode."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage": {
"description": "Detected language for a structural component.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage",
"properties": {
"confidence": {
"description": "Confidence of detected language. Range `[0, 1]`.",
"format": "float",
"type": "number"
},
"languageCode": {
"description": "The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageDimension": {
"description": "Dimension for the page.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageDimension",
"properties": {
"height": {
"description": "Page height.",
"format": "float",
"type": "number"
},
"unit": {
"description": "Dimension unit.",
"type": "string"
},
"width": {
"description": "Page width.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageFormField": {
"description": "A form field detected on the page.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageFormField",
"properties": {
"correctedKeyText": {
"description": "Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction.",
"type": "string"
},
"correctedValueText": {
"description": "Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction.",
"type": "string"
},
"fieldName": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
"description": "Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc."
},
"fieldValue": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
"description": "Layout for the FormField value."
},
"nameDetectedLanguages": {
"description": "A list of detected languages for name together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
},
"type": "array"
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
"description": "The history of this annotation."
},
"valueDetectedLanguages": {
"description": "A list of detected languages for value together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
},
"type": "array"
},
"valueType": {
"description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageImage": {
"description": "Rendered image contents for this page.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageImage",
"properties": {
"content": {
"description": "Raw byte content of the image.",
"format": "byte",
"type": "string"
},
"height": {
"description": "Height of the image in pixels.",
"format": "int32",
"type": "integer"
},
"mimeType": {
"description": "Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.",
"type": "string"
},
"width": {
"description": "Width of the image in pixels.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores": {
"description": "Image quality scores for the page image.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores",
"properties": {
"detectedDefects": {
"description": "A list of detected defects.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect"
},
"type": "array"
},
"qualityScore": {
"description": "The overall quality score. Range `[0, 1]` where `1` is perfect quality.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect": {
"description": "Image Quality Defects",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect",
"properties": {
"confidence": {
"description": "Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.",
"format": "float",
"type": "number"
},
"type": {
"description": "Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageLayout": {
"description": "Visual element describing a layout unit on a page.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
"properties": {
"boundingPoly": {
"$ref": "GoogleCloudDocumentaiV1beta2BoundingPoly",
"description": "The bounding polygon for the Layout."
},
"confidence": {
"description": "Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.",
"format": "float",
"type": "number"
},
"orientation": {
"description": "Detected orientation for the Layout.",
"enum": [
"ORIENTATION_UNSPECIFIED",
"PAGE_UP",
"PAGE_RIGHT",
"PAGE_DOWN",
"PAGE_LEFT"
],
"enumDescriptions": [
"Unspecified orientation.",
"Orientation is aligned with page up.",
"Orientation is aligned with page right. Turn the head 90 degrees clockwise from upright to read.",
"Orientation is aligned with page down. Turn the head 180 degrees from upright to read.",
"Orientation is aligned with page left. Turn the head 90 degrees counterclockwise from upright to read."
],
"type": "string"
},
"textAnchor": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor",
"description": "Text anchor indexing into the Document.text."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageLine": {
"description": "A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageLine",
"properties": {
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
"description": "Layout for Line."
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
"deprecated": true,
"description": "The history of this annotation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageMatrix": {
"description": "Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageMatrix",
"properties": {
"cols": {
"description": "Number of columns in the matrix.",
"format": "int32",
"type": "integer"
},
"data": {
"description": "The matrix data.",
"format": "byte",
"type": "string"
},
"rows": {
"description": "Number of rows in the matrix.",
"format": "int32",
"type": "integer"
},
"type": {
"description": "This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageParagraph": {
"description": "A collection of lines that a human would perceive as a paragraph.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageParagraph",
"properties": {
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
"description": "Layout for Paragraph."
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
"deprecated": true,
"description": "The history of this annotation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageSymbol": {
"description": "A detected symbol.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageSymbol",
"properties": {
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
"description": "Layout for Symbol."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageTable": {
"description": "A table representation similar to HTML table structure.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageTable",
"properties": {
"bodyRows": {
"description": "Body rows of the table.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow"
},
"type": "array"
},
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
},
"type": "array"
},
"headerRows": {
"description": "Header rows of the table.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
"description": "Layout for Table."
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
"deprecated": true,
"description": "The history of this table."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell": {
"description": "A cell representation inside the table.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell",
"properties": {
"colSpan": {
"description": "How many columns this cell spans.",
"format": "int32",
"type": "integer"
},
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
"description": "Layout for TableCell."
},
"rowSpan": {
"description": "How many rows this cell spans.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow": {
"description": "A row of table cells.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow",
"properties": {
"cells": {
"description": "Cells that make up this row.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageToken": {
"description": "A detected token.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageToken",
"properties": {
"detectedBreak": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak",
"description": "Detected break at the end of a Token."
},
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
"description": "Layout for Token."
},
"provenance": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
"deprecated": true,
"description": "The history of this annotation."
},
"styleInfo": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo",
"description": "Text style attributes."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak": {
"description": "Detected break at the end of a Token.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak",
"properties": {
"type": {
"description": "Detected break type.",
"enum": [
"TYPE_UNSPECIFIED",
"SPACE",
"WIDE_SPACE",
"HYPHEN"
],
"enumDescriptions": [
"Unspecified break type.",
"A single whitespace.",
"A wider whitespace.",
"A hyphen that indicates that a token has been split across lines."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo": {
"description": "Font and other text style attributes.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo",
"properties": {
"backgroundColor": {
"$ref": "GoogleTypeColor",
"description": "Color of the background."
},
"bold": {
"description": "Whether the text is bold (equivalent to font_weight is at least `700`).",
"type": "boolean"
},
"fontSize": {
"description": "Font size in points (`1` point is `\u00b9\u2044\u2087\u2082` inches).",
"format": "int32",
"type": "integer"
},
"fontType": {
"description": "Name or style of the font.",
"type": "string"
},
"fontWeight": {
"description": "TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.",
"format": "int32",
"type": "integer"
},
"handwritten": {
"description": "Whether the text is handwritten.",
"type": "boolean"
},
"italic": {
"description": "Whether the text is italic.",
"type": "boolean"
},
"letterSpacing": {
"description": "Letter spacing in points.",
"format": "double",
"type": "number"
},
"pixelFontSize": {
"description": "Font size in pixels, equal to _unrounded font_size_ * _resolution_ \u00f7 `72.0`.",
"format": "double",
"type": "number"
},
"smallcaps": {
"description": "Whether the text is in small caps. This feature is not supported yet.",
"type": "boolean"
},
"strikeout": {
"description": "Whether the text is strikethrough. This feature is not supported yet.",
"type": "boolean"
},
"subscript": {
"description": "Whether the text is a subscript. This feature is not supported yet.",
"type": "boolean"
},
"superscript": {
"description": "Whether the text is a superscript. This feature is not supported yet.",
"type": "boolean"
},
"textColor": {
"$ref": "GoogleTypeColor",
"description": "Color of the text."
},
"underlined": {
"description": "Whether the text is underlined.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentPageVisualElement": {
"description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.",
"id": "GoogleCloudDocumentaiV1beta2DocumentPageVisualElement",
"properties": {
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage"
},
"type": "array"
},
"layout": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout",
"description": "Layout for VisualElement."
},
"type": {
"description": "Type of the VisualElement.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentProvenance": {
"description": "Structure to identify provenance relationships between annotations in different revisions.",
"id": "GoogleCloudDocumentaiV1beta2DocumentProvenance",
"properties": {
"id": {
"deprecated": true,
"description": "The Id of this operation. Needs to be unique within the scope of the revision.",
"format": "int32",
"type": "integer"
},
"parents": {
"description": "References to the original elements that are replaced.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent"
},
"type": "array"
},
"revision": {
"deprecated": true,
"description": "The index of the revision that produced this element.",
"format": "int32",
"type": "integer"
},
"type": {
"description": "The type of provenance operation.",
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
"ADD",
"REMOVE",
"UPDATE",
"REPLACE",
"EVAL_REQUESTED",
"EVAL_APPROVED",
"EVAL_SKIPPED"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
true,
true,
true
],
"enumDescriptions": [
"Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.",
"Add an element.",
"Remove an element identified by `parent`.",
"Updates any fields within the given provenance scope of the message. It overwrites the fields rather than replacing them. Use this when you want to update a field value of an entity without also updating all the child properties.",
"Currently unused. Replace an element identified by `parent`.",
"Deprecated. Request human review for the element identified by `parent`.",
"Deprecated. Element is reviewed and approved at human review, confidence will be set to 1.0.",
"Deprecated. Element is skipped in the validation process."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentProvenanceParent": {
"description": "The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.",
"id": "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent",
"properties": {
"id": {
"deprecated": true,
"description": "The id of the parent provenance.",
"format": "int32",
"type": "integer"
},
"index": {
"description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.",
"format": "int32",
"type": "integer"
},
"revision": {
"description": "The index of the index into current revision's parent_ids list.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentRevision": {
"description": "Contains past or forward revisions of this document.",
"id": "GoogleCloudDocumentaiV1beta2DocumentRevision",
"properties": {
"agent": {
"description": "If the change was made by a person specify the name or id of that person.",
"type": "string"
},
"createTime": {
"description": "The time that the revision was created, internally generated by doc proto storage at the time of create.",
"format": "google-datetime",
"type": "string"
},
"humanReview": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview",
"description": "Human Review information of this revision."
},
"id": {
"description": "Id of the revision, internally generated by doc proto storage. Unique within the context of the document.",
"type": "string"
},
"parent": {
"deprecated": true,
"description": "The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.",
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"parentIds": {
"description": "The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.",
"items": {
"type": "string"
},
"type": "array"
},
"processor": {
"description": "If the annotation was made by processor identify the processor by its resource name.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview": {
"description": "Human Review information of the document.",
"id": "GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview",
"properties": {
"state": {
"description": "Human review state. e.g. `requested`, `succeeded`, `rejected`.",
"type": "string"
},
"stateMessage": {
"description": "A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentShardInfo": {
"description": "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.",
"id": "GoogleCloudDocumentaiV1beta2DocumentShardInfo",
"properties": {
"shardCount": {
"description": "Total number of shards.",
"format": "int64",
"type": "string"
},
"shardIndex": {
"description": "The 0-based index of this shard.",
"format": "int64",
"type": "string"
},
"textOffset": {
"description": "The index of the first character in Document.text in the overall document global text.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentStyle": {
"description": "Annotation for common text style attributes. This adheres to CSS conventions as much as possible.",
"id": "GoogleCloudDocumentaiV1beta2DocumentStyle",
"properties": {
"backgroundColor": {
"$ref": "GoogleTypeColor",
"description": "Text background color."
},
"color": {
"$ref": "GoogleTypeColor",
"description": "Text color."
},
"fontFamily": {
"description": "Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp",
"type": "string"
},
"fontSize": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentStyleFontSize",
"description": "Font size."
},
"fontWeight": {
"description": "[Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.",
"type": "string"
},
"textAnchor": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor",
"description": "Text anchor indexing into the Document.text."
},
"textDecoration": {
"description": "[Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. ",
"type": "string"
},
"textStyle": {
"description": "[Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentStyleFontSize": {
"description": "Font size with unit.",
"id": "GoogleCloudDocumentaiV1beta2DocumentStyleFontSize",
"properties": {
"size": {
"description": "Font size for the text.",
"format": "float",
"type": "number"
},
"unit": {
"description": "Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentTextAnchor": {
"description": "Text reference indexing into the Document.text.",
"id": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor",
"properties": {
"content": {
"description": "Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.",
"type": "string"
},
"textSegments": {
"description": "The text segments from the Document.text.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment": {
"description": "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",
"id": "GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment",
"properties": {
"endIndex": {
"description": "TextSegment half open end UTF-8 char index in the Document.text.",
"format": "int64",
"type": "string"
},
"startIndex": {
"description": "TextSegment start UTF-8 char index in the Document.text.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2DocumentTextChange": {
"description": "This message is used for text changes aka. OCR corrections.",
"id": "GoogleCloudDocumentaiV1beta2DocumentTextChange",
"properties": {
"changedText": {
"description": "The text that replaces the text identified in the `text_anchor`.",
"type": "string"
},
"provenance": {
"deprecated": true,
"description": "The history of this annotation.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance"
},
"type": "array"
},
"textAnchor": {
"$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor",
"description": "Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2EntityExtractionParams": {
"description": "Parameters to control entity extraction behavior.",
"id": "GoogleCloudDocumentaiV1beta2EntityExtractionParams",
"properties": {
"enabled": {
"description": "Whether to enable entity extraction.",
"type": "boolean"
},
"modelVersion": {
"description": "Model version of the entity extraction. Default is \"builtin/stable\". Specify \"builtin/latest\" for the latest model.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2FormExtractionParams": {
"description": "Parameters to control form extraction behavior.",
"id": "GoogleCloudDocumentaiV1beta2FormExtractionParams",
"properties": {
"enabled": {
"description": "Whether to enable form extraction.",
"type": "boolean"
},
"keyValuePairHints": {
"description": "Reserved for future use.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2KeyValuePairHint"
},
"type": "array"
},
"modelVersion": {
"description": "Model version of the form extraction system. Default is \"builtin/stable\". Specify \"builtin/latest\" for the latest model. For custom form models, specify: \"custom/{model_name}\". Model name format is \"bucket_name/path/to/modeldir\" corresponding to \"gs://bucket_name/path/to/modeldir\" where annotated examples are stored.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2GcsDestination": {
"description": "The Google Cloud Storage location where the output file will be written to.",
"id": "GoogleCloudDocumentaiV1beta2GcsDestination",
"properties": {
"uri": {
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2GcsSource": {
"description": "The Google Cloud Storage location where the input file will be read from.",
"id": "GoogleCloudDocumentaiV1beta2GcsSource",
"properties": {
"uri": {
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2InputConfig": {
"description": "The desired input location and metadata.",
"id": "GoogleCloudDocumentaiV1beta2InputConfig",
"properties": {
"contents": {
"description": "Content in bytes, represented as a stream of bytes. Note: As with all `bytes` fields, proto buffer messages use a pure binary representation, whereas JSON representations use base64. This field only works for synchronous ProcessDocument method.",
"format": "byte",
"type": "string"
},
"gcsSource": {
"$ref": "GoogleCloudDocumentaiV1beta2GcsSource",
"description": "The Google Cloud Storage location to read the input from. This must be a single file."
},
"mimeType": {
"description": "Required. Mimetype of the input. Current supported mimetypes are application/pdf, image/tiff, and image/gif. In addition, application/json type is supported for requests with ProcessDocumentRequest.automl_params field set. The JSON file needs to be in Document format.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2KeyValuePairHint": {
"description": "Reserved for future use.",
"id": "GoogleCloudDocumentaiV1beta2KeyValuePairHint",
"properties": {
"key": {
"description": "The key text for the hint.",
"type": "string"
},
"valueTypes": {
"description": "Type of the value. This is case-insensitive, and could be one of: ADDRESS, LOCATION, ORGANIZATION, PERSON, PHONE_NUMBER, ID, NUMBER, EMAIL, PRICE, TERMS, DATE, NAME. Types not in this list will be ignored.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2NormalizedVertex": {
"description": "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.",
"id": "GoogleCloudDocumentaiV1beta2NormalizedVertex",
"properties": {
"x": {
"description": "X coordinate.",
"format": "float",
"type": "number"
},
"y": {
"description": "Y coordinate (starts from the top of the image).",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2OcrParams": {
"description": "Parameters to control Optical Character Recognition (OCR) behavior.",
"id": "GoogleCloudDocumentaiV1beta2OcrParams",
"properties": {
"languageHints": {
"description": "List of languages to use for OCR. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Document processing returns an error if one or more of the specified languages is not one of the supported languages.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2OperationMetadata": {
"description": "Contains metadata for the BatchProcessDocuments operation.",
"id": "GoogleCloudDocumentaiV1beta2OperationMetadata",
"properties": {
"createTime": {
"description": "The creation time of the operation.",
"format": "google-datetime",
"type": "string"
},
"state": {
"description": "The state of the current batch processing.",
"enum": [
"STATE_UNSPECIFIED",
"ACCEPTED",
"WAITING",
"RUNNING",
"SUCCEEDED",
"CANCELLED",
"FAILED"
],
"enumDescriptions": [
"The default value. This value is used if the state is omitted.",
"Request is received.",
"Request operation is waiting for scheduling.",
"Request is being processed.",
"The batch processing completed successfully.",
"The batch processing was cancelled.",
"The batch processing has failed."
],
"type": "string"
},
"stateMessage": {
"description": "A message providing more details about the current state of processing.",
"type": "string"
},
"updateTime": {
"description": "The last update time of the operation.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2OutputConfig": {
"description": "The desired output location and metadata.",
"id": "GoogleCloudDocumentaiV1beta2OutputConfig",
"properties": {
"gcsDestination": {
"$ref": "GoogleCloudDocumentaiV1beta2GcsDestination",
"description": "The Google Cloud Storage location to write the output to."
},
"pagesPerShard": {
"description": "The max number of pages to include into each output Document shard JSON on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 parsed pages will be produced. If `pages_per_shard` = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under the prefix OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where x and y are 1-indexed page numbers. Example GCS outputs with 157 pages and pages_per_shard = 50: pages-001-to-050.json pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2ProcessDocumentRequest": {
"description": "Request to process one document.",
"id": "GoogleCloudDocumentaiV1beta2ProcessDocumentRequest",
"properties": {
"automlParams": {
"$ref": "GoogleCloudDocumentaiV1beta2AutoMlParams",
"description": "Controls AutoML model prediction behavior. AutoMlParams cannot be used together with other Params."
},
"documentType": {
"description": "Specifies a known document type for deeper structure detection. Valid values are currently \"general\" and \"invoice\". If not provided, \"general\"\\ is used as default. If any other value is given, the request is rejected.",
"type": "string"
},
"entityExtractionParams": {
"$ref": "GoogleCloudDocumentaiV1beta2EntityExtractionParams",
"description": "Controls entity extraction behavior. If not specified, the system will decide reasonable defaults."
},
"formExtractionParams": {
"$ref": "GoogleCloudDocumentaiV1beta2FormExtractionParams",
"description": "Controls form extraction behavior. If not specified, the system will decide reasonable defaults."
},
"inputConfig": {
"$ref": "GoogleCloudDocumentaiV1beta2InputConfig",
"description": "Required. Information about the input file."
},
"ocrParams": {
"$ref": "GoogleCloudDocumentaiV1beta2OcrParams",
"description": "Controls OCR behavior. If not specified, the system will decide reasonable defaults."
},
"outputConfig": {
"$ref": "GoogleCloudDocumentaiV1beta2OutputConfig",
"description": "The desired output location. This field is only needed in BatchProcessDocumentsRequest."
},
"parent": {
"description": "Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. This field is only populated when used in ProcessDocument method.",
"type": "string"
},
"tableExtractionParams": {
"$ref": "GoogleCloudDocumentaiV1beta2TableExtractionParams",
"description": "Controls table extraction behavior. If not specified, the system will decide reasonable defaults."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2ProcessDocumentResponse": {
"description": "Response to a single document processing request.",
"id": "GoogleCloudDocumentaiV1beta2ProcessDocumentResponse",
"properties": {
"inputConfig": {
"$ref": "GoogleCloudDocumentaiV1beta2InputConfig",
"description": "Information about the input file. This is the same as the corresponding input config in the request."
},
"outputConfig": {
"$ref": "GoogleCloudDocumentaiV1beta2OutputConfig",
"description": "The output location of the parsed responses. The responses are written to this location as JSON-serialized `Document` objects."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2TableBoundHint": {
"description": "A hint for a table bounding box on the page for table parsing.",
"id": "GoogleCloudDocumentaiV1beta2TableBoundHint",
"properties": {
"boundingBox": {
"$ref": "GoogleCloudDocumentaiV1beta2BoundingPoly",
"description": "Bounding box hint for a table on this page. The coordinates must be normalized to [0,1] and the bounding box must be an axis-aligned rectangle."
},
"pageNumber": {
"description": "Optional. Page number for multi-paged inputs this hint applies to. If not provided, this hint will apply to all pages by default. This value is 1-based.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2TableExtractionParams": {
"description": "Parameters to control table extraction behavior.",
"id": "GoogleCloudDocumentaiV1beta2TableExtractionParams",
"properties": {
"enabled": {
"description": "Whether to enable table extraction.",
"type": "boolean"
},
"headerHints": {
"description": "Optional. Reserved for future use.",
"items": {
"type": "string"
},
"type": "array"
},
"modelVersion": {
"description": "Model version of the table extraction system. Default is \"builtin/stable\". Specify \"builtin/latest\" for the latest model.",
"type": "string"
},
"tableBoundHints": {
"description": "Optional. Table bounding box hints that can be provided to complex cases which our algorithm cannot locate the table(s) in.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta2TableBoundHint"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta2Vertex": {
"description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.",
"id": "GoogleCloudDocumentaiV1beta2Vertex",
"properties": {
"x": {
"description": "X coordinate.",
"format": "int32",
"type": "integer"
},
"y": {
"description": "Y coordinate (starts from the top of the image).",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata": {
"id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"errorDocumentCount": {
"description": "Total number of documents that failed to be deleted in storage.",
"format": "int32",
"type": "integer"
},
"individualBatchDeleteStatuses": {
"description": "The list of response details of each document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus"
},
"type": "array"
},
"totalDocumentCount": {
"description": "Total number of documents deleting from dataset.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus": {
"description": "The status of each individual document in the batch delete process.",
"id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus",
"properties": {
"documentId": {
"$ref": "GoogleCloudDocumentaiV1beta3DocumentId",
"description": "The document id of the document."
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of deleting the document in storage."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse": {
"description": "Response of the delete documents operation.",
"id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3BatchProcessMetadata": {
"description": "The long-running operation metadata for BatchProcessDocuments.",
"id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadata",
"properties": {
"createTime": {
"description": "The creation time of the operation.",
"format": "google-datetime",
"type": "string"
},
"individualProcessStatuses": {
"description": "The list of response details of each document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus"
},
"type": "array"
},
"state": {
"description": "The state of the current batch processing.",
"enum": [
"STATE_UNSPECIFIED",
"WAITING",
"RUNNING",
"SUCCEEDED",
"CANCELLING",
"CANCELLED",
"FAILED"
],
"enumDescriptions": [
"The default value. This value is used if the state is omitted.",
"Request operation is waiting for scheduling.",
"Request is being processed.",
"The batch processing completed successfully.",
"The batch processing was being cancelled.",
"The batch processing was cancelled.",
"The batch processing has failed."
],
"type": "string"
},
"stateMessage": {
"description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed.",
"type": "string"
},
"updateTime": {
"description": "The last update time of the operation.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus": {
"description": "The status of a each individual document in the batch process.",
"id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus",
"properties": {
"humanReviewOperation": {
"deprecated": true,
"description": "The name of the operation triggered by the processed document. If the human review process isn't triggered, this field will be empty. It has the same response type and metadata as the long-running operation returned by the ReviewDocument method.",
"type": "string"
},
"humanReviewStatus": {
"$ref": "GoogleCloudDocumentaiV1beta3HumanReviewStatus",
"description": "The status of human review on the processed document."
},
"inputGcsSource": {
"description": "The source of the document, same as the input_gcs_source field in the request when the batch process started.",
"type": "string"
},
"outputGcsDestination": {
"description": "The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty.",
"type": "string"
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status processing the document."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3BatchProcessResponse": {
"description": "Response message for BatchProcessDocuments.",
"id": "GoogleCloudDocumentaiV1beta3BatchProcessResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3CommonOperationMetadata": {
"description": "The common metadata for long running operations.",
"id": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"properties": {
"createTime": {
"description": "The creation time of the operation.",
"format": "google-datetime",
"type": "string"
},
"resource": {
"description": "A related resource to this operation.",
"type": "string"
},
"state": {
"description": "The state of the operation.",
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",
"CANCELLING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
],
"enumDescriptions": [
"Unspecified state.",
"Operation is still running.",
"Operation is being cancelled.",
"Operation succeeded.",
"Operation failed.",
"Operation is cancelled."
],
"type": "string"
},
"stateMessage": {
"description": "A message providing more details about the current state of processing.",
"type": "string"
},
"updateTime": {
"description": "The last update time of the operation.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3Dataset": {
"description": "A singleton resource under a Processor which configures a collection of documents.",
"id": "GoogleCloudDocumentaiV1beta3Dataset",
"properties": {
"documentWarehouseConfig": {
"$ref": "GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig",
"deprecated": true,
"description": "Optional. Deprecated. Warehouse-based dataset configuration is not supported."
},
"gcsManagedConfig": {
"$ref": "GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig",
"description": "Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the dataset documents are stored under a user-managed Cloud Storage location."
},
"name": {
"description": "Dataset resource name. Format: `projects/{project}/locations/{location}/processors/{processor}/dataset`",
"type": "string"
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"spannerIndexingConfig": {
"$ref": "GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig",
"description": "Optional. A lightweight indexing source with low latency and high reliability, but lacking advanced features like CMEK and content-based search."
},
"state": {
"description": "Required. State of the dataset. Ignored when updating dataset.",
"enum": [
"STATE_UNSPECIFIED",
"UNINITIALIZED",
"INITIALIZING",
"INITIALIZED"
],
"enumDescriptions": [
"Default unspecified enum, should not be used.",
"Dataset has not been initialized.",
"Dataset is being initialized.",
"Dataset has been initialized."
],
"type": "string"
},
"unmanagedDatasetConfig": {
"$ref": "GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig",
"description": "Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed)."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig": {
"description": "Configuration specific to the Document AI Warehouse-based implementation.",
"id": "GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig",
"properties": {
"collection": {
"description": "Output only. The collection in Document AI Warehouse associated with the dataset.",
"readOnly": true,
"type": "string"
},
"schema": {
"description": "Output only. The schema in Document AI Warehouse associated with the dataset.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig": {
"description": "Configuration specific to the Cloud Storage-based implementation.",
"id": "GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig",
"properties": {
"gcsPrefix": {
"$ref": "GoogleCloudDocumentaiV1beta3GcsPrefix",
"description": "Required. The Cloud Storage URI (a directory) where the documents belonging to the dataset must be stored."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig": {
"description": "Configuration specific to spanner-based indexing.",
"id": "GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig": {
"description": "Configuration specific to an unmanaged dataset.",
"id": "GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata": {
"description": "The long-running operation metadata for the DeleteProcessor method.",
"id": "GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata": {
"description": "The long-running operation metadata for the DeleteProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata": {
"description": "The long-running operation metadata for the DeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse": {
"description": "Response message for the DeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DisableProcessorMetadata": {
"description": "The long-running operation metadata for the DisableProcessor method.",
"id": "GoogleCloudDocumentaiV1beta3DisableProcessorMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DisableProcessorResponse": {
"description": "Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.",
"id": "GoogleCloudDocumentaiV1beta3DisableProcessorResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DocumentId": {
"description": "Document Identifier.",
"id": "GoogleCloudDocumentaiV1beta3DocumentId",
"properties": {
"gcsManagedDocId": {
"$ref": "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId",
"description": "A document id within user-managed Cloud Storage."
},
"revisionRef": {
"$ref": "GoogleCloudDocumentaiV1beta3RevisionRef",
"description": "Points to a specific revision of the document if set."
},
"unmanagedDocId": {
"$ref": "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId",
"description": "A document id within unmanaged dataset."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId": {
"description": "Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.",
"id": "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId",
"properties": {
"cwDocId": {
"deprecated": true,
"description": "Id of the document (indexed) managed by Content Warehouse.",
"type": "string"
},
"gcsUri": {
"description": "Required. The Cloud Storage URI where the actual document is stored.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId": {
"description": "Identifies a document uniquely within the scope of a dataset in unmanaged option.",
"id": "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId",
"properties": {
"docId": {
"description": "Required. The id of the document.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3EnableProcessorMetadata": {
"description": "The long-running operation metadata for the EnableProcessor method.",
"id": "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3EnableProcessorResponse": {
"description": "Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.",
"id": "GoogleCloudDocumentaiV1beta3EnableProcessorResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata": {
"description": "Metadata of the EvaluateProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse": {
"description": "Response of the EvaluateProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse",
"properties": {
"evaluation": {
"description": "The resource name of the created evaluation.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3GcsPrefix": {
"description": "Specifies all documents on Cloud Storage with a common prefix.",
"id": "GoogleCloudDocumentaiV1beta3GcsPrefix",
"properties": {
"gcsUriPrefix": {
"description": "The URI prefix.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3HumanReviewStatus": {
"description": "The status of human review on a processed document.",
"id": "GoogleCloudDocumentaiV1beta3HumanReviewStatus",
"properties": {
"humanReviewOperation": {
"description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.",
"type": "string"
},
"state": {
"description": "The state of human review on the processing request.",
"enum": [
"STATE_UNSPECIFIED",
"SKIPPED",
"VALIDATION_PASSED",
"IN_PROGRESS",
"ERROR"
],
"enumDescriptions": [
"Human review state is unspecified. Most likely due to an internal error.",
"Human review is skipped for the document. This can happen because human review isn't enabled on the processor or the processing request has been set to skip this document.",
"Human review validation is triggered and passed, so no review is needed.",
"Human review validation is triggered and the document is under review.",
"Some error happened during triggering human review, see the state_message for details."
],
"type": "string"
},
"stateMessage": {
"description": "A message providing more details about the human review state.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata": {
"description": "Metadata of the import document operation.",
"id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"importConfigValidationResults": {
"description": "Validation statuses of the batch documents import config.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult"
},
"type": "array"
},
"individualImportStatuses": {
"description": "The list of response details of each document.",
"items": {
"$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus"
},
"type": "array"
},
"totalDocumentCount": {
"description": "Total number of the documents that are qualified for importing.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult": {
"description": "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.",
"id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult",
"properties": {
"inputGcsSource": {
"description": "The source Cloud Storage URI specified in the import config.",
"type": "string"
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The validation status of import config."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus": {
"description": "The status of each individual document in the import process.",
"id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus",
"properties": {
"inputGcsSource": {
"description": "The source Cloud Storage URI of the document.",
"type": "string"
},
"outputDocumentId": {
"$ref": "GoogleCloudDocumentaiV1beta3DocumentId",
"description": "The document id of imported document if it was successful, otherwise empty."
},
"status": {
"$ref": "GoogleRpcStatus",
"description": "The status of the importing of the document."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ImportDocumentsResponse": {
"description": "Response of the import document operation.",
"id": "GoogleCloudDocumentaiV1beta3ImportDocumentsResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata": {
"description": "The long-running operation metadata for the ImportProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata for the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse": {
"description": "The response message for the ImportProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse",
"properties": {
"processorVersion": {
"description": "The destination processor version name.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata": {
"description": "The long-running operation metadata for the ReviewDocument method.",
"id": "GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"createTime": {
"description": "The creation time of the operation.",
"format": "google-datetime",
"type": "string"
},
"questionId": {
"description": "The Crowd Compute question ID.",
"type": "string"
},
"state": {
"description": "Used only when Operation.done is false.",
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",
"CANCELLING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
],
"enumDescriptions": [
"Unspecified state.",
"Operation is still running.",
"Operation is being cancelled.",
"Operation succeeded.",
"Operation failed.",
"Operation is cancelled."
],
"type": "string"
},
"stateMessage": {
"description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed.",
"type": "string"
},
"updateTime": {
"description": "The last update time of the operation.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3ReviewDocumentResponse": {
"description": "Response message for the ReviewDocument method.",
"id": "GoogleCloudDocumentaiV1beta3ReviewDocumentResponse",
"properties": {
"gcsDestination": {
"description": "The Cloud Storage uri for the human reviewed document if the review is succeeded.",
"type": "string"
},
"rejectionReason": {
"description": "The reason why the review is rejected by reviewer.",
"type": "string"
},
"state": {
"description": "The state of the review operation.",
"enum": [
"STATE_UNSPECIFIED",
"REJECTED",
"SUCCEEDED"
],
"enumDescriptions": [
"The default value. This value is used if the state is omitted.",
"The review operation is rejected by the reviewer.",
"The review operation is succeeded."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3RevisionRef": {
"description": "The revision reference specifies which revision on the document to read.",
"id": "GoogleCloudDocumentaiV1beta3RevisionRef",
"properties": {
"latestProcessorVersion": {
"description": "Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`",
"type": "string"
},
"revisionCase": {
"description": "Reads the revision by the predefined case.",
"enum": [
"REVISION_CASE_UNSPECIFIED",
"LATEST_HUMAN_REVIEW",
"LATEST_TIMESTAMP",
"BASE_OCR_REVISION"
],
"enumDescriptions": [
"Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`.",
"The latest revision made by a human.",
"The latest revision based on timestamp.",
"The first (OCR) revision."
],
"type": "string"
},
"revisionId": {
"description": "Reads the revision given by the id.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata": {
"description": "The long-running operation metadata for the SetDefaultProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse": {
"description": "Response message for the SetDefaultProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata": {
"description": "The metadata that represents a processor version being created.",
"id": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
},
"testDatasetValidation": {
"$ref": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation",
"description": "The test dataset validation information."
},
"trainingDatasetValidation": {
"$ref": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation",
"description": "The training dataset validation information."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation": {
"description": "The dataset validation information. This includes any and all errors with documents and the dataset.",
"id": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation",
"properties": {
"datasetErrorCount": {
"description": "The total number of dataset errors.",
"format": "int32",
"type": "integer"
},
"datasetErrors": {
"description": "Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
},
"documentErrorCount": {
"description": "The total number of document errors.",
"format": "int32",
"type": "integer"
},
"documentErrors": {
"description": "Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training.",
"items": {
"$ref": "GoogleRpcStatus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse": {
"description": "The response for TrainProcessorVersion.",
"id": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse",
"properties": {
"processorVersion": {
"description": "The resource name of the processor version produced by training.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata": {
"description": "The long-running operation metadata for the UndeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse": {
"description": "Response message for the UndeployProcessorVersion method.",
"id": "GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse",
"properties": {},
"type": "object"
},
"GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata": {
"id": "GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata",
"properties": {
"commonMetadata": {
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
"description": "The basic metadata of the long-running operation."
}
},
"type": "object"
},
"GoogleLongrunningOperation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "GoogleLongrunningOperation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
"type": "boolean"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
"type": "object"
}
},
"type": "object"
},
"GoogleProtobufEmpty": {
"description": "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); }",
"id": "GoogleProtobufEmpty",
"properties": {},
"type": "object"
},
"GoogleRpcStatus": {
"description": "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](https://github.com/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](https://cloud.google.com/apis/design/errors).",
"id": "GoogleRpcStatus",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"GoogleTypeColor": {
"description": "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\u2014for 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(''); }; // ...",
"id": "GoogleTypeColor",
"properties": {
"alpha": {
"description": "The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).",
"format": "float",
"type": "number"
},
"blue": {
"description": "The amount of blue in the color as a value in the interval [0, 1].",
"format": "float",
"type": "number"
},
"green": {
"description": "The amount of green in the color as a value in the interval [0, 1].",
"format": "float",
"type": "number"
},
"red": {
"description": "The amount of red in the color as a value in the interval [0, 1].",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleTypeDate": {
"description": "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",
"id": "GoogleTypeDate",
"properties": {
"day": {
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
"format": "int32",
"type": "integer"
},
"month": {
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
"format": "int32",
"type": "integer"
},
"year": {
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleTypeDateTime": {
"description": "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.",
"id": "GoogleTypeDateTime",
"properties": {
"day": {
"description": "Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.",
"format": "int32",
"type": "integer"
},
"hours": {
"description": "Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",
"format": "int32",
"type": "integer"
},
"minutes": {
"description": "Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.",
"format": "int32",
"type": "integer"
},
"month": {
"description": "Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.",
"format": "int32",
"type": "integer"
},
"nanos": {
"description": "Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.",
"format": "int32",
"type": "integer"
},
"seconds": {
"description": "Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.",
"format": "int32",
"type": "integer"
},
"timeZone": {
"$ref": "GoogleTypeTimeZone",
"description": "Time zone."
},
"utcOffset": {
"description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.",
"format": "google-duration",
"type": "string"
},
"year": {
"description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleTypeMoney": {
"description": "Represents an amount of money with its currency type.",
"id": "GoogleTypeMoney",
"properties": {
"currencyCode": {
"description": "The three-letter currency code defined in ISO 4217.",
"type": "string"
},
"nanos": {
"description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
"format": "int32",
"type": "integer"
},
"units": {
"description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleTypePostalAddress": {
"description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / 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, please see: https://support.google.com/business/answer/6397478",
"id": "GoogleTypePostalAddress",
"properties": {
"addressLines": {
"description": "Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).",
"items": {
"type": "string"
},
"type": "array"
},
"administrativeArea": {
"description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.",
"type": "string"
},
"languageCode": {
"description": "Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\".",
"type": "string"
},
"locality": {
"description": "Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.",
"type": "string"
},
"organization": {
"description": "Optional. The name of the organization at the address.",
"type": "string"
},
"postalCode": {
"description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).",
"type": "string"
},
"recipients": {
"description": "Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain \"care of\" information.",
"items": {
"type": "string"
},
"type": "array"
},
"regionCode": {
"description": "Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland.",
"type": "string"
},
"revision": {
"description": "The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.",
"format": "int32",
"type": "integer"
},
"sortingCode": {
"description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (e.g. \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (e.g. C\u00f4te d'Ivoire).",
"type": "string"
},
"sublocality": {
"description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.",
"type": "string"
}
},
"type": "object"
},
"GoogleTypeTimeZone": {
"description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).",
"id": "GoogleTypeTimeZone",
"properties": {
"id": {
"description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".",
"type": "string"
},
"version": {
"description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Cloud Document AI API",
"version": "v1beta2",
"version_module": true
}