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.
Files changed (321) hide show
  1. {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.188.0.dist-info}/METADATA +1 -1
  2. {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.188.0.dist-info}/RECORD +321 -319
  3. googleapiclient/discovery.py +13 -6
  4. googleapiclient/discovery_cache/documents/accessapproval.v1.json +9 -3
  5. googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +3 -3
  6. googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json +2 -2
  7. googleapiclient/discovery_cache/documents/admin.directory_v1.json +75 -1
  8. googleapiclient/discovery_cache/documents/admin.directoryv1.json +75 -1
  9. googleapiclient/discovery_cache/documents/admin.reports_v1.json +37 -6
  10. googleapiclient/discovery_cache/documents/admin.reportsv1.json +37 -6
  11. googleapiclient/discovery_cache/documents/aiplatform.v1.json +20205 -8402
  12. googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +22191 -10441
  13. googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +6 -2
  14. googleapiclient/discovery_cache/documents/alloydb.v1.json +377 -22
  15. googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +403 -36
  16. googleapiclient/discovery_cache/documents/alloydb.v1beta.json +403 -36
  17. googleapiclient/discovery_cache/documents/analyticshub.v1.json +40 -2
  18. googleapiclient/discovery_cache/documents/androidmanagement.v1.json +13 -11
  19. googleapiclient/discovery_cache/documents/androidpublisher.v3.json +314 -6
  20. googleapiclient/discovery_cache/documents/apigateway.v1.json +4 -4
  21. googleapiclient/discovery_cache/documents/apigateway.v1beta.json +4 -4
  22. googleapiclient/discovery_cache/documents/apigee.v1.json +1236 -52
  23. googleapiclient/discovery_cache/documents/apihub.v1.json +685 -7
  24. googleapiclient/discovery_cache/documents/apim.v1alpha.json +4 -4
  25. googleapiclient/discovery_cache/documents/appengine.v1.json +180 -11
  26. googleapiclient/discovery_cache/documents/appengine.v1alpha.json +71 -13
  27. googleapiclient/discovery_cache/documents/appengine.v1beta.json +225 -13
  28. googleapiclient/discovery_cache/documents/apphub.v1.json +331 -5
  29. googleapiclient/discovery_cache/documents/apphub.v1alpha.json +331 -5
  30. googleapiclient/discovery_cache/documents/appsmarket.v2.json +283 -0
  31. googleapiclient/discovery_cache/documents/artifactregistry.v1.json +150 -5
  32. googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +2 -2
  33. googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +2 -2
  34. googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +3 -3
  35. googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +3 -3
  36. googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json +55 -4
  37. googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json +883 -5
  38. googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1beta.json +914 -3
  39. googleapiclient/discovery_cache/documents/backupdr.v1.json +383 -34
  40. googleapiclient/discovery_cache/documents/batch.v1.json +14 -8
  41. googleapiclient/discovery_cache/documents/beyondcorp.v1.json +24 -24
  42. googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +24 -24
  43. googleapiclient/discovery_cache/documents/biglake.v1.json +273 -1
  44. googleapiclient/discovery_cache/documents/bigquery.v2.json +45 -3
  45. googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +16 -2
  46. googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +16 -1
  47. googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +5 -5
  48. googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json +43 -1
  49. googleapiclient/discovery_cache/documents/calendar.v3.json +21 -5
  50. googleapiclient/discovery_cache/documents/certificatemanager.v1.json +48 -4
  51. googleapiclient/discovery_cache/documents/chat.v1.json +38 -30
  52. googleapiclient/discovery_cache/documents/checks.v1alpha.json +3 -3
  53. googleapiclient/discovery_cache/documents/chromemanagement.v1.json +224 -6
  54. googleapiclient/discovery_cache/documents/chromewebstore.v2.json +550 -0
  55. googleapiclient/discovery_cache/documents/classroom.v1.json +10 -6
  56. googleapiclient/discovery_cache/documents/cloudasset.v1.json +11 -4
  57. googleapiclient/discovery_cache/documents/cloudbuild.v1.json +41 -2
  58. googleapiclient/discovery_cache/documents/cloudbuild.v2.json +12 -2
  59. googleapiclient/discovery_cache/documents/cloudchannel.v1.json +4 -4
  60. googleapiclient/discovery_cache/documents/clouddeploy.v1.json +115 -4
  61. googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +4 -4
  62. googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +81 -8
  63. googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +124 -8
  64. googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +124 -8
  65. googleapiclient/discovery_cache/documents/cloudidentity.v1.json +6 -5
  66. googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +79 -6
  67. googleapiclient/discovery_cache/documents/cloudkms.v1.json +1056 -245
  68. googleapiclient/discovery_cache/documents/cloudlocationfinder.v1.json +2 -2
  69. googleapiclient/discovery_cache/documents/cloudlocationfinder.v1alpha.json +2 -2
  70. googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json +5 -3
  71. googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json +5 -3
  72. googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json +5 -3
  73. googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json +5 -3
  74. googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +20 -8
  75. googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +83 -9
  76. googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +201 -7
  77. googleapiclient/discovery_cache/documents/cloudshell.v1.json +51 -3
  78. googleapiclient/discovery_cache/documents/cloudsupport.v2.json +6 -1
  79. googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +6 -1
  80. googleapiclient/discovery_cache/documents/cloudtasks.v2.json +2 -2
  81. googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json +2 -2
  82. googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +2 -2
  83. googleapiclient/discovery_cache/documents/composer.v1.json +7 -5
  84. googleapiclient/discovery_cache/documents/composer.v1beta1.json +7 -5
  85. googleapiclient/discovery_cache/documents/compute.alpha.json +6736 -1882
  86. googleapiclient/discovery_cache/documents/compute.beta.json +7349 -2205
  87. googleapiclient/discovery_cache/documents/compute.v1.json +4065 -1275
  88. googleapiclient/discovery_cache/documents/config.v1.json +96 -10
  89. googleapiclient/discovery_cache/documents/connectors.v1.json +62 -6
  90. googleapiclient/discovery_cache/documents/connectors.v2.json +252 -1
  91. googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +376 -4
  92. googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +4224 -326
  93. googleapiclient/discovery_cache/documents/container.v1.json +473 -190
  94. googleapiclient/discovery_cache/documents/container.v1beta1.json +756 -190
  95. googleapiclient/discovery_cache/documents/containeranalysis.v1.json +30 -1
  96. googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +34 -3
  97. googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +34 -3
  98. googleapiclient/discovery_cache/documents/content.v2.1.json +12 -645
  99. googleapiclient/discovery_cache/documents/datacatalog.v1.json +249 -5
  100. googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json +247 -3
  101. googleapiclient/discovery_cache/documents/dataflow.v1b3.json +121 -1
  102. googleapiclient/discovery_cache/documents/dataform.v1.json +63 -4
  103. googleapiclient/discovery_cache/documents/dataform.v1beta1.json +834 -41
  104. googleapiclient/discovery_cache/documents/datafusion.v1.json +221 -2
  105. googleapiclient/discovery_cache/documents/datafusion.v1beta1.json +221 -2
  106. googleapiclient/discovery_cache/documents/datalineage.v1.json +3 -3
  107. googleapiclient/discovery_cache/documents/datamanager.v1.json +156 -6
  108. googleapiclient/discovery_cache/documents/datamigration.v1.json +121 -33
  109. googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +13 -1
  110. googleapiclient/discovery_cache/documents/dataplex.v1.json +654 -36
  111. googleapiclient/discovery_cache/documents/dataportability.v1.json +55 -1
  112. googleapiclient/discovery_cache/documents/dataportability.v1beta.json +55 -1
  113. googleapiclient/discovery_cache/documents/dataproc.v1.json +24 -2
  114. googleapiclient/discovery_cache/documents/datastore.v1.json +3 -23
  115. googleapiclient/discovery_cache/documents/datastore.v1beta1.json +1 -21
  116. googleapiclient/discovery_cache/documents/datastore.v1beta3.json +1 -21
  117. googleapiclient/discovery_cache/documents/datastream.v1.json +259 -33
  118. googleapiclient/discovery_cache/documents/datastream.v1alpha1.json +13 -1
  119. googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +46 -15
  120. googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +46 -15
  121. googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +46 -15
  122. googleapiclient/discovery_cache/documents/developerconnect.v1.json +461 -21
  123. googleapiclient/discovery_cache/documents/dfareporting.v4.json +47 -6
  124. googleapiclient/discovery_cache/documents/dfareporting.v5.json +47 -6
  125. googleapiclient/discovery_cache/documents/dialogflow.v2.json +60 -11
  126. googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +59 -10
  127. googleapiclient/discovery_cache/documents/dialogflow.v3.json +154 -7
  128. googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +154 -7
  129. googleapiclient/discovery_cache/documents/discoveryengine.v1.json +2695 -794
  130. googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +3488 -872
  131. googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +1261 -546
  132. googleapiclient/discovery_cache/documents/displayvideo.v2.json +196 -1426
  133. googleapiclient/discovery_cache/documents/displayvideo.v3.json +2356 -3035
  134. googleapiclient/discovery_cache/documents/displayvideo.v4.json +1779 -208
  135. googleapiclient/discovery_cache/documents/dlp.v2.json +26 -10
  136. googleapiclient/discovery_cache/documents/docs.v1.json +282 -43
  137. googleapiclient/discovery_cache/documents/documentai.v1.json +2476 -420
  138. googleapiclient/discovery_cache/documents/documentai.v1beta3.json +1701 -248
  139. googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json +3 -3
  140. googleapiclient/discovery_cache/documents/drive.v2.json +2 -2
  141. googleapiclient/discovery_cache/documents/drive.v3.json +245 -14
  142. googleapiclient/discovery_cache/documents/eventarc.v1.json +20 -95
  143. googleapiclient/discovery_cache/documents/file.v1.json +134 -13
  144. googleapiclient/discovery_cache/documents/file.v1beta1.json +26 -14
  145. googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +17 -12
  146. googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +101 -20
  147. googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json +15 -3
  148. googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json +15 -3
  149. googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json +59 -7
  150. googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json +59 -7
  151. googleapiclient/discovery_cache/documents/firebasehosting.v1.json +3 -3
  152. googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json +3 -3
  153. googleapiclient/discovery_cache/documents/firebaseml.v1.json +3 -3
  154. googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +408 -261
  155. googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json +2 -2
  156. googleapiclient/discovery_cache/documents/firestore.v1.json +202 -31
  157. googleapiclient/discovery_cache/documents/firestore.v1beta1.json +192 -21
  158. googleapiclient/discovery_cache/documents/firestore.v1beta2.json +1 -21
  159. googleapiclient/discovery_cache/documents/gkebackup.v1.json +4 -4
  160. googleapiclient/discovery_cache/documents/gkehub.v1.json +4 -4
  161. googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +727 -4
  162. googleapiclient/discovery_cache/documents/gkehub.v1beta.json +727 -4
  163. googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +4 -4
  164. googleapiclient/discovery_cache/documents/gkehub.v2.json +4 -4
  165. googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +4 -4
  166. googleapiclient/discovery_cache/documents/gkehub.v2beta.json +4 -4
  167. googleapiclient/discovery_cache/documents/gkeonprem.v1.json +180 -2
  168. googleapiclient/discovery_cache/documents/gmail.v1.json +42 -2
  169. googleapiclient/discovery_cache/documents/healthcare.v1.json +58 -21
  170. googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +58 -21
  171. googleapiclient/discovery_cache/documents/iam.v1.json +73 -73
  172. googleapiclient/discovery_cache/documents/iamcredentials.v1.json +1 -1
  173. googleapiclient/discovery_cache/documents/identitytoolkit.v1.json +5 -5
  174. googleapiclient/discovery_cache/documents/ids.v1.json +14 -2
  175. googleapiclient/discovery_cache/documents/kmsinventory.v1.json +26 -10
  176. googleapiclient/discovery_cache/documents/language.v1.json +170 -4
  177. googleapiclient/discovery_cache/documents/language.v1beta2.json +170 -4
  178. googleapiclient/discovery_cache/documents/language.v2.json +170 -4
  179. googleapiclient/discovery_cache/documents/licensing.v1.json +2 -2
  180. googleapiclient/discovery_cache/documents/logging.v2.json +46 -9
  181. googleapiclient/discovery_cache/documents/looker.v1.json +61 -4
  182. googleapiclient/discovery_cache/documents/managedkafka.v1.json +290 -8
  183. googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json +304 -1
  184. googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json +189 -17
  185. googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +189 -17
  186. googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json +2 -2
  187. googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +2 -2
  188. googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json +9 -9
  189. googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +9 -9
  190. googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json +2 -2
  191. googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json +2 -2
  192. googleapiclient/discovery_cache/documents/merchantapi.products_v1.json +42 -11
  193. googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +13 -11
  194. googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json +130 -1
  195. googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json +2 -2
  196. googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json +2 -2
  197. googleapiclient/discovery_cache/documents/metastore.v1.json +4 -4
  198. googleapiclient/discovery_cache/documents/metastore.v1alpha.json +4 -4
  199. googleapiclient/discovery_cache/documents/metastore.v1beta.json +4 -4
  200. googleapiclient/discovery_cache/documents/migrationcenter.v1.json +15 -6
  201. googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +348 -11
  202. googleapiclient/discovery_cache/documents/ml.v1.json +13 -1
  203. googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json +9 -5
  204. googleapiclient/discovery_cache/documents/netapp.v1.json +453 -18
  205. googleapiclient/discovery_cache/documents/netapp.v1beta1.json +453 -18
  206. googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +6 -7
  207. googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +4 -4
  208. googleapiclient/discovery_cache/documents/networkmanagement.v1.json +123 -16
  209. googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +119 -16
  210. googleapiclient/discovery_cache/documents/networksecurity.v1.json +419 -6
  211. googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +189 -7
  212. googleapiclient/discovery_cache/documents/networkservices.v1.json +366 -53
  213. googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +80 -55
  214. googleapiclient/discovery_cache/documents/notebooks.v1.json +4 -4
  215. googleapiclient/discovery_cache/documents/notebooks.v2.json +23 -10
  216. googleapiclient/discovery_cache/documents/observability.v1.json +5 -5
  217. googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +3 -3
  218. googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +3 -3
  219. googleapiclient/discovery_cache/documents/oracledatabase.v1.json +4 -4
  220. googleapiclient/discovery_cache/documents/orgpolicy.v2.json +4 -4
  221. googleapiclient/discovery_cache/documents/osconfig.v1.json +16 -3
  222. googleapiclient/discovery_cache/documents/osconfig.v1beta.json +16 -3
  223. googleapiclient/discovery_cache/documents/osconfig.v2.json +5 -5
  224. googleapiclient/discovery_cache/documents/osconfig.v2beta.json +5 -5
  225. googleapiclient/discovery_cache/documents/oslogin.v1.json +44 -1
  226. googleapiclient/discovery_cache/documents/parallelstore.v1.json +2 -2
  227. googleapiclient/discovery_cache/documents/parallelstore.v1beta.json +2 -2
  228. googleapiclient/discovery_cache/documents/parametermanager.v1.json +22 -2
  229. googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +34 -1
  230. googleapiclient/discovery_cache/documents/people.v1.json +2 -2
  231. googleapiclient/discovery_cache/documents/places.v1.json +13 -5
  232. googleapiclient/discovery_cache/documents/policysimulator.v1.json +8 -8
  233. googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +8 -8
  234. googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +8 -8
  235. googleapiclient/discovery_cache/documents/privateca.v1.json +5 -5
  236. googleapiclient/discovery_cache/documents/privateca.v1beta1.json +4 -4
  237. googleapiclient/discovery_cache/documents/pubsub.v1.json +202 -27
  238. googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json +153 -3
  239. googleapiclient/discovery_cache/documents/pubsub.v1beta2.json +153 -3
  240. googleapiclient/discovery_cache/documents/pubsublite.v1.json +3 -3
  241. googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +10 -8
  242. googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json +4 -4
  243. googleapiclient/discovery_cache/documents/recommender.v1beta1.json +5 -5
  244. googleapiclient/discovery_cache/documents/redis.v1.json +51 -36
  245. googleapiclient/discovery_cache/documents/redis.v1beta1.json +51 -36
  246. googleapiclient/discovery_cache/documents/retail.v2.json +5 -5
  247. googleapiclient/discovery_cache/documents/retail.v2alpha.json +9 -7
  248. googleapiclient/discovery_cache/documents/retail.v2beta.json +9 -7
  249. googleapiclient/discovery_cache/documents/run.v1.json +269 -5
  250. googleapiclient/discovery_cache/documents/run.v2.json +320 -6
  251. googleapiclient/discovery_cache/documents/runtimeconfig.v1.json +13 -1
  252. googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json +23 -398
  253. googleapiclient/discovery_cache/documents/safebrowsing.v5.json +79 -5
  254. googleapiclient/discovery_cache/documents/searchads360.v0.json +228 -21
  255. googleapiclient/discovery_cache/documents/secretmanager.v1.json +47 -2
  256. googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +47 -2
  257. googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +47 -2
  258. googleapiclient/discovery_cache/documents/securitycenter.v1.json +641 -7
  259. googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +637 -7
  260. googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +634 -5
  261. googleapiclient/discovery_cache/documents/securityposture.v1.json +13 -1
  262. googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +17 -1
  263. googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +5 -1
  264. googleapiclient/discovery_cache/documents/servicecontrol.v1.json +9 -1
  265. googleapiclient/discovery_cache/documents/servicecontrol.v2.json +9 -1
  266. googleapiclient/discovery_cache/documents/servicedirectory.v1.json +2 -2
  267. googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json +2 -2
  268. googleapiclient/discovery_cache/documents/servicemanagement.v1.json +4 -4
  269. googleapiclient/discovery_cache/documents/servicenetworking.v1.json +4 -4
  270. googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +2 -2
  271. googleapiclient/discovery_cache/documents/serviceusage.v1.json +35 -12
  272. googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +35 -12
  273. googleapiclient/discovery_cache/documents/sheets.v4.json +2 -2
  274. googleapiclient/discovery_cache/documents/solar.v1.json +6 -1
  275. googleapiclient/discovery_cache/documents/spanner.v1.json +131 -8
  276. googleapiclient/discovery_cache/documents/speech.v1.json +3 -3
  277. googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +3 -3
  278. googleapiclient/discovery_cache/documents/sqladmin.v1.json +280 -13
  279. googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +287 -15
  280. googleapiclient/discovery_cache/documents/storage.v1.json +6 -2
  281. googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json +14 -4
  282. googleapiclient/discovery_cache/documents/storagetransfer.v1.json +27 -3
  283. googleapiclient/discovery_cache/documents/sts.v1.json +10 -1
  284. googleapiclient/discovery_cache/documents/sts.v1beta.json +10 -1
  285. googleapiclient/discovery_cache/documents/tagmanager.v2.json +55 -1
  286. googleapiclient/discovery_cache/documents/tasks.v1.json +2 -2
  287. googleapiclient/discovery_cache/documents/testing.v1.json +7 -2
  288. googleapiclient/discovery_cache/documents/texttospeech.v1.json +4 -4
  289. googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +4 -4
  290. googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +2 -2
  291. googleapiclient/discovery_cache/documents/tpu.v1.json +31 -4
  292. googleapiclient/discovery_cache/documents/tpu.v1alpha1.json +44 -17
  293. googleapiclient/discovery_cache/documents/tpu.v2.json +4 -4
  294. googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +4 -4
  295. googleapiclient/discovery_cache/documents/trafficdirector.v2.json +228 -1
  296. googleapiclient/discovery_cache/documents/trafficdirector.v3.json +228 -1
  297. googleapiclient/discovery_cache/documents/translate.v3.json +118 -18
  298. googleapiclient/discovery_cache/documents/translate.v3beta1.json +106 -10
  299. googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +6 -6
  300. googleapiclient/discovery_cache/documents/vault.v1.json +3 -3
  301. googleapiclient/discovery_cache/documents/verifiedaccess.v2.json +9 -5
  302. googleapiclient/discovery_cache/documents/vision.v1.json +3 -3
  303. googleapiclient/discovery_cache/documents/vmmigration.v1.json +22 -6
  304. googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +22 -6
  305. googleapiclient/discovery_cache/documents/vmwareengine.v1.json +549 -2
  306. googleapiclient/discovery_cache/documents/vpcaccess.v1.json +14 -2
  307. googleapiclient/discovery_cache/documents/vpcaccess.v1beta1.json +14 -2
  308. googleapiclient/discovery_cache/documents/walletobjects.v1.json +6 -1
  309. googleapiclient/discovery_cache/documents/webrisk.v1.json +3 -3
  310. googleapiclient/discovery_cache/documents/workflows.v1.json +14 -2
  311. googleapiclient/discovery_cache/documents/workflows.v1beta.json +14 -2
  312. googleapiclient/discovery_cache/documents/workloadmanager.v1.json +5 -5
  313. googleapiclient/discovery_cache/documents/workspaceevents.v1.json +706 -1
  314. googleapiclient/discovery_cache/documents/workstations.v1.json +47 -4
  315. googleapiclient/discovery_cache/documents/workstations.v1beta.json +53 -3
  316. googleapiclient/discovery_cache/documents/youtube.v3.json +149 -1
  317. googleapiclient/discovery_cache/documents/youtubereporting.v1.json +6 -1
  318. googleapiclient/version.py +1 -1
  319. {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.188.0.dist-info}/WHEEL +0 -0
  320. {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.188.0.dist-info}/licenses/LICENSE +0 -0
  321. {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.188.0.dist-info}/top_level.txt +0 -0
