google-api-python-client 2.186.0__py3-none-any.whl → 2.188.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.188.0.dist-info}/METADATA +1 -1
- {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.188.0.dist-info}/RECORD +321 -319
- googleapiclient/discovery.py +13 -6
- googleapiclient/discovery_cache/documents/accessapproval.v1.json +9 -3
- googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +3 -3
- googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json +2 -2
- googleapiclient/discovery_cache/documents/admin.directory_v1.json +75 -1
- googleapiclient/discovery_cache/documents/admin.directoryv1.json +75 -1
- googleapiclient/discovery_cache/documents/admin.reports_v1.json +37 -6
- googleapiclient/discovery_cache/documents/admin.reportsv1.json +37 -6
- googleapiclient/discovery_cache/documents/aiplatform.v1.json +20205 -8402
- googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +22191 -10441
- googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +6 -2
- googleapiclient/discovery_cache/documents/alloydb.v1.json +377 -22
- googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +403 -36
- googleapiclient/discovery_cache/documents/alloydb.v1beta.json +403 -36
- googleapiclient/discovery_cache/documents/analyticshub.v1.json +40 -2
- googleapiclient/discovery_cache/documents/androidmanagement.v1.json +13 -11
- googleapiclient/discovery_cache/documents/androidpublisher.v3.json +314 -6
- googleapiclient/discovery_cache/documents/apigateway.v1.json +4 -4
- googleapiclient/discovery_cache/documents/apigateway.v1beta.json +4 -4
- googleapiclient/discovery_cache/documents/apigee.v1.json +1236 -52
- googleapiclient/discovery_cache/documents/apihub.v1.json +685 -7
- googleapiclient/discovery_cache/documents/apim.v1alpha.json +4 -4
- googleapiclient/discovery_cache/documents/appengine.v1.json +180 -11
- googleapiclient/discovery_cache/documents/appengine.v1alpha.json +71 -13
- googleapiclient/discovery_cache/documents/appengine.v1beta.json +225 -13
- googleapiclient/discovery_cache/documents/apphub.v1.json +331 -5
- googleapiclient/discovery_cache/documents/apphub.v1alpha.json +331 -5
- googleapiclient/discovery_cache/documents/appsmarket.v2.json +283 -0
- googleapiclient/discovery_cache/documents/artifactregistry.v1.json +150 -5
- googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +2 -2
- googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +3 -3
- googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json +55 -4
- googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json +883 -5
- googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1beta.json +914 -3
- googleapiclient/discovery_cache/documents/backupdr.v1.json +383 -34
- googleapiclient/discovery_cache/documents/batch.v1.json +14 -8
- googleapiclient/discovery_cache/documents/beyondcorp.v1.json +24 -24
- googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +24 -24
- googleapiclient/discovery_cache/documents/biglake.v1.json +273 -1
- googleapiclient/discovery_cache/documents/bigquery.v2.json +45 -3
- googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +16 -2
- googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +16 -1
- googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +5 -5
- googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json +43 -1
- googleapiclient/discovery_cache/documents/calendar.v3.json +21 -5
- googleapiclient/discovery_cache/documents/certificatemanager.v1.json +48 -4
- googleapiclient/discovery_cache/documents/chat.v1.json +38 -30
- googleapiclient/discovery_cache/documents/checks.v1alpha.json +3 -3
- googleapiclient/discovery_cache/documents/chromemanagement.v1.json +224 -6
- googleapiclient/discovery_cache/documents/chromewebstore.v2.json +550 -0
- googleapiclient/discovery_cache/documents/classroom.v1.json +10 -6
- googleapiclient/discovery_cache/documents/cloudasset.v1.json +11 -4
- googleapiclient/discovery_cache/documents/cloudbuild.v1.json +41 -2
- googleapiclient/discovery_cache/documents/cloudbuild.v2.json +12 -2
- googleapiclient/discovery_cache/documents/cloudchannel.v1.json +4 -4
- googleapiclient/discovery_cache/documents/clouddeploy.v1.json +115 -4
- googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +4 -4
- googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +81 -8
- googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +124 -8
- googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +124 -8
- googleapiclient/discovery_cache/documents/cloudidentity.v1.json +6 -5
- googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +79 -6
- googleapiclient/discovery_cache/documents/cloudkms.v1.json +1056 -245
- googleapiclient/discovery_cache/documents/cloudlocationfinder.v1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudlocationfinder.v1alpha.json +2 -2
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json +5 -3
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json +5 -3
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json +5 -3
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json +5 -3
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +20 -8
- googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +83 -9
- googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +201 -7
- googleapiclient/discovery_cache/documents/cloudshell.v1.json +51 -3
- googleapiclient/discovery_cache/documents/cloudsupport.v2.json +6 -1
- googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +6 -1
- googleapiclient/discovery_cache/documents/cloudtasks.v2.json +2 -2
- googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json +2 -2
- googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +2 -2
- googleapiclient/discovery_cache/documents/composer.v1.json +7 -5
- googleapiclient/discovery_cache/documents/composer.v1beta1.json +7 -5
- googleapiclient/discovery_cache/documents/compute.alpha.json +6736 -1882
- googleapiclient/discovery_cache/documents/compute.beta.json +7349 -2205
- googleapiclient/discovery_cache/documents/compute.v1.json +4065 -1275
- googleapiclient/discovery_cache/documents/config.v1.json +96 -10
- googleapiclient/discovery_cache/documents/connectors.v1.json +62 -6
- googleapiclient/discovery_cache/documents/connectors.v2.json +252 -1
- googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +376 -4
- googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +4224 -326
- googleapiclient/discovery_cache/documents/container.v1.json +473 -190
- googleapiclient/discovery_cache/documents/container.v1beta1.json +756 -190
- googleapiclient/discovery_cache/documents/containeranalysis.v1.json +30 -1
- googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +34 -3
- googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +34 -3
- googleapiclient/discovery_cache/documents/content.v2.1.json +12 -645
- googleapiclient/discovery_cache/documents/datacatalog.v1.json +249 -5
- googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json +247 -3
- googleapiclient/discovery_cache/documents/dataflow.v1b3.json +121 -1
- googleapiclient/discovery_cache/documents/dataform.v1.json +63 -4
- googleapiclient/discovery_cache/documents/dataform.v1beta1.json +834 -41
- googleapiclient/discovery_cache/documents/datafusion.v1.json +221 -2
- googleapiclient/discovery_cache/documents/datafusion.v1beta1.json +221 -2
- googleapiclient/discovery_cache/documents/datalineage.v1.json +3 -3
- googleapiclient/discovery_cache/documents/datamanager.v1.json +156 -6
- googleapiclient/discovery_cache/documents/datamigration.v1.json +121 -33
- googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +13 -1
- googleapiclient/discovery_cache/documents/dataplex.v1.json +654 -36
- googleapiclient/discovery_cache/documents/dataportability.v1.json +55 -1
- googleapiclient/discovery_cache/documents/dataportability.v1beta.json +55 -1
- googleapiclient/discovery_cache/documents/dataproc.v1.json +24 -2
- googleapiclient/discovery_cache/documents/datastore.v1.json +3 -23
- googleapiclient/discovery_cache/documents/datastore.v1beta1.json +1 -21
- googleapiclient/discovery_cache/documents/datastore.v1beta3.json +1 -21
- googleapiclient/discovery_cache/documents/datastream.v1.json +259 -33
- googleapiclient/discovery_cache/documents/datastream.v1alpha1.json +13 -1
- googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +46 -15
- googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +46 -15
- googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +46 -15
- googleapiclient/discovery_cache/documents/developerconnect.v1.json +461 -21
- googleapiclient/discovery_cache/documents/dfareporting.v4.json +47 -6
- googleapiclient/discovery_cache/documents/dfareporting.v5.json +47 -6
- googleapiclient/discovery_cache/documents/dialogflow.v2.json +60 -11
- googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +59 -10
- googleapiclient/discovery_cache/documents/dialogflow.v3.json +154 -7
- googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +154 -7
- googleapiclient/discovery_cache/documents/discoveryengine.v1.json +2695 -794
- googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +3488 -872
- googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +1261 -546
- googleapiclient/discovery_cache/documents/displayvideo.v2.json +196 -1426
- googleapiclient/discovery_cache/documents/displayvideo.v3.json +2356 -3035
- googleapiclient/discovery_cache/documents/displayvideo.v4.json +1779 -208
- googleapiclient/discovery_cache/documents/dlp.v2.json +26 -10
- googleapiclient/discovery_cache/documents/docs.v1.json +282 -43
- googleapiclient/discovery_cache/documents/documentai.v1.json +2476 -420
- googleapiclient/discovery_cache/documents/documentai.v1beta3.json +1701 -248
- googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json +3 -3
- googleapiclient/discovery_cache/documents/drive.v2.json +2 -2
- googleapiclient/discovery_cache/documents/drive.v3.json +245 -14
- googleapiclient/discovery_cache/documents/eventarc.v1.json +20 -95
- googleapiclient/discovery_cache/documents/file.v1.json +134 -13
- googleapiclient/discovery_cache/documents/file.v1beta1.json +26 -14
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +17 -12
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +101 -20
- googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json +15 -3
- googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json +15 -3
- googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json +59 -7
- googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json +59 -7
- googleapiclient/discovery_cache/documents/firebasehosting.v1.json +3 -3
- googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/firebaseml.v1.json +3 -3
- googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +408 -261
- googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/firestore.v1.json +202 -31
- googleapiclient/discovery_cache/documents/firestore.v1beta1.json +192 -21
- googleapiclient/discovery_cache/documents/firestore.v1beta2.json +1 -21
- googleapiclient/discovery_cache/documents/gkebackup.v1.json +4 -4
- googleapiclient/discovery_cache/documents/gkehub.v1.json +4 -4
- googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +727 -4
- googleapiclient/discovery_cache/documents/gkehub.v1beta.json +727 -4
- googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +4 -4
- googleapiclient/discovery_cache/documents/gkehub.v2.json +4 -4
- googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +4 -4
- googleapiclient/discovery_cache/documents/gkehub.v2beta.json +4 -4
- googleapiclient/discovery_cache/documents/gkeonprem.v1.json +180 -2
- googleapiclient/discovery_cache/documents/gmail.v1.json +42 -2
- googleapiclient/discovery_cache/documents/healthcare.v1.json +58 -21
- googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +58 -21
- googleapiclient/discovery_cache/documents/iam.v1.json +73 -73
- googleapiclient/discovery_cache/documents/iamcredentials.v1.json +1 -1
- googleapiclient/discovery_cache/documents/identitytoolkit.v1.json +5 -5
- googleapiclient/discovery_cache/documents/ids.v1.json +14 -2
- googleapiclient/discovery_cache/documents/kmsinventory.v1.json +26 -10
- googleapiclient/discovery_cache/documents/language.v1.json +170 -4
- googleapiclient/discovery_cache/documents/language.v1beta2.json +170 -4
- googleapiclient/discovery_cache/documents/language.v2.json +170 -4
- googleapiclient/discovery_cache/documents/licensing.v1.json +2 -2
- googleapiclient/discovery_cache/documents/logging.v2.json +46 -9
- googleapiclient/discovery_cache/documents/looker.v1.json +61 -4
- googleapiclient/discovery_cache/documents/managedkafka.v1.json +290 -8
- googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json +304 -1
- googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json +189 -17
- googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +189 -17
- googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json +2 -2
- googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json +9 -9
- googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +9 -9
- googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json +2 -2
- googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/merchantapi.products_v1.json +42 -11
- googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +13 -11
- googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json +130 -1
- googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json +2 -2
- googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/metastore.v1.json +4 -4
- googleapiclient/discovery_cache/documents/metastore.v1alpha.json +4 -4
- googleapiclient/discovery_cache/documents/metastore.v1beta.json +4 -4
- googleapiclient/discovery_cache/documents/migrationcenter.v1.json +15 -6
- googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +348 -11
- googleapiclient/discovery_cache/documents/ml.v1.json +13 -1
- googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json +9 -5
- googleapiclient/discovery_cache/documents/netapp.v1.json +453 -18
- googleapiclient/discovery_cache/documents/netapp.v1beta1.json +453 -18
- googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +6 -7
- googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +4 -4
- googleapiclient/discovery_cache/documents/networkmanagement.v1.json +123 -16
- googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +119 -16
- googleapiclient/discovery_cache/documents/networksecurity.v1.json +419 -6
- googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +189 -7
- googleapiclient/discovery_cache/documents/networkservices.v1.json +366 -53
- googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +80 -55
- googleapiclient/discovery_cache/documents/notebooks.v1.json +4 -4
- googleapiclient/discovery_cache/documents/notebooks.v2.json +23 -10
- googleapiclient/discovery_cache/documents/observability.v1.json +5 -5
- googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +3 -3
- googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/oracledatabase.v1.json +4 -4
- googleapiclient/discovery_cache/documents/orgpolicy.v2.json +4 -4
- googleapiclient/discovery_cache/documents/osconfig.v1.json +16 -3
- googleapiclient/discovery_cache/documents/osconfig.v1beta.json +16 -3
- googleapiclient/discovery_cache/documents/osconfig.v2.json +5 -5
- googleapiclient/discovery_cache/documents/osconfig.v2beta.json +5 -5
- googleapiclient/discovery_cache/documents/oslogin.v1.json +44 -1
- googleapiclient/discovery_cache/documents/parallelstore.v1.json +2 -2
- googleapiclient/discovery_cache/documents/parallelstore.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/parametermanager.v1.json +22 -2
- googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +34 -1
- googleapiclient/discovery_cache/documents/people.v1.json +2 -2
- googleapiclient/discovery_cache/documents/places.v1.json +13 -5
- googleapiclient/discovery_cache/documents/policysimulator.v1.json +8 -8
- googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +8 -8
- googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +8 -8
- googleapiclient/discovery_cache/documents/privateca.v1.json +5 -5
- googleapiclient/discovery_cache/documents/privateca.v1beta1.json +4 -4
- googleapiclient/discovery_cache/documents/pubsub.v1.json +202 -27
- googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json +153 -3
- googleapiclient/discovery_cache/documents/pubsub.v1beta2.json +153 -3
- googleapiclient/discovery_cache/documents/pubsublite.v1.json +3 -3
- googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +10 -8
- googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json +4 -4
- googleapiclient/discovery_cache/documents/recommender.v1beta1.json +5 -5
- googleapiclient/discovery_cache/documents/redis.v1.json +51 -36
- googleapiclient/discovery_cache/documents/redis.v1beta1.json +51 -36
- googleapiclient/discovery_cache/documents/retail.v2.json +5 -5
- googleapiclient/discovery_cache/documents/retail.v2alpha.json +9 -7
- googleapiclient/discovery_cache/documents/retail.v2beta.json +9 -7
- googleapiclient/discovery_cache/documents/run.v1.json +269 -5
- googleapiclient/discovery_cache/documents/run.v2.json +320 -6
- googleapiclient/discovery_cache/documents/runtimeconfig.v1.json +13 -1
- googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json +23 -398
- googleapiclient/discovery_cache/documents/safebrowsing.v5.json +79 -5
- googleapiclient/discovery_cache/documents/searchads360.v0.json +228 -21
- googleapiclient/discovery_cache/documents/secretmanager.v1.json +47 -2
- googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +47 -2
- googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +47 -2
- googleapiclient/discovery_cache/documents/securitycenter.v1.json +641 -7
- googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +637 -7
- googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +634 -5
- googleapiclient/discovery_cache/documents/securityposture.v1.json +13 -1
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +17 -1
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +5 -1
- googleapiclient/discovery_cache/documents/servicecontrol.v1.json +9 -1
- googleapiclient/discovery_cache/documents/servicecontrol.v2.json +9 -1
- googleapiclient/discovery_cache/documents/servicedirectory.v1.json +2 -2
- googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/servicemanagement.v1.json +4 -4
- googleapiclient/discovery_cache/documents/servicenetworking.v1.json +4 -4
- googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/serviceusage.v1.json +35 -12
- googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +35 -12
- googleapiclient/discovery_cache/documents/sheets.v4.json +2 -2
- googleapiclient/discovery_cache/documents/solar.v1.json +6 -1
- googleapiclient/discovery_cache/documents/spanner.v1.json +131 -8
- googleapiclient/discovery_cache/documents/speech.v1.json +3 -3
- googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/sqladmin.v1.json +280 -13
- googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +287 -15
- googleapiclient/discovery_cache/documents/storage.v1.json +6 -2
- googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json +14 -4
- googleapiclient/discovery_cache/documents/storagetransfer.v1.json +27 -3
- googleapiclient/discovery_cache/documents/sts.v1.json +10 -1
- googleapiclient/discovery_cache/documents/sts.v1beta.json +10 -1
- googleapiclient/discovery_cache/documents/tagmanager.v2.json +55 -1
- googleapiclient/discovery_cache/documents/tasks.v1.json +2 -2
- googleapiclient/discovery_cache/documents/testing.v1.json +7 -2
- googleapiclient/discovery_cache/documents/texttospeech.v1.json +4 -4
- googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +4 -4
- googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +2 -2
- googleapiclient/discovery_cache/documents/tpu.v1.json +31 -4
- googleapiclient/discovery_cache/documents/tpu.v1alpha1.json +44 -17
- googleapiclient/discovery_cache/documents/tpu.v2.json +4 -4
- googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +4 -4
- googleapiclient/discovery_cache/documents/trafficdirector.v2.json +228 -1
- googleapiclient/discovery_cache/documents/trafficdirector.v3.json +228 -1
- googleapiclient/discovery_cache/documents/translate.v3.json +118 -18
- googleapiclient/discovery_cache/documents/translate.v3beta1.json +106 -10
- googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +6 -6
- googleapiclient/discovery_cache/documents/vault.v1.json +3 -3
- googleapiclient/discovery_cache/documents/verifiedaccess.v2.json +9 -5
- googleapiclient/discovery_cache/documents/vision.v1.json +3 -3
- googleapiclient/discovery_cache/documents/vmmigration.v1.json +22 -6
- googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +22 -6
- googleapiclient/discovery_cache/documents/vmwareengine.v1.json +549 -2
- googleapiclient/discovery_cache/documents/vpcaccess.v1.json +14 -2
- googleapiclient/discovery_cache/documents/vpcaccess.v1beta1.json +14 -2
- googleapiclient/discovery_cache/documents/walletobjects.v1.json +6 -1
- googleapiclient/discovery_cache/documents/webrisk.v1.json +3 -3
- googleapiclient/discovery_cache/documents/workflows.v1.json +14 -2
- googleapiclient/discovery_cache/documents/workflows.v1beta.json +14 -2
- googleapiclient/discovery_cache/documents/workloadmanager.v1.json +5 -5
- googleapiclient/discovery_cache/documents/workspaceevents.v1.json +706 -1
- googleapiclient/discovery_cache/documents/workstations.v1.json +47 -4
- googleapiclient/discovery_cache/documents/workstations.v1beta.json +53 -3
- googleapiclient/discovery_cache/documents/youtube.v3.json +149 -1
- googleapiclient/discovery_cache/documents/youtubereporting.v1.json +6 -1
- googleapiclient/version.py +1 -1
- {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.188.0.dist-info}/WHEEL +0 -0
- {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.188.0.dist-info}/licenses/LICENSE +0 -0
- {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.188.0.dist-info}/top_level.txt +0 -0
|
@@ -169,7 +169,7 @@
|
|
|
169
169
|
],
|
|
170
170
|
"parameters": {
|
|
171
171
|
"extraLocationTypes": {
|
|
172
|
-
"description": "Optional.
|
|
172
|
+
"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
|
|
173
173
|
"location": "query",
|
|
174
174
|
"repeated": true,
|
|
175
175
|
"type": "string"
|
|
@@ -293,7 +293,7 @@
|
|
|
293
293
|
"type": "string"
|
|
294
294
|
},
|
|
295
295
|
"returnPartialSuccess": {
|
|
296
|
-
"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the
|
|
296
|
+
"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
|
|
297
297
|
"location": "query",
|
|
298
298
|
"type": "boolean"
|
|
299
299
|
}
|
|
@@ -904,8 +904,10 @@
|
|
|
904
904
|
}
|
|
905
905
|
},
|
|
906
906
|
"humanReviewConfig": {
|
|
907
|
+
"deprecated": true,
|
|
907
908
|
"methods": {
|
|
908
909
|
"reviewDocument": {
|
|
910
|
+
"deprecated": true,
|
|
909
911
|
"description": "Send a document for Human Review. The input document should be processed by the specified processor.",
|
|
910
912
|
"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/humanReviewConfig:reviewDocument",
|
|
911
913
|
"httpMethod": "POST",
|
|
@@ -1289,164 +1291,508 @@
|
|
|
1289
1291
|
}
|
|
1290
1292
|
}
|
|
1291
1293
|
}
|
|
1292
|
-
}
|
|
1293
|
-
}
|
|
1294
|
-
}
|
|
1295
|
-
}
|
|
1296
|
-
}
|
|
1297
1294
|
},
|
|
1298
|
-
"revision": "20251013",
|
|
1299
|
-
"rootUrl": "https://documentai.googleapis.com/",
|
|
1300
1295
|
"schemas": {
|
|
1301
|
-
"
|
|
1302
|
-
"
|
|
1303
|
-
"
|
|
1304
|
-
"
|
|
1305
|
-
"
|
|
1306
|
-
"
|
|
1307
|
-
"
|
|
1308
|
-
|
|
1309
|
-
|
|
1296
|
+
"methods": {
|
|
1297
|
+
"create": {
|
|
1298
|
+
"description": "Creates a schema.",
|
|
1299
|
+
"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas",
|
|
1300
|
+
"httpMethod": "POST",
|
|
1301
|
+
"id": "documentai.projects.locations.schemas.create",
|
|
1302
|
+
"parameterOrder": [
|
|
1303
|
+
"parent"
|
|
1304
|
+
],
|
|
1305
|
+
"parameters": {
|
|
1306
|
+
"parent": {
|
|
1307
|
+
"description": "Required. The parent (project and location) under which to create the Schema. Format: `projects/{project}/locations/{location}`",
|
|
1308
|
+
"location": "path",
|
|
1309
|
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
1310
|
+
"required": true,
|
|
1311
|
+
"type": "string"
|
|
1310
1312
|
}
|
|
1311
1313
|
},
|
|
1312
|
-
"
|
|
1314
|
+
"path": "v1beta3/{+parent}/schemas",
|
|
1315
|
+
"request": {
|
|
1316
|
+
"$ref": "GoogleCloudDocumentaiV1beta3NextSchema"
|
|
1313
1317
|
},
|
|
1314
|
-
"
|
|
1315
|
-
"
|
|
1316
|
-
"properties": {
|
|
1317
|
-
"childAlignmentRule": {
|
|
1318
|
-
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule"
|
|
1318
|
+
"response": {
|
|
1319
|
+
"$ref": "GoogleCloudDocumentaiV1beta3NextSchema"
|
|
1319
1320
|
},
|
|
1320
|
-
"
|
|
1321
|
-
"
|
|
1322
|
-
|
|
1321
|
+
"scopes": [
|
|
1322
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1323
|
+
]
|
|
1323
1324
|
},
|
|
1324
|
-
"
|
|
1325
|
-
"
|
|
1325
|
+
"delete": {
|
|
1326
|
+
"description": "Deletes a schema.",
|
|
1327
|
+
"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}",
|
|
1328
|
+
"httpMethod": "DELETE",
|
|
1329
|
+
"id": "documentai.projects.locations.schemas.delete",
|
|
1330
|
+
"parameterOrder": [
|
|
1331
|
+
"name"
|
|
1332
|
+
],
|
|
1333
|
+
"parameters": {
|
|
1334
|
+
"force": {
|
|
1335
|
+
"description": "Optional. If set to true, any child resources of this Schema will also be deleted. (Otherwise, the request will only work if the Schema has no child resources.)",
|
|
1336
|
+
"location": "query",
|
|
1337
|
+
"type": "boolean"
|
|
1326
1338
|
},
|
|
1327
|
-
"
|
|
1328
|
-
"
|
|
1339
|
+
"name": {
|
|
1340
|
+
"description": "Required. The name of the Schema to be deleted. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
|
|
1341
|
+
"location": "path",
|
|
1342
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$",
|
|
1343
|
+
"required": true,
|
|
1344
|
+
"type": "string"
|
|
1345
|
+
}
|
|
1329
1346
|
},
|
|
1330
|
-
"
|
|
1331
|
-
"
|
|
1347
|
+
"path": "v1beta3/{+name}",
|
|
1348
|
+
"response": {
|
|
1349
|
+
"$ref": "GoogleLongrunningOperation"
|
|
1332
1350
|
},
|
|
1333
|
-
"
|
|
1334
|
-
"
|
|
1351
|
+
"scopes": [
|
|
1352
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1353
|
+
]
|
|
1335
1354
|
},
|
|
1355
|
+
"get": {
|
|
1356
|
+
"description": "Gets a schema.",
|
|
1357
|
+
"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}",
|
|
1358
|
+
"httpMethod": "GET",
|
|
1359
|
+
"id": "documentai.projects.locations.schemas.get",
|
|
1360
|
+
"parameterOrder": [
|
|
1361
|
+
"name"
|
|
1362
|
+
],
|
|
1363
|
+
"parameters": {
|
|
1336
1364
|
"name": {
|
|
1337
|
-
"description": "
|
|
1365
|
+
"description": "Required. The name of the Schema to get. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
|
|
1366
|
+
"location": "path",
|
|
1367
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$",
|
|
1368
|
+
"required": true,
|
|
1338
1369
|
"type": "string"
|
|
1339
1370
|
}
|
|
1340
1371
|
},
|
|
1341
|
-
"
|
|
1372
|
+
"path": "v1beta3/{+name}",
|
|
1373
|
+
"response": {
|
|
1374
|
+
"$ref": "GoogleCloudDocumentaiV1beta3NextSchema"
|
|
1342
1375
|
},
|
|
1343
|
-
"
|
|
1344
|
-
"
|
|
1345
|
-
|
|
1346
|
-
|
|
1347
|
-
"
|
|
1348
|
-
"
|
|
1349
|
-
"
|
|
1350
|
-
"
|
|
1351
|
-
"
|
|
1352
|
-
|
|
1353
|
-
"
|
|
1354
|
-
"",
|
|
1355
|
-
"",
|
|
1356
|
-
""
|
|
1376
|
+
"scopes": [
|
|
1377
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1378
|
+
]
|
|
1379
|
+
},
|
|
1380
|
+
"list": {
|
|
1381
|
+
"description": "Lists Schemas.",
|
|
1382
|
+
"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas",
|
|
1383
|
+
"httpMethod": "GET",
|
|
1384
|
+
"id": "documentai.projects.locations.schemas.list",
|
|
1385
|
+
"parameterOrder": [
|
|
1386
|
+
"parent"
|
|
1357
1387
|
],
|
|
1388
|
+
"parameters": {
|
|
1389
|
+
"pageSize": {
|
|
1390
|
+
"description": "Optional. The maximum number of schema groups to return. If unspecified, at most `10` Schema will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`.",
|
|
1391
|
+
"format": "int32",
|
|
1392
|
+
"location": "query",
|
|
1393
|
+
"type": "integer"
|
|
1394
|
+
},
|
|
1395
|
+
"pageToken": {
|
|
1396
|
+
"description": "Optional. We will return the schema groups sorted by creation time. The page token will point to the next Schema.",
|
|
1397
|
+
"location": "query",
|
|
1358
1398
|
"type": "string"
|
|
1359
1399
|
},
|
|
1360
|
-
"
|
|
1361
|
-
"description": "
|
|
1362
|
-
"
|
|
1363
|
-
"
|
|
1400
|
+
"parent": {
|
|
1401
|
+
"description": "Required. Format: `projects/{project}/locations/{location}`",
|
|
1402
|
+
"location": "path",
|
|
1403
|
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
1404
|
+
"required": true,
|
|
1405
|
+
"type": "string"
|
|
1364
1406
|
}
|
|
1365
1407
|
},
|
|
1366
|
-
"
|
|
1367
|
-
|
|
1368
|
-
"
|
|
1369
|
-
"description": "A rule that aligns specified child fields with a parent field.",
|
|
1370
|
-
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule",
|
|
1371
|
-
"properties": {
|
|
1372
|
-
"alignmentRule": {
|
|
1373
|
-
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule",
|
|
1374
|
-
"description": "The alignment rule to apply to the child fields."
|
|
1408
|
+
"path": "v1beta3/{+parent}/schemas",
|
|
1409
|
+
"response": {
|
|
1410
|
+
"$ref": "GoogleCloudDocumentaiV1beta3ListSchemasResponse"
|
|
1375
1411
|
},
|
|
1376
|
-
"
|
|
1377
|
-
"
|
|
1378
|
-
|
|
1379
|
-
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField"
|
|
1412
|
+
"scopes": [
|
|
1413
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1414
|
+
]
|
|
1380
1415
|
},
|
|
1381
|
-
"
|
|
1416
|
+
"patch": {
|
|
1417
|
+
"description": "Updates a schema. Editable fields are: - `display_name` - `labels`",
|
|
1418
|
+
"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}",
|
|
1419
|
+
"httpMethod": "PATCH",
|
|
1420
|
+
"id": "documentai.projects.locations.schemas.patch",
|
|
1421
|
+
"parameterOrder": [
|
|
1422
|
+
"name"
|
|
1423
|
+
],
|
|
1424
|
+
"parameters": {
|
|
1425
|
+
"name": {
|
|
1426
|
+
"description": "Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
|
|
1427
|
+
"location": "path",
|
|
1428
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$",
|
|
1429
|
+
"required": true,
|
|
1430
|
+
"type": "string"
|
|
1382
1431
|
},
|
|
1383
|
-
"
|
|
1384
|
-
"
|
|
1385
|
-
"
|
|
1432
|
+
"updateMask": {
|
|
1433
|
+
"description": "Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.",
|
|
1434
|
+
"format": "google-fieldmask",
|
|
1435
|
+
"location": "query",
|
|
1436
|
+
"type": "string"
|
|
1386
1437
|
}
|
|
1387
1438
|
},
|
|
1388
|
-
"
|
|
1439
|
+
"path": "v1beta3/{+name}",
|
|
1440
|
+
"request": {
|
|
1441
|
+
"$ref": "GoogleCloudDocumentaiV1beta3NextSchema"
|
|
1389
1442
|
},
|
|
1390
|
-
"
|
|
1391
|
-
"
|
|
1392
|
-
|
|
1393
|
-
"
|
|
1394
|
-
"
|
|
1395
|
-
|
|
1396
|
-
"type": "number"
|
|
1443
|
+
"response": {
|
|
1444
|
+
"$ref": "GoogleCloudDocumentaiV1beta3NextSchema"
|
|
1445
|
+
},
|
|
1446
|
+
"scopes": [
|
|
1447
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1448
|
+
]
|
|
1397
1449
|
}
|
|
1398
1450
|
},
|
|
1399
|
-
"
|
|
1451
|
+
"resources": {
|
|
1452
|
+
"schemaVersions": {
|
|
1453
|
+
"methods": {
|
|
1454
|
+
"create": {
|
|
1455
|
+
"description": "Creates a schema version.",
|
|
1456
|
+
"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions",
|
|
1457
|
+
"httpMethod": "POST",
|
|
1458
|
+
"id": "documentai.projects.locations.schemas.schemaVersions.create",
|
|
1459
|
+
"parameterOrder": [
|
|
1460
|
+
"parent"
|
|
1461
|
+
],
|
|
1462
|
+
"parameters": {
|
|
1463
|
+
"parent": {
|
|
1464
|
+
"description": "Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
|
|
1465
|
+
"location": "path",
|
|
1466
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$",
|
|
1467
|
+
"required": true,
|
|
1468
|
+
"type": "string"
|
|
1469
|
+
}
|
|
1400
1470
|
},
|
|
1401
|
-
"
|
|
1402
|
-
"
|
|
1403
|
-
"
|
|
1404
|
-
"properties": {
|
|
1405
|
-
"alignmentRule": {
|
|
1406
|
-
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule",
|
|
1407
|
-
"description": "The alignment rule to apply to the fields."
|
|
1471
|
+
"path": "v1beta3/{+parent}/schemaVersions",
|
|
1472
|
+
"request": {
|
|
1473
|
+
"$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion"
|
|
1408
1474
|
},
|
|
1409
|
-
"
|
|
1410
|
-
"
|
|
1411
|
-
"items": {
|
|
1412
|
-
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField"
|
|
1475
|
+
"response": {
|
|
1476
|
+
"$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion"
|
|
1413
1477
|
},
|
|
1414
|
-
"
|
|
1478
|
+
"scopes": [
|
|
1479
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1480
|
+
]
|
|
1481
|
+
},
|
|
1482
|
+
"delete": {
|
|
1483
|
+
"description": "Deletes a schema version.",
|
|
1484
|
+
"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}",
|
|
1485
|
+
"httpMethod": "DELETE",
|
|
1486
|
+
"id": "documentai.projects.locations.schemas.schemaVersions.delete",
|
|
1487
|
+
"parameterOrder": [
|
|
1488
|
+
"name"
|
|
1489
|
+
],
|
|
1490
|
+
"parameters": {
|
|
1491
|
+
"name": {
|
|
1492
|
+
"description": "Required. The name of the SchemaVersion to delete. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`",
|
|
1493
|
+
"location": "path",
|
|
1494
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$",
|
|
1495
|
+
"required": true,
|
|
1496
|
+
"type": "string"
|
|
1415
1497
|
}
|
|
1416
1498
|
},
|
|
1417
|
-
"
|
|
1499
|
+
"path": "v1beta3/{+name}",
|
|
1500
|
+
"response": {
|
|
1501
|
+
"$ref": "GoogleLongrunningOperation"
|
|
1418
1502
|
},
|
|
1419
|
-
"
|
|
1420
|
-
"
|
|
1421
|
-
|
|
1422
|
-
"defaultValue": {
|
|
1423
|
-
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant",
|
|
1424
|
-
"description": "Default value to use if the field is not present. If the field is missing and the default value is not set, the validation run as if the field is not present in the validation logic."
|
|
1503
|
+
"scopes": [
|
|
1504
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1505
|
+
]
|
|
1425
1506
|
},
|
|
1426
|
-
"
|
|
1427
|
-
"description": "
|
|
1507
|
+
"generate": {
|
|
1508
|
+
"description": "Generates a schema version.",
|
|
1509
|
+
"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions:generate",
|
|
1510
|
+
"httpMethod": "POST",
|
|
1511
|
+
"id": "documentai.projects.locations.schemas.schemaVersions.generate",
|
|
1512
|
+
"parameterOrder": [
|
|
1513
|
+
"parent"
|
|
1514
|
+
],
|
|
1515
|
+
"parameters": {
|
|
1516
|
+
"parent": {
|
|
1517
|
+
"description": "Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
|
|
1518
|
+
"location": "path",
|
|
1519
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$",
|
|
1520
|
+
"required": true,
|
|
1428
1521
|
"type": "string"
|
|
1429
1522
|
}
|
|
1430
1523
|
},
|
|
1431
|
-
"
|
|
1432
|
-
|
|
1433
|
-
"
|
|
1434
|
-
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences",
|
|
1435
|
-
"properties": {
|
|
1436
|
-
"field": {
|
|
1437
|
-
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField"
|
|
1438
|
-
},
|
|
1439
|
-
"maxOccurrences": {
|
|
1440
|
-
"format": "uint32",
|
|
1441
|
-
"type": "integer"
|
|
1524
|
+
"path": "v1beta3/{+parent}/schemaVersions:generate",
|
|
1525
|
+
"request": {
|
|
1526
|
+
"$ref": "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest"
|
|
1442
1527
|
},
|
|
1443
|
-
"
|
|
1444
|
-
"
|
|
1445
|
-
"format": "uint32",
|
|
1446
|
-
"type": "integer"
|
|
1447
|
-
}
|
|
1528
|
+
"response": {
|
|
1529
|
+
"$ref": "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse"
|
|
1448
1530
|
},
|
|
1449
|
-
"
|
|
1531
|
+
"scopes": [
|
|
1532
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1533
|
+
]
|
|
1534
|
+
},
|
|
1535
|
+
"get": {
|
|
1536
|
+
"description": "Gets a schema version.",
|
|
1537
|
+
"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}",
|
|
1538
|
+
"httpMethod": "GET",
|
|
1539
|
+
"id": "documentai.projects.locations.schemas.schemaVersions.get",
|
|
1540
|
+
"parameterOrder": [
|
|
1541
|
+
"name"
|
|
1542
|
+
],
|
|
1543
|
+
"parameters": {
|
|
1544
|
+
"name": {
|
|
1545
|
+
"description": "Required. The name of the SchemaVersion to get. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`",
|
|
1546
|
+
"location": "path",
|
|
1547
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$",
|
|
1548
|
+
"required": true,
|
|
1549
|
+
"type": "string"
|
|
1550
|
+
}
|
|
1551
|
+
},
|
|
1552
|
+
"path": "v1beta3/{+name}",
|
|
1553
|
+
"response": {
|
|
1554
|
+
"$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion"
|
|
1555
|
+
},
|
|
1556
|
+
"scopes": [
|
|
1557
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1558
|
+
]
|
|
1559
|
+
},
|
|
1560
|
+
"list": {
|
|
1561
|
+
"description": "Lists SchemaVersions.",
|
|
1562
|
+
"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions",
|
|
1563
|
+
"httpMethod": "GET",
|
|
1564
|
+
"id": "documentai.projects.locations.schemas.schemaVersions.list",
|
|
1565
|
+
"parameterOrder": [
|
|
1566
|
+
"parent"
|
|
1567
|
+
],
|
|
1568
|
+
"parameters": {
|
|
1569
|
+
"pageSize": {
|
|
1570
|
+
"description": "Optional. The maximum number of SchemaVersion to return. If unspecified, at most `10` SchemaVersion will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`.",
|
|
1571
|
+
"format": "int32",
|
|
1572
|
+
"location": "query",
|
|
1573
|
+
"type": "integer"
|
|
1574
|
+
},
|
|
1575
|
+
"pageToken": {
|
|
1576
|
+
"description": "Optional. We will return the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion.",
|
|
1577
|
+
"location": "query",
|
|
1578
|
+
"type": "string"
|
|
1579
|
+
},
|
|
1580
|
+
"parent": {
|
|
1581
|
+
"description": "Required. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
|
|
1582
|
+
"location": "path",
|
|
1583
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$",
|
|
1584
|
+
"required": true,
|
|
1585
|
+
"type": "string"
|
|
1586
|
+
}
|
|
1587
|
+
},
|
|
1588
|
+
"path": "v1beta3/{+parent}/schemaVersions",
|
|
1589
|
+
"response": {
|
|
1590
|
+
"$ref": "GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse"
|
|
1591
|
+
},
|
|
1592
|
+
"scopes": [
|
|
1593
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1594
|
+
]
|
|
1595
|
+
},
|
|
1596
|
+
"patch": {
|
|
1597
|
+
"description": "Updates a schema version. Editable fields are: - `display_name` - `labels`",
|
|
1598
|
+
"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}",
|
|
1599
|
+
"httpMethod": "PATCH",
|
|
1600
|
+
"id": "documentai.projects.locations.schemas.schemaVersions.patch",
|
|
1601
|
+
"parameterOrder": [
|
|
1602
|
+
"name"
|
|
1603
|
+
],
|
|
1604
|
+
"parameters": {
|
|
1605
|
+
"name": {
|
|
1606
|
+
"description": "Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`",
|
|
1607
|
+
"location": "path",
|
|
1608
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$",
|
|
1609
|
+
"required": true,
|
|
1610
|
+
"type": "string"
|
|
1611
|
+
},
|
|
1612
|
+
"updateMask": {
|
|
1613
|
+
"description": "Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.",
|
|
1614
|
+
"format": "google-fieldmask",
|
|
1615
|
+
"location": "query",
|
|
1616
|
+
"type": "string"
|
|
1617
|
+
}
|
|
1618
|
+
},
|
|
1619
|
+
"path": "v1beta3/{+name}",
|
|
1620
|
+
"request": {
|
|
1621
|
+
"$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion"
|
|
1622
|
+
},
|
|
1623
|
+
"response": {
|
|
1624
|
+
"$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion"
|
|
1625
|
+
},
|
|
1626
|
+
"scopes": [
|
|
1627
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1628
|
+
]
|
|
1629
|
+
}
|
|
1630
|
+
}
|
|
1631
|
+
}
|
|
1632
|
+
}
|
|
1633
|
+
}
|
|
1634
|
+
}
|
|
1635
|
+
}
|
|
1636
|
+
}
|
|
1637
|
+
}
|
|
1638
|
+
},
|
|
1639
|
+
"revision": "20260104",
|
|
1640
|
+
"rootUrl": "https://documentai.googleapis.com/",
|
|
1641
|
+
"schemas": {
|
|
1642
|
+
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": {
|
|
1643
|
+
"description": "Definition of the validation rules. Those are the input to the validator logic and they are used to validate a document. Next ID: 3",
|
|
1644
|
+
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput",
|
|
1645
|
+
"properties": {
|
|
1646
|
+
"validationRules": {
|
|
1647
|
+
"items": {
|
|
1648
|
+
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule"
|
|
1649
|
+
},
|
|
1650
|
+
"type": "array"
|
|
1651
|
+
}
|
|
1652
|
+
},
|
|
1653
|
+
"type": "object"
|
|
1654
|
+
},
|
|
1655
|
+
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule": {
|
|
1656
|
+
"description": "Next ID: 9",
|
|
1657
|
+
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule",
|
|
1658
|
+
"properties": {
|
|
1659
|
+
"childAlignmentRule": {
|
|
1660
|
+
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule"
|
|
1661
|
+
},
|
|
1662
|
+
"description": {
|
|
1663
|
+
"description": "Description of the validation rule. This has no use but for documentation",
|
|
1664
|
+
"type": "string"
|
|
1665
|
+
},
|
|
1666
|
+
"entityAlignmentRule": {
|
|
1667
|
+
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule"
|
|
1668
|
+
},
|
|
1669
|
+
"fieldOccurrences": {
|
|
1670
|
+
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences"
|
|
1671
|
+
},
|
|
1672
|
+
"fieldRegex": {
|
|
1673
|
+
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegex"
|
|
1674
|
+
},
|
|
1675
|
+
"formValidation": {
|
|
1676
|
+
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFormValidation"
|
|
1677
|
+
},
|
|
1678
|
+
"name": {
|
|
1679
|
+
"description": "Name of the validation rule.",
|
|
1680
|
+
"type": "string"
|
|
1681
|
+
},
|
|
1682
|
+
"ruleId": {
|
|
1683
|
+
"description": "Unique identifier of the rule. Optional.",
|
|
1684
|
+
"type": "string"
|
|
1685
|
+
}
|
|
1686
|
+
},
|
|
1687
|
+
"type": "object"
|
|
1688
|
+
},
|
|
1689
|
+
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule": {
|
|
1690
|
+
"description": "A rule for checking field alignment. Horizontal alignment checks if fields are on the same row by comparing y-coordinates of bounding box centers, while vertical alignment checks if fields are on the same column by comparing x-coordinates of bounding box centers.",
|
|
1691
|
+
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule",
|
|
1692
|
+
"properties": {
|
|
1693
|
+
"alignmentType": {
|
|
1694
|
+
"enum": [
|
|
1695
|
+
"ALIGNMENT_TYPE_UNSPECIFIED",
|
|
1696
|
+
"ALIGNMENT_TYPE_HORIZONTAL",
|
|
1697
|
+
"ALIGNMENT_TYPE_VERTICAL"
|
|
1698
|
+
],
|
|
1699
|
+
"enumDescriptions": [
|
|
1700
|
+
"",
|
|
1701
|
+
"",
|
|
1702
|
+
""
|
|
1703
|
+
],
|
|
1704
|
+
"type": "string"
|
|
1705
|
+
},
|
|
1706
|
+
"tolerance": {
|
|
1707
|
+
"description": "The tolerance to use when comparing coordinates.",
|
|
1708
|
+
"format": "float",
|
|
1709
|
+
"type": "number"
|
|
1710
|
+
}
|
|
1711
|
+
},
|
|
1712
|
+
"type": "object"
|
|
1713
|
+
},
|
|
1714
|
+
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule": {
|
|
1715
|
+
"description": "A rule that aligns specified child fields with a parent field.",
|
|
1716
|
+
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleChildAlignmentRule",
|
|
1717
|
+
"properties": {
|
|
1718
|
+
"alignmentRule": {
|
|
1719
|
+
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule",
|
|
1720
|
+
"description": "The alignment rule to apply to the child fields."
|
|
1721
|
+
},
|
|
1722
|
+
"childFields": {
|
|
1723
|
+
"description": "The child fields to be aligned within the parent field.",
|
|
1724
|
+
"items": {
|
|
1725
|
+
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField"
|
|
1726
|
+
},
|
|
1727
|
+
"type": "array"
|
|
1728
|
+
},
|
|
1729
|
+
"parentField": {
|
|
1730
|
+
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField",
|
|
1731
|
+
"description": "The full path of the parent field."
|
|
1732
|
+
}
|
|
1733
|
+
},
|
|
1734
|
+
"type": "object"
|
|
1735
|
+
},
|
|
1736
|
+
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant": {
|
|
1737
|
+
"description": "The constant value used in the validation rules.",
|
|
1738
|
+
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant",
|
|
1739
|
+
"properties": {
|
|
1740
|
+
"floatValue": {
|
|
1741
|
+
"format": "float",
|
|
1742
|
+
"type": "number"
|
|
1743
|
+
}
|
|
1744
|
+
},
|
|
1745
|
+
"type": "object"
|
|
1746
|
+
},
|
|
1747
|
+
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule": {
|
|
1748
|
+
"description": "A rule that aligns specified fields with each other.",
|
|
1749
|
+
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleEntityAlignmentRule",
|
|
1750
|
+
"properties": {
|
|
1751
|
+
"alignmentRule": {
|
|
1752
|
+
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleAlignmentRule",
|
|
1753
|
+
"description": "The alignment rule to apply to the fields."
|
|
1754
|
+
},
|
|
1755
|
+
"fields": {
|
|
1756
|
+
"description": "The fields to be aligned.",
|
|
1757
|
+
"items": {
|
|
1758
|
+
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField"
|
|
1759
|
+
},
|
|
1760
|
+
"type": "array"
|
|
1761
|
+
}
|
|
1762
|
+
},
|
|
1763
|
+
"type": "object"
|
|
1764
|
+
},
|
|
1765
|
+
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField": {
|
|
1766
|
+
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField",
|
|
1767
|
+
"properties": {
|
|
1768
|
+
"defaultValue": {
|
|
1769
|
+
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleConstant",
|
|
1770
|
+
"description": "Default value to use if the field is not present. If the field is missing and the default value is not set, the validation run as if the field is not present in the validation logic."
|
|
1771
|
+
},
|
|
1772
|
+
"fieldName": {
|
|
1773
|
+
"description": "The field name to validate. This can be a simple field name or a nested field one using the ':' (meant as an aggregator) or '*' (meant as foreach) operators.",
|
|
1774
|
+
"type": "string"
|
|
1775
|
+
}
|
|
1776
|
+
},
|
|
1777
|
+
"type": "object"
|
|
1778
|
+
},
|
|
1779
|
+
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences": {
|
|
1780
|
+
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldOccurrences",
|
|
1781
|
+
"properties": {
|
|
1782
|
+
"field": {
|
|
1783
|
+
"$ref": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleField"
|
|
1784
|
+
},
|
|
1785
|
+
"maxOccurrences": {
|
|
1786
|
+
"format": "uint32",
|
|
1787
|
+
"type": "integer"
|
|
1788
|
+
},
|
|
1789
|
+
"minOccurrences": {
|
|
1790
|
+
"description": "Min and max occurrences of the field. If not set, there is limit set. The defined interval is a closed-closed interval, i.e. [min, max].",
|
|
1791
|
+
"format": "uint32",
|
|
1792
|
+
"type": "integer"
|
|
1793
|
+
}
|
|
1794
|
+
},
|
|
1795
|
+
"type": "object"
|
|
1450
1796
|
},
|
|
1451
1797
|
"CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegex": {
|
|
1452
1798
|
"id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRuleFieldRegex",
|
|
@@ -1920,25 +2266,223 @@
|
|
|
1920
2266
|
},
|
|
1921
2267
|
"type": "object"
|
|
1922
2268
|
},
|
|
1923
|
-
"
|
|
1924
|
-
"description": "The
|
|
1925
|
-
"id": "
|
|
2269
|
+
"GoogleCloudDocumentaiUiv1beta3DocumentSchema": {
|
|
2270
|
+
"description": "The schema defines the output of the processed document by a processor.",
|
|
2271
|
+
"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchema",
|
|
1926
2272
|
"properties": {
|
|
1927
|
-
"
|
|
1928
|
-
"
|
|
1929
|
-
"
|
|
1930
|
-
}
|
|
2273
|
+
"description": {
|
|
2274
|
+
"description": "Description of the schema.",
|
|
2275
|
+
"type": "string"
|
|
1931
2276
|
},
|
|
1932
|
-
"
|
|
2277
|
+
"displayName": {
|
|
2278
|
+
"description": "Display name to show to users.",
|
|
2279
|
+
"type": "string"
|
|
1933
2280
|
},
|
|
1934
|
-
"
|
|
1935
|
-
"description": "
|
|
1936
|
-
"
|
|
1937
|
-
"properties": {},
|
|
1938
|
-
"type": "object"
|
|
2281
|
+
"documentPrompt": {
|
|
2282
|
+
"description": "Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing.",
|
|
2283
|
+
"type": "string"
|
|
1939
2284
|
},
|
|
1940
|
-
"
|
|
1941
|
-
"description": "
|
|
2285
|
+
"entityTypes": {
|
|
2286
|
+
"description": "Entity types of the schema.",
|
|
2287
|
+
"items": {
|
|
2288
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType"
|
|
2289
|
+
},
|
|
2290
|
+
"type": "array"
|
|
2291
|
+
},
|
|
2292
|
+
"metadata": {
|
|
2293
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata",
|
|
2294
|
+
"description": "Metadata of the schema."
|
|
2295
|
+
}
|
|
2296
|
+
},
|
|
2297
|
+
"type": "object"
|
|
2298
|
+
},
|
|
2299
|
+
"GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType": {
|
|
2300
|
+
"description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.",
|
|
2301
|
+
"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType",
|
|
2302
|
+
"properties": {
|
|
2303
|
+
"baseTypes": {
|
|
2304
|
+
"description": "The entity type that this type is derived from. For now, one and only one should be set.",
|
|
2305
|
+
"items": {
|
|
2306
|
+
"type": "string"
|
|
2307
|
+
},
|
|
2308
|
+
"type": "array"
|
|
2309
|
+
},
|
|
2310
|
+
"description": {
|
|
2311
|
+
"description": "The description of the entity type. Could be used to provide more information about the entity type for model calls.",
|
|
2312
|
+
"type": "string"
|
|
2313
|
+
},
|
|
2314
|
+
"displayName": {
|
|
2315
|
+
"description": "User defined name for the type.",
|
|
2316
|
+
"type": "string"
|
|
2317
|
+
},
|
|
2318
|
+
"entityTypeMetadata": {
|
|
2319
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata",
|
|
2320
|
+
"description": "Metadata for the entity type."
|
|
2321
|
+
},
|
|
2322
|
+
"enumValues": {
|
|
2323
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues",
|
|
2324
|
+
"description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file."
|
|
2325
|
+
},
|
|
2326
|
+
"name": {
|
|
2327
|
+
"description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.",
|
|
2328
|
+
"type": "string"
|
|
2329
|
+
},
|
|
2330
|
+
"properties": {
|
|
2331
|
+
"description": "Description the nested structure, or composition of an entity.",
|
|
2332
|
+
"items": {
|
|
2333
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty"
|
|
2334
|
+
},
|
|
2335
|
+
"type": "array"
|
|
2336
|
+
}
|
|
2337
|
+
},
|
|
2338
|
+
"type": "object"
|
|
2339
|
+
},
|
|
2340
|
+
"GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues": {
|
|
2341
|
+
"description": "Defines the a list of enum values.",
|
|
2342
|
+
"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues",
|
|
2343
|
+
"properties": {
|
|
2344
|
+
"values": {
|
|
2345
|
+
"description": "The individual values that this enum values type can include.",
|
|
2346
|
+
"items": {
|
|
2347
|
+
"type": "string"
|
|
2348
|
+
},
|
|
2349
|
+
"type": "array"
|
|
2350
|
+
}
|
|
2351
|
+
},
|
|
2352
|
+
"type": "object"
|
|
2353
|
+
},
|
|
2354
|
+
"GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty": {
|
|
2355
|
+
"description": "Defines properties that can be part of the entity type.",
|
|
2356
|
+
"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty",
|
|
2357
|
+
"properties": {
|
|
2358
|
+
"description": {
|
|
2359
|
+
"description": "The description of the property. Could be used to provide more information about the property for model calls.",
|
|
2360
|
+
"type": "string"
|
|
2361
|
+
},
|
|
2362
|
+
"displayName": {
|
|
2363
|
+
"description": "User defined name for the property.",
|
|
2364
|
+
"type": "string"
|
|
2365
|
+
},
|
|
2366
|
+
"method": {
|
|
2367
|
+
"description": "Specifies how the entity's value is obtained.",
|
|
2368
|
+
"enum": [
|
|
2369
|
+
"METHOD_UNSPECIFIED",
|
|
2370
|
+
"EXTRACT",
|
|
2371
|
+
"DERIVE"
|
|
2372
|
+
],
|
|
2373
|
+
"enumDescriptions": [
|
|
2374
|
+
"Unspecified method. It defaults to `EXTRACT`.",
|
|
2375
|
+
"The entity's value is directly extracted as-is from the document text.",
|
|
2376
|
+
"The entity's value is derived through inference and is not necessarily an exact text extraction from the document."
|
|
2377
|
+
],
|
|
2378
|
+
"type": "string"
|
|
2379
|
+
},
|
|
2380
|
+
"name": {
|
|
2381
|
+
"description": "The name of the property. Follows the same guidelines as the EntityType name.",
|
|
2382
|
+
"type": "string"
|
|
2383
|
+
},
|
|
2384
|
+
"occurrenceType": {
|
|
2385
|
+
"description": "Occurrence type limits the number of instances an entity type appears in the document.",
|
|
2386
|
+
"enum": [
|
|
2387
|
+
"OCCURRENCE_TYPE_UNSPECIFIED",
|
|
2388
|
+
"OPTIONAL_ONCE",
|
|
2389
|
+
"OPTIONAL_MULTIPLE",
|
|
2390
|
+
"REQUIRED_ONCE",
|
|
2391
|
+
"REQUIRED_MULTIPLE"
|
|
2392
|
+
],
|
|
2393
|
+
"enumDescriptions": [
|
|
2394
|
+
"Unspecified occurrence type.",
|
|
2395
|
+
"There will be zero or one instance of this entity type. The same entity instance may be mentioned multiple times.",
|
|
2396
|
+
"The entity type will appear zero or multiple times.",
|
|
2397
|
+
"The entity type will only appear exactly once. The same entity instance may be mentioned multiple times.",
|
|
2398
|
+
"The entity type will appear once or more times."
|
|
2399
|
+
],
|
|
2400
|
+
"type": "string"
|
|
2401
|
+
},
|
|
2402
|
+
"propertyMetadata": {
|
|
2403
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3PropertyMetadata",
|
|
2404
|
+
"description": "Any additional metadata about the property can be added here."
|
|
2405
|
+
},
|
|
2406
|
+
"valueType": {
|
|
2407
|
+
"description": "A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.",
|
|
2408
|
+
"type": "string"
|
|
2409
|
+
}
|
|
2410
|
+
},
|
|
2411
|
+
"type": "object"
|
|
2412
|
+
},
|
|
2413
|
+
"GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata": {
|
|
2414
|
+
"description": "Metadata for global schema behavior.",
|
|
2415
|
+
"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata",
|
|
2416
|
+
"properties": {
|
|
2417
|
+
"documentAllowMultipleLabels": {
|
|
2418
|
+
"description": "If true, on a given page, there can be multiple `document` annotations covering it.",
|
|
2419
|
+
"type": "boolean"
|
|
2420
|
+
},
|
|
2421
|
+
"documentSplitter": {
|
|
2422
|
+
"description": "If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).",
|
|
2423
|
+
"type": "boolean"
|
|
2424
|
+
},
|
|
2425
|
+
"prefixedNamingOnProperties": {
|
|
2426
|
+
"description": "If set, all the nested entities must be prefixed with the parents.",
|
|
2427
|
+
"type": "boolean"
|
|
2428
|
+
},
|
|
2429
|
+
"skipNamingValidation": {
|
|
2430
|
+
"description": "If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.",
|
|
2431
|
+
"type": "boolean"
|
|
2432
|
+
}
|
|
2433
|
+
},
|
|
2434
|
+
"type": "object"
|
|
2435
|
+
},
|
|
2436
|
+
"GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata": {
|
|
2437
|
+
"description": "The long-running operation metadata for the EnableProcessor method.",
|
|
2438
|
+
"id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata",
|
|
2439
|
+
"properties": {
|
|
2440
|
+
"commonMetadata": {
|
|
2441
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
|
|
2442
|
+
"description": "The basic metadata of the long-running operation."
|
|
2443
|
+
}
|
|
2444
|
+
},
|
|
2445
|
+
"type": "object"
|
|
2446
|
+
},
|
|
2447
|
+
"GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse": {
|
|
2448
|
+
"description": "Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.",
|
|
2449
|
+
"id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse",
|
|
2450
|
+
"properties": {},
|
|
2451
|
+
"type": "object"
|
|
2452
|
+
},
|
|
2453
|
+
"GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata": {
|
|
2454
|
+
"description": "Metadata about an entity type.",
|
|
2455
|
+
"id": "GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata",
|
|
2456
|
+
"properties": {
|
|
2457
|
+
"fieldTierMetadata": {
|
|
2458
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata",
|
|
2459
|
+
"description": "Field tier metadata on the property"
|
|
2460
|
+
},
|
|
2461
|
+
"humanReviewLabelingMetadata": {
|
|
2462
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata",
|
|
2463
|
+
"description": "Human review labeling config on the entity."
|
|
2464
|
+
},
|
|
2465
|
+
"humanReviewMetadata": {
|
|
2466
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata",
|
|
2467
|
+
"description": "Human review config on the entity."
|
|
2468
|
+
},
|
|
2469
|
+
"inactive": {
|
|
2470
|
+
"description": "Whether the entity type should be considered inactive.",
|
|
2471
|
+
"type": "boolean"
|
|
2472
|
+
},
|
|
2473
|
+
"schemaEditabilityMetadata": {
|
|
2474
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata",
|
|
2475
|
+
"description": "Schema editability metadata on the entity."
|
|
2476
|
+
},
|
|
2477
|
+
"schemaInferenceMetadata": {
|
|
2478
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata",
|
|
2479
|
+
"description": "Schema inference metadata on the entity."
|
|
2480
|
+
}
|
|
2481
|
+
},
|
|
2482
|
+
"type": "object"
|
|
2483
|
+
},
|
|
2484
|
+
"GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata": {
|
|
2485
|
+
"description": "Metadata of the EvaluateProcessorVersion method.",
|
|
1942
2486
|
"id": "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata",
|
|
1943
2487
|
"properties": {
|
|
1944
2488
|
"commonMetadata": {
|
|
@@ -1959,6 +2503,91 @@
|
|
|
1959
2503
|
},
|
|
1960
2504
|
"type": "object"
|
|
1961
2505
|
},
|
|
2506
|
+
"GoogleCloudDocumentaiUiv1beta3EvaluationMetrics": {
|
|
2507
|
+
"description": "Evaluation metrics, either in aggregate or about a specific entity.",
|
|
2508
|
+
"id": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics",
|
|
2509
|
+
"properties": {
|
|
2510
|
+
"f1Score": {
|
|
2511
|
+
"description": "The calculated f1 score.",
|
|
2512
|
+
"format": "float",
|
|
2513
|
+
"type": "number"
|
|
2514
|
+
},
|
|
2515
|
+
"falseNegativesCount": {
|
|
2516
|
+
"description": "The amount of false negatives.",
|
|
2517
|
+
"format": "int32",
|
|
2518
|
+
"type": "integer"
|
|
2519
|
+
},
|
|
2520
|
+
"falsePositivesCount": {
|
|
2521
|
+
"description": "The amount of false positives.",
|
|
2522
|
+
"format": "int32",
|
|
2523
|
+
"type": "integer"
|
|
2524
|
+
},
|
|
2525
|
+
"groundTruthDocumentCount": {
|
|
2526
|
+
"description": "The amount of documents with a ground truth occurrence.",
|
|
2527
|
+
"format": "int32",
|
|
2528
|
+
"type": "integer"
|
|
2529
|
+
},
|
|
2530
|
+
"groundTruthOccurrencesCount": {
|
|
2531
|
+
"description": "The amount of occurrences in ground truth documents.",
|
|
2532
|
+
"format": "int32",
|
|
2533
|
+
"type": "integer"
|
|
2534
|
+
},
|
|
2535
|
+
"precision": {
|
|
2536
|
+
"description": "The calculated precision.",
|
|
2537
|
+
"format": "float",
|
|
2538
|
+
"type": "number"
|
|
2539
|
+
},
|
|
2540
|
+
"predictedDocumentCount": {
|
|
2541
|
+
"description": "The amount of documents with a predicted occurrence.",
|
|
2542
|
+
"format": "int32",
|
|
2543
|
+
"type": "integer"
|
|
2544
|
+
},
|
|
2545
|
+
"predictedOccurrencesCount": {
|
|
2546
|
+
"description": "The amount of occurrences in predicted documents.",
|
|
2547
|
+
"format": "int32",
|
|
2548
|
+
"type": "integer"
|
|
2549
|
+
},
|
|
2550
|
+
"recall": {
|
|
2551
|
+
"description": "The calculated recall.",
|
|
2552
|
+
"format": "float",
|
|
2553
|
+
"type": "number"
|
|
2554
|
+
},
|
|
2555
|
+
"totalDocumentsCount": {
|
|
2556
|
+
"description": "The amount of documents that had an occurrence of this label.",
|
|
2557
|
+
"format": "int32",
|
|
2558
|
+
"type": "integer"
|
|
2559
|
+
},
|
|
2560
|
+
"truePositivesCount": {
|
|
2561
|
+
"description": "The amount of true positives.",
|
|
2562
|
+
"format": "int32",
|
|
2563
|
+
"type": "integer"
|
|
2564
|
+
}
|
|
2565
|
+
},
|
|
2566
|
+
"type": "object"
|
|
2567
|
+
},
|
|
2568
|
+
"GoogleCloudDocumentaiUiv1beta3EvaluationReference": {
|
|
2569
|
+
"description": "Gives a short summary of an evaluation, and links to the evaluation itself.",
|
|
2570
|
+
"id": "GoogleCloudDocumentaiUiv1beta3EvaluationReference",
|
|
2571
|
+
"properties": {
|
|
2572
|
+
"aggregateMetrics": {
|
|
2573
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics",
|
|
2574
|
+
"description": "An aggregate of the statistics for the evaluation with fuzzy matching on."
|
|
2575
|
+
},
|
|
2576
|
+
"aggregateMetricsExact": {
|
|
2577
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics",
|
|
2578
|
+
"description": "An aggregate of the statistics for the evaluation with fuzzy matching off."
|
|
2579
|
+
},
|
|
2580
|
+
"evaluation": {
|
|
2581
|
+
"description": "The resource name of the evaluation.",
|
|
2582
|
+
"type": "string"
|
|
2583
|
+
},
|
|
2584
|
+
"operation": {
|
|
2585
|
+
"description": "The resource name of the Long Running Operation for the evaluation.",
|
|
2586
|
+
"type": "string"
|
|
2587
|
+
}
|
|
2588
|
+
},
|
|
2589
|
+
"type": "object"
|
|
2590
|
+
},
|
|
1962
2591
|
"GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata": {
|
|
1963
2592
|
"description": "Metadata of the batch export documents operation.",
|
|
1964
2593
|
"id": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata",
|
|
@@ -2048,109 +2677,499 @@
|
|
|
2048
2677
|
},
|
|
2049
2678
|
"type": "object"
|
|
2050
2679
|
},
|
|
2051
|
-
"GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse": {
|
|
2052
|
-
"description": "Response message associated with the ExportProcessorVersion operation.",
|
|
2053
|
-
"id": "GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse",
|
|
2680
|
+
"GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse": {
|
|
2681
|
+
"description": "Response message associated with the ExportProcessorVersion operation.",
|
|
2682
|
+
"id": "GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse",
|
|
2683
|
+
"properties": {
|
|
2684
|
+
"gcsUri": {
|
|
2685
|
+
"description": "The Cloud Storage URI containing the output artifacts.",
|
|
2686
|
+
"type": "string"
|
|
2687
|
+
}
|
|
2688
|
+
},
|
|
2689
|
+
"type": "object"
|
|
2690
|
+
},
|
|
2691
|
+
"GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata": {
|
|
2692
|
+
"description": "Metadata for how this field value is extracted.",
|
|
2693
|
+
"id": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata",
|
|
2694
|
+
"properties": {
|
|
2695
|
+
"entityQuery": {
|
|
2696
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery",
|
|
2697
|
+
"description": "Entity query config."
|
|
2698
|
+
},
|
|
2699
|
+
"summaryOptions": {
|
|
2700
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3SummaryOptions",
|
|
2701
|
+
"description": "Summary options config."
|
|
2702
|
+
}
|
|
2703
|
+
},
|
|
2704
|
+
"type": "object"
|
|
2705
|
+
},
|
|
2706
|
+
"GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery": {
|
|
2707
|
+
"description": "Message for entity query.",
|
|
2708
|
+
"id": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery",
|
|
2709
|
+
"properties": {
|
|
2710
|
+
"userEntityQuery": {
|
|
2711
|
+
"description": "The original entity query inputed by the user.",
|
|
2712
|
+
"type": "string"
|
|
2713
|
+
}
|
|
2714
|
+
},
|
|
2715
|
+
"type": "object"
|
|
2716
|
+
},
|
|
2717
|
+
"GoogleCloudDocumentaiUiv1beta3FieldTierMetadata": {
|
|
2718
|
+
"description": "Metadata for the field tier of a property.",
|
|
2719
|
+
"id": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata",
|
|
2720
|
+
"properties": {
|
|
2721
|
+
"tierLevel": {
|
|
2722
|
+
"description": "Integer that indicates the tier of a property. e.g. Invoice has entities that are classified as tier 1 which is the most important, while tier 2 and tier 3 less so. This attribute can be used to filter schema attributes before running eval. e.g. compute F1 score for only tier 1 entities. If not present this attribute should be inferred as 1.",
|
|
2723
|
+
"format": "int32",
|
|
2724
|
+
"type": "integer"
|
|
2725
|
+
}
|
|
2726
|
+
},
|
|
2727
|
+
"type": "object"
|
|
2728
|
+
},
|
|
2729
|
+
"GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata": {
|
|
2730
|
+
"description": "Metadata for human review labeling config.",
|
|
2731
|
+
"id": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata",
|
|
2732
|
+
"properties": {
|
|
2733
|
+
"enableNormalizationEditing": {
|
|
2734
|
+
"description": "Whether to enable normalization editing.",
|
|
2735
|
+
"type": "boolean"
|
|
2736
|
+
}
|
|
2737
|
+
},
|
|
2738
|
+
"type": "object"
|
|
2739
|
+
},
|
|
2740
|
+
"GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata": {
|
|
2741
|
+
"description": "Metadata for Human Review config.",
|
|
2742
|
+
"id": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata",
|
|
2743
|
+
"properties": {
|
|
2744
|
+
"confidenceThreshold": {
|
|
2745
|
+
"description": "The confidence threshold if human review validation is enabled.",
|
|
2746
|
+
"format": "float",
|
|
2747
|
+
"type": "number"
|
|
2748
|
+
},
|
|
2749
|
+
"enableValidation": {
|
|
2750
|
+
"description": "Whether to enable human review validation.",
|
|
2751
|
+
"type": "boolean"
|
|
2752
|
+
}
|
|
2753
|
+
},
|
|
2754
|
+
"type": "object"
|
|
2755
|
+
},
|
|
2756
|
+
"GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata": {
|
|
2757
|
+
"description": "Metadata of the import document operation.",
|
|
2758
|
+
"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata",
|
|
2759
|
+
"properties": {
|
|
2760
|
+
"commonMetadata": {
|
|
2761
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
|
|
2762
|
+
"description": "The basic metadata of the long-running operation."
|
|
2763
|
+
},
|
|
2764
|
+
"importConfigValidationResults": {
|
|
2765
|
+
"description": "Validation statuses of the batch documents import config.",
|
|
2766
|
+
"items": {
|
|
2767
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult"
|
|
2768
|
+
},
|
|
2769
|
+
"type": "array"
|
|
2770
|
+
},
|
|
2771
|
+
"individualImportStatuses": {
|
|
2772
|
+
"description": "The list of response details of each document.",
|
|
2773
|
+
"items": {
|
|
2774
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus"
|
|
2775
|
+
},
|
|
2776
|
+
"type": "array"
|
|
2777
|
+
},
|
|
2778
|
+
"totalDocumentCount": {
|
|
2779
|
+
"description": "Total number of the documents that are qualified for importing.",
|
|
2780
|
+
"format": "int32",
|
|
2781
|
+
"type": "integer"
|
|
2782
|
+
}
|
|
2783
|
+
},
|
|
2784
|
+
"type": "object"
|
|
2785
|
+
},
|
|
2786
|
+
"GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult": {
|
|
2787
|
+
"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.",
|
|
2788
|
+
"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult",
|
|
2789
|
+
"properties": {
|
|
2790
|
+
"inputGcsSource": {
|
|
2791
|
+
"description": "The source Cloud Storage URI specified in the import config.",
|
|
2792
|
+
"type": "string"
|
|
2793
|
+
},
|
|
2794
|
+
"status": {
|
|
2795
|
+
"$ref": "GoogleRpcStatus",
|
|
2796
|
+
"description": "The validation status of import config."
|
|
2797
|
+
}
|
|
2798
|
+
},
|
|
2799
|
+
"type": "object"
|
|
2800
|
+
},
|
|
2801
|
+
"GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus": {
|
|
2802
|
+
"description": "The status of each individual document in the import process.",
|
|
2803
|
+
"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus",
|
|
2804
|
+
"properties": {
|
|
2805
|
+
"inputGcsSource": {
|
|
2806
|
+
"description": "The source Cloud Storage URI of the document.",
|
|
2807
|
+
"type": "string"
|
|
2808
|
+
},
|
|
2809
|
+
"outputDocumentId": {
|
|
2810
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
|
|
2811
|
+
"description": "The document id of imported document if it was successful, otherwise empty."
|
|
2812
|
+
},
|
|
2813
|
+
"outputGcsDestination": {
|
|
2814
|
+
"description": "The output_gcs_destination of the processed document if it was successful, otherwise empty.",
|
|
2815
|
+
"type": "string"
|
|
2816
|
+
},
|
|
2817
|
+
"status": {
|
|
2818
|
+
"$ref": "GoogleRpcStatus",
|
|
2819
|
+
"description": "The status of the importing of the document."
|
|
2820
|
+
}
|
|
2821
|
+
},
|
|
2822
|
+
"type": "object"
|
|
2823
|
+
},
|
|
2824
|
+
"GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse": {
|
|
2825
|
+
"description": "Response of the import document operation.",
|
|
2826
|
+
"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse",
|
|
2827
|
+
"properties": {},
|
|
2828
|
+
"type": "object"
|
|
2829
|
+
},
|
|
2830
|
+
"GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata": {
|
|
2831
|
+
"description": "The long-running operation metadata for the ImportProcessorVersion method.",
|
|
2832
|
+
"id": "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata",
|
|
2833
|
+
"properties": {
|
|
2834
|
+
"commonMetadata": {
|
|
2835
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
|
|
2836
|
+
"description": "The basic metadata for the long-running operation."
|
|
2837
|
+
}
|
|
2838
|
+
},
|
|
2839
|
+
"type": "object"
|
|
2840
|
+
},
|
|
2841
|
+
"GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse": {
|
|
2842
|
+
"description": "The response message for the ImportProcessorVersion method.",
|
|
2843
|
+
"id": "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse",
|
|
2844
|
+
"properties": {
|
|
2845
|
+
"processorVersion": {
|
|
2846
|
+
"description": "The destination processor version name.",
|
|
2847
|
+
"type": "string"
|
|
2848
|
+
}
|
|
2849
|
+
},
|
|
2850
|
+
"type": "object"
|
|
2851
|
+
},
|
|
2852
|
+
"GoogleCloudDocumentaiUiv1beta3Processor": {
|
|
2853
|
+
"description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.",
|
|
2854
|
+
"id": "GoogleCloudDocumentaiUiv1beta3Processor",
|
|
2855
|
+
"properties": {
|
|
2856
|
+
"activeSchemaVersion": {
|
|
2857
|
+
"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}",
|
|
2858
|
+
"type": "string"
|
|
2859
|
+
},
|
|
2860
|
+
"createTime": {
|
|
2861
|
+
"description": "Output only. The time the processor was created.",
|
|
2862
|
+
"format": "google-datetime",
|
|
2863
|
+
"readOnly": true,
|
|
2864
|
+
"type": "string"
|
|
2865
|
+
},
|
|
2866
|
+
"defaultProcessorVersion": {
|
|
2867
|
+
"description": "The default processor version.",
|
|
2868
|
+
"type": "string"
|
|
2869
|
+
},
|
|
2870
|
+
"displayName": {
|
|
2871
|
+
"description": "The display name of the processor.",
|
|
2872
|
+
"type": "string"
|
|
2873
|
+
},
|
|
2874
|
+
"kmsKeyName": {
|
|
2875
|
+
"description": "The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.",
|
|
2876
|
+
"type": "string"
|
|
2877
|
+
},
|
|
2878
|
+
"name": {
|
|
2879
|
+
"description": "Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}`",
|
|
2880
|
+
"readOnly": true,
|
|
2881
|
+
"type": "string"
|
|
2882
|
+
},
|
|
2883
|
+
"processEndpoint": {
|
|
2884
|
+
"description": "Output only. Immutable. The http endpoint that can be called to invoke processing.",
|
|
2885
|
+
"readOnly": true,
|
|
2886
|
+
"type": "string"
|
|
2887
|
+
},
|
|
2888
|
+
"processorVersionAliases": {
|
|
2889
|
+
"description": "Output only. The processor version aliases.",
|
|
2890
|
+
"items": {
|
|
2891
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias"
|
|
2892
|
+
},
|
|
2893
|
+
"readOnly": true,
|
|
2894
|
+
"type": "array"
|
|
2895
|
+
},
|
|
2896
|
+
"satisfiesPzi": {
|
|
2897
|
+
"description": "Output only. Reserved for future use.",
|
|
2898
|
+
"readOnly": true,
|
|
2899
|
+
"type": "boolean"
|
|
2900
|
+
},
|
|
2901
|
+
"satisfiesPzs": {
|
|
2902
|
+
"description": "Output only. Reserved for future use.",
|
|
2903
|
+
"readOnly": true,
|
|
2904
|
+
"type": "boolean"
|
|
2905
|
+
},
|
|
2906
|
+
"state": {
|
|
2907
|
+
"description": "Output only. The state of the processor.",
|
|
2908
|
+
"enum": [
|
|
2909
|
+
"STATE_UNSPECIFIED",
|
|
2910
|
+
"ENABLED",
|
|
2911
|
+
"DISABLED",
|
|
2912
|
+
"ENABLING",
|
|
2913
|
+
"DISABLING",
|
|
2914
|
+
"CREATING",
|
|
2915
|
+
"FAILED",
|
|
2916
|
+
"DELETING"
|
|
2917
|
+
],
|
|
2918
|
+
"enumDescriptions": [
|
|
2919
|
+
"The processor is in an unspecified state.",
|
|
2920
|
+
"The processor is enabled, i.e., has an enabled version which can currently serve processing requests and all the feature dependencies have been successfully initialized.",
|
|
2921
|
+
"The processor is disabled.",
|
|
2922
|
+
"The processor is being enabled, will become `ENABLED` if successful.",
|
|
2923
|
+
"The processor is being disabled, will become `DISABLED` if successful.",
|
|
2924
|
+
"The processor is being created, will become either `ENABLED` (for successful creation) or `FAILED` (for failed ones). Once a processor is in this state, it can then be used for document processing, but the feature dependencies of the processor might not be fully created yet.",
|
|
2925
|
+
"The processor failed during creation or initialization of feature dependencies. The user should delete the processor and recreate one as all the functionalities of the processor are disabled.",
|
|
2926
|
+
"The processor is being deleted, will be removed if successful."
|
|
2927
|
+
],
|
|
2928
|
+
"readOnly": true,
|
|
2929
|
+
"type": "string"
|
|
2930
|
+
},
|
|
2931
|
+
"type": {
|
|
2932
|
+
"description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes.",
|
|
2933
|
+
"type": "string"
|
|
2934
|
+
}
|
|
2935
|
+
},
|
|
2936
|
+
"type": "object"
|
|
2937
|
+
},
|
|
2938
|
+
"GoogleCloudDocumentaiUiv1beta3ProcessorVersion": {
|
|
2939
|
+
"description": "A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.",
|
|
2940
|
+
"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersion",
|
|
2941
|
+
"properties": {
|
|
2942
|
+
"createTime": {
|
|
2943
|
+
"description": "Output only. The time the processor version was created.",
|
|
2944
|
+
"format": "google-datetime",
|
|
2945
|
+
"readOnly": true,
|
|
2946
|
+
"type": "string"
|
|
2947
|
+
},
|
|
2948
|
+
"deploymentAllowed": {
|
|
2949
|
+
"description": "Output only. Denotes that this `ProcessorVersion` can be deployed and undeployed.",
|
|
2950
|
+
"readOnly": true,
|
|
2951
|
+
"type": "boolean"
|
|
2952
|
+
},
|
|
2953
|
+
"deprecationInfo": {
|
|
2954
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo",
|
|
2955
|
+
"description": "Output only. If set, information about the eventual deprecation of this version.",
|
|
2956
|
+
"readOnly": true
|
|
2957
|
+
},
|
|
2958
|
+
"displayName": {
|
|
2959
|
+
"description": "The display name of the processor version.",
|
|
2960
|
+
"type": "string"
|
|
2961
|
+
},
|
|
2962
|
+
"documentSchema": {
|
|
2963
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchema",
|
|
2964
|
+
"description": "Output only. The schema of the processor version. Describes the output.",
|
|
2965
|
+
"readOnly": true
|
|
2966
|
+
},
|
|
2967
|
+
"genAiModelInfo": {
|
|
2968
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo",
|
|
2969
|
+
"description": "Output only. Information about Generative AI model-based processor versions.",
|
|
2970
|
+
"readOnly": true
|
|
2971
|
+
},
|
|
2972
|
+
"googleManaged": {
|
|
2973
|
+
"description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.",
|
|
2974
|
+
"readOnly": true,
|
|
2975
|
+
"type": "boolean"
|
|
2976
|
+
},
|
|
2977
|
+
"kmsKeyName": {
|
|
2978
|
+
"description": "Output only. The KMS key name used for encryption.",
|
|
2979
|
+
"readOnly": true,
|
|
2980
|
+
"type": "string"
|
|
2981
|
+
},
|
|
2982
|
+
"kmsKeyVersionName": {
|
|
2983
|
+
"description": "Output only. The KMS key version with which data is encrypted.",
|
|
2984
|
+
"readOnly": true,
|
|
2985
|
+
"type": "string"
|
|
2986
|
+
},
|
|
2987
|
+
"latestEvaluation": {
|
|
2988
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationReference",
|
|
2989
|
+
"description": "Output only. The most recently invoked evaluation for the processor version.",
|
|
2990
|
+
"readOnly": true
|
|
2991
|
+
},
|
|
2992
|
+
"modelType": {
|
|
2993
|
+
"description": "Output only. The model type of this processor version.",
|
|
2994
|
+
"enum": [
|
|
2995
|
+
"MODEL_TYPE_UNSPECIFIED",
|
|
2996
|
+
"MODEL_TYPE_GENERATIVE",
|
|
2997
|
+
"MODEL_TYPE_CUSTOM"
|
|
2998
|
+
],
|
|
2999
|
+
"enumDescriptions": [
|
|
3000
|
+
"The processor version has unspecified model type.",
|
|
3001
|
+
"The processor version has generative model type.",
|
|
3002
|
+
"The processor version has custom model type."
|
|
3003
|
+
],
|
|
3004
|
+
"readOnly": true,
|
|
3005
|
+
"type": "string"
|
|
3006
|
+
},
|
|
3007
|
+
"name": {
|
|
3008
|
+
"description": "Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`",
|
|
3009
|
+
"type": "string"
|
|
3010
|
+
},
|
|
3011
|
+
"satisfiesPzi": {
|
|
3012
|
+
"description": "Output only. Reserved for future use.",
|
|
3013
|
+
"readOnly": true,
|
|
3014
|
+
"type": "boolean"
|
|
3015
|
+
},
|
|
3016
|
+
"satisfiesPzs": {
|
|
3017
|
+
"description": "Output only. Reserved for future use.",
|
|
3018
|
+
"readOnly": true,
|
|
3019
|
+
"type": "boolean"
|
|
3020
|
+
},
|
|
3021
|
+
"schema": {
|
|
3022
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3Schema",
|
|
3023
|
+
"description": "The schema of the processor version. Describes the output."
|
|
3024
|
+
},
|
|
3025
|
+
"state": {
|
|
3026
|
+
"description": "Output only. The state of the processor version.",
|
|
3027
|
+
"enum": [
|
|
3028
|
+
"STATE_UNSPECIFIED",
|
|
3029
|
+
"DEPLOYED",
|
|
3030
|
+
"DEPLOYING",
|
|
3031
|
+
"UNDEPLOYED",
|
|
3032
|
+
"UNDEPLOYING",
|
|
3033
|
+
"CREATING",
|
|
3034
|
+
"DELETING",
|
|
3035
|
+
"FAILED",
|
|
3036
|
+
"IMPORTING"
|
|
3037
|
+
],
|
|
3038
|
+
"enumDescriptions": [
|
|
3039
|
+
"The processor version is in an unspecified state.",
|
|
3040
|
+
"The processor version is deployed and can be used for processing.",
|
|
3041
|
+
"The processor version is being deployed.",
|
|
3042
|
+
"The processor version is not deployed and cannot be used for processing.",
|
|
3043
|
+
"The processor version is being undeployed.",
|
|
3044
|
+
"The processor version is being created.",
|
|
3045
|
+
"The processor version is being deleted.",
|
|
3046
|
+
"The processor version failed and is in an indeterminate state.",
|
|
3047
|
+
"The processor version is being imported."
|
|
3048
|
+
],
|
|
3049
|
+
"readOnly": true,
|
|
3050
|
+
"type": "string"
|
|
3051
|
+
}
|
|
3052
|
+
},
|
|
3053
|
+
"type": "object"
|
|
3054
|
+
},
|
|
3055
|
+
"GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias": {
|
|
3056
|
+
"description": "Contains the alias and the aliased resource name of processor version.",
|
|
3057
|
+
"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias",
|
|
2054
3058
|
"properties": {
|
|
2055
|
-
"
|
|
2056
|
-
"description": "The
|
|
3059
|
+
"alias": {
|
|
3060
|
+
"description": "The alias in the form of `processor_version` resource name.",
|
|
3061
|
+
"type": "string"
|
|
3062
|
+
},
|
|
3063
|
+
"processorVersion": {
|
|
3064
|
+
"description": "The resource name of aliased processor version.",
|
|
2057
3065
|
"type": "string"
|
|
2058
3066
|
}
|
|
2059
3067
|
},
|
|
2060
3068
|
"type": "object"
|
|
2061
3069
|
},
|
|
2062
|
-
"
|
|
2063
|
-
"description": "
|
|
2064
|
-
"id": "
|
|
3070
|
+
"GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo": {
|
|
3071
|
+
"description": "Information about the upcoming deprecation of this processor version.",
|
|
3072
|
+
"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo",
|
|
2065
3073
|
"properties": {
|
|
2066
|
-
"
|
|
2067
|
-
"
|
|
2068
|
-
"
|
|
2069
|
-
|
|
2070
|
-
"importConfigValidationResults": {
|
|
2071
|
-
"description": "Validation statuses of the batch documents import config.",
|
|
2072
|
-
"items": {
|
|
2073
|
-
"$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult"
|
|
2074
|
-
},
|
|
2075
|
-
"type": "array"
|
|
2076
|
-
},
|
|
2077
|
-
"individualImportStatuses": {
|
|
2078
|
-
"description": "The list of response details of each document.",
|
|
2079
|
-
"items": {
|
|
2080
|
-
"$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus"
|
|
2081
|
-
},
|
|
2082
|
-
"type": "array"
|
|
3074
|
+
"deprecationTime": {
|
|
3075
|
+
"description": "The time at which this processor version will be deprecated.",
|
|
3076
|
+
"format": "google-datetime",
|
|
3077
|
+
"type": "string"
|
|
2083
3078
|
},
|
|
2084
|
-
"
|
|
2085
|
-
"description": "
|
|
2086
|
-
"
|
|
2087
|
-
"type": "integer"
|
|
3079
|
+
"replacementProcessorVersion": {
|
|
3080
|
+
"description": "If set, the processor version that will be used as a replacement.",
|
|
3081
|
+
"type": "string"
|
|
2088
3082
|
}
|
|
2089
3083
|
},
|
|
2090
3084
|
"type": "object"
|
|
2091
3085
|
},
|
|
2092
|
-
"
|
|
2093
|
-
"description": "
|
|
2094
|
-
"id": "
|
|
3086
|
+
"GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo": {
|
|
3087
|
+
"description": "Information about Generative AI model-based processor versions.",
|
|
3088
|
+
"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo",
|
|
2095
3089
|
"properties": {
|
|
2096
|
-
"
|
|
2097
|
-
"
|
|
2098
|
-
"
|
|
3090
|
+
"customGenAiModelInfo": {
|
|
3091
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo",
|
|
3092
|
+
"description": "Information for a custom Generative AI model created by the user."
|
|
2099
3093
|
},
|
|
2100
|
-
"
|
|
2101
|
-
"$ref": "
|
|
2102
|
-
"description": "
|
|
3094
|
+
"foundationGenAiModelInfo": {
|
|
3095
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo",
|
|
3096
|
+
"description": "Information for a pretrained Google-managed foundation model."
|
|
2103
3097
|
}
|
|
2104
3098
|
},
|
|
2105
3099
|
"type": "object"
|
|
2106
3100
|
},
|
|
2107
|
-
"
|
|
2108
|
-
"description": "
|
|
2109
|
-
"id": "
|
|
3101
|
+
"GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": {
|
|
3102
|
+
"description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.",
|
|
3103
|
+
"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo",
|
|
2110
3104
|
"properties": {
|
|
2111
|
-
"
|
|
2112
|
-
"description": "The
|
|
3105
|
+
"baseProcessorVersionId": {
|
|
3106
|
+
"description": "The base processor version ID for the custom model.",
|
|
2113
3107
|
"type": "string"
|
|
2114
3108
|
},
|
|
2115
|
-
"
|
|
2116
|
-
"
|
|
2117
|
-
"
|
|
2118
|
-
|
|
2119
|
-
"
|
|
2120
|
-
"
|
|
3109
|
+
"customModelType": {
|
|
3110
|
+
"description": "The type of custom model created by the user.",
|
|
3111
|
+
"enum": [
|
|
3112
|
+
"CUSTOM_MODEL_TYPE_UNSPECIFIED",
|
|
3113
|
+
"VERSIONED_FOUNDATION",
|
|
3114
|
+
"FINE_TUNED"
|
|
3115
|
+
],
|
|
3116
|
+
"enumDescriptions": [
|
|
3117
|
+
"The model type is unspecified.",
|
|
3118
|
+
"The model is a versioned foundation model.",
|
|
3119
|
+
"The model is a finetuned foundation model."
|
|
3120
|
+
],
|
|
2121
3121
|
"type": "string"
|
|
2122
|
-
},
|
|
2123
|
-
"status": {
|
|
2124
|
-
"$ref": "GoogleRpcStatus",
|
|
2125
|
-
"description": "The status of the importing of the document."
|
|
2126
3122
|
}
|
|
2127
3123
|
},
|
|
2128
3124
|
"type": "object"
|
|
2129
3125
|
},
|
|
2130
|
-
"
|
|
2131
|
-
"description": "
|
|
2132
|
-
"id": "
|
|
2133
|
-
"properties": {},
|
|
2134
|
-
"type": "object"
|
|
2135
|
-
},
|
|
2136
|
-
"GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata": {
|
|
2137
|
-
"description": "The long-running operation metadata for the ImportProcessorVersion method.",
|
|
2138
|
-
"id": "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata",
|
|
3126
|
+
"GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": {
|
|
3127
|
+
"description": "Information for a pretrained Google-managed foundation model.",
|
|
3128
|
+
"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo",
|
|
2139
3129
|
"properties": {
|
|
2140
|
-
"
|
|
2141
|
-
"
|
|
2142
|
-
"
|
|
3130
|
+
"finetuningAllowed": {
|
|
3131
|
+
"description": "Whether finetuning is allowed for this base processor version.",
|
|
3132
|
+
"type": "boolean"
|
|
3133
|
+
},
|
|
3134
|
+
"minTrainLabeledDocuments": {
|
|
3135
|
+
"description": "The minimum number of labeled documents in the training dataset required for finetuning.",
|
|
3136
|
+
"format": "int32",
|
|
3137
|
+
"type": "integer"
|
|
2143
3138
|
}
|
|
2144
3139
|
},
|
|
2145
3140
|
"type": "object"
|
|
2146
3141
|
},
|
|
2147
|
-
"
|
|
2148
|
-
"description": "
|
|
2149
|
-
"id": "
|
|
3142
|
+
"GoogleCloudDocumentaiUiv1beta3PropertyMetadata": {
|
|
3143
|
+
"description": "Metadata about a property.",
|
|
3144
|
+
"id": "GoogleCloudDocumentaiUiv1beta3PropertyMetadata",
|
|
2150
3145
|
"properties": {
|
|
2151
|
-
"
|
|
2152
|
-
"
|
|
2153
|
-
"
|
|
3146
|
+
"fieldExtractionMetadata": {
|
|
3147
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata",
|
|
3148
|
+
"description": "Field extraction metadata on the property."
|
|
3149
|
+
},
|
|
3150
|
+
"fieldTierMetadata": {
|
|
3151
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata",
|
|
3152
|
+
"description": "Field tier metadata on the property"
|
|
3153
|
+
},
|
|
3154
|
+
"humanReviewLabelingMetadata": {
|
|
3155
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata",
|
|
3156
|
+
"description": "Human review labeling config on the property."
|
|
3157
|
+
},
|
|
3158
|
+
"humanReviewMetadata": {
|
|
3159
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata",
|
|
3160
|
+
"description": "Human review validation config on the property."
|
|
3161
|
+
},
|
|
3162
|
+
"inactive": {
|
|
3163
|
+
"description": "Whether the property should be considered as \"inactive\".",
|
|
3164
|
+
"type": "boolean"
|
|
3165
|
+
},
|
|
3166
|
+
"schemaEditabilityMetadata": {
|
|
3167
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata",
|
|
3168
|
+
"description": "Schema editability metadata on the property."
|
|
3169
|
+
},
|
|
3170
|
+
"schemaInferenceMetadata": {
|
|
3171
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata",
|
|
3172
|
+
"description": "Schema inference metadata on the property."
|
|
2154
3173
|
}
|
|
2155
3174
|
},
|
|
2156
3175
|
"type": "object"
|
|
@@ -2257,59 +3276,192 @@
|
|
|
2257
3276
|
"BASE_OCR_REVISION"
|
|
2258
3277
|
],
|
|
2259
3278
|
"enumDescriptions": [
|
|
2260
|
-
"Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`.",
|
|
2261
|
-
"The latest revision made by a human.",
|
|
2262
|
-
"The latest revision based on timestamp.",
|
|
2263
|
-
"The first (OCR) revision."
|
|
3279
|
+
"Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`.",
|
|
3280
|
+
"The latest revision made by a human.",
|
|
3281
|
+
"The latest revision based on timestamp.",
|
|
3282
|
+
"The first (OCR) revision."
|
|
3283
|
+
],
|
|
3284
|
+
"type": "string"
|
|
3285
|
+
},
|
|
3286
|
+
"revisionId": {
|
|
3287
|
+
"description": "Reads the revision given by the id.",
|
|
3288
|
+
"type": "string"
|
|
3289
|
+
}
|
|
3290
|
+
},
|
|
3291
|
+
"type": "object"
|
|
3292
|
+
},
|
|
3293
|
+
"GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata": {
|
|
3294
|
+
"description": "Metadata of the sample documents operation.",
|
|
3295
|
+
"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata",
|
|
3296
|
+
"properties": {
|
|
3297
|
+
"commonMetadata": {
|
|
3298
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
|
|
3299
|
+
"description": "The basic metadata of the long-running operation."
|
|
3300
|
+
}
|
|
3301
|
+
},
|
|
3302
|
+
"type": "object"
|
|
3303
|
+
},
|
|
3304
|
+
"GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse": {
|
|
3305
|
+
"description": "Response of the sample documents operation.",
|
|
3306
|
+
"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse",
|
|
3307
|
+
"properties": {
|
|
3308
|
+
"sampleTestStatus": {
|
|
3309
|
+
"$ref": "GoogleRpcStatus",
|
|
3310
|
+
"description": "The status of sampling documents in test split."
|
|
3311
|
+
},
|
|
3312
|
+
"sampleTrainingStatus": {
|
|
3313
|
+
"$ref": "GoogleRpcStatus",
|
|
3314
|
+
"description": "The status of sampling documents in training split."
|
|
3315
|
+
},
|
|
3316
|
+
"selectedDocuments": {
|
|
3317
|
+
"description": "The result of the sampling process.",
|
|
3318
|
+
"items": {
|
|
3319
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument"
|
|
3320
|
+
},
|
|
3321
|
+
"type": "array"
|
|
3322
|
+
}
|
|
3323
|
+
},
|
|
3324
|
+
"type": "object"
|
|
3325
|
+
},
|
|
3326
|
+
"GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument": {
|
|
3327
|
+
"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument",
|
|
3328
|
+
"properties": {
|
|
3329
|
+
"documentId": {
|
|
3330
|
+
"description": "An internal identifier for document.",
|
|
3331
|
+
"type": "string"
|
|
3332
|
+
}
|
|
3333
|
+
},
|
|
3334
|
+
"type": "object"
|
|
3335
|
+
},
|
|
3336
|
+
"GoogleCloudDocumentaiUiv1beta3Schema": {
|
|
3337
|
+
"description": "The schema defines the output of the processed document by a processor.",
|
|
3338
|
+
"id": "GoogleCloudDocumentaiUiv1beta3Schema",
|
|
3339
|
+
"properties": {
|
|
3340
|
+
"description": {
|
|
3341
|
+
"description": "Description of the schema.",
|
|
3342
|
+
"type": "string"
|
|
3343
|
+
},
|
|
3344
|
+
"displayName": {
|
|
3345
|
+
"description": "Display name to show to users.",
|
|
3346
|
+
"type": "string"
|
|
3347
|
+
},
|
|
3348
|
+
"entityTypes": {
|
|
3349
|
+
"description": "Entity types of the schema.",
|
|
3350
|
+
"items": {
|
|
3351
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType"
|
|
3352
|
+
},
|
|
3353
|
+
"type": "array"
|
|
3354
|
+
}
|
|
3355
|
+
},
|
|
3356
|
+
"type": "object"
|
|
3357
|
+
},
|
|
3358
|
+
"GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata": {
|
|
3359
|
+
"description": "Metadata that specifies whether a label is editable and reasons why. These fields are read-only. Changing these fields has no impact on the backend.",
|
|
3360
|
+
"id": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata",
|
|
3361
|
+
"properties": {
|
|
3362
|
+
"editable": {
|
|
3363
|
+
"description": "Explicit flag that controls whether the label is editable.",
|
|
3364
|
+
"type": "boolean"
|
|
3365
|
+
},
|
|
3366
|
+
"processorVersions": {
|
|
3367
|
+
"description": "Full resource name of processor versions that contain this label. e.g. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`",
|
|
3368
|
+
"items": {
|
|
3369
|
+
"type": "string"
|
|
3370
|
+
},
|
|
3371
|
+
"type": "array"
|
|
3372
|
+
}
|
|
3373
|
+
},
|
|
3374
|
+
"type": "object"
|
|
3375
|
+
},
|
|
3376
|
+
"GoogleCloudDocumentaiUiv1beta3SchemaEntityType": {
|
|
3377
|
+
"description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.",
|
|
3378
|
+
"id": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType",
|
|
3379
|
+
"properties": {
|
|
3380
|
+
"baseType": {
|
|
3381
|
+
"type": "string"
|
|
3382
|
+
},
|
|
3383
|
+
"description": {
|
|
3384
|
+
"description": "Description of the entity type.",
|
|
3385
|
+
"type": "string"
|
|
3386
|
+
},
|
|
3387
|
+
"enumValues": {
|
|
3388
|
+
"description": "If specified, lists all the possible values for this entity.",
|
|
3389
|
+
"items": {
|
|
3390
|
+
"type": "string"
|
|
3391
|
+
},
|
|
3392
|
+
"type": "array"
|
|
3393
|
+
},
|
|
3394
|
+
"hide": {
|
|
3395
|
+
"description": "If the entity type is hidden in the schema. This provides the functionality to temporally \"disable\" an entity without deleting it.",
|
|
3396
|
+
"type": "boolean"
|
|
3397
|
+
},
|
|
3398
|
+
"method": {
|
|
3399
|
+
"description": "Specifies how the entity's value is obtained.",
|
|
3400
|
+
"enum": [
|
|
3401
|
+
"METHOD_UNSPECIFIED",
|
|
3402
|
+
"EXTRACT",
|
|
3403
|
+
"DERIVE"
|
|
3404
|
+
],
|
|
3405
|
+
"enumDescriptions": [
|
|
3406
|
+
"Unspecified method. It defaults to `EXTRACT`.",
|
|
3407
|
+
"The entity's value is directly extracted as-is from the document text.",
|
|
3408
|
+
"The entity's value is derived through inference and is not necessarily an exact text extraction from the document."
|
|
3409
|
+
],
|
|
3410
|
+
"type": "string"
|
|
3411
|
+
},
|
|
3412
|
+
"occurrenceType": {
|
|
3413
|
+
"description": "Occurrence type limits the number of times an entity type appears in the document.",
|
|
3414
|
+
"enum": [
|
|
3415
|
+
"OCCURRENCE_TYPE_UNSPECIFIED",
|
|
3416
|
+
"OPTIONAL_ONCE",
|
|
3417
|
+
"OPTIONAL_MULTIPLE",
|
|
3418
|
+
"REQUIRED_ONCE",
|
|
3419
|
+
"REQUIRED_MULTIPLE"
|
|
3420
|
+
],
|
|
3421
|
+
"enumDescriptions": [
|
|
3422
|
+
"Unspecified occurrence type.",
|
|
3423
|
+
"The entity type will appear zero times or once.",
|
|
3424
|
+
"The entity type will appear zero or multiple times.",
|
|
3425
|
+
"The entity type will only appear exactly once.",
|
|
3426
|
+
"The entity type will appear once or more times."
|
|
2264
3427
|
],
|
|
2265
3428
|
"type": "string"
|
|
2266
3429
|
},
|
|
2267
|
-
"revisionId": {
|
|
2268
|
-
"description": "Reads the revision given by the id.",
|
|
2269
|
-
"type": "string"
|
|
2270
|
-
}
|
|
2271
|
-
},
|
|
2272
|
-
"type": "object"
|
|
2273
|
-
},
|
|
2274
|
-
"GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata": {
|
|
2275
|
-
"description": "Metadata of the sample documents operation.",
|
|
2276
|
-
"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata",
|
|
2277
|
-
"properties": {
|
|
2278
|
-
"commonMetadata": {
|
|
2279
|
-
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
|
|
2280
|
-
"description": "The basic metadata of the long-running operation."
|
|
2281
|
-
}
|
|
2282
|
-
},
|
|
2283
|
-
"type": "object"
|
|
2284
|
-
},
|
|
2285
|
-
"GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse": {
|
|
2286
|
-
"description": "Response of the sample documents operation.",
|
|
2287
|
-
"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse",
|
|
2288
3430
|
"properties": {
|
|
2289
|
-
"
|
|
2290
|
-
"$ref": "GoogleRpcStatus",
|
|
2291
|
-
"description": "The status of sampling documents in test split."
|
|
2292
|
-
},
|
|
2293
|
-
"sampleTrainingStatus": {
|
|
2294
|
-
"$ref": "GoogleRpcStatus",
|
|
2295
|
-
"description": "The status of sampling documents in training split."
|
|
2296
|
-
},
|
|
2297
|
-
"selectedDocuments": {
|
|
2298
|
-
"description": "The result of the sampling process.",
|
|
3431
|
+
"description": "Describing the nested structure of an entity. An EntityType may consist of several other EntityTypes. For example, in a document there can be an EntityType `ID`, which consists of EntityType `name` and `address`, with corresponding attributes, such as TEXT for both types and ONCE for occurrence types.",
|
|
2299
3432
|
"items": {
|
|
2300
|
-
"$ref": "
|
|
3433
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType"
|
|
2301
3434
|
},
|
|
2302
3435
|
"type": "array"
|
|
3436
|
+
},
|
|
3437
|
+
"source": {
|
|
3438
|
+
"description": "Source of this entity type.",
|
|
3439
|
+
"enum": [
|
|
3440
|
+
"SOURCE_UNSPECIFIED",
|
|
3441
|
+
"PREDEFINED",
|
|
3442
|
+
"USER_INPUT"
|
|
3443
|
+
],
|
|
3444
|
+
"enumDescriptions": [
|
|
3445
|
+
"Unspecified source.",
|
|
3446
|
+
"The entity type is in the predefined schema of a pretrained version of a processor.",
|
|
3447
|
+
"The entity type is added by the users either: - during an uptraining of an existing processor, or - during the process of creating a customized processor."
|
|
3448
|
+
],
|
|
3449
|
+
"type": "string"
|
|
3450
|
+
},
|
|
3451
|
+
"type": {
|
|
3452
|
+
"description": "Name of the type. It must satisfy the following constraints: 1. Must be unique within the set of same level types (with case-insensitive match). 2. Maximum 64 characters. 3. Must start with a letter. 4. Allowed characters: ASCII letters [a-zA-Z], ASCII digits [0-9], or one of the following punctuation characters: * underscore '_' (recommended) * hyphen '-' (allowed, not recommended) * colon ':' (allowed, not recommended) NOTE: Whitespace characters are not allowed. 5. Cannot end with a punctuation character. 6. Cannot contain the following restricted strings: \"google\", \"DocumentAI\" (case-insensitive match). 7. A slash character '/' is reserved as a separator in flattened representations of nested entity types (e.g., \"line_item/amount\") in which case each part (e.g., \"line_item\", \"amount\") must comply with the rules defined above. We recommend using the snake case (\"snake_case\") in entity type names.",
|
|
3453
|
+
"type": "string"
|
|
2303
3454
|
}
|
|
2304
3455
|
},
|
|
2305
3456
|
"type": "object"
|
|
2306
3457
|
},
|
|
2307
|
-
"
|
|
2308
|
-
"
|
|
3458
|
+
"GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata": {
|
|
3459
|
+
"description": "Metadata for schema inference. Only used on dataset.schema for schema inference, can be safely ignored elsewhere.",
|
|
3460
|
+
"id": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata",
|
|
2309
3461
|
"properties": {
|
|
2310
|
-
"
|
|
2311
|
-
"description": "
|
|
2312
|
-
"type": "
|
|
3462
|
+
"inferred": {
|
|
3463
|
+
"description": "True if is inferred by schema inference.",
|
|
3464
|
+
"type": "boolean"
|
|
2313
3465
|
}
|
|
2314
3466
|
},
|
|
2315
3467
|
"type": "object"
|
|
@@ -2331,6 +3483,43 @@
|
|
|
2331
3483
|
"properties": {},
|
|
2332
3484
|
"type": "object"
|
|
2333
3485
|
},
|
|
3486
|
+
"GoogleCloudDocumentaiUiv1beta3SummaryOptions": {
|
|
3487
|
+
"description": "Metadata for document summarization.",
|
|
3488
|
+
"id": "GoogleCloudDocumentaiUiv1beta3SummaryOptions",
|
|
3489
|
+
"properties": {
|
|
3490
|
+
"format": {
|
|
3491
|
+
"description": "The format the summary should be in.",
|
|
3492
|
+
"enum": [
|
|
3493
|
+
"FORMAT_UNSPECIFIED",
|
|
3494
|
+
"PARAGRAPH",
|
|
3495
|
+
"BULLETS"
|
|
3496
|
+
],
|
|
3497
|
+
"enumDescriptions": [
|
|
3498
|
+
"Default.",
|
|
3499
|
+
"Format the output in paragraphs.",
|
|
3500
|
+
"Format the output in bullets."
|
|
3501
|
+
],
|
|
3502
|
+
"type": "string"
|
|
3503
|
+
},
|
|
3504
|
+
"length": {
|
|
3505
|
+
"description": "How long the summary should be.",
|
|
3506
|
+
"enum": [
|
|
3507
|
+
"LENGTH_UNSPECIFIED",
|
|
3508
|
+
"BRIEF",
|
|
3509
|
+
"MODERATE",
|
|
3510
|
+
"COMPREHENSIVE"
|
|
3511
|
+
],
|
|
3512
|
+
"enumDescriptions": [
|
|
3513
|
+
"Default.",
|
|
3514
|
+
"A brief summary of one or two sentences.",
|
|
3515
|
+
"A paragraph-length summary.",
|
|
3516
|
+
"The longest option available."
|
|
3517
|
+
],
|
|
3518
|
+
"type": "string"
|
|
3519
|
+
}
|
|
3520
|
+
},
|
|
3521
|
+
"type": "object"
|
|
3522
|
+
},
|
|
2334
3523
|
"GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata": {
|
|
2335
3524
|
"description": "The metadata that represents a processor version being created.",
|
|
2336
3525
|
"id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata",
|
|
@@ -2441,6 +3630,17 @@
|
|
|
2441
3630
|
},
|
|
2442
3631
|
"type": "object"
|
|
2443
3632
|
},
|
|
3633
|
+
"GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata": {
|
|
3634
|
+
"description": "The long-running operation metadata for the UpdateProcessorVersion method.",
|
|
3635
|
+
"id": "GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata",
|
|
3636
|
+
"properties": {
|
|
3637
|
+
"commonMetadata": {
|
|
3638
|
+
"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
|
|
3639
|
+
"description": "The basic metadata for the long-running operation."
|
|
3640
|
+
}
|
|
3641
|
+
},
|
|
3642
|
+
"type": "object"
|
|
3643
|
+
},
|
|
2444
3644
|
"GoogleCloudDocumentaiV1BatchProcessMetadata": {
|
|
2445
3645
|
"description": "The long-running operation metadata for BatchProcessDocuments.",
|
|
2446
3646
|
"id": "GoogleCloudDocumentaiV1BatchProcessMetadata",
|
|
@@ -3068,6 +4268,7 @@
|
|
|
3068
4268
|
"description": "Inference-time options for the process API"
|
|
3069
4269
|
},
|
|
3070
4270
|
"skipHumanReview": {
|
|
4271
|
+
"deprecated": true,
|
|
3071
4272
|
"description": "Whether human review should be skipped for this request. Default to `false`.",
|
|
3072
4273
|
"type": "boolean"
|
|
3073
4274
|
}
|
|
@@ -3895,6 +5096,10 @@
|
|
|
3895
5096
|
"$ref": "GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutput",
|
|
3896
5097
|
"description": "The entity validation output for this revision."
|
|
3897
5098
|
},
|
|
5099
|
+
"provenance": {
|
|
5100
|
+
"$ref": "GoogleCloudDocumentaiV1beta3DocumentProvenance",
|
|
5101
|
+
"description": "Optional. The history of this revision."
|
|
5102
|
+
},
|
|
3898
5103
|
"revisionId": {
|
|
3899
5104
|
"description": "The revision id.",
|
|
3900
5105
|
"type": "string"
|
|
@@ -4057,12 +5262,16 @@
|
|
|
4057
5262
|
"description": "Validation result for a single validation rule.",
|
|
4058
5263
|
"id": "GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult",
|
|
4059
5264
|
"properties": {
|
|
5265
|
+
"rule": {
|
|
5266
|
+
"description": "Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}`",
|
|
5267
|
+
"type": "string"
|
|
5268
|
+
},
|
|
4060
5269
|
"ruleDescription": {
|
|
4061
5270
|
"description": "The description of the validation rule.",
|
|
4062
5271
|
"type": "string"
|
|
4063
5272
|
},
|
|
4064
5273
|
"ruleName": {
|
|
4065
|
-
"description": "The name of the validation rule.",
|
|
5274
|
+
"description": "The display name of the validation rule.",
|
|
4066
5275
|
"type": "string"
|
|
4067
5276
|
},
|
|
4068
5277
|
"validationDetails": {
|
|
@@ -5386,6 +6595,20 @@ true
|
|
|
5386
6595
|
},
|
|
5387
6596
|
"type": "object"
|
|
5388
6597
|
},
|
|
6598
|
+
"GoogleCloudDocumentaiV1beta3Documents": {
|
|
6599
|
+
"description": "A set of inline documents.",
|
|
6600
|
+
"id": "GoogleCloudDocumentaiV1beta3Documents",
|
|
6601
|
+
"properties": {
|
|
6602
|
+
"documents": {
|
|
6603
|
+
"description": "The list of documents.",
|
|
6604
|
+
"items": {
|
|
6605
|
+
"$ref": "GoogleCloudDocumentaiV1beta3Document"
|
|
6606
|
+
},
|
|
6607
|
+
"type": "array"
|
|
6608
|
+
}
|
|
6609
|
+
},
|
|
6610
|
+
"type": "object"
|
|
6611
|
+
},
|
|
5389
6612
|
"GoogleCloudDocumentaiV1beta3EnableProcessorMetadata": {
|
|
5390
6613
|
"description": "The long-running operation metadata for the EnableProcessor method.",
|
|
5391
6614
|
"id": "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata",
|
|
@@ -5738,6 +6961,63 @@ true
|
|
|
5738
6961
|
},
|
|
5739
6962
|
"type": "object"
|
|
5740
6963
|
},
|
|
6964
|
+
"GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest": {
|
|
6965
|
+
"description": "Request message for GenerateSchemaVersion.",
|
|
6966
|
+
"id": "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest",
|
|
6967
|
+
"properties": {
|
|
6968
|
+
"baseSchemaVersion": {
|
|
6969
|
+
"description": "The base schema version name to use for the schema generation. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`",
|
|
6970
|
+
"type": "string"
|
|
6971
|
+
},
|
|
6972
|
+
"gcsDocuments": {
|
|
6973
|
+
"$ref": "GoogleCloudDocumentaiV1beta3GcsDocuments",
|
|
6974
|
+
"description": "The set of documents placed on Cloud Storage."
|
|
6975
|
+
},
|
|
6976
|
+
"gcsPrefix": {
|
|
6977
|
+
"$ref": "GoogleCloudDocumentaiV1beta3GcsPrefix",
|
|
6978
|
+
"description": "The common prefix of documents placed on Cloud Storage."
|
|
6979
|
+
},
|
|
6980
|
+
"generateSchemaVersionParams": {
|
|
6981
|
+
"$ref": "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams",
|
|
6982
|
+
"description": "Optional. User specified parameters for the schema generation."
|
|
6983
|
+
},
|
|
6984
|
+
"inlineDocuments": {
|
|
6985
|
+
"$ref": "GoogleCloudDocumentaiV1beta3Documents",
|
|
6986
|
+
"description": "The set of documents specified inline. For each document, its `uri` or `content` field must be set."
|
|
6987
|
+
},
|
|
6988
|
+
"rawDocuments": {
|
|
6989
|
+
"$ref": "GoogleCloudDocumentaiV1beta3RawDocuments",
|
|
6990
|
+
"description": "The set of raw documents."
|
|
6991
|
+
}
|
|
6992
|
+
},
|
|
6993
|
+
"type": "object"
|
|
6994
|
+
},
|
|
6995
|
+
"GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams": {
|
|
6996
|
+
"description": "The parameters for the schema generation.",
|
|
6997
|
+
"id": "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams",
|
|
6998
|
+
"properties": {
|
|
6999
|
+
"history": {
|
|
7000
|
+
"$ref": "GoogleCloudDocumentaiV1beta3SchemaGenerationHistory",
|
|
7001
|
+
"description": "Optional. Previous prompt-answers in a chronological order."
|
|
7002
|
+
},
|
|
7003
|
+
"prompt": {
|
|
7004
|
+
"description": "Optional. The prompt used for the schema generation.",
|
|
7005
|
+
"type": "string"
|
|
7006
|
+
}
|
|
7007
|
+
},
|
|
7008
|
+
"type": "object"
|
|
7009
|
+
},
|
|
7010
|
+
"GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse": {
|
|
7011
|
+
"description": "Response message for GenerateSchemaVersion.",
|
|
7012
|
+
"id": "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse",
|
|
7013
|
+
"properties": {
|
|
7014
|
+
"schemaVersion": {
|
|
7015
|
+
"$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion",
|
|
7016
|
+
"description": "The schema version generated by the model."
|
|
7017
|
+
}
|
|
7018
|
+
},
|
|
7019
|
+
"type": "object"
|
|
7020
|
+
},
|
|
5741
7021
|
"GoogleCloudDocumentaiV1beta3GetDocumentResponse": {
|
|
5742
7022
|
"id": "GoogleCloudDocumentaiV1beta3GetDocumentResponse",
|
|
5743
7023
|
"properties": {
|
|
@@ -5884,6 +7164,10 @@ true
|
|
|
5884
7164
|
"Identifies the unassigned documents."
|
|
5885
7165
|
],
|
|
5886
7166
|
"type": "string"
|
|
7167
|
+
},
|
|
7168
|
+
"documentType": {
|
|
7169
|
+
"description": "Optional. If set, determines the type of the documents to be imported in this batch. It can be used to auto-label the documents with a single entity of the provided type. This field can only be used with a classifier or splitter processor. Providing this field is mutually exclusive with `entities` and `auto_labeling_config`.",
|
|
7170
|
+
"type": "string"
|
|
5887
7171
|
}
|
|
5888
7172
|
},
|
|
5889
7173
|
"type": "object"
|
|
@@ -6080,6 +7364,76 @@ true
|
|
|
6080
7364
|
},
|
|
6081
7365
|
"type": "object"
|
|
6082
7366
|
},
|
|
7367
|
+
"GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse": {
|
|
7368
|
+
"description": "Response message for ListSchemaVersions.",
|
|
7369
|
+
"id": "GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse",
|
|
7370
|
+
"properties": {
|
|
7371
|
+
"nextPageToken": {
|
|
7372
|
+
"description": "Points to the next SchemaVersion, otherwise empty.",
|
|
7373
|
+
"type": "string"
|
|
7374
|
+
},
|
|
7375
|
+
"schemaVersions": {
|
|
7376
|
+
"description": "The list of SchemaVersions.",
|
|
7377
|
+
"items": {
|
|
7378
|
+
"$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion"
|
|
7379
|
+
},
|
|
7380
|
+
"type": "array"
|
|
7381
|
+
}
|
|
7382
|
+
},
|
|
7383
|
+
"type": "object"
|
|
7384
|
+
},
|
|
7385
|
+
"GoogleCloudDocumentaiV1beta3ListSchemasResponse": {
|
|
7386
|
+
"description": "Response message for ListSchemas.",
|
|
7387
|
+
"id": "GoogleCloudDocumentaiV1beta3ListSchemasResponse",
|
|
7388
|
+
"properties": {
|
|
7389
|
+
"nextPageToken": {
|
|
7390
|
+
"description": "Points to the next Schema, otherwise empty.",
|
|
7391
|
+
"type": "string"
|
|
7392
|
+
},
|
|
7393
|
+
"schemas": {
|
|
7394
|
+
"description": "The list of Schemas.",
|
|
7395
|
+
"items": {
|
|
7396
|
+
"$ref": "GoogleCloudDocumentaiV1beta3NextSchema"
|
|
7397
|
+
},
|
|
7398
|
+
"type": "array"
|
|
7399
|
+
}
|
|
7400
|
+
},
|
|
7401
|
+
"type": "object"
|
|
7402
|
+
},
|
|
7403
|
+
"GoogleCloudDocumentaiV1beta3NextSchema": {
|
|
7404
|
+
"description": "NextSchema is a collection of SchemaVersions.",
|
|
7405
|
+
"id": "GoogleCloudDocumentaiV1beta3NextSchema",
|
|
7406
|
+
"properties": {
|
|
7407
|
+
"createTime": {
|
|
7408
|
+
"description": "Output only. The time when the Schema was created.",
|
|
7409
|
+
"format": "google-datetime",
|
|
7410
|
+
"readOnly": true,
|
|
7411
|
+
"type": "string"
|
|
7412
|
+
},
|
|
7413
|
+
"displayName": {
|
|
7414
|
+
"description": "Required. The user-defined name of the Schema.",
|
|
7415
|
+
"type": "string"
|
|
7416
|
+
},
|
|
7417
|
+
"labels": {
|
|
7418
|
+
"additionalProperties": {
|
|
7419
|
+
"type": "string"
|
|
7420
|
+
},
|
|
7421
|
+
"description": "Optional. The GCP labels for the Schema.",
|
|
7422
|
+
"type": "object"
|
|
7423
|
+
},
|
|
7424
|
+
"name": {
|
|
7425
|
+
"description": "Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
|
|
7426
|
+
"type": "string"
|
|
7427
|
+
},
|
|
7428
|
+
"updateTime": {
|
|
7429
|
+
"description": "Output only. The time when the Schema was last updated.",
|
|
7430
|
+
"format": "google-datetime",
|
|
7431
|
+
"readOnly": true,
|
|
7432
|
+
"type": "string"
|
|
7433
|
+
}
|
|
7434
|
+
},
|
|
7435
|
+
"type": "object"
|
|
7436
|
+
},
|
|
6083
7437
|
"GoogleCloudDocumentaiV1beta3NormalizedVertex": {
|
|
6084
7438
|
"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.",
|
|
6085
7439
|
"id": "GoogleCloudDocumentaiV1beta3NormalizedVertex",
|
|
@@ -6245,6 +7599,10 @@ true
|
|
|
6245
7599
|
"description": "Optional. Whether to include table annotations in layout parser response.",
|
|
6246
7600
|
"type": "boolean"
|
|
6247
7601
|
},
|
|
7602
|
+
"enableTableSplit": {
|
|
7603
|
+
"description": "Optional. Whether to split table.",
|
|
7604
|
+
"type": "boolean"
|
|
7605
|
+
},
|
|
6248
7606
|
"returnBoundingBoxes": {
|
|
6249
7607
|
"description": "Optional. Whether to include bounding boxes in layout parser processor response.",
|
|
6250
7608
|
"type": "boolean"
|
|
@@ -6323,6 +7681,7 @@ true
|
|
|
6323
7681
|
"description": "A raw document content (bytes)."
|
|
6324
7682
|
},
|
|
6325
7683
|
"skipHumanReview": {
|
|
7684
|
+
"deprecated": true,
|
|
6326
7685
|
"description": "Whether human review should be skipped for this request. Default to `false`.",
|
|
6327
7686
|
"type": "boolean"
|
|
6328
7687
|
}
|
|
@@ -6353,6 +7712,10 @@ true
|
|
|
6353
7712
|
"description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.",
|
|
6354
7713
|
"id": "GoogleCloudDocumentaiV1beta3Processor",
|
|
6355
7714
|
"properties": {
|
|
7715
|
+
"activeSchemaVersion": {
|
|
7716
|
+
"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}",
|
|
7717
|
+
"type": "string"
|
|
7718
|
+
},
|
|
6356
7719
|
"createTime": {
|
|
6357
7720
|
"description": "Output only. The time the processor was created.",
|
|
6358
7721
|
"format": "google-datetime",
|
|
@@ -6733,6 +8096,20 @@ true
|
|
|
6733
8096
|
},
|
|
6734
8097
|
"type": "object"
|
|
6735
8098
|
},
|
|
8099
|
+
"GoogleCloudDocumentaiV1beta3RawDocuments": {
|
|
8100
|
+
"description": "Specifies a set of raw documents.",
|
|
8101
|
+
"id": "GoogleCloudDocumentaiV1beta3RawDocuments",
|
|
8102
|
+
"properties": {
|
|
8103
|
+
"documents": {
|
|
8104
|
+
"description": "Specifies raw document content and mime type.",
|
|
8105
|
+
"items": {
|
|
8106
|
+
"$ref": "GoogleCloudDocumentaiV1beta3RawDocument"
|
|
8107
|
+
},
|
|
8108
|
+
"type": "array"
|
|
8109
|
+
}
|
|
8110
|
+
},
|
|
8111
|
+
"type": "object"
|
|
8112
|
+
},
|
|
6736
8113
|
"GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata": {
|
|
6737
8114
|
"description": "The long-running operation metadata for the ReviewDocument method.",
|
|
6738
8115
|
"id": "GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata",
|
|
@@ -6878,6 +8255,71 @@ true
|
|
|
6878
8255
|
},
|
|
6879
8256
|
"type": "object"
|
|
6880
8257
|
},
|
|
8258
|
+
"GoogleCloudDocumentaiV1beta3SchemaGenerationHistory": {
|
|
8259
|
+
"description": "The history of schema generation iterations.",
|
|
8260
|
+
"id": "GoogleCloudDocumentaiV1beta3SchemaGenerationHistory",
|
|
8261
|
+
"properties": {
|
|
8262
|
+
"iterations": {
|
|
8263
|
+
"description": "Required. Previous prompt-answers in a chronological order.",
|
|
8264
|
+
"items": {
|
|
8265
|
+
"$ref": "GoogleCloudDocumentaiV1beta3SchemaGenerationIteration"
|
|
8266
|
+
},
|
|
8267
|
+
"type": "array"
|
|
8268
|
+
}
|
|
8269
|
+
},
|
|
8270
|
+
"type": "object"
|
|
8271
|
+
},
|
|
8272
|
+
"GoogleCloudDocumentaiV1beta3SchemaGenerationIteration": {
|
|
8273
|
+
"description": "A single iteration of the schema generation.",
|
|
8274
|
+
"id": "GoogleCloudDocumentaiV1beta3SchemaGenerationIteration",
|
|
8275
|
+
"properties": {
|
|
8276
|
+
"adjustedSchema": {
|
|
8277
|
+
"$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion",
|
|
8278
|
+
"description": "Optional. The previous schema version adjusted by the model."
|
|
8279
|
+
},
|
|
8280
|
+
"generatedSchema": {
|
|
8281
|
+
"$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion",
|
|
8282
|
+
"description": "Required. The schema version generated by the model."
|
|
8283
|
+
},
|
|
8284
|
+
"prompt": {
|
|
8285
|
+
"description": "Optional. The prompt used for the iteration.",
|
|
8286
|
+
"type": "string"
|
|
8287
|
+
}
|
|
8288
|
+
},
|
|
8289
|
+
"type": "object"
|
|
8290
|
+
},
|
|
8291
|
+
"GoogleCloudDocumentaiV1beta3SchemaVersion": {
|
|
8292
|
+
"description": "SchemaVersion is a version of the Schema which is created in SchemaGroup.",
|
|
8293
|
+
"id": "GoogleCloudDocumentaiV1beta3SchemaVersion",
|
|
8294
|
+
"properties": {
|
|
8295
|
+
"createTime": {
|
|
8296
|
+
"description": "Output only. The time when the SchemaVersion was created.",
|
|
8297
|
+
"format": "google-datetime",
|
|
8298
|
+
"readOnly": true,
|
|
8299
|
+
"type": "string"
|
|
8300
|
+
},
|
|
8301
|
+
"displayName": {
|
|
8302
|
+
"description": "Required. The user-defined name of the SchemaVersion.",
|
|
8303
|
+
"type": "string"
|
|
8304
|
+
},
|
|
8305
|
+
"labels": {
|
|
8306
|
+
"additionalProperties": {
|
|
8307
|
+
"type": "string"
|
|
8308
|
+
},
|
|
8309
|
+
"description": "Optional. The GCP labels for the SchemaVersion.",
|
|
8310
|
+
"type": "object"
|
|
8311
|
+
},
|
|
8312
|
+
"name": {
|
|
8313
|
+
"description": "Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`",
|
|
8314
|
+
"type": "string"
|
|
8315
|
+
},
|
|
8316
|
+
"schema": {
|
|
8317
|
+
"$ref": "GoogleCloudDocumentaiV1beta3DocumentSchema",
|
|
8318
|
+
"description": "Required. The schema of the SchemaVersion."
|
|
8319
|
+
}
|
|
8320
|
+
},
|
|
8321
|
+
"type": "object"
|
|
8322
|
+
},
|
|
6881
8323
|
"GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata": {
|
|
6882
8324
|
"description": "The long-running operation metadata for the SetDefaultProcessorVersion method.",
|
|
6883
8325
|
"id": "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata",
|
|
@@ -7121,6 +8563,17 @@ true
|
|
|
7121
8563
|
},
|
|
7122
8564
|
"type": "object"
|
|
7123
8565
|
},
|
|
8566
|
+
"GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata": {
|
|
8567
|
+
"description": "The long-running operation metadata for the UpdateProcessorVersion method.",
|
|
8568
|
+
"id": "GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata",
|
|
8569
|
+
"properties": {
|
|
8570
|
+
"commonMetadata": {
|
|
8571
|
+
"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
|
|
8572
|
+
"description": "The basic metadata for the long-running operation."
|
|
8573
|
+
}
|
|
8574
|
+
},
|
|
8575
|
+
"type": "object"
|
|
8576
|
+
},
|
|
7124
8577
|
"GoogleCloudDocumentaiV1beta3Vertex": {
|
|
7125
8578
|
"description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.",
|
|
7126
8579
|
"id": "GoogleCloudDocumentaiV1beta3Vertex",
|
|
@@ -7206,7 +8659,7 @@ true
|
|
|
7206
8659
|
"type": "array"
|
|
7207
8660
|
},
|
|
7208
8661
|
"unreachable": {
|
|
7209
|
-
"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections
|
|
8662
|
+
"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.",
|
|
7210
8663
|
"items": {
|
|
7211
8664
|
"type": "string"
|
|
7212
8665
|
},
|