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