@@ -198,7 +198,7 @@
198
198
  ],
199
199
  "parameters": {
200
200
  "extraLocationTypes": {
201
- "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
201
+ "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
202
202
  "location": "query",
203
203
  "repeated": true,
204
204
  "type": "string"
@@ -322,7 +322,7 @@
322
322
  "type": "string"
323
323
  },
324
324
  "returnPartialSuccess": {
325
- "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
325
+ "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.",
326
326
  "location": "query",
327
327
  "type": "boolean"
328
328
  }
@@ -661,8 +661,10 @@
661
661
  },
662
662
  "resources": {
663
663
  "humanReviewConfig": {
664
+ "deprecated": true,
664
665
  "methods": {
665
666
  "reviewDocument": {
667
+ "deprecated": true,
666
668
  "description": "Send a document for Human Review. The input document should be processed by the specified processor.",
667
669
  "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/humanReviewConfig:reviewDocument",
668
670
  "httpMethod": "POST",
@@ -1018,6 +1020,345 @@
1018
1020
  }
1019
1021
  }
1020
1022
  }
1023
+ },
1024
+ "schemas": {
1025
+ "methods": {
1026
+ "create": {
1027
+ "description": "Creates a schema.",
1028
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas",
1029
+ "httpMethod": "POST",
1030
+ "id": "documentai.projects.locations.schemas.create",
1031
+ "parameterOrder": [
1032
+ "parent"
1033
+ ],
1034
+ "parameters": {
1035
+ "parent": {
1036
+ "description": "Required. The parent (project and location) under which to create the Schema. Format: `projects/{project}/locations/{location}`",
1037
+ "location": "path",
1038
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
1039
+ "required": true,
1040
+ "type": "string"
1041
+ }
1042
+ },
1043
+ "path": "v1/{+parent}/schemas",
1044
+ "request": {
1045
+ "$ref": "GoogleCloudDocumentaiV1NextSchema"
1046
+ },
1047
+ "response": {
1048
+ "$ref": "GoogleCloudDocumentaiV1NextSchema"
1049
+ },
1050
+ "scopes": [
1051
+ "https://www.googleapis.com/auth/cloud-platform"
1052
+ ]
1053
+ },
1054
+ "delete": {
1055
+ "description": "Deletes a schema.",
1056
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}",
1057
+ "httpMethod": "DELETE",
1058
+ "id": "documentai.projects.locations.schemas.delete",
1059
+ "parameterOrder": [
1060
+ "name"
1061
+ ],
1062
+ "parameters": {
1063
+ "force": {
1064
+ "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.)",
1065
+ "location": "query",
1066
+ "type": "boolean"
1067
+ },
1068
+ "name": {
1069
+ "description": "Required. The name of the Schema to be deleted. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
1070
+ "location": "path",
1071
+ "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$",
1072
+ "required": true,
1073
+ "type": "string"
1074
+ }
1075
+ },
1076
+ "path": "v1/{+name}",
1077
+ "response": {
1078
+ "$ref": "GoogleLongrunningOperation"
1079
+ },
1080
+ "scopes": [
1081
+ "https://www.googleapis.com/auth/cloud-platform"
1082
+ ]
1083
+ },
1084
+ "get": {
1085
+ "description": "Gets a schema.",
1086
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}",
1087
+ "httpMethod": "GET",
1088
+ "id": "documentai.projects.locations.schemas.get",
1089
+ "parameterOrder": [
1090
+ "name"
1091
+ ],
1092
+ "parameters": {
1093
+ "name": {
1094
+ "description": "Required. The name of the Schema to get. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
1095
+ "location": "path",
1096
+ "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$",
1097
+ "required": true,
1098
+ "type": "string"
1099
+ }
1100
+ },
1101
+ "path": "v1/{+name}",
1102
+ "response": {
1103
+ "$ref": "GoogleCloudDocumentaiV1NextSchema"
1104
+ },
1105
+ "scopes": [
1106
+ "https://www.googleapis.com/auth/cloud-platform"
1107
+ ]
1108
+ },
1109
+ "list": {
1110
+ "description": "Lists Schemas.",
1111
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas",
1112
+ "httpMethod": "GET",
1113
+ "id": "documentai.projects.locations.schemas.list",
1114
+ "parameterOrder": [
1115
+ "parent"
1116
+ ],
1117
+ "parameters": {
1118
+ "pageSize": {
1119
+ "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`.",
1120
+ "format": "int32",
1121
+ "location": "query",
1122
+ "type": "integer"
1123
+ },
1124
+ "pageToken": {
1125
+ "description": "Optional. We will return the schema groups sorted by creation time. The page token will point to the next Schema.",
1126
+ "location": "query",
1127
+ "type": "string"
1128
+ },
1129
+ "parent": {
1130
+ "description": "Required. Format: `projects/{project}/locations/{location}`",
1131
+ "location": "path",
1132
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
1133
+ "required": true,
1134
+ "type": "string"
1135
+ }
1136
+ },
1137
+ "path": "v1/{+parent}/schemas",
1138
+ "response": {
1139
+ "$ref": "GoogleCloudDocumentaiV1ListSchemasResponse"
1140
+ },
1141
+ "scopes": [
1142
+ "https://www.googleapis.com/auth/cloud-platform"
1143
+ ]
1144
+ },
1145
+ "patch": {
1146
+ "description": "Updates a schema. Editable fields are: - `display_name` - `labels`",
1147
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}",
1148
+ "httpMethod": "PATCH",
1149
+ "id": "documentai.projects.locations.schemas.patch",
1150
+ "parameterOrder": [
1151
+ "name"
1152
+ ],
1153
+ "parameters": {
1154
+ "name": {
1155
+ "description": "Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
1156
+ "location": "path",
1157
+ "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$",
1158
+ "required": true,
1159
+ "type": "string"
1160
+ },
1161
+ "updateMask": {
1162
+ "description": "Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.",
1163
+ "format": "google-fieldmask",
1164
+ "location": "query",
1165
+ "type": "string"
1166
+ }
1167
+ },
1168
+ "path": "v1/{+name}",
1169
+ "request": {
1170
+ "$ref": "GoogleCloudDocumentaiV1NextSchema"
1171
+ },
1172
+ "response": {
1173
+ "$ref": "GoogleCloudDocumentaiV1NextSchema"
1174
+ },
1175
+ "scopes": [
1176
+ "https://www.googleapis.com/auth/cloud-platform"
1177
+ ]
1178
+ }
1179
+ },
1180
+ "resources": {
1181
+ "schemaVersions": {
1182
+ "methods": {
1183
+ "create": {
1184
+ "description": "Creates a schema version.",
1185
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions",
1186
+ "httpMethod": "POST",
1187
+ "id": "documentai.projects.locations.schemas.schemaVersions.create",
1188
+ "parameterOrder": [
1189
+ "parent"
1190
+ ],
1191
+ "parameters": {
1192
+ "parent": {
1193
+ "description": "Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
1194
+ "location": "path",
1195
+ "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$",
1196
+ "required": true,
1197
+ "type": "string"
1198
+ }
1199
+ },
1200
+ "path": "v1/{+parent}/schemaVersions",
1201
+ "request": {
1202
+ "$ref": "GoogleCloudDocumentaiV1SchemaVersion"
1203
+ },
1204
+ "response": {
1205
+ "$ref": "GoogleCloudDocumentaiV1SchemaVersion"
1206
+ },
1207
+ "scopes": [
1208
+ "https://www.googleapis.com/auth/cloud-platform"
1209
+ ]
1210
+ },
1211
+ "delete": {
1212
+ "description": "Deletes a schema version.",
1213
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}",
1214
+ "httpMethod": "DELETE",
1215
+ "id": "documentai.projects.locations.schemas.schemaVersions.delete",
1216
+ "parameterOrder": [
1217
+ "name"
1218
+ ],
1219
+ "parameters": {
1220
+ "name": {
1221
+ "description": "Required. The name of the SchemaVersion to delete. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`",
1222
+ "location": "path",
1223
+ "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$",
1224
+ "required": true,
1225
+ "type": "string"
1226
+ }
1227
+ },
1228
+ "path": "v1/{+name}",
1229
+ "response": {
1230
+ "$ref": "GoogleLongrunningOperation"
1231
+ },
1232
+ "scopes": [
1233
+ "https://www.googleapis.com/auth/cloud-platform"
1234
+ ]
1235
+ },
1236
+ "generate": {
1237
+ "description": "Generates a schema version.",
1238
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions:generate",
1239
+ "httpMethod": "POST",
1240
+ "id": "documentai.projects.locations.schemas.schemaVersions.generate",
1241
+ "parameterOrder": [
1242
+ "parent"
1243
+ ],
1244
+ "parameters": {
1245
+ "parent": {
1246
+ "description": "Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
1247
+ "location": "path",
1248
+ "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$",
1249
+ "required": true,
1250
+ "type": "string"
1251
+ }
1252
+ },
1253
+ "path": "v1/{+parent}/schemaVersions:generate",
1254
+ "request": {
1255
+ "$ref": "GoogleCloudDocumentaiV1GenerateSchemaVersionRequest"
1256
+ },
1257
+ "response": {
1258
+ "$ref": "GoogleCloudDocumentaiV1GenerateSchemaVersionResponse"
1259
+ },
1260
+ "scopes": [
1261
+ "https://www.googleapis.com/auth/cloud-platform"
1262
+ ]
1263
+ },
1264
+ "get": {
1265
+ "description": "Gets a schema version.",
1266
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}",
1267
+ "httpMethod": "GET",
1268
+ "id": "documentai.projects.locations.schemas.schemaVersions.get",
1269
+ "parameterOrder": [
1270
+ "name"
1271
+ ],
1272
+ "parameters": {
1273
+ "name": {
1274
+ "description": "Required. The name of the SchemaVersion to get. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`",
1275
+ "location": "path",
1276
+ "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$",
1277
+ "required": true,
1278
+ "type": "string"
1279
+ }
1280
+ },
1281
+ "path": "v1/{+name}",
1282
+ "response": {
1283
+ "$ref": "GoogleCloudDocumentaiV1SchemaVersion"
1284
+ },
1285
+ "scopes": [
1286
+ "https://www.googleapis.com/auth/cloud-platform"
1287
+ ]
1288
+ },
1289
+ "list": {
1290
+ "description": "Lists SchemaVersions.",
1291
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions",
1292
+ "httpMethod": "GET",
1293
+ "id": "documentai.projects.locations.schemas.schemaVersions.list",
1294
+ "parameterOrder": [
1295
+ "parent"
1296
+ ],
1297
+ "parameters": {
1298
+ "pageSize": {
1299
+ "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`.",
1300
+ "format": "int32",
1301
+ "location": "query",
1302
+ "type": "integer"
1303
+ },
1304
+ "pageToken": {
1305
+ "description": "Optional. We will return the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion.",
1306
+ "location": "query",
1307
+ "type": "string"
1308
+ },
1309
+ "parent": {
1310
+ "description": "Required. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
1311
+ "location": "path",
1312
+ "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$",
1313
+ "required": true,
1314
+ "type": "string"
1315
+ }
1316
+ },
1317
+ "path": "v1/{+parent}/schemaVersions",
1318
+ "response": {
1319
+ "$ref": "GoogleCloudDocumentaiV1ListSchemaVersionsResponse"
1320
+ },
1321
+ "scopes": [
1322
+ "https://www.googleapis.com/auth/cloud-platform"
1323
+ ]
1324
+ },
1325
+ "patch": {
1326
+ "description": "Updates a schema version. Editable fields are: - `display_name` - `labels`",
1327
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}",
1328
+ "httpMethod": "PATCH",
1329
+ "id": "documentai.projects.locations.schemas.schemaVersions.patch",
1330
+ "parameterOrder": [
1331
+ "name"
1332
+ ],
1333
+ "parameters": {
1334
+ "name": {
1335
+ "description": "Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`",
1336
+ "location": "path",
1337
+ "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$",
1338
+ "required": true,
1339
+ "type": "string"
1340
+ },
1341
+ "updateMask": {
1342
+ "description": "Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.",
1343
+ "format": "google-fieldmask",
1344
+ "location": "query",
1345
+ "type": "string"
1346
+ }
1347
+ },
1348
+ "path": "v1/{+name}",
1349
+ "request": {
1350
+ "$ref": "GoogleCloudDocumentaiV1SchemaVersion"
1351
+ },
1352
+ "response": {
1353
+ "$ref": "GoogleCloudDocumentaiV1SchemaVersion"
1354
+ },
1355
+ "scopes": [
1356
+ "https://www.googleapis.com/auth/cloud-platform"
1357
+ ]
1358
+ }
1359
+ }
1360
+ }
1361
+ }
1021
1362
  }
1022
1363
  }
1023
1364
  },
@@ -1053,11 +1394,11 @@
1053
1394
  }
1054
1395
  }
1055
1396
  },
1056
- "revision": "20251013",
1397
+ "revision": "20260104",
1057
1398
  "rootUrl": "https://documentai.googleapis.com/",
1058
1399
  "schemas": {
1059
1400
  "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": {
1060
- "description": "Definition of the validation rules. Those are the input to the validator logic and they are used to validate a document.",
1401
+ "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",
1061
1402
  "id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput",
1062
1403
  "properties": {
1063
1404
  "validationRules": {
@@ -1070,6 +1411,7 @@
1070
1411
  "type": "object"
1071
1412
  },
1072
1413
  "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule": {
1414
+ "description": "Next ID: 9",
1073
1415
  "id": "CloudAiDocumentaiLabHifiaToolsValidationValidatorInputValidationRule",
1074
1416
  "properties": {
1075
1417
  "childAlignmentRule": {
@@ -1094,6 +1436,10 @@
1094
1436
  "name": {
1095
1437
  "description": "Name of the validation rule.",
1096
1438
  "type": "string"
1439
+ },
1440
+ "ruleId": {
1441
+ "description": "Unique identifier of the rule. Optional.",
1442
+ "type": "string"
1097
1443
  }
1098
1444
  },
1099
1445
  "type": "object"
@@ -1678,7 +2024,174 @@
1678
2024
  },
1679
2025
  "type": "object"
1680
2026
  },
1681
- "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata": {
2027
+ "GoogleCloudDocumentaiUiv1beta3DocumentSchema": {
2028
+ "description": "The schema defines the output of the processed document by a processor.",
2029
+ "id": "GoogleCloudDocumentaiUiv1beta3DocumentSchema",
2030
+ "properties": {
2031
+ "description": {
2032
+ "description": "Description of the schema.",
2033
+ "type": "string"
2034
+ },
2035
+ "displayName": {
2036
+ "description": "Display name to show to users.",
2037
+ "type": "string"
2038
+ },
2039
+ "documentPrompt": {
2040
+ "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.",
2041
+ "type": "string"
2042
+ },
2043
+ "entityTypes": {
2044
+ "description": "Entity types of the schema.",
2045
+ "items": {
2046
+ "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType"
2047
+ },
2048
+ "type": "array"
2049
+ },
2050
+ "metadata": {
2051
+ "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata",
2052
+ "description": "Metadata of the schema."
2053
+ }
2054
+ },
2055
+ "type": "object"
2056
+ },
2057
+ "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType": {
2058
+ "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.",
2059
+ "id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType",
2060
+ "properties": {
2061
+ "baseTypes": {
2062
+ "description": "The entity type that this type is derived from. For now, one and only one should be set.",
2063
+ "items": {
2064
+ "type": "string"
2065
+ },
2066
+ "type": "array"
2067
+ },
2068
+ "description": {
2069
+ "description": "The description of the entity type. Could be used to provide more information about the entity type for model calls.",
2070
+ "type": "string"
2071
+ },
2072
+ "displayName": {
2073
+ "description": "User defined name for the type.",
2074
+ "type": "string"
2075
+ },
2076
+ "entityTypeMetadata": {
2077
+ "$ref": "GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata",
2078
+ "description": "Metadata for the entity type."
2079
+ },
2080
+ "enumValues": {
2081
+ "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues",
2082
+ "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."
2083
+ },
2084
+ "name": {
2085
+ "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.",
2086
+ "type": "string"
2087
+ },
2088
+ "properties": {
2089
+ "description": "Description the nested structure, or composition of an entity.",
2090
+ "items": {
2091
+ "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty"
2092
+ },
2093
+ "type": "array"
2094
+ }
2095
+ },
2096
+ "type": "object"
2097
+ },
2098
+ "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues": {
2099
+ "description": "Defines the a list of enum values.",
2100
+ "id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues",
2101
+ "properties": {
2102
+ "values": {
2103
+ "description": "The individual values that this enum values type can include.",
2104
+ "items": {
2105
+ "type": "string"
2106
+ },
2107
+ "type": "array"
2108
+ }
2109
+ },
2110
+ "type": "object"
2111
+ },
2112
+ "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty": {
2113
+ "description": "Defines properties that can be part of the entity type.",
2114
+ "id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty",
2115
+ "properties": {
2116
+ "description": {
2117
+ "description": "The description of the property. Could be used to provide more information about the property for model calls.",
2118
+ "type": "string"
2119
+ },
2120
+ "displayName": {
2121
+ "description": "User defined name for the property.",
2122
+ "type": "string"
2123
+ },
2124
+ "method": {
2125
+ "description": "Specifies how the entity's value is obtained.",
2126
+ "enum": [
2127
+ "METHOD_UNSPECIFIED",
2128
+ "EXTRACT",
2129
+ "DERIVE"
2130
+ ],
2131
+ "enumDescriptions": [
2132
+ "Unspecified method. It defaults to `EXTRACT`.",
2133
+ "The entity's value is directly extracted as-is from the document text.",
2134
+ "The entity's value is derived through inference and is not necessarily an exact text extraction from the document."
2135
+ ],
2136
+ "type": "string"
2137
+ },
2138
+ "name": {
2139
+ "description": "The name of the property. Follows the same guidelines as the EntityType name.",
2140
+ "type": "string"
2141
+ },
2142
+ "occurrenceType": {
2143
+ "description": "Occurrence type limits the number of instances an entity type appears in the document.",
2144
+ "enum": [
2145
+ "OCCURRENCE_TYPE_UNSPECIFIED",
2146
+ "OPTIONAL_ONCE",
2147
+ "OPTIONAL_MULTIPLE",
2148
+ "REQUIRED_ONCE",
2149
+ "REQUIRED_MULTIPLE"
2150
+ ],
2151
+ "enumDescriptions": [
2152
+ "Unspecified occurrence type.",
2153
+ "There will be zero or one instance of this entity type. The same entity instance may be mentioned multiple times.",
2154
+ "The entity type will appear zero or multiple times.",
2155
+ "The entity type will only appear exactly once. The same entity instance may be mentioned multiple times.",
2156
+ "The entity type will appear once or more times."
2157
+ ],
2158
+ "type": "string"
2159
+ },
2160
+ "propertyMetadata": {
2161
+ "$ref": "GoogleCloudDocumentaiUiv1beta3PropertyMetadata",
2162
+ "description": "Any additional metadata about the property can be added here."
2163
+ },
2164
+ "valueType": {
2165
+ "description": "A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.",
2166
+ "type": "string"
2167
+ }
2168
+ },
2169
+ "type": "object"
2170
+ },
2171
+ "GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata": {
2172
+ "description": "Metadata for global schema behavior.",
2173
+ "id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata",
2174
+ "properties": {
2175
+ "documentAllowMultipleLabels": {
2176
+ "description": "If true, on a given page, there can be multiple `document` annotations covering it.",
2177
+ "type": "boolean"
2178
+ },
2179
+ "documentSplitter": {
2180
+ "description": "If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).",
2181
+ "type": "boolean"
2182
+ },
2183
+ "prefixedNamingOnProperties": {
2184
+ "description": "If set, all the nested entities must be prefixed with the parents.",
2185
+ "type": "boolean"
2186
+ },
2187
+ "skipNamingValidation": {
2188
+ "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.",
2189
+ "type": "boolean"
2190
+ }
2191
+ },
2192
+ "type": "object"
2193
+ },
2194
+ "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata": {
1682
2195
  "description": "The long-running operation metadata for the EnableProcessor method.",
1683
2196
  "id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata",
1684
2197
  "properties": {
@@ -1695,6 +2208,37 @@
1695
2208
  "properties": {},
1696
2209
  "type": "object"
1697
2210
  },
2211
+ "GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata": {
2212
+ "description": "Metadata about an entity type.",
2213
+ "id": "GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata",
2214
+ "properties": {
2215
+ "fieldTierMetadata": {
2216
+ "$ref": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata",
2217
+ "description": "Field tier metadata on the property"
2218
+ },
2219
+ "humanReviewLabelingMetadata": {
2220
+ "$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata",
2221
+ "description": "Human review labeling config on the entity."
2222
+ },
2223
+ "humanReviewMetadata": {
2224
+ "$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata",
2225
+ "description": "Human review config on the entity."
2226
+ },
2227
+ "inactive": {
2228
+ "description": "Whether the entity type should be considered inactive.",
2229
+ "type": "boolean"
2230
+ },
2231
+ "schemaEditabilityMetadata": {
2232
+ "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata",
2233
+ "description": "Schema editability metadata on the entity."
2234
+ },
2235
+ "schemaInferenceMetadata": {
2236
+ "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata",
2237
+ "description": "Schema inference metadata on the entity."
2238
+ }
2239
+ },
2240
+ "type": "object"
2241
+ },
1698
2242
  "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata": {
1699
2243
  "description": "Metadata of the EvaluateProcessorVersion method.",
1700
2244
  "id": "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata",
@@ -1717,6 +2261,91 @@
1717
2261
  },
1718
2262
  "type": "object"
1719
2263
  },
2264
+ "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics": {
2265
+ "description": "Evaluation metrics, either in aggregate or about a specific entity.",
2266
+ "id": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics",
2267
+ "properties": {
2268
+ "f1Score": {
2269
+ "description": "The calculated f1 score.",
2270
+ "format": "float",
2271
+ "type": "number"
2272
+ },
2273
+ "falseNegativesCount": {
2274
+ "description": "The amount of false negatives.",
2275
+ "format": "int32",
2276
+ "type": "integer"
2277
+ },
2278
+ "falsePositivesCount": {
2279
+ "description": "The amount of false positives.",
2280
+ "format": "int32",
2281
+ "type": "integer"
2282
+ },
2283
+ "groundTruthDocumentCount": {
2284
+ "description": "The amount of documents with a ground truth occurrence.",
2285
+ "format": "int32",
2286
+ "type": "integer"
2287
+ },
2288
+ "groundTruthOccurrencesCount": {
2289
+ "description": "The amount of occurrences in ground truth documents.",
2290
+ "format": "int32",
2291
+ "type": "integer"
2292
+ },
2293
+ "precision": {
2294
+ "description": "The calculated precision.",
2295
+ "format": "float",
2296
+ "type": "number"
2297
+ },
2298
+ "predictedDocumentCount": {
2299
+ "description": "The amount of documents with a predicted occurrence.",
2300
+ "format": "int32",
2301
+ "type": "integer"
2302
+ },
2303
+ "predictedOccurrencesCount": {
2304
+ "description": "The amount of occurrences in predicted documents.",
2305
+ "format": "int32",
2306
+ "type": "integer"
2307
+ },
2308
+ "recall": {
2309
+ "description": "The calculated recall.",
2310
+ "format": "float",
2311
+ "type": "number"
2312
+ },
2313
+ "totalDocumentsCount": {
2314
+ "description": "The amount of documents that had an occurrence of this label.",
2315
+ "format": "int32",
2316
+ "type": "integer"
2317
+ },
2318
+ "truePositivesCount": {
2319
+ "description": "The amount of true positives.",
2320
+ "format": "int32",
2321
+ "type": "integer"
2322
+ }
2323
+ },
2324
+ "type": "object"
2325
+ },
2326
+ "GoogleCloudDocumentaiUiv1beta3EvaluationReference": {
2327
+ "description": "Gives a short summary of an evaluation, and links to the evaluation itself.",
2328
+ "id": "GoogleCloudDocumentaiUiv1beta3EvaluationReference",
2329
+ "properties": {
2330
+ "aggregateMetrics": {
2331
+ "$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics",
2332
+ "description": "An aggregate of the statistics for the evaluation with fuzzy matching on."
2333
+ },
2334
+ "aggregateMetricsExact": {
2335
+ "$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics",
2336
+ "description": "An aggregate of the statistics for the evaluation with fuzzy matching off."
2337
+ },
2338
+ "evaluation": {
2339
+ "description": "The resource name of the evaluation.",
2340
+ "type": "string"
2341
+ },
2342
+ "operation": {
2343
+ "description": "The resource name of the Long Running Operation for the evaluation.",
2344
+ "type": "string"
2345
+ }
2346
+ },
2347
+ "type": "object"
2348
+ },
1720
2349
  "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata": {
1721
2350
  "description": "Metadata of the batch export documents operation.",
1722
2351
  "id": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata",
@@ -1817,27 +2446,92 @@
1817
2446
  },
1818
2447
  "type": "object"
1819
2448
  },
1820
- "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata": {
1821
- "description": "Metadata of the import document operation.",
1822
- "id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata",
2449
+ "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata": {
2450
+ "description": "Metadata for how this field value is extracted.",
2451
+ "id": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata",
1823
2452
  "properties": {
1824
- "commonMetadata": {
1825
- "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
1826
- "description": "The basic metadata of the long-running operation."
2453
+ "entityQuery": {
2454
+ "$ref": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery",
2455
+ "description": "Entity query config."
1827
2456
  },
1828
- "importConfigValidationResults": {
1829
- "description": "Validation statuses of the batch documents import config.",
1830
- "items": {
1831
- "$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult"
2457
+ "summaryOptions": {
2458
+ "$ref": "GoogleCloudDocumentaiUiv1beta3SummaryOptions",
2459
+ "description": "Summary options config."
2460
+ }
1832
2461
  },
1833
- "type": "array"
2462
+ "type": "object"
1834
2463
  },
1835
- "individualImportStatuses": {
1836
- "description": "The list of response details of each document.",
1837
- "items": {
1838
- "$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus"
2464
+ "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery": {
2465
+ "description": "Message for entity query.",
2466
+ "id": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery",
2467
+ "properties": {
2468
+ "userEntityQuery": {
2469
+ "description": "The original entity query inputed by the user.",
2470
+ "type": "string"
2471
+ }
1839
2472
  },
1840
- "type": "array"
2473
+ "type": "object"
2474
+ },
2475
+ "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata": {
2476
+ "description": "Metadata for the field tier of a property.",
2477
+ "id": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata",
2478
+ "properties": {
2479
+ "tierLevel": {
2480
+ "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.",
2481
+ "format": "int32",
2482
+ "type": "integer"
2483
+ }
2484
+ },
2485
+ "type": "object"
2486
+ },
2487
+ "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata": {
2488
+ "description": "Metadata for human review labeling config.",
2489
+ "id": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata",
2490
+ "properties": {
2491
+ "enableNormalizationEditing": {
2492
+ "description": "Whether to enable normalization editing.",
2493
+ "type": "boolean"
2494
+ }
2495
+ },
2496
+ "type": "object"
2497
+ },
2498
+ "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata": {
2499
+ "description": "Metadata for Human Review config.",
2500
+ "id": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata",
2501
+ "properties": {
2502
+ "confidenceThreshold": {
2503
+ "description": "The confidence threshold if human review validation is enabled.",
2504
+ "format": "float",
2505
+ "type": "number"
2506
+ },
2507
+ "enableValidation": {
2508
+ "description": "Whether to enable human review validation.",
2509
+ "type": "boolean"
2510
+ }
2511
+ },
2512
+ "type": "object"
2513
+ },
2514
+ "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata": {
2515
+ "description": "Metadata of the import document operation.",
2516
+ "id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata",
2517
+ "properties": {
2518
+ "commonMetadata": {
2519
+ "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
2520
+ "description": "The basic metadata of the long-running operation."
2521
+ },
2522
+ "importConfigValidationResults": {
2523
+ "description": "Validation statuses of the batch documents import config.",
2524
+ "items": {
2525
+ "$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult"
2526
+ },
2527
+ "type": "array"
2528
+ },
2529
+ "individualImportStatuses": {
2530
+ "description": "The list of response details of each document.",
2531
+ "items": {
2532
+ "$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus"
2533
+ },
2534
+ "type": "array"
1841
2535
  },
1842
2536
  "totalDocumentCount": {
1843
2537
  "description": "Total number of the documents that are qualified for importing.",
@@ -1913,273 +2607,450 @@
1913
2607
  },
1914
2608
  "type": "object"
1915
2609
  },
1916
- "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata": {
1917
- "description": "The metadata proto of `ResyncDataset` method.",
1918
- "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata",
2610
+ "GoogleCloudDocumentaiUiv1beta3Processor": {
2611
+ "description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.",
2612
+ "id": "GoogleCloudDocumentaiUiv1beta3Processor",
1919
2613
  "properties": {
1920
- "commonMetadata": {
1921
- "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
1922
- "description": "The basic metadata of the long-running operation."
2614
+ "activeSchemaVersion": {
2615
+ "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}",
2616
+ "type": "string"
1923
2617
  },
1924
- "datasetResyncStatuses": {
1925
- "description": "The list of dataset resync statuses. Not checked when ResyncDatasetRequest.dataset_documents is specified.",
1926
- "items": {
1927
- "$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus"
2618
+ "createTime": {
2619
+ "description": "Output only. The time the processor was created.",
2620
+ "format": "google-datetime",
2621
+ "readOnly": true,
2622
+ "type": "string"
1928
2623
  },
1929
- "type": "array"
2624
+ "defaultProcessorVersion": {
2625
+ "description": "The default processor version.",
2626
+ "type": "string"
1930
2627
  },
1931
- "individualDocumentResyncStatuses": {
1932
- "description": "The list of document resync statuses. The same document could have multiple `individual_document_resync_statuses` if it has multiple inconsistencies.",
2628
+ "displayName": {
2629
+ "description": "The display name of the processor.",
2630
+ "type": "string"
2631
+ },
2632
+ "kmsKeyName": {
2633
+ "description": "The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.",
2634
+ "type": "string"
2635
+ },
2636
+ "name": {
2637
+ "description": "Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}`",
2638
+ "readOnly": true,
2639
+ "type": "string"
2640
+ },
2641
+ "processEndpoint": {
2642
+ "description": "Output only. Immutable. The http endpoint that can be called to invoke processing.",
2643
+ "readOnly": true,
2644
+ "type": "string"
2645
+ },
2646
+ "processorVersionAliases": {
2647
+ "description": "Output only. The processor version aliases.",
1933
2648
  "items": {
1934
- "$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus"
2649
+ "$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias"
1935
2650
  },
2651
+ "readOnly": true,
1936
2652
  "type": "array"
1937
- }
1938
2653
  },
1939
- "type": "object"
2654
+ "satisfiesPzi": {
2655
+ "description": "Output only. Reserved for future use.",
2656
+ "readOnly": true,
2657
+ "type": "boolean"
1940
2658
  },
1941
- "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus": {
1942
- "description": "Resync status against inconsistency types on the dataset level.",
1943
- "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus",
1944
- "properties": {
1945
- "datasetInconsistencyType": {
1946
- "description": "The type of the inconsistency of the dataset.",
2659
+ "satisfiesPzs": {
2660
+ "description": "Output only. Reserved for future use.",
2661
+ "readOnly": true,
2662
+ "type": "boolean"
2663
+ },
2664
+ "state": {
2665
+ "description": "Output only. The state of the processor.",
1947
2666
  "enum": [
1948
- "DATASET_INCONSISTENCY_TYPE_UNSPECIFIED",
1949
- "DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER"
2667
+ "STATE_UNSPECIFIED",
2668
+ "ENABLED",
2669
+ "DISABLED",
2670
+ "ENABLING",
2671
+ "DISABLING",
2672
+ "CREATING",
2673
+ "FAILED",
2674
+ "DELETING"
1950
2675
  ],
1951
2676
  "enumDescriptions": [
1952
- "Default value.",
1953
- "The marker file under the dataset folder is not found."
2677
+ "The processor is in an unspecified state.",
2678
+ "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.",
2679
+ "The processor is disabled.",
2680
+ "The processor is being enabled, will become `ENABLED` if successful.",
2681
+ "The processor is being disabled, will become `DISABLED` if successful.",
2682
+ "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.",
2683
+ "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.",
2684
+ "The processor is being deleted, will be removed if successful."
1954
2685
  ],
2686
+ "readOnly": true,
1955
2687
  "type": "string"
1956
2688
  },
1957
- "status": {
1958
- "$ref": "GoogleRpcStatus",
1959
- "description": "The status of resyncing the dataset with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`."
2689
+ "type": {
2690
+ "description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes.",
2691
+ "type": "string"
1960
2692
  }
1961
2693
  },
1962
2694
  "type": "object"
1963
2695
  },
1964
- "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus": {
1965
- "description": "Resync status for each document per inconsistency type.",
1966
- "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus",
2696
+ "GoogleCloudDocumentaiUiv1beta3ProcessorVersion": {
2697
+ "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.",
2698
+ "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersion",
1967
2699
  "properties": {
1968
- "documentId": {
1969
- "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
1970
- "description": "The document identifier."
2700
+ "createTime": {
2701
+ "description": "Output only. The time the processor version was created.",
2702
+ "format": "google-datetime",
2703
+ "readOnly": true,
2704
+ "type": "string"
1971
2705
  },
1972
- "documentInconsistencyType": {
1973
- "description": "The type of document inconsistency.",
1974
- "enum": [
1975
- "DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED",
1976
- "DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO",
1977
- "DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA",
1978
- "DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE"
1979
- ],
1980
- "enumDescriptions": [
1981
- "Default value.",
1982
- "The document proto is invalid.",
1983
- "Indexed docproto metadata is mismatched.",
1984
- "The page image or thumbnails are missing."
1985
- ],
2706
+ "deploymentAllowed": {
2707
+ "description": "Output only. Denotes that this `ProcessorVersion` can be deployed and undeployed.",
2708
+ "readOnly": true,
2709
+ "type": "boolean"
2710
+ },
2711
+ "deprecationInfo": {
2712
+ "$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo",
2713
+ "description": "Output only. If set, information about the eventual deprecation of this version.",
2714
+ "readOnly": true
2715
+ },
2716
+ "displayName": {
2717
+ "description": "The display name of the processor version.",
1986
2718
  "type": "string"
1987
2719
  },
1988
- "status": {
1989
- "$ref": "GoogleRpcStatus",
1990
- "description": "The status of resyncing the document with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`."
1991
- }
2720
+ "documentSchema": {
2721
+ "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchema",
2722
+ "description": "Output only. The schema of the processor version. Describes the output.",
2723
+ "readOnly": true
1992
2724
  },
1993
- "type": "object"
2725
+ "genAiModelInfo": {
2726
+ "$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo",
2727
+ "description": "Output only. Information about Generative AI model-based processor versions.",
2728
+ "readOnly": true
1994
2729
  },
1995
- "GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse": {
1996
- "description": "The response proto of ResyncDataset method.",
1997
- "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse",
1998
- "properties": {},
1999
- "type": "object"
2730
+ "googleManaged": {
2731
+ "description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.",
2732
+ "readOnly": true,
2733
+ "type": "boolean"
2000
2734
  },
2001
- "GoogleCloudDocumentaiUiv1beta3RevisionRef": {
2002
- "description": "The revision reference specifies which revision on the document to read.",
2003
- "id": "GoogleCloudDocumentaiUiv1beta3RevisionRef",
2004
- "properties": {
2005
- "latestProcessorVersion": {
2006
- "description": "Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`",
2735
+ "kmsKeyName": {
2736
+ "description": "Output only. The KMS key name used for encryption.",
2737
+ "readOnly": true,
2007
2738
  "type": "string"
2008
2739
  },
2009
- "revisionCase": {
2010
- "description": "Reads the revision by the predefined case.",
2740
+ "kmsKeyVersionName": {
2741
+ "description": "Output only. The KMS key version with which data is encrypted.",
2742
+ "readOnly": true,
2743
+ "type": "string"
2744
+ },
2745
+ "latestEvaluation": {
2746
+ "$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationReference",
2747
+ "description": "Output only. The most recently invoked evaluation for the processor version.",
2748
+ "readOnly": true
2749
+ },
2750
+ "modelType": {
2751
+ "description": "Output only. The model type of this processor version.",
2011
2752
  "enum": [
2012
- "REVISION_CASE_UNSPECIFIED",
2013
- "LATEST_HUMAN_REVIEW",
2014
- "LATEST_TIMESTAMP",
2015
- "BASE_OCR_REVISION"
2753
+ "MODEL_TYPE_UNSPECIFIED",
2754
+ "MODEL_TYPE_GENERATIVE",
2755
+ "MODEL_TYPE_CUSTOM"
2016
2756
  ],
2017
2757
  "enumDescriptions": [
2018
- "Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`.",
2019
- "The latest revision made by a human.",
2020
- "The latest revision based on timestamp.",
2021
- "The first (OCR) revision."
2758
+ "The processor version has unspecified model type.",
2759
+ "The processor version has generative model type.",
2760
+ "The processor version has custom model type."
2022
2761
  ],
2762
+ "readOnly": true,
2023
2763
  "type": "string"
2024
2764
  },
2025
- "revisionId": {
2026
- "description": "Reads the revision given by the id.",
2765
+ "name": {
2766
+ "description": "Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`",
2027
2767
  "type": "string"
2028
- }
2029
2768
  },
2030
- "type": "object"
2769
+ "satisfiesPzi": {
2770
+ "description": "Output only. Reserved for future use.",
2771
+ "readOnly": true,
2772
+ "type": "boolean"
2031
2773
  },
2032
- "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata": {
2033
- "description": "Metadata of the sample documents operation.",
2034
- "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata",
2035
- "properties": {
2036
- "commonMetadata": {
2037
- "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
2038
- "description": "The basic metadata of the long-running operation."
2039
- }
2774
+ "satisfiesPzs": {
2775
+ "description": "Output only. Reserved for future use.",
2776
+ "readOnly": true,
2777
+ "type": "boolean"
2040
2778
  },
2041
- "type": "object"
2779
+ "schema": {
2780
+ "$ref": "GoogleCloudDocumentaiUiv1beta3Schema",
2781
+ "description": "The schema of the processor version. Describes the output."
2042
2782
  },
2043
- "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse": {
2044
- "description": "Response of the sample documents operation.",
2045
- "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse",
2046
- "properties": {
2047
- "sampleTestStatus": {
2048
- "$ref": "GoogleRpcStatus",
2049
- "description": "The status of sampling documents in test split."
2783
+ "state": {
2784
+ "description": "Output only. The state of the processor version.",
2785
+ "enum": [
2786
+ "STATE_UNSPECIFIED",
2787
+ "DEPLOYED",
2788
+ "DEPLOYING",
2789
+ "UNDEPLOYED",
2790
+ "UNDEPLOYING",
2791
+ "CREATING",
2792
+ "DELETING",
2793
+ "FAILED",
2794
+ "IMPORTING"
2795
+ ],
2796
+ "enumDescriptions": [
2797
+ "The processor version is in an unspecified state.",
2798
+ "The processor version is deployed and can be used for processing.",
2799
+ "The processor version is being deployed.",
2800
+ "The processor version is not deployed and cannot be used for processing.",
2801
+ "The processor version is being undeployed.",
2802
+ "The processor version is being created.",
2803
+ "The processor version is being deleted.",
2804
+ "The processor version failed and is in an indeterminate state.",
2805
+ "The processor version is being imported."
2806
+ ],
2807
+ "readOnly": true,
2808
+ "type": "string"
2809
+ }
2050
2810
  },
2051
- "sampleTrainingStatus": {
2052
- "$ref": "GoogleRpcStatus",
2053
- "description": "The status of sampling documents in training split."
2811
+ "type": "object"
2054
2812
  },
2055
- "selectedDocuments": {
2056
- "description": "The result of the sampling process.",
2057
- "items": {
2058
- "$ref": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument"
2813
+ "GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias": {
2814
+ "description": "Contains the alias and the aliased resource name of processor version.",
2815
+ "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias",
2816
+ "properties": {
2817
+ "alias": {
2818
+ "description": "The alias in the form of `processor_version` resource name.",
2819
+ "type": "string"
2059
2820
  },
2060
- "type": "array"
2821
+ "processorVersion": {
2822
+ "description": "The resource name of aliased processor version.",
2823
+ "type": "string"
2061
2824
  }
2062
2825
  },
2063
2826
  "type": "object"
2064
2827
  },
2065
- "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument": {
2066
- "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument",
2828
+ "GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo": {
2829
+ "description": "Information about the upcoming deprecation of this processor version.",
2830
+ "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo",
2067
2831
  "properties": {
2068
- "documentId": {
2069
- "description": "An internal identifier for document.",
2832
+ "deprecationTime": {
2833
+ "description": "The time at which this processor version will be deprecated.",
2834
+ "format": "google-datetime",
2835
+ "type": "string"
2836
+ },
2837
+ "replacementProcessorVersion": {
2838
+ "description": "If set, the processor version that will be used as a replacement.",
2070
2839
  "type": "string"
2071
2840
  }
2072
2841
  },
2073
2842
  "type": "object"
2074
2843
  },
2075
- "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata": {
2076
- "description": "The long-running operation metadata for the SetDefaultProcessorVersion method.",
2077
- "id": "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata",
2844
+ "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo": {
2845
+ "description": "Information about Generative AI model-based processor versions.",
2846
+ "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo",
2078
2847
  "properties": {
2079
- "commonMetadata": {
2080
- "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
2081
- "description": "The basic metadata of the long-running operation."
2848
+ "customGenAiModelInfo": {
2849
+ "$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo",
2850
+ "description": "Information for a custom Generative AI model created by the user."
2851
+ },
2852
+ "foundationGenAiModelInfo": {
2853
+ "$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo",
2854
+ "description": "Information for a pretrained Google-managed foundation model."
2082
2855
  }
2083
2856
  },
2084
2857
  "type": "object"
2085
2858
  },
2086
- "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse": {
2087
- "description": "Response message for the SetDefaultProcessorVersion method.",
2088
- "id": "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse",
2089
- "properties": {},
2859
+ "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": {
2860
+ "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.",
2861
+ "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo",
2862
+ "properties": {
2863
+ "baseProcessorVersionId": {
2864
+ "description": "The base processor version ID for the custom model.",
2865
+ "type": "string"
2866
+ },
2867
+ "customModelType": {
2868
+ "description": "The type of custom model created by the user.",
2869
+ "enum": [
2870
+ "CUSTOM_MODEL_TYPE_UNSPECIFIED",
2871
+ "VERSIONED_FOUNDATION",
2872
+ "FINE_TUNED"
2873
+ ],
2874
+ "enumDescriptions": [
2875
+ "The model type is unspecified.",
2876
+ "The model is a versioned foundation model.",
2877
+ "The model is a finetuned foundation model."
2878
+ ],
2879
+ "type": "string"
2880
+ }
2881
+ },
2090
2882
  "type": "object"
2091
2883
  },
2092
- "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata": {
2093
- "description": "The metadata that represents a processor version being created.",
2094
- "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata",
2884
+ "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": {
2885
+ "description": "Information for a pretrained Google-managed foundation model.",
2886
+ "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo",
2095
2887
  "properties": {
2096
- "commonMetadata": {
2097
- "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
2098
- "description": "The basic metadata of the long-running operation."
2888
+ "finetuningAllowed": {
2889
+ "description": "Whether finetuning is allowed for this base processor version.",
2890
+ "type": "boolean"
2099
2891
  },
2100
- "testDatasetValidation": {
2101
- "$ref": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation",
2102
- "description": "The test dataset validation information."
2892
+ "minTrainLabeledDocuments": {
2893
+ "description": "The minimum number of labeled documents in the training dataset required for finetuning.",
2894
+ "format": "int32",
2895
+ "type": "integer"
2896
+ }
2103
2897
  },
2104
- "trainingDatasetValidation": {
2105
- "$ref": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation",
2106
- "description": "The training dataset validation information."
2898
+ "type": "object"
2899
+ },
2900
+ "GoogleCloudDocumentaiUiv1beta3PropertyMetadata": {
2901
+ "description": "Metadata about a property.",
2902
+ "id": "GoogleCloudDocumentaiUiv1beta3PropertyMetadata",
2903
+ "properties": {
2904
+ "fieldExtractionMetadata": {
2905
+ "$ref": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata",
2906
+ "description": "Field extraction metadata on the property."
2907
+ },
2908
+ "fieldTierMetadata": {
2909
+ "$ref": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata",
2910
+ "description": "Field tier metadata on the property"
2911
+ },
2912
+ "humanReviewLabelingMetadata": {
2913
+ "$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata",
2914
+ "description": "Human review labeling config on the property."
2915
+ },
2916
+ "humanReviewMetadata": {
2917
+ "$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata",
2918
+ "description": "Human review validation config on the property."
2919
+ },
2920
+ "inactive": {
2921
+ "description": "Whether the property should be considered as \"inactive\".",
2922
+ "type": "boolean"
2923
+ },
2924
+ "schemaEditabilityMetadata": {
2925
+ "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata",
2926
+ "description": "Schema editability metadata on the property."
2927
+ },
2928
+ "schemaInferenceMetadata": {
2929
+ "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata",
2930
+ "description": "Schema inference metadata on the property."
2107
2931
  }
2108
2932
  },
2109
2933
  "type": "object"
2110
2934
  },
2111
- "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation": {
2112
- "description": "The dataset validation information. This includes any and all errors with documents and the dataset.",
2113
- "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation",
2935
+ "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata": {
2936
+ "description": "The metadata proto of `ResyncDataset` method.",
2937
+ "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata",
2114
2938
  "properties": {
2115
- "datasetErrorCount": {
2116
- "description": "The total number of dataset errors.",
2117
- "format": "int32",
2118
- "type": "integer"
2939
+ "commonMetadata": {
2940
+ "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
2941
+ "description": "The basic metadata of the long-running operation."
2119
2942
  },
2120
- "datasetErrors": {
2121
- "description": "Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training.",
2943
+ "datasetResyncStatuses": {
2944
+ "description": "The list of dataset resync statuses. Not checked when ResyncDatasetRequest.dataset_documents is specified.",
2122
2945
  "items": {
2123
- "$ref": "GoogleRpcStatus"
2946
+ "$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus"
2124
2947
  },
2125
2948
  "type": "array"
2126
2949
  },
2127
- "documentErrorCount": {
2128
- "description": "The total number of document errors.",
2129
- "format": "int32",
2130
- "type": "integer"
2131
- },
2132
- "documentErrors": {
2133
- "description": "Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training.",
2950
+ "individualDocumentResyncStatuses": {
2951
+ "description": "The list of document resync statuses. The same document could have multiple `individual_document_resync_statuses` if it has multiple inconsistencies.",
2134
2952
  "items": {
2135
- "$ref": "GoogleRpcStatus"
2953
+ "$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus"
2136
2954
  },
2137
2955
  "type": "array"
2138
2956
  }
2139
2957
  },
2140
2958
  "type": "object"
2141
2959
  },
2142
- "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse": {
2143
- "description": "The response for TrainProcessorVersion.",
2144
- "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse",
2960
+ "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus": {
2961
+ "description": "Resync status against inconsistency types on the dataset level.",
2962
+ "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus",
2145
2963
  "properties": {
2146
- "processorVersion": {
2147
- "description": "The resource name of the processor version produced by training.",
2964
+ "datasetInconsistencyType": {
2965
+ "description": "The type of the inconsistency of the dataset.",
2966
+ "enum": [
2967
+ "DATASET_INCONSISTENCY_TYPE_UNSPECIFIED",
2968
+ "DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER"
2969
+ ],
2970
+ "enumDescriptions": [
2971
+ "Default value.",
2972
+ "The marker file under the dataset folder is not found."
2973
+ ],
2148
2974
  "type": "string"
2975
+ },
2976
+ "status": {
2977
+ "$ref": "GoogleRpcStatus",
2978
+ "description": "The status of resyncing the dataset with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`."
2149
2979
  }
2150
2980
  },
2151
2981
  "type": "object"
2152
2982
  },
2153
- "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata": {
2154
- "description": "The long-running operation metadata for the UndeployProcessorVersion method.",
2155
- "id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata",
2983
+ "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus": {
2984
+ "description": "Resync status for each document per inconsistency type.",
2985
+ "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus",
2156
2986
  "properties": {
2157
- "commonMetadata": {
2158
- "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
2159
- "description": "The basic metadata of the long-running operation."
2987
+ "documentId": {
2988
+ "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
2989
+ "description": "The document identifier."
2990
+ },
2991
+ "documentInconsistencyType": {
2992
+ "description": "The type of document inconsistency.",
2993
+ "enum": [
2994
+ "DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED",
2995
+ "DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO",
2996
+ "DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA",
2997
+ "DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE"
2998
+ ],
2999
+ "enumDescriptions": [
3000
+ "Default value.",
3001
+ "The document proto is invalid.",
3002
+ "Indexed docproto metadata is mismatched.",
3003
+ "The page image or thumbnails are missing."
3004
+ ],
3005
+ "type": "string"
3006
+ },
3007
+ "status": {
3008
+ "$ref": "GoogleRpcStatus",
3009
+ "description": "The status of resyncing the document with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`."
2160
3010
  }
2161
3011
  },
2162
3012
  "type": "object"
2163
3013
  },
2164
- "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse": {
2165
- "description": "Response message for the UndeployProcessorVersion method.",
2166
- "id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse",
3014
+ "GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse": {
3015
+ "description": "The response proto of ResyncDataset method.",
3016
+ "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse",
2167
3017
  "properties": {},
2168
3018
  "type": "object"
2169
3019
  },
2170
- "GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata": {
2171
- "id": "GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata",
3020
+ "GoogleCloudDocumentaiUiv1beta3RevisionRef": {
3021
+ "description": "The revision reference specifies which revision on the document to read.",
3022
+ "id": "GoogleCloudDocumentaiUiv1beta3RevisionRef",
2172
3023
  "properties": {
2173
- "commonMetadata": {
2174
- "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
2175
- "description": "The basic metadata of the long-running operation."
3024
+ "latestProcessorVersion": {
3025
+ "description": "Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`",
3026
+ "type": "string"
3027
+ },
3028
+ "revisionCase": {
3029
+ "description": "Reads the revision by the predefined case.",
3030
+ "enum": [
3031
+ "REVISION_CASE_UNSPECIFIED",
3032
+ "LATEST_HUMAN_REVIEW",
3033
+ "LATEST_TIMESTAMP",
3034
+ "BASE_OCR_REVISION"
3035
+ ],
3036
+ "enumDescriptions": [
3037
+ "Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`.",
3038
+ "The latest revision made by a human.",
3039
+ "The latest revision based on timestamp.",
3040
+ "The first (OCR) revision."
3041
+ ],
3042
+ "type": "string"
3043
+ },
3044
+ "revisionId": {
3045
+ "description": "Reads the revision given by the id.",
3046
+ "type": "string"
2176
3047
  }
2177
3048
  },
2178
3049
  "type": "object"
2179
3050
  },
2180
- "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata": {
2181
- "description": "The long-running operation metadata for updating the human review configuration.",
2182
- "id": "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata",
3051
+ "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata": {
3052
+ "description": "Metadata of the sample documents operation.",
3053
+ "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata",
2183
3054
  "properties": {
2184
3055
  "commonMetadata": {
2185
3056
  "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
@@ -2188,188 +3059,518 @@
2188
3059
  },
2189
3060
  "type": "object"
2190
3061
  },
2191
- "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata": {
2192
- "description": "The long-running operation metadata for UpdateLabelerPool.",
2193
- "id": "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata",
3062
+ "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse": {
3063
+ "description": "Response of the sample documents operation.",
3064
+ "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse",
2194
3065
  "properties": {
2195
- "commonMetadata": {
2196
- "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
2197
- "description": "The basic metadata of the long-running operation."
3066
+ "sampleTestStatus": {
3067
+ "$ref": "GoogleRpcStatus",
3068
+ "description": "The status of sampling documents in test split."
3069
+ },
3070
+ "sampleTrainingStatus": {
3071
+ "$ref": "GoogleRpcStatus",
3072
+ "description": "The status of sampling documents in training split."
3073
+ },
3074
+ "selectedDocuments": {
3075
+ "description": "The result of the sampling process.",
3076
+ "items": {
3077
+ "$ref": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument"
3078
+ },
3079
+ "type": "array"
2198
3080
  }
2199
3081
  },
2200
3082
  "type": "object"
2201
3083
  },
2202
- "GoogleCloudDocumentaiV1Barcode": {
2203
- "description": "Encodes the detailed information of a barcode.",
2204
- "id": "GoogleCloudDocumentaiV1Barcode",
3084
+ "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument": {
3085
+ "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument",
2205
3086
  "properties": {
2206
- "format": {
2207
- "description": "Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type.",
3087
+ "documentId": {
3088
+ "description": "An internal identifier for document.",
2208
3089
  "type": "string"
3090
+ }
2209
3091
  },
2210
- "rawValue": {
2211
- "description": "Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.",
3092
+ "type": "object"
3093
+ },
3094
+ "GoogleCloudDocumentaiUiv1beta3Schema": {
3095
+ "description": "The schema defines the output of the processed document by a processor.",
3096
+ "id": "GoogleCloudDocumentaiUiv1beta3Schema",
3097
+ "properties": {
3098
+ "description": {
3099
+ "description": "Description of the schema.",
2212
3100
  "type": "string"
2213
3101
  },
2214
- "valueFormat": {
2215
- "description": "Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license.",
3102
+ "displayName": {
3103
+ "description": "Display name to show to users.",
2216
3104
  "type": "string"
3105
+ },
3106
+ "entityTypes": {
3107
+ "description": "Entity types of the schema.",
3108
+ "items": {
3109
+ "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType"
3110
+ },
3111
+ "type": "array"
2217
3112
  }
2218
3113
  },
2219
3114
  "type": "object"
2220
3115
  },
2221
- "GoogleCloudDocumentaiV1BatchDocumentsInputConfig": {
2222
- "description": "The common config to specify a set of documents used as input.",
2223
- "id": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig",
3116
+ "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata": {
3117
+ "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.",
3118
+ "id": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata",
2224
3119
  "properties": {
2225
- "gcsDocuments": {
2226
- "$ref": "GoogleCloudDocumentaiV1GcsDocuments",
2227
- "description": "The set of documents individually specified on Cloud Storage."
3120
+ "editable": {
3121
+ "description": "Explicit flag that controls whether the label is editable.",
3122
+ "type": "boolean"
2228
3123
  },
2229
- "gcsPrefix": {
2230
- "$ref": "GoogleCloudDocumentaiV1GcsPrefix",
2231
- "description": "The set of documents that match the specified Cloud Storage `gcs_prefix`."
3124
+ "processorVersions": {
3125
+ "description": "Full resource name of processor versions that contain this label. e.g. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`",
3126
+ "items": {
3127
+ "type": "string"
3128
+ },
3129
+ "type": "array"
2232
3130
  }
2233
3131
  },
2234
3132
  "type": "object"
2235
3133
  },
2236
- "GoogleCloudDocumentaiV1BatchProcessMetadata": {
2237
- "description": "The long-running operation metadata for BatchProcessDocuments.",
2238
- "id": "GoogleCloudDocumentaiV1BatchProcessMetadata",
3134
+ "GoogleCloudDocumentaiUiv1beta3SchemaEntityType": {
3135
+ "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.",
3136
+ "id": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType",
2239
3137
  "properties": {
2240
- "createTime": {
2241
- "description": "The creation time of the operation.",
2242
- "format": "google-datetime",
3138
+ "baseType": {
2243
3139
  "type": "string"
2244
3140
  },
2245
- "individualProcessStatuses": {
2246
- "description": "The list of response details of each document.",
3141
+ "description": {
3142
+ "description": "Description of the entity type.",
3143
+ "type": "string"
3144
+ },
3145
+ "enumValues": {
3146
+ "description": "If specified, lists all the possible values for this entity.",
2247
3147
  "items": {
2248
- "$ref": "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus"
3148
+ "type": "string"
2249
3149
  },
2250
3150
  "type": "array"
2251
3151
  },
2252
- "state": {
2253
- "description": "The state of the current batch processing.",
3152
+ "hide": {
3153
+ "description": "If the entity type is hidden in the schema. This provides the functionality to temporally \"disable\" an entity without deleting it.",
3154
+ "type": "boolean"
3155
+ },
3156
+ "method": {
3157
+ "description": "Specifies how the entity's value is obtained.",
2254
3158
  "enum": [
2255
- "STATE_UNSPECIFIED",
2256
- "WAITING",
2257
- "RUNNING",
2258
- "SUCCEEDED",
2259
- "CANCELLING",
2260
- "CANCELLED",
2261
- "FAILED"
3159
+ "METHOD_UNSPECIFIED",
3160
+ "EXTRACT",
3161
+ "DERIVE"
2262
3162
  ],
2263
3163
  "enumDescriptions": [
2264
- "The default value. This value is used if the state is omitted.",
2265
- "Request operation is waiting for scheduling.",
2266
- "Request is being processed.",
2267
- "The batch processing completed successfully.",
2268
- "The batch processing was being cancelled.",
2269
- "The batch processing was cancelled.",
2270
- "The batch processing has failed."
3164
+ "Unspecified method. It defaults to `EXTRACT`.",
3165
+ "The entity's value is directly extracted as-is from the document text.",
3166
+ "The entity's value is derived through inference and is not necessarily an exact text extraction from the document."
2271
3167
  ],
2272
3168
  "type": "string"
2273
3169
  },
2274
- "stateMessage": {
2275
- "description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed.",
3170
+ "occurrenceType": {
3171
+ "description": "Occurrence type limits the number of times an entity type appears in the document.",
3172
+ "enum": [
3173
+ "OCCURRENCE_TYPE_UNSPECIFIED",
3174
+ "OPTIONAL_ONCE",
3175
+ "OPTIONAL_MULTIPLE",
3176
+ "REQUIRED_ONCE",
3177
+ "REQUIRED_MULTIPLE"
3178
+ ],
3179
+ "enumDescriptions": [
3180
+ "Unspecified occurrence type.",
3181
+ "The entity type will appear zero times or once.",
3182
+ "The entity type will appear zero or multiple times.",
3183
+ "The entity type will only appear exactly once.",
3184
+ "The entity type will appear once or more times."
3185
+ ],
2276
3186
  "type": "string"
2277
3187
  },
2278
- "updateTime": {
2279
- "description": "The last update time of the operation.",
2280
- "format": "google-datetime",
3188
+ "properties": {
3189
+ "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.",
3190
+ "items": {
3191
+ "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType"
3192
+ },
3193
+ "type": "array"
3194
+ },
3195
+ "source": {
3196
+ "description": "Source of this entity type.",
3197
+ "enum": [
3198
+ "SOURCE_UNSPECIFIED",
3199
+ "PREDEFINED",
3200
+ "USER_INPUT"
3201
+ ],
3202
+ "enumDescriptions": [
3203
+ "Unspecified source.",
3204
+ "The entity type is in the predefined schema of a pretrained version of a processor.",
3205
+ "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."
3206
+ ],
3207
+ "type": "string"
3208
+ },
3209
+ "type": {
3210
+ "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.",
2281
3211
  "type": "string"
2282
3212
  }
2283
3213
  },
2284
3214
  "type": "object"
2285
3215
  },
2286
- "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus": {
2287
- "description": "The status of a each individual document in the batch process.",
2288
- "id": "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus",
3216
+ "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata": {
3217
+ "description": "Metadata for schema inference. Only used on dataset.schema for schema inference, can be safely ignored elsewhere.",
3218
+ "id": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata",
2289
3219
  "properties": {
2290
- "humanReviewStatus": {
2291
- "$ref": "GoogleCloudDocumentaiV1HumanReviewStatus",
2292
- "description": "The status of human review on the processed document."
2293
- },
2294
- "inputGcsSource": {
2295
- "description": "The source of the document, same as the input_gcs_source field in the request when the batch process started.",
2296
- "type": "string"
3220
+ "inferred": {
3221
+ "description": "True if is inferred by schema inference.",
3222
+ "type": "boolean"
3223
+ }
2297
3224
  },
2298
- "outputGcsDestination": {
2299
- "description": "The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty.",
2300
- "type": "string"
3225
+ "type": "object"
2301
3226
  },
2302
- "status": {
2303
- "$ref": "GoogleRpcStatus",
2304
- "description": "The status processing the document."
3227
+ "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata": {
3228
+ "description": "The long-running operation metadata for the SetDefaultProcessorVersion method.",
3229
+ "id": "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata",
3230
+ "properties": {
3231
+ "commonMetadata": {
3232
+ "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
3233
+ "description": "The basic metadata of the long-running operation."
2305
3234
  }
2306
3235
  },
2307
3236
  "type": "object"
2308
3237
  },
2309
- "GoogleCloudDocumentaiV1BatchProcessRequest": {
2310
- "description": "Request message for BatchProcessDocuments.",
2311
- "id": "GoogleCloudDocumentaiV1BatchProcessRequest",
2312
- "properties": {
2313
- "documentOutputConfig": {
2314
- "$ref": "GoogleCloudDocumentaiV1DocumentOutputConfig",
2315
- "description": "The output configuration for the BatchProcessDocuments method."
3238
+ "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse": {
3239
+ "description": "Response message for the SetDefaultProcessorVersion method.",
3240
+ "id": "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse",
3241
+ "properties": {},
3242
+ "type": "object"
2316
3243
  },
2317
- "inputDocuments": {
2318
- "$ref": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig",
2319
- "description": "The input documents for the BatchProcessDocuments method."
3244
+ "GoogleCloudDocumentaiUiv1beta3SummaryOptions": {
3245
+ "description": "Metadata for document summarization.",
3246
+ "id": "GoogleCloudDocumentaiUiv1beta3SummaryOptions",
3247
+ "properties": {
3248
+ "format": {
3249
+ "description": "The format the summary should be in.",
3250
+ "enum": [
3251
+ "FORMAT_UNSPECIFIED",
3252
+ "PARAGRAPH",
3253
+ "BULLETS"
3254
+ ],
3255
+ "enumDescriptions": [
3256
+ "Default.",
3257
+ "Format the output in paragraphs.",
3258
+ "Format the output in bullets."
3259
+ ],
3260
+ "type": "string"
2320
3261
  },
2321
- "labels": {
2322
- "additionalProperties": {
3262
+ "length": {
3263
+ "description": "How long the summary should be.",
3264
+ "enum": [
3265
+ "LENGTH_UNSPECIFIED",
3266
+ "BRIEF",
3267
+ "MODERATE",
3268
+ "COMPREHENSIVE"
3269
+ ],
3270
+ "enumDescriptions": [
3271
+ "Default.",
3272
+ "A brief summary of one or two sentences.",
3273
+ "A paragraph-length summary.",
3274
+ "The longest option available."
3275
+ ],
2323
3276
  "type": "string"
3277
+ }
2324
3278
  },
2325
- "description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.",
2326
3279
  "type": "object"
2327
3280
  },
2328
- "processOptions": {
2329
- "$ref": "GoogleCloudDocumentaiV1ProcessOptions",
2330
- "description": "Inference-time options for the process API"
3281
+ "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata": {
3282
+ "description": "The metadata that represents a processor version being created.",
3283
+ "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata",
3284
+ "properties": {
3285
+ "commonMetadata": {
3286
+ "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
3287
+ "description": "The basic metadata of the long-running operation."
2331
3288
  },
2332
- "skipHumanReview": {
2333
- "description": "Whether human review should be skipped for this request. Default to `false`.",
2334
- "type": "boolean"
2335
- }
3289
+ "testDatasetValidation": {
3290
+ "$ref": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation",
3291
+ "description": "The test dataset validation information."
2336
3292
  },
2337
- "type": "object"
3293
+ "trainingDatasetValidation": {
3294
+ "$ref": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation",
3295
+ "description": "The training dataset validation information."
3296
+ }
2338
3297
  },
2339
- "GoogleCloudDocumentaiV1BatchProcessResponse": {
2340
- "description": "Response message for BatchProcessDocuments.",
2341
- "id": "GoogleCloudDocumentaiV1BatchProcessResponse",
2342
- "properties": {},
2343
3298
  "type": "object"
2344
3299
  },
2345
- "GoogleCloudDocumentaiV1BoundingPoly": {
2346
- "description": "A bounding polygon for the detected image annotation.",
2347
- "id": "GoogleCloudDocumentaiV1BoundingPoly",
3300
+ "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation": {
3301
+ "description": "The dataset validation information. This includes any and all errors with documents and the dataset.",
3302
+ "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation",
2348
3303
  "properties": {
2349
- "normalizedVertices": {
2350
- "description": "The bounding polygon normalized vertices.",
3304
+ "datasetErrorCount": {
3305
+ "description": "The total number of dataset errors.",
3306
+ "format": "int32",
3307
+ "type": "integer"
3308
+ },
3309
+ "datasetErrors": {
3310
+ "description": "Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training.",
2351
3311
  "items": {
2352
- "$ref": "GoogleCloudDocumentaiV1NormalizedVertex"
3312
+ "$ref": "GoogleRpcStatus"
2353
3313
  },
2354
3314
  "type": "array"
2355
3315
  },
2356
- "vertices": {
2357
- "description": "The bounding polygon vertices.",
3316
+ "documentErrorCount": {
3317
+ "description": "The total number of document errors.",
3318
+ "format": "int32",
3319
+ "type": "integer"
3320
+ },
3321
+ "documentErrors": {
3322
+ "description": "Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training.",
2358
3323
  "items": {
2359
- "$ref": "GoogleCloudDocumentaiV1Vertex"
3324
+ "$ref": "GoogleRpcStatus"
2360
3325
  },
2361
3326
  "type": "array"
2362
3327
  }
2363
3328
  },
2364
3329
  "type": "object"
2365
3330
  },
2366
- "GoogleCloudDocumentaiV1CommonOperationMetadata": {
2367
- "description": "The common metadata for long running operations.",
2368
- "id": "GoogleCloudDocumentaiV1CommonOperationMetadata",
3331
+ "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse": {
3332
+ "description": "The response for TrainProcessorVersion.",
3333
+ "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse",
2369
3334
  "properties": {
2370
- "createTime": {
2371
- "description": "The creation time of the operation.",
2372
- "format": "google-datetime",
3335
+ "processorVersion": {
3336
+ "description": "The resource name of the processor version produced by training.",
3337
+ "type": "string"
3338
+ }
3339
+ },
3340
+ "type": "object"
3341
+ },
3342
+ "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata": {
3343
+ "description": "The long-running operation metadata for the UndeployProcessorVersion method.",
3344
+ "id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata",
3345
+ "properties": {
3346
+ "commonMetadata": {
3347
+ "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
3348
+ "description": "The basic metadata of the long-running operation."
3349
+ }
3350
+ },
3351
+ "type": "object"
3352
+ },
3353
+ "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse": {
3354
+ "description": "Response message for the UndeployProcessorVersion method.",
3355
+ "id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse",
3356
+ "properties": {},
3357
+ "type": "object"
3358
+ },
3359
+ "GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata": {
3360
+ "id": "GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata",
3361
+ "properties": {
3362
+ "commonMetadata": {
3363
+ "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
3364
+ "description": "The basic metadata of the long-running operation."
3365
+ }
3366
+ },
3367
+ "type": "object"
3368
+ },
3369
+ "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata": {
3370
+ "description": "The long-running operation metadata for updating the human review configuration.",
3371
+ "id": "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata",
3372
+ "properties": {
3373
+ "commonMetadata": {
3374
+ "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
3375
+ "description": "The basic metadata of the long-running operation."
3376
+ }
3377
+ },
3378
+ "type": "object"
3379
+ },
3380
+ "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata": {
3381
+ "description": "The long-running operation metadata for UpdateLabelerPool.",
3382
+ "id": "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata",
3383
+ "properties": {
3384
+ "commonMetadata": {
3385
+ "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
3386
+ "description": "The basic metadata of the long-running operation."
3387
+ }
3388
+ },
3389
+ "type": "object"
3390
+ },
3391
+ "GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata": {
3392
+ "description": "The long-running operation metadata for the UpdateProcessorVersion method.",
3393
+ "id": "GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata",
3394
+ "properties": {
3395
+ "commonMetadata": {
3396
+ "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata",
3397
+ "description": "The basic metadata for the long-running operation."
3398
+ }
3399
+ },
3400
+ "type": "object"
3401
+ },
3402
+ "GoogleCloudDocumentaiV1Barcode": {
3403
+ "description": "Encodes the detailed information of a barcode.",
3404
+ "id": "GoogleCloudDocumentaiV1Barcode",
3405
+ "properties": {
3406
+ "format": {
3407
+ "description": "Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type.",
3408
+ "type": "string"
3409
+ },
3410
+ "rawValue": {
3411
+ "description": "Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.",
3412
+ "type": "string"
3413
+ },
3414
+ "valueFormat": {
3415
+ "description": "Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license.",
3416
+ "type": "string"
3417
+ }
3418
+ },
3419
+ "type": "object"
3420
+ },
3421
+ "GoogleCloudDocumentaiV1BatchDocumentsInputConfig": {
3422
+ "description": "The common config to specify a set of documents used as input.",
3423
+ "id": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig",
3424
+ "properties": {
3425
+ "gcsDocuments": {
3426
+ "$ref": "GoogleCloudDocumentaiV1GcsDocuments",
3427
+ "description": "The set of documents individually specified on Cloud Storage."
3428
+ },
3429
+ "gcsPrefix": {
3430
+ "$ref": "GoogleCloudDocumentaiV1GcsPrefix",
3431
+ "description": "The set of documents that match the specified Cloud Storage `gcs_prefix`."
3432
+ }
3433
+ },
3434
+ "type": "object"
3435
+ },
3436
+ "GoogleCloudDocumentaiV1BatchProcessMetadata": {
3437
+ "description": "The long-running operation metadata for BatchProcessDocuments.",
3438
+ "id": "GoogleCloudDocumentaiV1BatchProcessMetadata",
3439
+ "properties": {
3440
+ "createTime": {
3441
+ "description": "The creation time of the operation.",
3442
+ "format": "google-datetime",
3443
+ "type": "string"
3444
+ },
3445
+ "individualProcessStatuses": {
3446
+ "description": "The list of response details of each document.",
3447
+ "items": {
3448
+ "$ref": "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus"
3449
+ },
3450
+ "type": "array"
3451
+ },
3452
+ "state": {
3453
+ "description": "The state of the current batch processing.",
3454
+ "enum": [
3455
+ "STATE_UNSPECIFIED",
3456
+ "WAITING",
3457
+ "RUNNING",
3458
+ "SUCCEEDED",
3459
+ "CANCELLING",
3460
+ "CANCELLED",
3461
+ "FAILED"
3462
+ ],
3463
+ "enumDescriptions": [
3464
+ "The default value. This value is used if the state is omitted.",
3465
+ "Request operation is waiting for scheduling.",
3466
+ "Request is being processed.",
3467
+ "The batch processing completed successfully.",
3468
+ "The batch processing was being cancelled.",
3469
+ "The batch processing was cancelled.",
3470
+ "The batch processing has failed."
3471
+ ],
3472
+ "type": "string"
3473
+ },
3474
+ "stateMessage": {
3475
+ "description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed.",
3476
+ "type": "string"
3477
+ },
3478
+ "updateTime": {
3479
+ "description": "The last update time of the operation.",
3480
+ "format": "google-datetime",
3481
+ "type": "string"
3482
+ }
3483
+ },
3484
+ "type": "object"
3485
+ },
3486
+ "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus": {
3487
+ "description": "The status of a each individual document in the batch process.",
3488
+ "id": "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus",
3489
+ "properties": {
3490
+ "humanReviewStatus": {
3491
+ "$ref": "GoogleCloudDocumentaiV1HumanReviewStatus",
3492
+ "description": "The status of human review on the processed document."
3493
+ },
3494
+ "inputGcsSource": {
3495
+ "description": "The source of the document, same as the input_gcs_source field in the request when the batch process started.",
3496
+ "type": "string"
3497
+ },
3498
+ "outputGcsDestination": {
3499
+ "description": "The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty.",
3500
+ "type": "string"
3501
+ },
3502
+ "status": {
3503
+ "$ref": "GoogleRpcStatus",
3504
+ "description": "The status processing the document."
3505
+ }
3506
+ },
3507
+ "type": "object"
3508
+ },
3509
+ "GoogleCloudDocumentaiV1BatchProcessRequest": {
3510
+ "description": "Request message for BatchProcessDocuments.",
3511
+ "id": "GoogleCloudDocumentaiV1BatchProcessRequest",
3512
+ "properties": {
3513
+ "documentOutputConfig": {
3514
+ "$ref": "GoogleCloudDocumentaiV1DocumentOutputConfig",
3515
+ "description": "The output configuration for the BatchProcessDocuments method."
3516
+ },
3517
+ "inputDocuments": {
3518
+ "$ref": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig",
3519
+ "description": "The input documents for the BatchProcessDocuments method."
3520
+ },
3521
+ "labels": {
3522
+ "additionalProperties": {
3523
+ "type": "string"
3524
+ },
3525
+ "description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.",
3526
+ "type": "object"
3527
+ },
3528
+ "processOptions": {
3529
+ "$ref": "GoogleCloudDocumentaiV1ProcessOptions",
3530
+ "description": "Inference-time options for the process API"
3531
+ },
3532
+ "skipHumanReview": {
3533
+ "deprecated": true,
3534
+ "description": "Whether human review should be skipped for this request. Default to `false`.",
3535
+ "type": "boolean"
3536
+ }
3537
+ },
3538
+ "type": "object"
3539
+ },
3540
+ "GoogleCloudDocumentaiV1BatchProcessResponse": {
3541
+ "description": "Response message for BatchProcessDocuments.",
3542
+ "id": "GoogleCloudDocumentaiV1BatchProcessResponse",
3543
+ "properties": {},
3544
+ "type": "object"
3545
+ },
3546
+ "GoogleCloudDocumentaiV1BoundingPoly": {
3547
+ "description": "A bounding polygon for the detected image annotation.",
3548
+ "id": "GoogleCloudDocumentaiV1BoundingPoly",
3549
+ "properties": {
3550
+ "normalizedVertices": {
3551
+ "description": "The bounding polygon normalized vertices.",
3552
+ "items": {
3553
+ "$ref": "GoogleCloudDocumentaiV1NormalizedVertex"
3554
+ },
3555
+ "type": "array"
3556
+ },
3557
+ "vertices": {
3558
+ "description": "The bounding polygon vertices.",
3559
+ "items": {
3560
+ "$ref": "GoogleCloudDocumentaiV1Vertex"
3561
+ },
3562
+ "type": "array"
3563
+ }
3564
+ },
3565
+ "type": "object"
3566
+ },
3567
+ "GoogleCloudDocumentaiV1CommonOperationMetadata": {
3568
+ "description": "The common metadata for long running operations.",
3569
+ "id": "GoogleCloudDocumentaiV1CommonOperationMetadata",
3570
+ "properties": {
3571
+ "createTime": {
3572
+ "description": "The creation time of the operation.",
3573
+ "format": "google-datetime",
2373
3574
  "type": "string"
2374
3575
  },
2375
3576
  "resource": {
@@ -2873,6 +4074,10 @@
2873
4074
  "$ref": "GoogleCloudDocumentaiV1DocumentEntityValidationOutput",
2874
4075
  "description": "The entity validation output for this revision."
2875
4076
  },
4077
+ "provenance": {
4078
+ "$ref": "GoogleCloudDocumentaiV1DocumentProvenance",
4079
+ "description": "Optional. The history of this revision."
4080
+ },
2876
4081
  "revisionId": {
2877
4082
  "description": "The revision id.",
2878
4083
  "type": "string"
@@ -3035,12 +4240,16 @@
3035
4240
  "description": "Validation result for a single validation rule.",
3036
4241
  "id": "GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult",
3037
4242
  "properties": {
4243
+ "rule": {
4244
+ "description": "Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}`",
4245
+ "type": "string"
4246
+ },
3038
4247
  "ruleDescription": {
3039
4248
  "description": "The description of the validation rule.",
3040
4249
  "type": "string"
3041
4250
  },
3042
4251
  "ruleName": {
3043
- "description": "The name of the validation rule.",
4252
+ "description": "The display name of the validation rule.",
3044
4253
  "type": "string"
3045
4254
  },
3046
4255
  "validationDetails": {
@@ -4250,6 +5459,20 @@ true
4250
5459
  },
4251
5460
  "type": "object"
4252
5461
  },
5462
+ "GoogleCloudDocumentaiV1Documents": {
5463
+ "description": "A set of inline documents.",
5464
+ "id": "GoogleCloudDocumentaiV1Documents",
5465
+ "properties": {
5466
+ "documents": {
5467
+ "description": "The list of documents.",
5468
+ "items": {
5469
+ "$ref": "GoogleCloudDocumentaiV1Document"
5470
+ },
5471
+ "type": "array"
5472
+ }
5473
+ },
5474
+ "type": "object"
5475
+ },
4253
5476
  "GoogleCloudDocumentaiV1EnableProcessorMetadata": {
4254
5477
  "description": "The long-running operation metadata for the EnableProcessor method.",
4255
5478
  "id": "GoogleCloudDocumentaiV1EnableProcessorMetadata",
@@ -4580,16 +5803,73 @@ true
4580
5803
  },
4581
5804
  "type": "object"
4582
5805
  },
4583
- "GoogleCloudDocumentaiV1HumanReviewStatus": {
4584
- "description": "The status of human review on a processed document.",
4585
- "id": "GoogleCloudDocumentaiV1HumanReviewStatus",
5806
+ "GoogleCloudDocumentaiV1GenerateSchemaVersionRequest": {
5807
+ "description": "Request message for GenerateSchemaVersion.",
5808
+ "id": "GoogleCloudDocumentaiV1GenerateSchemaVersionRequest",
4586
5809
  "properties": {
4587
- "humanReviewOperation": {
4588
- "description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.",
5810
+ "baseSchemaVersion": {
5811
+ "description": "The base schema version name to use for the schema generation. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`",
4589
5812
  "type": "string"
4590
5813
  },
4591
- "state": {
4592
- "description": "The state of human review on the processing request.",
5814
+ "gcsDocuments": {
5815
+ "$ref": "GoogleCloudDocumentaiV1GcsDocuments",
5816
+ "description": "The set of documents placed on Cloud Storage."
5817
+ },
5818
+ "gcsPrefix": {
5819
+ "$ref": "GoogleCloudDocumentaiV1GcsPrefix",
5820
+ "description": "The common prefix of documents placed on Cloud Storage."
5821
+ },
5822
+ "generateSchemaVersionParams": {
5823
+ "$ref": "GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams",
5824
+ "description": "Optional. User specified parameters for the schema generation."
5825
+ },
5826
+ "inlineDocuments": {
5827
+ "$ref": "GoogleCloudDocumentaiV1Documents",
5828
+ "description": "The set of documents specified inline. For each document, its `uri` or `content` field must be set."
5829
+ },
5830
+ "rawDocuments": {
5831
+ "$ref": "GoogleCloudDocumentaiV1RawDocuments",
5832
+ "description": "The set of raw documents."
5833
+ }
5834
+ },
5835
+ "type": "object"
5836
+ },
5837
+ "GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams": {
5838
+ "description": "The parameters for the schema generation.",
5839
+ "id": "GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams",
5840
+ "properties": {
5841
+ "history": {
5842
+ "$ref": "GoogleCloudDocumentaiV1SchemaGenerationHistory",
5843
+ "description": "Optional. Previous prompt-answers in a chronological order."
5844
+ },
5845
+ "prompt": {
5846
+ "description": "Optional. The prompt used for the schema generation.",
5847
+ "type": "string"
5848
+ }
5849
+ },
5850
+ "type": "object"
5851
+ },
5852
+ "GoogleCloudDocumentaiV1GenerateSchemaVersionResponse": {
5853
+ "description": "Response message for GenerateSchemaVersion.",
5854
+ "id": "GoogleCloudDocumentaiV1GenerateSchemaVersionResponse",
5855
+ "properties": {
5856
+ "schemaVersion": {
5857
+ "$ref": "GoogleCloudDocumentaiV1SchemaVersion",
5858
+ "description": "The schema version generated by the model."
5859
+ }
5860
+ },
5861
+ "type": "object"
5862
+ },
5863
+ "GoogleCloudDocumentaiV1HumanReviewStatus": {
5864
+ "description": "The status of human review on a processed document.",
5865
+ "id": "GoogleCloudDocumentaiV1HumanReviewStatus",
5866
+ "properties": {
5867
+ "humanReviewOperation": {
5868
+ "description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.",
5869
+ "type": "string"
5870
+ },
5871
+ "state": {
5872
+ "description": "The state of human review on the processing request.",
4593
5873
  "enum": [
4594
5874
  "STATE_UNSPECIFIED",
4595
5875
  "SKIPPED",
@@ -4685,6 +5965,76 @@ true
4685
5965
  },
4686
5966
  "type": "object"
4687
5967
  },
5968
+ "GoogleCloudDocumentaiV1ListSchemaVersionsResponse": {
5969
+ "description": "Response message for ListSchemaVersions.",
5970
+ "id": "GoogleCloudDocumentaiV1ListSchemaVersionsResponse",
5971
+ "properties": {
5972
+ "nextPageToken": {
5973
+ "description": "Points to the next SchemaVersion, otherwise empty.",
5974
+ "type": "string"
5975
+ },
5976
+ "schemaVersions": {
5977
+ "description": "The list of SchemaVersions.",
5978
+ "items": {
5979
+ "$ref": "GoogleCloudDocumentaiV1SchemaVersion"
5980
+ },
5981
+ "type": "array"
5982
+ }
5983
+ },
5984
+ "type": "object"
5985
+ },
5986
+ "GoogleCloudDocumentaiV1ListSchemasResponse": {
5987
+ "description": "Response message for ListSchemas.",
5988
+ "id": "GoogleCloudDocumentaiV1ListSchemasResponse",
5989
+ "properties": {
5990
+ "nextPageToken": {
5991
+ "description": "Points to the next Schema, otherwise empty.",
5992
+ "type": "string"
5993
+ },
5994
+ "schemas": {
5995
+ "description": "The list of Schemas.",
5996
+ "items": {
5997
+ "$ref": "GoogleCloudDocumentaiV1NextSchema"
5998
+ },
5999
+ "type": "array"
6000
+ }
6001
+ },
6002
+ "type": "object"
6003
+ },
6004
+ "GoogleCloudDocumentaiV1NextSchema": {
6005
+ "description": "NextSchema is a collection of SchemaVersions.",
6006
+ "id": "GoogleCloudDocumentaiV1NextSchema",
6007
+ "properties": {
6008
+ "createTime": {
6009
+ "description": "Output only. The time when the Schema was created.",
6010
+ "format": "google-datetime",
6011
+ "readOnly": true,
6012
+ "type": "string"
6013
+ },
6014
+ "displayName": {
6015
+ "description": "Required. The user-defined name of the Schema.",
6016
+ "type": "string"
6017
+ },
6018
+ "labels": {
6019
+ "additionalProperties": {
6020
+ "type": "string"
6021
+ },
6022
+ "description": "Optional. The GCP labels for the Schema.",
6023
+ "type": "object"
6024
+ },
6025
+ "name": {
6026
+ "description": "Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`",
6027
+ "type": "string"
6028
+ },
6029
+ "updateTime": {
6030
+ "description": "Output only. The time when the Schema was last updated.",
6031
+ "format": "google-datetime",
6032
+ "readOnly": true,
6033
+ "type": "string"
6034
+ }
6035
+ },
6036
+ "type": "object"
6037
+ },
4688
6038
  "GoogleCloudDocumentaiV1NormalizedVertex": {
4689
6039
  "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.",
4690
6040
  "id": "GoogleCloudDocumentaiV1NormalizedVertex",
@@ -4834,6 +6184,14 @@ true
4834
6184
  "$ref": "GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig",
4835
6185
  "description": "Optional. Config for chunking in layout parser processor."
4836
6186
  },
6187
+ "enableImageAnnotation": {
6188
+ "description": "Optional. Whether to include image annotations in layout parser response.",
6189
+ "type": "boolean"
6190
+ },
6191
+ "enableTableAnnotation": {
6192
+ "description": "Optional. Whether to include table annotations in layout parser response.",
6193
+ "type": "boolean"
6194
+ },
4837
6195
  "returnBoundingBoxes": {
4838
6196
  "description": "Optional. Whether to include bounding boxes in layout parser processor response.",
4839
6197
  "type": "boolean"
@@ -4898,6 +6256,7 @@ true
4898
6256
  "description": "A raw document content (bytes)."
4899
6257
  },
4900
6258
  "skipHumanReview": {
6259
+ "deprecated": true,
4901
6260
  "description": "Whether human review should be skipped for this request. Default to `false`.",
4902
6261
  "type": "boolean"
4903
6262
  }
@@ -4923,6 +6282,10 @@ true
4923
6282
  "description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.",
4924
6283
  "id": "GoogleCloudDocumentaiV1Processor",
4925
6284
  "properties": {
6285
+ "activeSchemaVersion": {
6286
+ "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}",
6287
+ "type": "string"
6288
+ },
4926
6289
  "createTime": {
4927
6290
  "description": "Output only. The time the processor was created.",
4928
6291
  "format": "google-datetime",
@@ -5288,6 +6651,20 @@ true
5288
6651
  },
5289
6652
  "type": "object"
5290
6653
  },
6654
+ "GoogleCloudDocumentaiV1RawDocuments": {
6655
+ "description": "Specifies a set of raw documents.",
6656
+ "id": "GoogleCloudDocumentaiV1RawDocuments",
6657
+ "properties": {
6658
+ "documents": {
6659
+ "description": "Specifies raw document content and mime type.",
6660
+ "items": {
6661
+ "$ref": "GoogleCloudDocumentaiV1RawDocument"
6662
+ },
6663
+ "type": "array"
6664
+ }
6665
+ },
6666
+ "type": "object"
6667
+ },
5291
6668
  "GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata": {
5292
6669
  "description": "The long-running operation metadata for the ReviewDocument method.",
5293
6670
  "id": "GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata",
@@ -5363,6 +6740,71 @@ true
5363
6740
  },
5364
6741
  "type": "object"
5365
6742
  },
6743
+ "GoogleCloudDocumentaiV1SchemaGenerationHistory": {
6744
+ "description": "The history of schema generation iterations.",
6745
+ "id": "GoogleCloudDocumentaiV1SchemaGenerationHistory",
6746
+ "properties": {
6747
+ "iterations": {
6748
+ "description": "Required. Previous prompt-answers in a chronological order.",
6749
+ "items": {
6750
+ "$ref": "GoogleCloudDocumentaiV1SchemaGenerationIteration"
6751
+ },
6752
+ "type": "array"
6753
+ }
6754
+ },
6755
+ "type": "object"
6756
+ },
6757
+ "GoogleCloudDocumentaiV1SchemaGenerationIteration": {
6758
+ "description": "A single iteration of the schema generation.",
6759
+ "id": "GoogleCloudDocumentaiV1SchemaGenerationIteration",
6760
+ "properties": {
6761
+ "adjustedSchema": {
6762
+ "$ref": "GoogleCloudDocumentaiV1SchemaVersion",
6763
+ "description": "Optional. The previous schema version adjusted by the model."
6764
+ },
6765
+ "generatedSchema": {
6766
+ "$ref": "GoogleCloudDocumentaiV1SchemaVersion",
6767
+ "description": "Required. The schema version generated by the model."
6768
+ },
6769
+ "prompt": {
6770
+ "description": "Optional. The prompt used for the iteration.",
6771
+ "type": "string"
6772
+ }
6773
+ },
6774
+ "type": "object"
6775
+ },
6776
+ "GoogleCloudDocumentaiV1SchemaVersion": {
6777
+ "description": "SchemaVersion is a version of the Schema which is created in SchemaGroup.",
6778
+ "id": "GoogleCloudDocumentaiV1SchemaVersion",
6779
+ "properties": {
6780
+ "createTime": {
6781
+ "description": "Output only. The time when the SchemaVersion was created.",
6782
+ "format": "google-datetime",
6783
+ "readOnly": true,
6784
+ "type": "string"
6785
+ },
6786
+ "displayName": {
6787
+ "description": "Required. The user-defined name of the SchemaVersion.",
6788
+ "type": "string"
6789
+ },
6790
+ "labels": {
6791
+ "additionalProperties": {
6792
+ "type": "string"
6793
+ },
6794
+ "description": "Optional. The GCP labels for the SchemaVersion.",
6795
+ "type": "object"
6796
+ },
6797
+ "name": {
6798
+ "description": "Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`",
6799
+ "type": "string"
6800
+ },
6801
+ "schema": {
6802
+ "$ref": "GoogleCloudDocumentaiV1DocumentSchema",
6803
+ "description": "Required. The schema of the SchemaVersion."
6804
+ }
6805
+ },
6806
+ "type": "object"
6807
+ },
5366
6808
  "GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata": {
5367
6809
  "description": "The long-running operation metadata for the SetDefaultProcessorVersion method.",
5368
6810
  "id": "GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata",
@@ -5949,177 +7391,743 @@ true
5949
7391
  },
5950
7392
  "type": "object"
5951
7393
  },
5952
- "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata": {
5953
- "description": "The long-running operation metadata for the EnableProcessor method.",
5954
- "id": "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata",
7394
+ "GoogleCloudDocumentaiV1beta3DocumentSchema": {
7395
+ "description": "The schema defines the output of the processed document by a processor.",
7396
+ "id": "GoogleCloudDocumentaiV1beta3DocumentSchema",
5955
7397
  "properties": {
5956
- "commonMetadata": {
5957
- "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
5958
- "description": "The basic metadata of the long-running operation."
7398
+ "description": {
7399
+ "description": "Description of the schema.",
7400
+ "type": "string"
7401
+ },
7402
+ "displayName": {
7403
+ "description": "Display name to show to users.",
7404
+ "type": "string"
7405
+ },
7406
+ "entityTypes": {
7407
+ "description": "Entity types of the schema.",
7408
+ "items": {
7409
+ "$ref": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType"
7410
+ },
7411
+ "type": "array"
7412
+ },
7413
+ "metadata": {
7414
+ "$ref": "GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata",
7415
+ "description": "Metadata of the schema."
5959
7416
  }
5960
7417
  },
5961
7418
  "type": "object"
5962
7419
  },
5963
- "GoogleCloudDocumentaiV1beta3EnableProcessorResponse": {
5964
- "description": "Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.",
5965
- "id": "GoogleCloudDocumentaiV1beta3EnableProcessorResponse",
5966
- "properties": {},
7420
+ "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType": {
7421
+ "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.",
7422
+ "id": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType",
7423
+ "properties": {
7424
+ "baseTypes": {
7425
+ "description": "The entity type that this type is derived from. For now, one and only one should be set.",
7426
+ "items": {
7427
+ "type": "string"
7428
+ },
7429
+ "type": "array"
7430
+ },
7431
+ "description": {
7432
+ "description": "The description of the entity type. Could be used to provide more information about the entity type for model calls.",
7433
+ "type": "string"
7434
+ },
7435
+ "displayName": {
7436
+ "description": "User defined name for the type.",
7437
+ "type": "string"
7438
+ },
7439
+ "entityTypeMetadata": {
7440
+ "$ref": "GoogleCloudDocumentaiV1beta3EntityTypeMetadata",
7441
+ "description": "Metadata for the entity type."
7442
+ },
7443
+ "enumValues": {
7444
+ "$ref": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues",
7445
+ "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."
7446
+ },
7447
+ "name": {
7448
+ "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.",
7449
+ "type": "string"
7450
+ },
7451
+ "properties": {
7452
+ "description": "Description the nested structure, or composition of an entity.",
7453
+ "items": {
7454
+ "$ref": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty"
7455
+ },
7456
+ "type": "array"
7457
+ }
7458
+ },
5967
7459
  "type": "object"
5968
7460
  },
5969
- "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata": {
5970
- "description": "Metadata of the EvaluateProcessorVersion method.",
5971
- "id": "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata",
7461
+ "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues": {
7462
+ "description": "Defines the a list of enum values.",
7463
+ "id": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues",
5972
7464
  "properties": {
5973
- "commonMetadata": {
5974
- "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
5975
- "description": "The basic metadata of the long-running operation."
7465
+ "values": {
7466
+ "description": "The individual values that this enum values type can include.",
7467
+ "items": {
7468
+ "type": "string"
7469
+ },
7470
+ "type": "array"
7471
+ }
7472
+ },
7473
+ "type": "object"
7474
+ },
7475
+ "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty": {
7476
+ "description": "Defines properties that can be part of the entity type.",
7477
+ "id": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty",
7478
+ "properties": {
7479
+ "description": {
7480
+ "description": "The description of the property. Could be used to provide more information about the property for model calls.",
7481
+ "type": "string"
7482
+ },
7483
+ "displayName": {
7484
+ "description": "User defined name for the property.",
7485
+ "type": "string"
7486
+ },
7487
+ "method": {
7488
+ "description": "Specifies how the entity's value is obtained.",
7489
+ "enum": [
7490
+ "METHOD_UNSPECIFIED",
7491
+ "EXTRACT",
7492
+ "DERIVE"
7493
+ ],
7494
+ "enumDescriptions": [
7495
+ "Unspecified method. It defaults to `EXTRACT`.",
7496
+ "The entity's value is directly extracted as-is from the document text.",
7497
+ "The entity's value is derived through inference and is not necessarily an exact text extraction from the document."
7498
+ ],
7499
+ "type": "string"
7500
+ },
7501
+ "name": {
7502
+ "description": "The name of the property. Follows the same guidelines as the EntityType name.",
7503
+ "type": "string"
7504
+ },
7505
+ "occurrenceType": {
7506
+ "description": "Occurrence type limits the number of instances an entity type appears in the document.",
7507
+ "enum": [
7508
+ "OCCURRENCE_TYPE_UNSPECIFIED",
7509
+ "OPTIONAL_ONCE",
7510
+ "OPTIONAL_MULTIPLE",
7511
+ "REQUIRED_ONCE",
7512
+ "REQUIRED_MULTIPLE"
7513
+ ],
7514
+ "enumDescriptions": [
7515
+ "Unspecified occurrence type.",
7516
+ "There will be zero or one instance of this entity type. The same entity instance may be mentioned multiple times.",
7517
+ "The entity type will appear zero or multiple times.",
7518
+ "The entity type will only appear exactly once. The same entity instance may be mentioned multiple times.",
7519
+ "The entity type will appear once or more times."
7520
+ ],
7521
+ "type": "string"
7522
+ },
7523
+ "propertyMetadata": {
7524
+ "$ref": "GoogleCloudDocumentaiV1beta3PropertyMetadata",
7525
+ "description": "Any additional metadata about the property can be added here."
7526
+ },
7527
+ "valueType": {
7528
+ "description": "A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.",
7529
+ "type": "string"
7530
+ }
7531
+ },
7532
+ "type": "object"
7533
+ },
7534
+ "GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata": {
7535
+ "description": "Metadata for global schema behavior.",
7536
+ "id": "GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata",
7537
+ "properties": {
7538
+ "documentAllowMultipleLabels": {
7539
+ "description": "If true, on a given page, there can be multiple `document` annotations covering it.",
7540
+ "type": "boolean"
7541
+ },
7542
+ "documentSplitter": {
7543
+ "description": "If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).",
7544
+ "type": "boolean"
7545
+ },
7546
+ "prefixedNamingOnProperties": {
7547
+ "description": "If set, all the nested entities must be prefixed with the parents.",
7548
+ "type": "boolean"
7549
+ },
7550
+ "skipNamingValidation": {
7551
+ "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.",
7552
+ "type": "boolean"
7553
+ }
7554
+ },
7555
+ "type": "object"
7556
+ },
7557
+ "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata": {
7558
+ "description": "The long-running operation metadata for the EnableProcessor method.",
7559
+ "id": "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata",
7560
+ "properties": {
7561
+ "commonMetadata": {
7562
+ "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
7563
+ "description": "The basic metadata of the long-running operation."
7564
+ }
7565
+ },
7566
+ "type": "object"
7567
+ },
7568
+ "GoogleCloudDocumentaiV1beta3EnableProcessorResponse": {
7569
+ "description": "Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.",
7570
+ "id": "GoogleCloudDocumentaiV1beta3EnableProcessorResponse",
7571
+ "properties": {},
7572
+ "type": "object"
7573
+ },
7574
+ "GoogleCloudDocumentaiV1beta3EntityTypeMetadata": {
7575
+ "description": "Metadata about an entity type.",
7576
+ "id": "GoogleCloudDocumentaiV1beta3EntityTypeMetadata",
7577
+ "properties": {
7578
+ "inactive": {
7579
+ "description": "Whether the entity type should be considered inactive.",
7580
+ "type": "boolean"
7581
+ }
7582
+ },
7583
+ "type": "object"
7584
+ },
7585
+ "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata": {
7586
+ "description": "Metadata of the EvaluateProcessorVersion method.",
7587
+ "id": "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata",
7588
+ "properties": {
7589
+ "commonMetadata": {
7590
+ "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
7591
+ "description": "The basic metadata of the long-running operation."
7592
+ }
7593
+ },
7594
+ "type": "object"
7595
+ },
7596
+ "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse": {
7597
+ "description": "Response of the EvaluateProcessorVersion method.",
7598
+ "id": "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse",
7599
+ "properties": {
7600
+ "evaluation": {
7601
+ "description": "The resource name of the created evaluation.",
7602
+ "type": "string"
7603
+ }
7604
+ },
7605
+ "type": "object"
7606
+ },
7607
+ "GoogleCloudDocumentaiV1beta3EvaluationMetrics": {
7608
+ "description": "Evaluation metrics, either in aggregate or about a specific entity.",
7609
+ "id": "GoogleCloudDocumentaiV1beta3EvaluationMetrics",
7610
+ "properties": {
7611
+ "f1Score": {
7612
+ "description": "The calculated f1 score.",
7613
+ "format": "float",
7614
+ "type": "number"
7615
+ },
7616
+ "falseNegativesCount": {
7617
+ "description": "The amount of false negatives.",
7618
+ "format": "int32",
7619
+ "type": "integer"
7620
+ },
7621
+ "falsePositivesCount": {
7622
+ "description": "The amount of false positives.",
7623
+ "format": "int32",
7624
+ "type": "integer"
7625
+ },
7626
+ "groundTruthDocumentCount": {
7627
+ "description": "The amount of documents with a ground truth occurrence.",
7628
+ "format": "int32",
7629
+ "type": "integer"
7630
+ },
7631
+ "groundTruthOccurrencesCount": {
7632
+ "description": "The amount of occurrences in ground truth documents.",
7633
+ "format": "int32",
7634
+ "type": "integer"
7635
+ },
7636
+ "precision": {
7637
+ "description": "The calculated precision.",
7638
+ "format": "float",
7639
+ "type": "number"
7640
+ },
7641
+ "predictedDocumentCount": {
7642
+ "description": "The amount of documents with a predicted occurrence.",
7643
+ "format": "int32",
7644
+ "type": "integer"
7645
+ },
7646
+ "predictedOccurrencesCount": {
7647
+ "description": "The amount of occurrences in predicted documents.",
7648
+ "format": "int32",
7649
+ "type": "integer"
7650
+ },
7651
+ "recall": {
7652
+ "description": "The calculated recall.",
7653
+ "format": "float",
7654
+ "type": "number"
7655
+ },
7656
+ "totalDocumentsCount": {
7657
+ "description": "The amount of documents that had an occurrence of this label.",
7658
+ "format": "int32",
7659
+ "type": "integer"
7660
+ },
7661
+ "truePositivesCount": {
7662
+ "description": "The amount of true positives.",
7663
+ "format": "int32",
7664
+ "type": "integer"
7665
+ }
7666
+ },
7667
+ "type": "object"
7668
+ },
7669
+ "GoogleCloudDocumentaiV1beta3EvaluationReference": {
7670
+ "description": "Gives a short summary of an evaluation, and links to the evaluation itself.",
7671
+ "id": "GoogleCloudDocumentaiV1beta3EvaluationReference",
7672
+ "properties": {
7673
+ "aggregateMetrics": {
7674
+ "$ref": "GoogleCloudDocumentaiV1beta3EvaluationMetrics",
7675
+ "description": "An aggregate of the statistics for the evaluation with fuzzy matching on."
7676
+ },
7677
+ "aggregateMetricsExact": {
7678
+ "$ref": "GoogleCloudDocumentaiV1beta3EvaluationMetrics",
7679
+ "description": "An aggregate of the statistics for the evaluation with fuzzy matching off."
7680
+ },
7681
+ "evaluation": {
7682
+ "description": "The resource name of the evaluation.",
7683
+ "type": "string"
7684
+ },
7685
+ "operation": {
7686
+ "description": "The resource name of the Long Running Operation for the evaluation.",
7687
+ "type": "string"
7688
+ }
7689
+ },
7690
+ "type": "object"
7691
+ },
7692
+ "GoogleCloudDocumentaiV1beta3FieldExtractionMetadata": {
7693
+ "description": "Metadata for how this field value is extracted.",
7694
+ "id": "GoogleCloudDocumentaiV1beta3FieldExtractionMetadata",
7695
+ "properties": {
7696
+ "summaryOptions": {
7697
+ "$ref": "GoogleCloudDocumentaiV1beta3SummaryOptions",
7698
+ "description": "Summary options config."
7699
+ }
7700
+ },
7701
+ "type": "object"
7702
+ },
7703
+ "GoogleCloudDocumentaiV1beta3GcsPrefix": {
7704
+ "description": "Specifies all documents on Cloud Storage with a common prefix.",
7705
+ "id": "GoogleCloudDocumentaiV1beta3GcsPrefix",
7706
+ "properties": {
7707
+ "gcsUriPrefix": {
7708
+ "description": "The URI prefix.",
7709
+ "type": "string"
7710
+ }
7711
+ },
7712
+ "type": "object"
7713
+ },
7714
+ "GoogleCloudDocumentaiV1beta3HumanReviewStatus": {
7715
+ "description": "The status of human review on a processed document.",
7716
+ "id": "GoogleCloudDocumentaiV1beta3HumanReviewStatus",
7717
+ "properties": {
7718
+ "humanReviewOperation": {
7719
+ "description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.",
7720
+ "type": "string"
7721
+ },
7722
+ "state": {
7723
+ "description": "The state of human review on the processing request.",
7724
+ "enum": [
7725
+ "STATE_UNSPECIFIED",
7726
+ "SKIPPED",
7727
+ "VALIDATION_PASSED",
7728
+ "IN_PROGRESS",
7729
+ "ERROR"
7730
+ ],
7731
+ "enumDescriptions": [
7732
+ "Human review state is unspecified. Most likely due to an internal error.",
7733
+ "Human review is skipped for the document. This can happen because human review isn't enabled on the processor or the processing request has been set to skip this document.",
7734
+ "Human review validation is triggered and passed, so no review is needed.",
7735
+ "Human review validation is triggered and the document is under review.",
7736
+ "Some error happened during triggering human review, see the state_message for details."
7737
+ ],
7738
+ "type": "string"
7739
+ },
7740
+ "stateMessage": {
7741
+ "description": "A message providing more details about the human review state.",
7742
+ "type": "string"
7743
+ }
7744
+ },
7745
+ "type": "object"
7746
+ },
7747
+ "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata": {
7748
+ "description": "Metadata of the import document operation.",
7749
+ "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata",
7750
+ "properties": {
7751
+ "commonMetadata": {
7752
+ "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
7753
+ "description": "The basic metadata of the long-running operation."
7754
+ },
7755
+ "importConfigValidationResults": {
7756
+ "description": "Validation statuses of the batch documents import config.",
7757
+ "items": {
7758
+ "$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult"
7759
+ },
7760
+ "type": "array"
7761
+ },
7762
+ "individualImportStatuses": {
7763
+ "description": "The list of response details of each document.",
7764
+ "items": {
7765
+ "$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus"
7766
+ },
7767
+ "type": "array"
7768
+ },
7769
+ "totalDocumentCount": {
7770
+ "description": "Total number of the documents that are qualified for importing.",
7771
+ "format": "int32",
7772
+ "type": "integer"
7773
+ }
7774
+ },
7775
+ "type": "object"
7776
+ },
7777
+ "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult": {
7778
+ "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.",
7779
+ "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult",
7780
+ "properties": {
7781
+ "inputGcsSource": {
7782
+ "description": "The source Cloud Storage URI specified in the import config.",
7783
+ "type": "string"
7784
+ },
7785
+ "status": {
7786
+ "$ref": "GoogleRpcStatus",
7787
+ "description": "The validation status of import config."
7788
+ }
7789
+ },
7790
+ "type": "object"
7791
+ },
7792
+ "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus": {
7793
+ "description": "The status of each individual document in the import process.",
7794
+ "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus",
7795
+ "properties": {
7796
+ "inputGcsSource": {
7797
+ "description": "The source Cloud Storage URI of the document.",
7798
+ "type": "string"
7799
+ },
7800
+ "outputDocumentId": {
7801
+ "$ref": "GoogleCloudDocumentaiV1beta3DocumentId",
7802
+ "description": "The document id of imported document if it was successful, otherwise empty."
7803
+ },
7804
+ "status": {
7805
+ "$ref": "GoogleRpcStatus",
7806
+ "description": "The status of the importing of the document."
7807
+ }
7808
+ },
7809
+ "type": "object"
7810
+ },
7811
+ "GoogleCloudDocumentaiV1beta3ImportDocumentsResponse": {
7812
+ "description": "Response of the import document operation.",
7813
+ "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsResponse",
7814
+ "properties": {},
7815
+ "type": "object"
7816
+ },
7817
+ "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata": {
7818
+ "description": "The long-running operation metadata for the ImportProcessorVersion method.",
7819
+ "id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata",
7820
+ "properties": {
7821
+ "commonMetadata": {
7822
+ "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
7823
+ "description": "The basic metadata for the long-running operation."
7824
+ }
7825
+ },
7826
+ "type": "object"
7827
+ },
7828
+ "GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse": {
7829
+ "description": "The response message for the ImportProcessorVersion method.",
7830
+ "id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse",
7831
+ "properties": {
7832
+ "processorVersion": {
7833
+ "description": "The destination processor version name.",
7834
+ "type": "string"
7835
+ }
7836
+ },
7837
+ "type": "object"
7838
+ },
7839
+ "GoogleCloudDocumentaiV1beta3Processor": {
7840
+ "description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.",
7841
+ "id": "GoogleCloudDocumentaiV1beta3Processor",
7842
+ "properties": {
7843
+ "activeSchemaVersion": {
7844
+ "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}",
7845
+ "type": "string"
7846
+ },
7847
+ "createTime": {
7848
+ "description": "Output only. The time the processor was created.",
7849
+ "format": "google-datetime",
7850
+ "readOnly": true,
7851
+ "type": "string"
7852
+ },
7853
+ "defaultProcessorVersion": {
7854
+ "description": "The default processor version.",
7855
+ "type": "string"
7856
+ },
7857
+ "displayName": {
7858
+ "description": "The display name of the processor.",
7859
+ "type": "string"
7860
+ },
7861
+ "kmsKeyName": {
7862
+ "description": "The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.",
7863
+ "type": "string"
7864
+ },
7865
+ "name": {
7866
+ "description": "Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}`",
7867
+ "readOnly": true,
7868
+ "type": "string"
7869
+ },
7870
+ "processEndpoint": {
7871
+ "description": "Output only. Immutable. The http endpoint that can be called to invoke processing.",
7872
+ "readOnly": true,
7873
+ "type": "string"
7874
+ },
7875
+ "processorVersionAliases": {
7876
+ "description": "Output only. The processor version aliases.",
7877
+ "items": {
7878
+ "$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionAlias"
7879
+ },
7880
+ "readOnly": true,
7881
+ "type": "array"
7882
+ },
7883
+ "satisfiesPzi": {
7884
+ "description": "Output only. Reserved for future use.",
7885
+ "readOnly": true,
7886
+ "type": "boolean"
7887
+ },
7888
+ "satisfiesPzs": {
7889
+ "description": "Output only. Reserved for future use.",
7890
+ "readOnly": true,
7891
+ "type": "boolean"
7892
+ },
7893
+ "state": {
7894
+ "description": "Output only. The state of the processor.",
7895
+ "enum": [
7896
+ "STATE_UNSPECIFIED",
7897
+ "ENABLED",
7898
+ "DISABLED",
7899
+ "ENABLING",
7900
+ "DISABLING",
7901
+ "CREATING",
7902
+ "FAILED",
7903
+ "DELETING"
7904
+ ],
7905
+ "enumDescriptions": [
7906
+ "The processor is in an unspecified state.",
7907
+ "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.",
7908
+ "The processor is disabled.",
7909
+ "The processor is being enabled, will become `ENABLED` if successful.",
7910
+ "The processor is being disabled, will become `DISABLED` if successful.",
7911
+ "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.",
7912
+ "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.",
7913
+ "The processor is being deleted, will be removed if successful."
7914
+ ],
7915
+ "readOnly": true,
7916
+ "type": "string"
7917
+ },
7918
+ "type": {
7919
+ "description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes.",
7920
+ "type": "string"
5976
7921
  }
5977
7922
  },
5978
7923
  "type": "object"
5979
7924
  },
5980
- "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse": {
5981
- "description": "Response of the EvaluateProcessorVersion method.",
5982
- "id": "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse",
7925
+ "GoogleCloudDocumentaiV1beta3ProcessorVersion": {
7926
+ "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.",
7927
+ "id": "GoogleCloudDocumentaiV1beta3ProcessorVersion",
5983
7928
  "properties": {
5984
- "evaluation": {
5985
- "description": "The resource name of the created evaluation.",
7929
+ "createTime": {
7930
+ "description": "Output only. The time the processor version was created.",
7931
+ "format": "google-datetime",
7932
+ "readOnly": true,
5986
7933
  "type": "string"
5987
- }
5988
7934
  },
5989
- "type": "object"
7935
+ "deprecationInfo": {
7936
+ "$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo",
7937
+ "description": "Output only. If set, information about the eventual deprecation of this version.",
7938
+ "readOnly": true
5990
7939
  },
5991
- "GoogleCloudDocumentaiV1beta3GcsPrefix": {
5992
- "description": "Specifies all documents on Cloud Storage with a common prefix.",
5993
- "id": "GoogleCloudDocumentaiV1beta3GcsPrefix",
5994
- "properties": {
5995
- "gcsUriPrefix": {
5996
- "description": "The URI prefix.",
7940
+ "displayName": {
7941
+ "description": "The display name of the processor version.",
5997
7942
  "type": "string"
5998
- }
5999
7943
  },
6000
- "type": "object"
7944
+ "documentSchema": {
7945
+ "$ref": "GoogleCloudDocumentaiV1beta3DocumentSchema",
7946
+ "description": "Output only. The schema of the processor version. Describes the output.",
7947
+ "readOnly": true
6001
7948
  },
6002
- "GoogleCloudDocumentaiV1beta3HumanReviewStatus": {
6003
- "description": "The status of human review on a processed document.",
6004
- "id": "GoogleCloudDocumentaiV1beta3HumanReviewStatus",
6005
- "properties": {
6006
- "humanReviewOperation": {
6007
- "description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.",
7949
+ "genAiModelInfo": {
7950
+ "$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo",
7951
+ "description": "Output only. Information about Generative AI model-based processor versions.",
7952
+ "readOnly": true
7953
+ },
7954
+ "googleManaged": {
7955
+ "description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.",
7956
+ "readOnly": true,
7957
+ "type": "boolean"
7958
+ },
7959
+ "kmsKeyName": {
7960
+ "description": "Output only. The KMS key name used for encryption.",
7961
+ "readOnly": true,
6008
7962
  "type": "string"
6009
7963
  },
6010
- "state": {
6011
- "description": "The state of human review on the processing request.",
7964
+ "kmsKeyVersionName": {
7965
+ "description": "Output only. The KMS key version with which data is encrypted.",
7966
+ "readOnly": true,
7967
+ "type": "string"
7968
+ },
7969
+ "latestEvaluation": {
7970
+ "$ref": "GoogleCloudDocumentaiV1beta3EvaluationReference",
7971
+ "description": "Output only. The most recently invoked evaluation for the processor version.",
7972
+ "readOnly": true
7973
+ },
7974
+ "modelType": {
7975
+ "description": "Output only. The model type of this processor version.",
6012
7976
  "enum": [
6013
- "STATE_UNSPECIFIED",
6014
- "SKIPPED",
6015
- "VALIDATION_PASSED",
6016
- "IN_PROGRESS",
6017
- "ERROR"
7977
+ "MODEL_TYPE_UNSPECIFIED",
7978
+ "MODEL_TYPE_GENERATIVE",
7979
+ "MODEL_TYPE_CUSTOM"
6018
7980
  ],
6019
7981
  "enumDescriptions": [
6020
- "Human review state is unspecified. Most likely due to an internal error.",
6021
- "Human review is skipped for the document. This can happen because human review isn't enabled on the processor or the processing request has been set to skip this document.",
6022
- "Human review validation is triggered and passed, so no review is needed.",
6023
- "Human review validation is triggered and the document is under review.",
6024
- "Some error happened during triggering human review, see the state_message for details."
7982
+ "The processor version has unspecified model type.",
7983
+ "The processor version has generative model type.",
7984
+ "The processor version has custom model type."
6025
7985
  ],
7986
+ "readOnly": true,
6026
7987
  "type": "string"
6027
7988
  },
6028
- "stateMessage": {
6029
- "description": "A message providing more details about the human review state.",
7989
+ "name": {
7990
+ "description": "Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`",
7991
+ "type": "string"
7992
+ },
7993
+ "satisfiesPzi": {
7994
+ "description": "Output only. Reserved for future use.",
7995
+ "readOnly": true,
7996
+ "type": "boolean"
7997
+ },
7998
+ "satisfiesPzs": {
7999
+ "description": "Output only. Reserved for future use.",
8000
+ "readOnly": true,
8001
+ "type": "boolean"
8002
+ },
8003
+ "state": {
8004
+ "description": "Output only. The state of the processor version.",
8005
+ "enum": [
8006
+ "STATE_UNSPECIFIED",
8007
+ "DEPLOYED",
8008
+ "DEPLOYING",
8009
+ "UNDEPLOYED",
8010
+ "UNDEPLOYING",
8011
+ "CREATING",
8012
+ "DELETING",
8013
+ "FAILED",
8014
+ "IMPORTING"
8015
+ ],
8016
+ "enumDescriptions": [
8017
+ "The processor version is in an unspecified state.",
8018
+ "The processor version is deployed and can be used for processing.",
8019
+ "The processor version is being deployed.",
8020
+ "The processor version is not deployed and cannot be used for processing.",
8021
+ "The processor version is being undeployed.",
8022
+ "The processor version is being created.",
8023
+ "The processor version is being deleted.",
8024
+ "The processor version failed and is in an indeterminate state.",
8025
+ "The processor version is being imported."
8026
+ ],
8027
+ "readOnly": true,
6030
8028
  "type": "string"
6031
8029
  }
6032
8030
  },
6033
8031
  "type": "object"
6034
8032
  },
6035
- "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata": {
6036
- "description": "Metadata of the import document operation.",
6037
- "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata",
8033
+ "GoogleCloudDocumentaiV1beta3ProcessorVersionAlias": {
8034
+ "description": "Contains the alias and the aliased resource name of processor version.",
8035
+ "id": "GoogleCloudDocumentaiV1beta3ProcessorVersionAlias",
6038
8036
  "properties": {
6039
- "commonMetadata": {
6040
- "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
6041
- "description": "The basic metadata of the long-running operation."
6042
- },
6043
- "importConfigValidationResults": {
6044
- "description": "Validation statuses of the batch documents import config.",
6045
- "items": {
6046
- "$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult"
8037
+ "alias": {
8038
+ "description": "The alias in the form of `processor_version` resource name.",
8039
+ "type": "string"
6047
8040
  },
6048
- "type": "array"
8041
+ "processorVersion": {
8042
+ "description": "The resource name of aliased processor version.",
8043
+ "type": "string"
8044
+ }
6049
8045
  },
6050
- "individualImportStatuses": {
6051
- "description": "The list of response details of each document.",
6052
- "items": {
6053
- "$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus"
8046
+ "type": "object"
6054
8047
  },
6055
- "type": "array"
8048
+ "GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo": {
8049
+ "description": "Information about the upcoming deprecation of this processor version.",
8050
+ "id": "GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo",
8051
+ "properties": {
8052
+ "deprecationTime": {
8053
+ "description": "The time at which this processor version will be deprecated.",
8054
+ "format": "google-datetime",
8055
+ "type": "string"
6056
8056
  },
6057
- "totalDocumentCount": {
6058
- "description": "Total number of the documents that are qualified for importing.",
6059
- "format": "int32",
6060
- "type": "integer"
8057
+ "replacementProcessorVersion": {
8058
+ "description": "If set, the processor version that will be used as a replacement.",
8059
+ "type": "string"
6061
8060
  }
6062
8061
  },
6063
8062
  "type": "object"
6064
8063
  },
6065
- "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult": {
6066
- "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.",
6067
- "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult",
8064
+ "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo": {
8065
+ "description": "Information about Generative AI model-based processor versions.",
8066
+ "id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo",
6068
8067
  "properties": {
6069
- "inputGcsSource": {
6070
- "description": "The source Cloud Storage URI specified in the import config.",
6071
- "type": "string"
8068
+ "customGenAiModelInfo": {
8069
+ "$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo",
8070
+ "description": "Information for a custom Generative AI model created by the user."
6072
8071
  },
6073
- "status": {
6074
- "$ref": "GoogleRpcStatus",
6075
- "description": "The validation status of import config."
8072
+ "foundationGenAiModelInfo": {
8073
+ "$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo",
8074
+ "description": "Information for a pretrained Google-managed foundation model."
6076
8075
  }
6077
8076
  },
6078
8077
  "type": "object"
6079
8078
  },
6080
- "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus": {
6081
- "description": "The status of each individual document in the import process.",
6082
- "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus",
8079
+ "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": {
8080
+ "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.",
8081
+ "id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo",
6083
8082
  "properties": {
6084
- "inputGcsSource": {
6085
- "description": "The source Cloud Storage URI of the document.",
8083
+ "baseProcessorVersionId": {
8084
+ "description": "The base processor version ID for the custom model.",
6086
8085
  "type": "string"
6087
8086
  },
6088
- "outputDocumentId": {
6089
- "$ref": "GoogleCloudDocumentaiV1beta3DocumentId",
6090
- "description": "The document id of imported document if it was successful, otherwise empty."
6091
- },
6092
- "status": {
6093
- "$ref": "GoogleRpcStatus",
6094
- "description": "The status of the importing of the document."
8087
+ "customModelType": {
8088
+ "description": "The type of custom model created by the user.",
8089
+ "enum": [
8090
+ "CUSTOM_MODEL_TYPE_UNSPECIFIED",
8091
+ "VERSIONED_FOUNDATION",
8092
+ "FINE_TUNED"
8093
+ ],
8094
+ "enumDescriptions": [
8095
+ "The model type is unspecified.",
8096
+ "The model is a versioned foundation model.",
8097
+ "The model is a finetuned foundation model."
8098
+ ],
8099
+ "type": "string"
6095
8100
  }
6096
8101
  },
6097
8102
  "type": "object"
6098
8103
  },
6099
- "GoogleCloudDocumentaiV1beta3ImportDocumentsResponse": {
6100
- "description": "Response of the import document operation.",
6101
- "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsResponse",
6102
- "properties": {},
6103
- "type": "object"
6104
- },
6105
- "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata": {
6106
- "description": "The long-running operation metadata for the ImportProcessorVersion method.",
6107
- "id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata",
8104
+ "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": {
8105
+ "description": "Information for a pretrained Google-managed foundation model.",
8106
+ "id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo",
6108
8107
  "properties": {
6109
- "commonMetadata": {
6110
- "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
6111
- "description": "The basic metadata for the long-running operation."
8108
+ "finetuningAllowed": {
8109
+ "description": "Whether finetuning is allowed for this base processor version.",
8110
+ "type": "boolean"
8111
+ },
8112
+ "minTrainLabeledDocuments": {
8113
+ "description": "The minimum number of labeled documents in the training dataset required for finetuning.",
8114
+ "format": "int32",
8115
+ "type": "integer"
6112
8116
  }
6113
8117
  },
6114
8118
  "type": "object"
6115
8119
  },
6116
- "GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse": {
6117
- "description": "The response message for the ImportProcessorVersion method.",
6118
- "id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse",
8120
+ "GoogleCloudDocumentaiV1beta3PropertyMetadata": {
8121
+ "description": "Metadata about a property.",
8122
+ "id": "GoogleCloudDocumentaiV1beta3PropertyMetadata",
6119
8123
  "properties": {
6120
- "processorVersion": {
6121
- "description": "The destination processor version name.",
6122
- "type": "string"
8124
+ "fieldExtractionMetadata": {
8125
+ "$ref": "GoogleCloudDocumentaiV1beta3FieldExtractionMetadata",
8126
+ "description": "Field extraction metadata on the property."
8127
+ },
8128
+ "inactive": {
8129
+ "description": "Whether the property should be considered as \"inactive\".",
8130
+ "type": "boolean"
6123
8131
  }
6124
8132
  },
6125
8133
  "type": "object"
@@ -6250,6 +8258,43 @@ true
6250
8258
  "properties": {},
6251
8259
  "type": "object"
6252
8260
  },
8261
+ "GoogleCloudDocumentaiV1beta3SummaryOptions": {
8262
+ "description": "Metadata for document summarization.",
8263
+ "id": "GoogleCloudDocumentaiV1beta3SummaryOptions",
8264
+ "properties": {
8265
+ "format": {
8266
+ "description": "The format the summary should be in.",
8267
+ "enum": [
8268
+ "FORMAT_UNSPECIFIED",
8269
+ "PARAGRAPH",
8270
+ "BULLETS"
8271
+ ],
8272
+ "enumDescriptions": [
8273
+ "Default.",
8274
+ "Format the output in paragraphs.",
8275
+ "Format the output in bullets."
8276
+ ],
8277
+ "type": "string"
8278
+ },
8279
+ "length": {
8280
+ "description": "How long the summary should be.",
8281
+ "enum": [
8282
+ "LENGTH_UNSPECIFIED",
8283
+ "BRIEF",
8284
+ "MODERATE",
8285
+ "COMPREHENSIVE"
8286
+ ],
8287
+ "enumDescriptions": [
8288
+ "Default.",
8289
+ "A brief summary of one or two sentences.",
8290
+ "A paragraph-length summary.",
8291
+ "The longest option available."
8292
+ ],
8293
+ "type": "string"
8294
+ }
8295
+ },
8296
+ "type": "object"
8297
+ },
6253
8298
  "GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata": {
6254
8299
  "description": "The metadata that represents a processor version being created.",
6255
8300
  "id": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata",
@@ -6338,6 +8383,17 @@ true
6338
8383
  },
6339
8384
  "type": "object"
6340
8385
  },
8386
+ "GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata": {
8387
+ "description": "The long-running operation metadata for the UpdateProcessorVersion method.",
8388
+ "id": "GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata",
8389
+ "properties": {
8390
+ "commonMetadata": {
8391
+ "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata",
8392
+ "description": "The basic metadata for the long-running operation."
8393
+ }
8394
+ },
8395
+ "type": "object"
8396
+ },
6341
8397
  "GoogleCloudLocationListLocationsResponse": {
6342
8398
  "description": "The response message for Locations.ListLocations.",
6343
8399
  "id": "GoogleCloudLocationListLocationsResponse",
@@ -6406,7 +8462,7 @@ true
6406
8462
  "type": "array"
6407
8463
  },
6408
8464
  "unreachable": {
6409
- "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.",
8465
+ "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.",
6410
8466
  "items": {
6411
8467
  "type": "string"
6412
8468
  },