google-api-python-client 2.186.0__py3-none-any.whl → 2.188.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (321) hide show
  1. {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.188.0.dist-info}/METADATA +1 -1
  2. {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.188.0.dist-info}/RECORD +321 -319
  3. googleapiclient/discovery.py +13 -6
  4. googleapiclient/discovery_cache/documents/accessapproval.v1.json +9 -3
  5. googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +3 -3
  6. googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json +2 -2
  7. googleapiclient/discovery_cache/documents/admin.directory_v1.json +75 -1
  8. googleapiclient/discovery_cache/documents/admin.directoryv1.json +75 -1
  9. googleapiclient/discovery_cache/documents/admin.reports_v1.json +37 -6
  10. googleapiclient/discovery_cache/documents/admin.reportsv1.json +37 -6
  11. googleapiclient/discovery_cache/documents/aiplatform.v1.json +20205 -8402
  12. googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +22191 -10441
  13. googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +6 -2
  14. googleapiclient/discovery_cache/documents/alloydb.v1.json +377 -22
  15. googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +403 -36
  16. googleapiclient/discovery_cache/documents/alloydb.v1beta.json +403 -36
  17. googleapiclient/discovery_cache/documents/analyticshub.v1.json +40 -2
  18. googleapiclient/discovery_cache/documents/androidmanagement.v1.json +13 -11
  19. googleapiclient/discovery_cache/documents/androidpublisher.v3.json +314 -6
  20. googleapiclient/discovery_cache/documents/apigateway.v1.json +4 -4
  21. googleapiclient/discovery_cache/documents/apigateway.v1beta.json +4 -4
  22. googleapiclient/discovery_cache/documents/apigee.v1.json +1236 -52
  23. googleapiclient/discovery_cache/documents/apihub.v1.json +685 -7
  24. googleapiclient/discovery_cache/documents/apim.v1alpha.json +4 -4
  25. googleapiclient/discovery_cache/documents/appengine.v1.json +180 -11
  26. googleapiclient/discovery_cache/documents/appengine.v1alpha.json +71 -13
  27. googleapiclient/discovery_cache/documents/appengine.v1beta.json +225 -13
  28. googleapiclient/discovery_cache/documents/apphub.v1.json +331 -5
  29. googleapiclient/discovery_cache/documents/apphub.v1alpha.json +331 -5
  30. googleapiclient/discovery_cache/documents/appsmarket.v2.json +283 -0
  31. googleapiclient/discovery_cache/documents/artifactregistry.v1.json +150 -5
  32. googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +2 -2
  33. googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +2 -2
  34. googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +3 -3
  35. googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +3 -3
  36. googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json +55 -4
  37. googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json +883 -5
  38. googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1beta.json +914 -3
  39. googleapiclient/discovery_cache/documents/backupdr.v1.json +383 -34
  40. googleapiclient/discovery_cache/documents/batch.v1.json +14 -8
  41. googleapiclient/discovery_cache/documents/beyondcorp.v1.json +24 -24
  42. googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +24 -24
  43. googleapiclient/discovery_cache/documents/biglake.v1.json +273 -1
  44. googleapiclient/discovery_cache/documents/bigquery.v2.json +45 -3
  45. googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +16 -2
  46. googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +16 -1
  47. googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +5 -5
  48. googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json +43 -1
  49. googleapiclient/discovery_cache/documents/calendar.v3.json +21 -5
  50. googleapiclient/discovery_cache/documents/certificatemanager.v1.json +48 -4
  51. googleapiclient/discovery_cache/documents/chat.v1.json +38 -30
  52. googleapiclient/discovery_cache/documents/checks.v1alpha.json +3 -3
  53. googleapiclient/discovery_cache/documents/chromemanagement.v1.json +224 -6
  54. googleapiclient/discovery_cache/documents/chromewebstore.v2.json +550 -0
  55. googleapiclient/discovery_cache/documents/classroom.v1.json +10 -6
  56. googleapiclient/discovery_cache/documents/cloudasset.v1.json +11 -4
  57. googleapiclient/discovery_cache/documents/cloudbuild.v1.json +41 -2
  58. googleapiclient/discovery_cache/documents/cloudbuild.v2.json +12 -2
  59. googleapiclient/discovery_cache/documents/cloudchannel.v1.json +4 -4
  60. googleapiclient/discovery_cache/documents/clouddeploy.v1.json +115 -4
  61. googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +4 -4
  62. googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +81 -8
  63. googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +124 -8
  64. googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +124 -8
  65. googleapiclient/discovery_cache/documents/cloudidentity.v1.json +6 -5
  66. googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +79 -6
  67. googleapiclient/discovery_cache/documents/cloudkms.v1.json +1056 -245
  68. googleapiclient/discovery_cache/documents/cloudlocationfinder.v1.json +2 -2
  69. googleapiclient/discovery_cache/documents/cloudlocationfinder.v1alpha.json +2 -2
  70. googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json +5 -3
  71. googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json +5 -3
  72. googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json +5 -3
  73. googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json +5 -3
  74. googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +20 -8
  75. googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +83 -9
  76. googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +201 -7
  77. googleapiclient/discovery_cache/documents/cloudshell.v1.json +51 -3
  78. googleapiclient/discovery_cache/documents/cloudsupport.v2.json +6 -1
  79. googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +6 -1
  80. googleapiclient/discovery_cache/documents/cloudtasks.v2.json +2 -2
  81. googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json +2 -2
  82. googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +2 -2
  83. googleapiclient/discovery_cache/documents/composer.v1.json +7 -5
  84. googleapiclient/discovery_cache/documents/composer.v1beta1.json +7 -5
  85. googleapiclient/discovery_cache/documents/compute.alpha.json +6736 -1882
  86. googleapiclient/discovery_cache/documents/compute.beta.json +7349 -2205
  87. googleapiclient/discovery_cache/documents/compute.v1.json +4065 -1275
  88. googleapiclient/discovery_cache/documents/config.v1.json +96 -10
  89. googleapiclient/discovery_cache/documents/connectors.v1.json +62 -6
  90. googleapiclient/discovery_cache/documents/connectors.v2.json +252 -1
  91. googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +376 -4
  92. googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +4224 -326
  93. googleapiclient/discovery_cache/documents/container.v1.json +473 -190
  94. googleapiclient/discovery_cache/documents/container.v1beta1.json +756 -190
  95. googleapiclient/discovery_cache/documents/containeranalysis.v1.json +30 -1
  96. googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +34 -3
  97. googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +34 -3
  98. googleapiclient/discovery_cache/documents/content.v2.1.json +12 -645
  99. googleapiclient/discovery_cache/documents/datacatalog.v1.json +249 -5
  100. googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json +247 -3
  101. googleapiclient/discovery_cache/documents/dataflow.v1b3.json +121 -1
  102. googleapiclient/discovery_cache/documents/dataform.v1.json +63 -4
  103. googleapiclient/discovery_cache/documents/dataform.v1beta1.json +834 -41
  104. googleapiclient/discovery_cache/documents/datafusion.v1.json +221 -2
  105. googleapiclient/discovery_cache/documents/datafusion.v1beta1.json +221 -2
  106. googleapiclient/discovery_cache/documents/datalineage.v1.json +3 -3
  107. googleapiclient/discovery_cache/documents/datamanager.v1.json +156 -6
  108. googleapiclient/discovery_cache/documents/datamigration.v1.json +121 -33
  109. googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +13 -1
  110. googleapiclient/discovery_cache/documents/dataplex.v1.json +654 -36
  111. googleapiclient/discovery_cache/documents/dataportability.v1.json +55 -1
  112. googleapiclient/discovery_cache/documents/dataportability.v1beta.json +55 -1
  113. googleapiclient/discovery_cache/documents/dataproc.v1.json +24 -2
  114. googleapiclient/discovery_cache/documents/datastore.v1.json +3 -23
  115. googleapiclient/discovery_cache/documents/datastore.v1beta1.json +1 -21
  116. googleapiclient/discovery_cache/documents/datastore.v1beta3.json +1 -21
  117. googleapiclient/discovery_cache/documents/datastream.v1.json +259 -33
  118. googleapiclient/discovery_cache/documents/datastream.v1alpha1.json +13 -1
  119. googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +46 -15
  120. googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +46 -15
  121. googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +46 -15
  122. googleapiclient/discovery_cache/documents/developerconnect.v1.json +461 -21
  123. googleapiclient/discovery_cache/documents/dfareporting.v4.json +47 -6
  124. googleapiclient/discovery_cache/documents/dfareporting.v5.json +47 -6
  125. googleapiclient/discovery_cache/documents/dialogflow.v2.json +60 -11
  126. googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +59 -10
  127. googleapiclient/discovery_cache/documents/dialogflow.v3.json +154 -7
  128. googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +154 -7
  129. googleapiclient/discovery_cache/documents/discoveryengine.v1.json +2695 -794
  130. googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +3488 -872
  131. googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +1261 -546
  132. googleapiclient/discovery_cache/documents/displayvideo.v2.json +196 -1426
  133. googleapiclient/discovery_cache/documents/displayvideo.v3.json +2356 -3035
  134. googleapiclient/discovery_cache/documents/displayvideo.v4.json +1779 -208
  135. googleapiclient/discovery_cache/documents/dlp.v2.json +26 -10
  136. googleapiclient/discovery_cache/documents/docs.v1.json +282 -43
  137. googleapiclient/discovery_cache/documents/documentai.v1.json +2476 -420
  138. googleapiclient/discovery_cache/documents/documentai.v1beta3.json +1701 -248
  139. googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json +3 -3
  140. googleapiclient/discovery_cache/documents/drive.v2.json +2 -2
  141. googleapiclient/discovery_cache/documents/drive.v3.json +245 -14
  142. googleapiclient/discovery_cache/documents/eventarc.v1.json +20 -95
  143. googleapiclient/discovery_cache/documents/file.v1.json +134 -13
  144. googleapiclient/discovery_cache/documents/file.v1beta1.json +26 -14
  145. googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +17 -12
  146. googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +101 -20
  147. googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json +15 -3
  148. googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json +15 -3
  149. googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json +59 -7
  150. googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json +59 -7
  151. googleapiclient/discovery_cache/documents/firebasehosting.v1.json +3 -3
  152. googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json +3 -3
  153. googleapiclient/discovery_cache/documents/firebaseml.v1.json +3 -3
  154. googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +408 -261
  155. googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json +2 -2
  156. googleapiclient/discovery_cache/documents/firestore.v1.json +202 -31
  157. googleapiclient/discovery_cache/documents/firestore.v1beta1.json +192 -21
  158. googleapiclient/discovery_cache/documents/firestore.v1beta2.json +1 -21
  159. googleapiclient/discovery_cache/documents/gkebackup.v1.json +4 -4
  160. googleapiclient/discovery_cache/documents/gkehub.v1.json +4 -4
  161. googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +727 -4
  162. googleapiclient/discovery_cache/documents/gkehub.v1beta.json +727 -4
  163. googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +4 -4
  164. googleapiclient/discovery_cache/documents/gkehub.v2.json +4 -4
  165. googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +4 -4
  166. googleapiclient/discovery_cache/documents/gkehub.v2beta.json +4 -4
  167. googleapiclient/discovery_cache/documents/gkeonprem.v1.json +180 -2
  168. googleapiclient/discovery_cache/documents/gmail.v1.json +42 -2
  169. googleapiclient/discovery_cache/documents/healthcare.v1.json +58 -21
  170. googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +58 -21
  171. googleapiclient/discovery_cache/documents/iam.v1.json +73 -73
  172. googleapiclient/discovery_cache/documents/iamcredentials.v1.json +1 -1
  173. googleapiclient/discovery_cache/documents/identitytoolkit.v1.json +5 -5
  174. googleapiclient/discovery_cache/documents/ids.v1.json +14 -2
  175. googleapiclient/discovery_cache/documents/kmsinventory.v1.json +26 -10
  176. googleapiclient/discovery_cache/documents/language.v1.json +170 -4
  177. googleapiclient/discovery_cache/documents/language.v1beta2.json +170 -4
  178. googleapiclient/discovery_cache/documents/language.v2.json +170 -4
  179. googleapiclient/discovery_cache/documents/licensing.v1.json +2 -2
  180. googleapiclient/discovery_cache/documents/logging.v2.json +46 -9
  181. googleapiclient/discovery_cache/documents/looker.v1.json +61 -4
  182. googleapiclient/discovery_cache/documents/managedkafka.v1.json +290 -8
  183. googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json +304 -1
  184. googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json +189 -17
  185. googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +189 -17
  186. googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json +2 -2
  187. googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +2 -2
  188. googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json +9 -9
  189. googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +9 -9
  190. googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json +2 -2
  191. googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json +2 -2
  192. googleapiclient/discovery_cache/documents/merchantapi.products_v1.json +42 -11
  193. googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +13 -11
  194. googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json +130 -1
  195. googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json +2 -2
  196. googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json +2 -2
  197. googleapiclient/discovery_cache/documents/metastore.v1.json +4 -4
  198. googleapiclient/discovery_cache/documents/metastore.v1alpha.json +4 -4
  199. googleapiclient/discovery_cache/documents/metastore.v1beta.json +4 -4
  200. googleapiclient/discovery_cache/documents/migrationcenter.v1.json +15 -6
  201. googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +348 -11
  202. googleapiclient/discovery_cache/documents/ml.v1.json +13 -1
  203. googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json +9 -5
  204. googleapiclient/discovery_cache/documents/netapp.v1.json +453 -18
  205. googleapiclient/discovery_cache/documents/netapp.v1beta1.json +453 -18
  206. googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +6 -7
  207. googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +4 -4
  208. googleapiclient/discovery_cache/documents/networkmanagement.v1.json +123 -16
  209. googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +119 -16
  210. googleapiclient/discovery_cache/documents/networksecurity.v1.json +419 -6
  211. googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +189 -7
  212. googleapiclient/discovery_cache/documents/networkservices.v1.json +366 -53
  213. googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +80 -55
  214. googleapiclient/discovery_cache/documents/notebooks.v1.json +4 -4
  215. googleapiclient/discovery_cache/documents/notebooks.v2.json +23 -10
  216. googleapiclient/discovery_cache/documents/observability.v1.json +5 -5
  217. googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +3 -3
  218. googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +3 -3
  219. googleapiclient/discovery_cache/documents/oracledatabase.v1.json +4 -4
  220. googleapiclient/discovery_cache/documents/orgpolicy.v2.json +4 -4
  221. googleapiclient/discovery_cache/documents/osconfig.v1.json +16 -3
  222. googleapiclient/discovery_cache/documents/osconfig.v1beta.json +16 -3
  223. googleapiclient/discovery_cache/documents/osconfig.v2.json +5 -5
  224. googleapiclient/discovery_cache/documents/osconfig.v2beta.json +5 -5
  225. googleapiclient/discovery_cache/documents/oslogin.v1.json +44 -1
  226. googleapiclient/discovery_cache/documents/parallelstore.v1.json +2 -2
  227. googleapiclient/discovery_cache/documents/parallelstore.v1beta.json +2 -2
  228. googleapiclient/discovery_cache/documents/parametermanager.v1.json +22 -2
  229. googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +34 -1
  230. googleapiclient/discovery_cache/documents/people.v1.json +2 -2
  231. googleapiclient/discovery_cache/documents/places.v1.json +13 -5
  232. googleapiclient/discovery_cache/documents/policysimulator.v1.json +8 -8
  233. googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +8 -8
  234. googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +8 -8
  235. googleapiclient/discovery_cache/documents/privateca.v1.json +5 -5
  236. googleapiclient/discovery_cache/documents/privateca.v1beta1.json +4 -4
  237. googleapiclient/discovery_cache/documents/pubsub.v1.json +202 -27
  238. googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json +153 -3
  239. googleapiclient/discovery_cache/documents/pubsub.v1beta2.json +153 -3
  240. googleapiclient/discovery_cache/documents/pubsublite.v1.json +3 -3
  241. googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +10 -8
  242. googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json +4 -4
  243. googleapiclient/discovery_cache/documents/recommender.v1beta1.json +5 -5
  244. googleapiclient/discovery_cache/documents/redis.v1.json +51 -36
  245. googleapiclient/discovery_cache/documents/redis.v1beta1.json +51 -36
  246. googleapiclient/discovery_cache/documents/retail.v2.json +5 -5
  247. googleapiclient/discovery_cache/documents/retail.v2alpha.json +9 -7
  248. googleapiclient/discovery_cache/documents/retail.v2beta.json +9 -7
  249. googleapiclient/discovery_cache/documents/run.v1.json +269 -5
  250. googleapiclient/discovery_cache/documents/run.v2.json +320 -6
  251. googleapiclient/discovery_cache/documents/runtimeconfig.v1.json +13 -1
  252. googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json +23 -398
  253. googleapiclient/discovery_cache/documents/safebrowsing.v5.json +79 -5
  254. googleapiclient/discovery_cache/documents/searchads360.v0.json +228 -21
  255. googleapiclient/discovery_cache/documents/secretmanager.v1.json +47 -2
  256. googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +47 -2
  257. googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +47 -2
  258. googleapiclient/discovery_cache/documents/securitycenter.v1.json +641 -7
  259. googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +637 -7
  260. googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +634 -5
  261. googleapiclient/discovery_cache/documents/securityposture.v1.json +13 -1
  262. googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +17 -1
  263. googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +5 -1
  264. googleapiclient/discovery_cache/documents/servicecontrol.v1.json +9 -1
  265. googleapiclient/discovery_cache/documents/servicecontrol.v2.json +9 -1
  266. googleapiclient/discovery_cache/documents/servicedirectory.v1.json +2 -2
  267. googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json +2 -2
  268. googleapiclient/discovery_cache/documents/servicemanagement.v1.json +4 -4
  269. googleapiclient/discovery_cache/documents/servicenetworking.v1.json +4 -4
  270. googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +2 -2
  271. googleapiclient/discovery_cache/documents/serviceusage.v1.json +35 -12
  272. googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +35 -12
  273. googleapiclient/discovery_cache/documents/sheets.v4.json +2 -2
  274. googleapiclient/discovery_cache/documents/solar.v1.json +6 -1
  275. googleapiclient/discovery_cache/documents/spanner.v1.json +131 -8
  276. googleapiclient/discovery_cache/documents/speech.v1.json +3 -3
  277. googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +3 -3
  278. googleapiclient/discovery_cache/documents/sqladmin.v1.json +280 -13
  279. googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +287 -15
  280. googleapiclient/discovery_cache/documents/storage.v1.json +6 -2
  281. googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json +14 -4
  282. googleapiclient/discovery_cache/documents/storagetransfer.v1.json +27 -3
  283. googleapiclient/discovery_cache/documents/sts.v1.json +10 -1
  284. googleapiclient/discovery_cache/documents/sts.v1beta.json +10 -1
  285. googleapiclient/discovery_cache/documents/tagmanager.v2.json +55 -1
  286. googleapiclient/discovery_cache/documents/tasks.v1.json +2 -2
  287. googleapiclient/discovery_cache/documents/testing.v1.json +7 -2
  288. googleapiclient/discovery_cache/documents/texttospeech.v1.json +4 -4
  289. googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +4 -4
  290. googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +2 -2
  291. googleapiclient/discovery_cache/documents/tpu.v1.json +31 -4
  292. googleapiclient/discovery_cache/documents/tpu.v1alpha1.json +44 -17
  293. googleapiclient/discovery_cache/documents/tpu.v2.json +4 -4
  294. googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +4 -4
  295. googleapiclient/discovery_cache/documents/trafficdirector.v2.json +228 -1
  296. googleapiclient/discovery_cache/documents/trafficdirector.v3.json +228 -1
  297. googleapiclient/discovery_cache/documents/translate.v3.json +118 -18
  298. googleapiclient/discovery_cache/documents/translate.v3beta1.json +106 -10
  299. googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +6 -6
  300. googleapiclient/discovery_cache/documents/vault.v1.json +3 -3
  301. googleapiclient/discovery_cache/documents/verifiedaccess.v2.json +9 -5
  302. googleapiclient/discovery_cache/documents/vision.v1.json +3 -3
  303. googleapiclient/discovery_cache/documents/vmmigration.v1.json +22 -6
  304. googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +22 -6
  305. googleapiclient/discovery_cache/documents/vmwareengine.v1.json +549 -2
  306. googleapiclient/discovery_cache/documents/vpcaccess.v1.json +14 -2
  307. googleapiclient/discovery_cache/documents/vpcaccess.v1beta1.json +14 -2
  308. googleapiclient/discovery_cache/documents/walletobjects.v1.json +6 -1
  309. googleapiclient/discovery_cache/documents/webrisk.v1.json +3 -3
  310. googleapiclient/discovery_cache/documents/workflows.v1.json +14 -2
  311. googleapiclient/discovery_cache/documents/workflows.v1beta.json +14 -2
  312. googleapiclient/discovery_cache/documents/workloadmanager.v1.json +5 -5
  313. googleapiclient/discovery_cache/documents/workspaceevents.v1.json +706 -1
  314. googleapiclient/discovery_cache/documents/workstations.v1.json +47 -4
  315. googleapiclient/discovery_cache/documents/workstations.v1beta.json +53 -3
  316. googleapiclient/discovery_cache/documents/youtube.v3.json +149 -1
  317. googleapiclient/discovery_cache/documents/youtubereporting.v1.json +6 -1
  318. googleapiclient/version.py +1 -1
  319. {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.188.0.dist-info}/WHEEL +0 -0
  320. {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.188.0.dist-info}/licenses/LICENSE +0 -0
  321. {google_api_python_client-2.186.0.dist-info → google_api_python_client-2.188.0.dist-info}/top_level.txt +0 -0
@@ -141,49 +141,6 @@
141
141
  },
142
142
  "protocol": "rest",
143
143
  "resources": {
144
- "media": {
145
- "methods": {
146
- "download": {
147
- "description": "Downloads a file from the session.",
148
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}:downloadFile",
149
- "httpMethod": "GET",
150
- "id": "discoveryengine.media.download",
151
- "parameterOrder": [
152
- "name"
153
- ],
154
- "parameters": {
155
- "fileId": {
156
- "description": "Required. The ID of the file to be downloaded.",
157
- "location": "query",
158
- "type": "string"
159
- },
160
- "name": {
161
- "description": "Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`",
162
- "location": "path",
163
- "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$",
164
- "required": true,
165
- "type": "string"
166
- },
167
- "viewId": {
168
- "description": "Optional. The ID of the view to be downloaded.",
169
- "location": "query",
170
- "type": "string"
171
- }
172
- },
173
- "path": "v1/{+name}:downloadFile",
174
- "response": {
175
- "$ref": "GdataMedia"
176
- },
177
- "scopes": [
178
- "https://www.googleapis.com/auth/cloud-platform",
179
- "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
180
- "https://www.googleapis.com/auth/discoveryengine.readwrite"
181
- ],
182
- "supportsMediaDownload": true,
183
- "useMediaDownloadService": true
184
- }
185
- }
186
- },
187
144
  "projects": {
188
145
  "methods": {
189
146
  "provision": {
@@ -594,7 +551,7 @@
594
551
  "type": "string"
595
552
  },
596
553
  "updateMask": {
597
- "description": "Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.",
554
+ "description": "Indicates which fields in the provided DataConnector to update. Supported field paths include: - `refresh_interval` - `params` - `auto_run_disabled` - `action_config` - `action_config.action_params` - `action_config.service_name` - `destination_configs` - `blocking_reasons` - `sync_mode` - `incremental_sync_disabled` - `incremental_refresh_interval` - `data_protection_policy` Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.",
598
555
  "format": "google-fieldmask",
599
556
  "location": "query",
600
557
  "type": "string"
@@ -678,7 +635,7 @@
678
635
  "type": "string"
679
636
  },
680
637
  "returnPartialSuccess": {
681
- "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
638
+ "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
682
639
  "location": "query",
683
640
  "type": "boolean"
684
641
  }
@@ -730,7 +687,7 @@
730
687
  "type": "string"
731
688
  },
732
689
  "userPseudoId": {
733
- "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
690
+ "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
734
691
  "location": "query",
735
692
  "type": "string"
736
693
  }
@@ -1342,7 +1299,7 @@
1342
1299
  "type": "string"
1343
1300
  },
1344
1301
  "returnPartialSuccess": {
1345
- "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
1302
+ "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
1346
1303
  "location": "query",
1347
1304
  "type": "boolean"
1348
1305
  }
@@ -1915,7 +1872,7 @@
1915
1872
  "type": "string"
1916
1873
  },
1917
1874
  "returnPartialSuccess": {
1918
- "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
1875
+ "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
1919
1876
  "location": "query",
1920
1877
  "type": "boolean"
1921
1878
  }
@@ -1994,7 +1951,7 @@
1994
1951
  "type": "string"
1995
1952
  },
1996
1953
  "returnPartialSuccess": {
1997
- "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
1954
+ "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
1998
1955
  "location": "query",
1999
1956
  "type": "boolean"
2000
1957
  }
@@ -2232,7 +2189,7 @@
2232
2189
  "type": "string"
2233
2190
  },
2234
2191
  "returnPartialSuccess": {
2235
- "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
2192
+ "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
2236
2193
  "location": "query",
2237
2194
  "type": "boolean"
2238
2195
  }
@@ -2281,6 +2238,129 @@
2281
2238
  "https://www.googleapis.com/auth/discoveryengine.readwrite"
2282
2239
  ]
2283
2240
  },
2241
+ "create": {
2242
+ "description": "Creates a ServingConfig. Note: The Google Cloud console works only with the default serving config. Additional ServingConfigs can be created and managed only via the API. A maximum of 100 ServingConfigs are allowed in an Engine, otherwise a RESOURCE_EXHAUSTED error is returned.",
2243
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs",
2244
+ "httpMethod": "POST",
2245
+ "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.create",
2246
+ "parameterOrder": [
2247
+ "parent"
2248
+ ],
2249
+ "parameters": {
2250
+ "parent": {
2251
+ "description": "Required. Full resource name of parent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`",
2252
+ "location": "path",
2253
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
2254
+ "required": true,
2255
+ "type": "string"
2256
+ },
2257
+ "servingConfigId": {
2258
+ "description": "Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/.",
2259
+ "location": "query",
2260
+ "type": "string"
2261
+ }
2262
+ },
2263
+ "path": "v1/{+parent}/servingConfigs",
2264
+ "request": {
2265
+ "$ref": "GoogleCloudDiscoveryengineV1ServingConfig"
2266
+ },
2267
+ "response": {
2268
+ "$ref": "GoogleCloudDiscoveryengineV1ServingConfig"
2269
+ },
2270
+ "scopes": [
2271
+ "https://www.googleapis.com/auth/cloud-platform",
2272
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
2273
+ ]
2274
+ },
2275
+ "delete": {
2276
+ "description": "Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.",
2277
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}",
2278
+ "httpMethod": "DELETE",
2279
+ "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.delete",
2280
+ "parameterOrder": [
2281
+ "name"
2282
+ ],
2283
+ "parameters": {
2284
+ "name": {
2285
+ "description": "Required. The resource name of the ServingConfig to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`",
2286
+ "location": "path",
2287
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
2288
+ "required": true,
2289
+ "type": "string"
2290
+ }
2291
+ },
2292
+ "path": "v1/{+name}",
2293
+ "response": {
2294
+ "$ref": "GoogleProtobufEmpty"
2295
+ },
2296
+ "scopes": [
2297
+ "https://www.googleapis.com/auth/cloud-platform",
2298
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
2299
+ ]
2300
+ },
2301
+ "get": {
2302
+ "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.",
2303
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}",
2304
+ "httpMethod": "GET",
2305
+ "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.get",
2306
+ "parameterOrder": [
2307
+ "name"
2308
+ ],
2309
+ "parameters": {
2310
+ "name": {
2311
+ "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`",
2312
+ "location": "path",
2313
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
2314
+ "required": true,
2315
+ "type": "string"
2316
+ }
2317
+ },
2318
+ "path": "v1/{+name}",
2319
+ "response": {
2320
+ "$ref": "GoogleCloudDiscoveryengineV1ServingConfig"
2321
+ },
2322
+ "scopes": [
2323
+ "https://www.googleapis.com/auth/cloud-platform",
2324
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
2325
+ ]
2326
+ },
2327
+ "list": {
2328
+ "description": "Lists all ServingConfigs linked to this dataStore.",
2329
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs",
2330
+ "httpMethod": "GET",
2331
+ "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.list",
2332
+ "parameterOrder": [
2333
+ "parent"
2334
+ ],
2335
+ "parameters": {
2336
+ "pageSize": {
2337
+ "description": "Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.",
2338
+ "format": "int32",
2339
+ "location": "query",
2340
+ "type": "integer"
2341
+ },
2342
+ "pageToken": {
2343
+ "description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.",
2344
+ "location": "query",
2345
+ "type": "string"
2346
+ },
2347
+ "parent": {
2348
+ "description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`",
2349
+ "location": "path",
2350
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
2351
+ "required": true,
2352
+ "type": "string"
2353
+ }
2354
+ },
2355
+ "path": "v1/{+parent}/servingConfigs",
2356
+ "response": {
2357
+ "$ref": "GoogleCloudDiscoveryengineV1ListServingConfigsResponse"
2358
+ },
2359
+ "scopes": [
2360
+ "https://www.googleapis.com/auth/cloud-platform",
2361
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
2362
+ ]
2363
+ },
2284
2364
  "patch": {
2285
2365
  "description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.",
2286
2366
  "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}",
@@ -2863,7 +2943,7 @@
2863
2943
  "type": "string"
2864
2944
  },
2865
2945
  "returnPartialSuccess": {
2866
- "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
2946
+ "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
2867
2947
  "location": "query",
2868
2948
  "type": "boolean"
2869
2949
  }
@@ -3211,7 +3291,7 @@
3211
3291
  "type": "string"
3212
3292
  },
3213
3293
  "returnPartialSuccess": {
3214
- "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
3294
+ "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
3215
3295
  "location": "query",
3216
3296
  "type": "boolean"
3217
3297
  }
@@ -3436,6 +3516,83 @@
3436
3516
  ]
3437
3517
  }
3438
3518
  }
3519
+ },
3520
+ "widgetConfigs": {
3521
+ "methods": {
3522
+ "get": {
3523
+ "description": "Gets a WidgetConfig.",
3524
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}",
3525
+ "httpMethod": "GET",
3526
+ "id": "discoveryengine.projects.locations.collections.dataStores.widgetConfigs.get",
3527
+ "parameterOrder": [
3528
+ "name"
3529
+ ],
3530
+ "parameters": {
3531
+ "acceptCache": {
3532
+ "description": "Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.",
3533
+ "location": "query",
3534
+ "type": "boolean"
3535
+ },
3536
+ "getWidgetConfigRequestOption.turnOffCollectionComponents": {
3537
+ "description": "Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.",
3538
+ "location": "query",
3539
+ "type": "boolean"
3540
+ },
3541
+ "name": {
3542
+ "description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`",
3543
+ "location": "path",
3544
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$",
3545
+ "required": true,
3546
+ "type": "string"
3547
+ }
3548
+ },
3549
+ "path": "v1/{+name}",
3550
+ "response": {
3551
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfig"
3552
+ },
3553
+ "scopes": [
3554
+ "https://www.googleapis.com/auth/cloud-platform",
3555
+ "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
3556
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
3557
+ ]
3558
+ },
3559
+ "patch": {
3560
+ "description": "Update a WidgetConfig.",
3561
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}",
3562
+ "httpMethod": "PATCH",
3563
+ "id": "discoveryengine.projects.locations.collections.dataStores.widgetConfigs.patch",
3564
+ "parameterOrder": [
3565
+ "name"
3566
+ ],
3567
+ "parameters": {
3568
+ "name": {
3569
+ "description": "Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
3570
+ "location": "path",
3571
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$",
3572
+ "required": true,
3573
+ "type": "string"
3574
+ },
3575
+ "updateMask": {
3576
+ "description": "Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.",
3577
+ "format": "google-fieldmask",
3578
+ "location": "query",
3579
+ "type": "string"
3580
+ }
3581
+ },
3582
+ "path": "v1/{+name}",
3583
+ "request": {
3584
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfig"
3585
+ },
3586
+ "response": {
3587
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfig"
3588
+ },
3589
+ "scopes": [
3590
+ "https://www.googleapis.com/auth/cloud-platform",
3591
+ "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
3592
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
3593
+ ]
3594
+ }
3595
+ }
3439
3596
  }
3440
3597
  }
3441
3598
  },
@@ -3608,24 +3765,32 @@
3608
3765
  "resources": {
3609
3766
  "assistants": {
3610
3767
  "methods": {
3611
- "get": {
3612
- "description": "Gets an Assistant.",
3613
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}",
3614
- "httpMethod": "GET",
3615
- "id": "discoveryengine.projects.locations.collections.engines.assistants.get",
3768
+ "create": {
3769
+ "description": "Creates an Assistant.",
3770
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants",
3771
+ "httpMethod": "POST",
3772
+ "id": "discoveryengine.projects.locations.collections.engines.assistants.create",
3616
3773
  "parameterOrder": [
3617
- "name"
3774
+ "parent"
3618
3775
  ],
3619
3776
  "parameters": {
3620
- "name": {
3621
- "description": "Required. Resource name of Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`",
3777
+ "assistantId": {
3778
+ "description": "Required. The ID to use for the Assistant, which will become the final component of the Assistant's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.",
3779
+ "location": "query",
3780
+ "type": "string"
3781
+ },
3782
+ "parent": {
3783
+ "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`",
3622
3784
  "location": "path",
3623
- "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$",
3785
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
3624
3786
  "required": true,
3625
3787
  "type": "string"
3626
3788
  }
3627
3789
  },
3628
- "path": "v1/{+name}",
3790
+ "path": "v1/{+parent}/assistants",
3791
+ "request": {
3792
+ "$ref": "GoogleCloudDiscoveryengineV1Assistant"
3793
+ },
3629
3794
  "response": {
3630
3795
  "$ref": "GoogleCloudDiscoveryengineV1Assistant"
3631
3796
  },
@@ -3635,35 +3800,26 @@
3635
3800
  "https://www.googleapis.com/auth/discoveryengine.readwrite"
3636
3801
  ]
3637
3802
  },
3638
- "patch": {
3639
- "description": "Updates an Assistant",
3803
+ "delete": {
3804
+ "description": "Deletes an Assistant.",
3640
3805
  "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}",
3641
- "httpMethod": "PATCH",
3642
- "id": "discoveryengine.projects.locations.collections.engines.assistants.patch",
3806
+ "httpMethod": "DELETE",
3807
+ "id": "discoveryengine.projects.locations.collections.engines.assistants.delete",
3643
3808
  "parameterOrder": [
3644
3809
  "name"
3645
3810
  ],
3646
3811
  "parameters": {
3647
3812
  "name": {
3648
- "description": "Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.",
3813
+ "description": "Required. Resource name of Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` If the caller does not have permission to delete the Assistant, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Assistant to delete does not exist, a NOT_FOUND error is returned.",
3649
3814
  "location": "path",
3650
3815
  "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$",
3651
3816
  "required": true,
3652
3817
  "type": "string"
3653
- },
3654
- "updateMask": {
3655
- "description": "The list of fields to update.",
3656
- "format": "google-fieldmask",
3657
- "location": "query",
3658
- "type": "string"
3659
3818
  }
3660
3819
  },
3661
3820
  "path": "v1/{+name}",
3662
- "request": {
3663
- "$ref": "GoogleCloudDiscoveryengineV1Assistant"
3664
- },
3665
3821
  "response": {
3666
- "$ref": "GoogleCloudDiscoveryengineV1Assistant"
3822
+ "$ref": "GoogleProtobufEmpty"
3667
3823
  },
3668
3824
  "scopes": [
3669
3825
  "https://www.googleapis.com/auth/cloud-platform",
@@ -3671,44 +3827,181 @@
3671
3827
  "https://www.googleapis.com/auth/discoveryengine.readwrite"
3672
3828
  ]
3673
3829
  },
3674
- "streamAssist": {
3675
- "description": "Assists the user with a query in a streaming fashion.",
3676
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}:streamAssist",
3677
- "httpMethod": "POST",
3678
- "id": "discoveryengine.projects.locations.collections.engines.assistants.streamAssist",
3830
+ "get": {
3831
+ "description": "Gets an Assistant.",
3832
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}",
3833
+ "httpMethod": "GET",
3834
+ "id": "discoveryengine.projects.locations.collections.engines.assistants.get",
3679
3835
  "parameterOrder": [
3680
3836
  "name"
3681
3837
  ],
3682
3838
  "parameters": {
3683
3839
  "name": {
3684
- "description": "Required. The resource name of the Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`",
3840
+ "description": "Required. Resource name of Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`",
3685
3841
  "location": "path",
3686
3842
  "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$",
3687
3843
  "required": true,
3688
3844
  "type": "string"
3689
3845
  }
3690
3846
  },
3691
- "path": "v1/{+name}:streamAssist",
3692
- "request": {
3693
- "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequest"
3694
- },
3847
+ "path": "v1/{+name}",
3695
3848
  "response": {
3696
- "$ref": "GoogleCloudDiscoveryengineV1StreamAssistResponse"
3849
+ "$ref": "GoogleCloudDiscoveryengineV1Assistant"
3697
3850
  },
3698
3851
  "scopes": [
3699
3852
  "https://www.googleapis.com/auth/cloud-platform",
3700
3853
  "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
3701
3854
  "https://www.googleapis.com/auth/discoveryengine.readwrite"
3702
3855
  ]
3703
- }
3704
- }
3705
3856
  },
3706
- "completionConfig": {
3707
- "methods": {
3708
- "completeQuery": {
3709
- "description": "Completes the user input with advanced keyword suggestions.",
3710
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/completionConfig:completeQuery",
3711
- "httpMethod": "POST",
3857
+ "list": {
3858
+ "description": "Lists all Assistants under an Engine.",
3859
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants",
3860
+ "httpMethod": "GET",
3861
+ "id": "discoveryengine.projects.locations.collections.engines.assistants.list",
3862
+ "parameterOrder": [
3863
+ "parent"
3864
+ ],
3865
+ "parameters": {
3866
+ "pageSize": {
3867
+ "description": "Maximum number of Assistants to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.",
3868
+ "format": "int32",
3869
+ "location": "query",
3870
+ "type": "integer"
3871
+ },
3872
+ "pageToken": {
3873
+ "description": "A page token ListAssistantsResponse.next_page_token, received from a previous AssistantService.ListAssistants call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAssistants must match the call that provided the page token.",
3874
+ "location": "query",
3875
+ "type": "string"
3876
+ },
3877
+ "parent": {
3878
+ "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`",
3879
+ "location": "path",
3880
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
3881
+ "required": true,
3882
+ "type": "string"
3883
+ }
3884
+ },
3885
+ "path": "v1/{+parent}/assistants",
3886
+ "response": {
3887
+ "$ref": "GoogleCloudDiscoveryengineV1ListAssistantsResponse"
3888
+ },
3889
+ "scopes": [
3890
+ "https://www.googleapis.com/auth/cloud-platform",
3891
+ "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
3892
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
3893
+ ]
3894
+ },
3895
+ "patch": {
3896
+ "description": "Updates an Assistant",
3897
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}",
3898
+ "httpMethod": "PATCH",
3899
+ "id": "discoveryengine.projects.locations.collections.engines.assistants.patch",
3900
+ "parameterOrder": [
3901
+ "name"
3902
+ ],
3903
+ "parameters": {
3904
+ "name": {
3905
+ "description": "Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.",
3906
+ "location": "path",
3907
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$",
3908
+ "required": true,
3909
+ "type": "string"
3910
+ },
3911
+ "updateMask": {
3912
+ "description": "The list of fields to update.",
3913
+ "format": "google-fieldmask",
3914
+ "location": "query",
3915
+ "type": "string"
3916
+ }
3917
+ },
3918
+ "path": "v1/{+name}",
3919
+ "request": {
3920
+ "$ref": "GoogleCloudDiscoveryengineV1Assistant"
3921
+ },
3922
+ "response": {
3923
+ "$ref": "GoogleCloudDiscoveryengineV1Assistant"
3924
+ },
3925
+ "scopes": [
3926
+ "https://www.googleapis.com/auth/cloud-platform",
3927
+ "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
3928
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
3929
+ ]
3930
+ },
3931
+ "streamAssist": {
3932
+ "description": "Assists the user with a query in a streaming fashion.",
3933
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}:streamAssist",
3934
+ "httpMethod": "POST",
3935
+ "id": "discoveryengine.projects.locations.collections.engines.assistants.streamAssist",
3936
+ "parameterOrder": [
3937
+ "name"
3938
+ ],
3939
+ "parameters": {
3940
+ "name": {
3941
+ "description": "Required. The resource name of the Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`",
3942
+ "location": "path",
3943
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$",
3944
+ "required": true,
3945
+ "type": "string"
3946
+ }
3947
+ },
3948
+ "path": "v1/{+name}:streamAssist",
3949
+ "request": {
3950
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequest"
3951
+ },
3952
+ "response": {
3953
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistResponse"
3954
+ },
3955
+ "scopes": [
3956
+ "https://www.googleapis.com/auth/cloud-platform",
3957
+ "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
3958
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
3959
+ ]
3960
+ }
3961
+ },
3962
+ "resources": {
3963
+ "agents": {
3964
+ "resources": {
3965
+ "operations": {
3966
+ "methods": {
3967
+ "get": {
3968
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
3969
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/operations/{operationsId}",
3970
+ "httpMethod": "GET",
3971
+ "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get",
3972
+ "parameterOrder": [
3973
+ "name"
3974
+ ],
3975
+ "parameters": {
3976
+ "name": {
3977
+ "description": "The name of the operation resource.",
3978
+ "location": "path",
3979
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+/operations/[^/]+$",
3980
+ "required": true,
3981
+ "type": "string"
3982
+ }
3983
+ },
3984
+ "path": "v1/{+name}",
3985
+ "response": {
3986
+ "$ref": "GoogleLongrunningOperation"
3987
+ },
3988
+ "scopes": [
3989
+ "https://www.googleapis.com/auth/cloud-platform",
3990
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
3991
+ ]
3992
+ }
3993
+ }
3994
+ }
3995
+ }
3996
+ }
3997
+ }
3998
+ },
3999
+ "completionConfig": {
4000
+ "methods": {
4001
+ "completeQuery": {
4002
+ "description": "Completes the user input with advanced keyword suggestions.",
4003
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/completionConfig:completeQuery",
4004
+ "httpMethod": "POST",
3712
4005
  "id": "discoveryengine.projects.locations.collections.engines.completionConfig.completeQuery",
3713
4006
  "parameterOrder": [
3714
4007
  "completionConfig"
@@ -4191,7 +4484,7 @@
4191
4484
  "type": "string"
4192
4485
  },
4193
4486
  "returnPartialSuccess": {
4194
- "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
4487
+ "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
4195
4488
  "location": "query",
4196
4489
  "type": "boolean"
4197
4490
  }
@@ -4238,6 +4531,129 @@
4238
4531
  "https://www.googleapis.com/auth/discoveryengine.readwrite"
4239
4532
  ]
4240
4533
  },
4534
+ "create": {
4535
+ "description": "Creates a ServingConfig. Note: The Google Cloud console works only with the default serving config. Additional ServingConfigs can be created and managed only via the API. A maximum of 100 ServingConfigs are allowed in an Engine, otherwise a RESOURCE_EXHAUSTED error is returned.",
4536
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs",
4537
+ "httpMethod": "POST",
4538
+ "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.create",
4539
+ "parameterOrder": [
4540
+ "parent"
4541
+ ],
4542
+ "parameters": {
4543
+ "parent": {
4544
+ "description": "Required. Full resource name of parent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`",
4545
+ "location": "path",
4546
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
4547
+ "required": true,
4548
+ "type": "string"
4549
+ },
4550
+ "servingConfigId": {
4551
+ "description": "Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/.",
4552
+ "location": "query",
4553
+ "type": "string"
4554
+ }
4555
+ },
4556
+ "path": "v1/{+parent}/servingConfigs",
4557
+ "request": {
4558
+ "$ref": "GoogleCloudDiscoveryengineV1ServingConfig"
4559
+ },
4560
+ "response": {
4561
+ "$ref": "GoogleCloudDiscoveryengineV1ServingConfig"
4562
+ },
4563
+ "scopes": [
4564
+ "https://www.googleapis.com/auth/cloud-platform",
4565
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
4566
+ ]
4567
+ },
4568
+ "delete": {
4569
+ "description": "Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.",
4570
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}",
4571
+ "httpMethod": "DELETE",
4572
+ "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.delete",
4573
+ "parameterOrder": [
4574
+ "name"
4575
+ ],
4576
+ "parameters": {
4577
+ "name": {
4578
+ "description": "Required. The resource name of the ServingConfig to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`",
4579
+ "location": "path",
4580
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
4581
+ "required": true,
4582
+ "type": "string"
4583
+ }
4584
+ },
4585
+ "path": "v1/{+name}",
4586
+ "response": {
4587
+ "$ref": "GoogleProtobufEmpty"
4588
+ },
4589
+ "scopes": [
4590
+ "https://www.googleapis.com/auth/cloud-platform",
4591
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
4592
+ ]
4593
+ },
4594
+ "get": {
4595
+ "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.",
4596
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}",
4597
+ "httpMethod": "GET",
4598
+ "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.get",
4599
+ "parameterOrder": [
4600
+ "name"
4601
+ ],
4602
+ "parameters": {
4603
+ "name": {
4604
+ "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`",
4605
+ "location": "path",
4606
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
4607
+ "required": true,
4608
+ "type": "string"
4609
+ }
4610
+ },
4611
+ "path": "v1/{+name}",
4612
+ "response": {
4613
+ "$ref": "GoogleCloudDiscoveryengineV1ServingConfig"
4614
+ },
4615
+ "scopes": [
4616
+ "https://www.googleapis.com/auth/cloud-platform",
4617
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
4618
+ ]
4619
+ },
4620
+ "list": {
4621
+ "description": "Lists all ServingConfigs linked to this dataStore.",
4622
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs",
4623
+ "httpMethod": "GET",
4624
+ "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.list",
4625
+ "parameterOrder": [
4626
+ "parent"
4627
+ ],
4628
+ "parameters": {
4629
+ "pageSize": {
4630
+ "description": "Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.",
4631
+ "format": "int32",
4632
+ "location": "query",
4633
+ "type": "integer"
4634
+ },
4635
+ "pageToken": {
4636
+ "description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.",
4637
+ "location": "query",
4638
+ "type": "string"
4639
+ },
4640
+ "parent": {
4641
+ "description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`",
4642
+ "location": "path",
4643
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
4644
+ "required": true,
4645
+ "type": "string"
4646
+ }
4647
+ },
4648
+ "path": "v1/{+parent}/servingConfigs",
4649
+ "response": {
4650
+ "$ref": "GoogleCloudDiscoveryengineV1ListServingConfigsResponse"
4651
+ },
4652
+ "scopes": [
4653
+ "https://www.googleapis.com/auth/cloud-platform",
4654
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
4655
+ ]
4656
+ },
4241
4657
  "patch": {
4242
4658
  "description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.",
4243
4659
  "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}",
@@ -4601,39 +5017,116 @@
4601
5017
  }
4602
5018
  }
4603
5019
  }
4604
- }
4605
- }
4606
5020
  },
4607
- "operations": {
5021
+ "widgetConfigs": {
4608
5022
  "methods": {
4609
5023
  "get": {
4610
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
4611
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations/{operationsId}",
5024
+ "description": "Gets a WidgetConfig.",
5025
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/widgetConfigs/{widgetConfigsId}",
4612
5026
  "httpMethod": "GET",
4613
- "id": "discoveryengine.projects.locations.collections.operations.get",
5027
+ "id": "discoveryengine.projects.locations.collections.engines.widgetConfigs.get",
4614
5028
  "parameterOrder": [
4615
5029
  "name"
4616
5030
  ],
4617
5031
  "parameters": {
5032
+ "acceptCache": {
5033
+ "description": "Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.",
5034
+ "location": "query",
5035
+ "type": "boolean"
5036
+ },
5037
+ "getWidgetConfigRequestOption.turnOffCollectionComponents": {
5038
+ "description": "Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.",
5039
+ "location": "query",
5040
+ "type": "boolean"
5041
+ },
4618
5042
  "name": {
4619
- "description": "The name of the operation resource.",
5043
+ "description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`",
4620
5044
  "location": "path",
4621
- "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/operations/[^/]+$",
5045
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/widgetConfigs/[^/]+$",
4622
5046
  "required": true,
4623
5047
  "type": "string"
4624
5048
  }
4625
5049
  },
4626
5050
  "path": "v1/{+name}",
4627
5051
  "response": {
4628
- "$ref": "GoogleLongrunningOperation"
5052
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfig"
4629
5053
  },
4630
5054
  "scopes": [
4631
5055
  "https://www.googleapis.com/auth/cloud-platform",
5056
+ "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
4632
5057
  "https://www.googleapis.com/auth/discoveryengine.readwrite"
4633
5058
  ]
4634
5059
  },
4635
- "list": {
4636
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
5060
+ "patch": {
5061
+ "description": "Update a WidgetConfig.",
5062
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/widgetConfigs/{widgetConfigsId}",
5063
+ "httpMethod": "PATCH",
5064
+ "id": "discoveryengine.projects.locations.collections.engines.widgetConfigs.patch",
5065
+ "parameterOrder": [
5066
+ "name"
5067
+ ],
5068
+ "parameters": {
5069
+ "name": {
5070
+ "description": "Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
5071
+ "location": "path",
5072
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/widgetConfigs/[^/]+$",
5073
+ "required": true,
5074
+ "type": "string"
5075
+ },
5076
+ "updateMask": {
5077
+ "description": "Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.",
5078
+ "format": "google-fieldmask",
5079
+ "location": "query",
5080
+ "type": "string"
5081
+ }
5082
+ },
5083
+ "path": "v1/{+name}",
5084
+ "request": {
5085
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfig"
5086
+ },
5087
+ "response": {
5088
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfig"
5089
+ },
5090
+ "scopes": [
5091
+ "https://www.googleapis.com/auth/cloud-platform",
5092
+ "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
5093
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
5094
+ ]
5095
+ }
5096
+ }
5097
+ }
5098
+ }
5099
+ },
5100
+ "operations": {
5101
+ "methods": {
5102
+ "get": {
5103
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
5104
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations/{operationsId}",
5105
+ "httpMethod": "GET",
5106
+ "id": "discoveryengine.projects.locations.collections.operations.get",
5107
+ "parameterOrder": [
5108
+ "name"
5109
+ ],
5110
+ "parameters": {
5111
+ "name": {
5112
+ "description": "The name of the operation resource.",
5113
+ "location": "path",
5114
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/operations/[^/]+$",
5115
+ "required": true,
5116
+ "type": "string"
5117
+ }
5118
+ },
5119
+ "path": "v1/{+name}",
5120
+ "response": {
5121
+ "$ref": "GoogleLongrunningOperation"
5122
+ },
5123
+ "scopes": [
5124
+ "https://www.googleapis.com/auth/cloud-platform",
5125
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
5126
+ ]
5127
+ },
5128
+ "list": {
5129
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
4637
5130
  "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations",
4638
5131
  "httpMethod": "GET",
4639
5132
  "id": "discoveryengine.projects.locations.collections.operations.list",
@@ -4665,7 +5158,7 @@
4665
5158
  "type": "string"
4666
5159
  },
4667
5160
  "returnPartialSuccess": {
4668
- "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
5161
+ "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
4669
5162
  "location": "query",
4670
5163
  "type": "boolean"
4671
5164
  }
@@ -4717,7 +5210,7 @@
4717
5210
  "type": "string"
4718
5211
  },
4719
5212
  "userPseudoId": {
4720
- "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
5213
+ "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
4721
5214
  "location": "query",
4722
5215
  "type": "string"
4723
5216
  }
@@ -5300,7 +5793,7 @@
5300
5793
  "type": "string"
5301
5794
  },
5302
5795
  "returnPartialSuccess": {
5303
- "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
5796
+ "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
5304
5797
  "location": "query",
5305
5798
  "type": "boolean"
5306
5799
  }
@@ -5843,7 +6336,7 @@
5843
6336
  "type": "string"
5844
6337
  },
5845
6338
  "returnPartialSuccess": {
5846
- "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
6339
+ "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
5847
6340
  "location": "query",
5848
6341
  "type": "boolean"
5849
6342
  }
@@ -5922,7 +6415,7 @@
5922
6415
  "type": "string"
5923
6416
  },
5924
6417
  "returnPartialSuccess": {
5925
- "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
6418
+ "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
5926
6419
  "location": "query",
5927
6420
  "type": "boolean"
5928
6421
  }
@@ -6130,6 +6623,129 @@
6130
6623
  "https://www.googleapis.com/auth/discoveryengine.readwrite"
6131
6624
  ]
6132
6625
  },
6626
+ "create": {
6627
+ "description": "Creates a ServingConfig. Note: The Google Cloud console works only with the default serving config. Additional ServingConfigs can be created and managed only via the API. A maximum of 100 ServingConfigs are allowed in an Engine, otherwise a RESOURCE_EXHAUSTED error is returned.",
6628
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs",
6629
+ "httpMethod": "POST",
6630
+ "id": "discoveryengine.projects.locations.dataStores.servingConfigs.create",
6631
+ "parameterOrder": [
6632
+ "parent"
6633
+ ],
6634
+ "parameters": {
6635
+ "parent": {
6636
+ "description": "Required. Full resource name of parent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`",
6637
+ "location": "path",
6638
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
6639
+ "required": true,
6640
+ "type": "string"
6641
+ },
6642
+ "servingConfigId": {
6643
+ "description": "Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/.",
6644
+ "location": "query",
6645
+ "type": "string"
6646
+ }
6647
+ },
6648
+ "path": "v1/{+parent}/servingConfigs",
6649
+ "request": {
6650
+ "$ref": "GoogleCloudDiscoveryengineV1ServingConfig"
6651
+ },
6652
+ "response": {
6653
+ "$ref": "GoogleCloudDiscoveryengineV1ServingConfig"
6654
+ },
6655
+ "scopes": [
6656
+ "https://www.googleapis.com/auth/cloud-platform",
6657
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
6658
+ ]
6659
+ },
6660
+ "delete": {
6661
+ "description": "Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.",
6662
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}",
6663
+ "httpMethod": "DELETE",
6664
+ "id": "discoveryengine.projects.locations.dataStores.servingConfigs.delete",
6665
+ "parameterOrder": [
6666
+ "name"
6667
+ ],
6668
+ "parameters": {
6669
+ "name": {
6670
+ "description": "Required. The resource name of the ServingConfig to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`",
6671
+ "location": "path",
6672
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
6673
+ "required": true,
6674
+ "type": "string"
6675
+ }
6676
+ },
6677
+ "path": "v1/{+name}",
6678
+ "response": {
6679
+ "$ref": "GoogleProtobufEmpty"
6680
+ },
6681
+ "scopes": [
6682
+ "https://www.googleapis.com/auth/cloud-platform",
6683
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
6684
+ ]
6685
+ },
6686
+ "get": {
6687
+ "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.",
6688
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}",
6689
+ "httpMethod": "GET",
6690
+ "id": "discoveryengine.projects.locations.dataStores.servingConfigs.get",
6691
+ "parameterOrder": [
6692
+ "name"
6693
+ ],
6694
+ "parameters": {
6695
+ "name": {
6696
+ "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`",
6697
+ "location": "path",
6698
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
6699
+ "required": true,
6700
+ "type": "string"
6701
+ }
6702
+ },
6703
+ "path": "v1/{+name}",
6704
+ "response": {
6705
+ "$ref": "GoogleCloudDiscoveryengineV1ServingConfig"
6706
+ },
6707
+ "scopes": [
6708
+ "https://www.googleapis.com/auth/cloud-platform",
6709
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
6710
+ ]
6711
+ },
6712
+ "list": {
6713
+ "description": "Lists all ServingConfigs linked to this dataStore.",
6714
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs",
6715
+ "httpMethod": "GET",
6716
+ "id": "discoveryengine.projects.locations.dataStores.servingConfigs.list",
6717
+ "parameterOrder": [
6718
+ "parent"
6719
+ ],
6720
+ "parameters": {
6721
+ "pageSize": {
6722
+ "description": "Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.",
6723
+ "format": "int32",
6724
+ "location": "query",
6725
+ "type": "integer"
6726
+ },
6727
+ "pageToken": {
6728
+ "description": "Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.",
6729
+ "location": "query",
6730
+ "type": "string"
6731
+ },
6732
+ "parent": {
6733
+ "description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`",
6734
+ "location": "path",
6735
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
6736
+ "required": true,
6737
+ "type": "string"
6738
+ }
6739
+ },
6740
+ "path": "v1/{+parent}/servingConfigs",
6741
+ "response": {
6742
+ "$ref": "GoogleCloudDiscoveryengineV1ListServingConfigsResponse"
6743
+ },
6744
+ "scopes": [
6745
+ "https://www.googleapis.com/auth/cloud-platform",
6746
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
6747
+ ]
6748
+ },
6133
6749
  "patch": {
6134
6750
  "description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.",
6135
6751
  "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}",
@@ -7063,6 +7679,83 @@
7063
7679
  ]
7064
7680
  }
7065
7681
  }
7682
+ },
7683
+ "widgetConfigs": {
7684
+ "methods": {
7685
+ "get": {
7686
+ "description": "Gets a WidgetConfig.",
7687
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}",
7688
+ "httpMethod": "GET",
7689
+ "id": "discoveryengine.projects.locations.dataStores.widgetConfigs.get",
7690
+ "parameterOrder": [
7691
+ "name"
7692
+ ],
7693
+ "parameters": {
7694
+ "acceptCache": {
7695
+ "description": "Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.",
7696
+ "location": "query",
7697
+ "type": "boolean"
7698
+ },
7699
+ "getWidgetConfigRequestOption.turnOffCollectionComponents": {
7700
+ "description": "Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.",
7701
+ "location": "query",
7702
+ "type": "boolean"
7703
+ },
7704
+ "name": {
7705
+ "description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`",
7706
+ "location": "path",
7707
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$",
7708
+ "required": true,
7709
+ "type": "string"
7710
+ }
7711
+ },
7712
+ "path": "v1/{+name}",
7713
+ "response": {
7714
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfig"
7715
+ },
7716
+ "scopes": [
7717
+ "https://www.googleapis.com/auth/cloud-platform",
7718
+ "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
7719
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
7720
+ ]
7721
+ },
7722
+ "patch": {
7723
+ "description": "Update a WidgetConfig.",
7724
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}",
7725
+ "httpMethod": "PATCH",
7726
+ "id": "discoveryengine.projects.locations.dataStores.widgetConfigs.patch",
7727
+ "parameterOrder": [
7728
+ "name"
7729
+ ],
7730
+ "parameters": {
7731
+ "name": {
7732
+ "description": "Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
7733
+ "location": "path",
7734
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$",
7735
+ "required": true,
7736
+ "type": "string"
7737
+ },
7738
+ "updateMask": {
7739
+ "description": "Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.",
7740
+ "format": "google-fieldmask",
7741
+ "location": "query",
7742
+ "type": "string"
7743
+ }
7744
+ },
7745
+ "path": "v1/{+name}",
7746
+ "request": {
7747
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfig"
7748
+ },
7749
+ "response": {
7750
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfig"
7751
+ },
7752
+ "scopes": [
7753
+ "https://www.googleapis.com/auth/cloud-platform",
7754
+ "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
7755
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
7756
+ ]
7757
+ }
7758
+ }
7066
7759
  }
7067
7760
  }
7068
7761
  },
@@ -7392,7 +8085,7 @@
7392
8085
  "type": "string"
7393
8086
  },
7394
8087
  "returnPartialSuccess": {
7395
- "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
8088
+ "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
7396
8089
  "location": "query",
7397
8090
  "type": "boolean"
7398
8091
  }
@@ -7570,7 +8263,7 @@
7570
8263
  "type": "string"
7571
8264
  },
7572
8265
  "returnPartialSuccess": {
7573
- "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
8266
+ "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
7574
8267
  "location": "query",
7575
8268
  "type": "boolean"
7576
8269
  }
@@ -7795,45 +8488,196 @@
7795
8488
  "https://www.googleapis.com/auth/cloud-platform",
7796
8489
  "https://www.googleapis.com/auth/discoveryengine.readwrite"
7797
8490
  ]
7798
- }
7799
8491
  },
7800
- "resources": {
7801
- "userLicenses": {
7802
- "methods": {
7803
- "list": {
7804
- "description": "Lists the User Licenses.",
7805
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/userLicenses",
7806
- "httpMethod": "GET",
7807
- "id": "discoveryengine.projects.locations.userStores.userLicenses.list",
8492
+ "create": {
8493
+ "description": "Creates a new User Store.",
8494
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores",
8495
+ "httpMethod": "POST",
8496
+ "id": "discoveryengine.projects.locations.userStores.create",
7808
8497
  "parameterOrder": [
7809
8498
  "parent"
7810
8499
  ],
7811
8500
  "parameters": {
7812
- "filter": {
7813
- "description": "Optional. Filter for the list request. Supported fields: * `license_assignment_state` Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.",
7814
- "location": "query",
7815
- "type": "string"
7816
- },
7817
- "pageSize": {
7818
- "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.",
7819
- "format": "int32",
7820
- "location": "query",
7821
- "type": "integer"
7822
- },
7823
- "pageToken": {
7824
- "description": "Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token.",
7825
- "location": "query",
7826
- "type": "string"
7827
- },
7828
8501
  "parent": {
7829
- "description": "Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`.",
8502
+ "description": "Required. The parent collection resource name, such as `projects/{project}/locations/{location}`.",
7830
8503
  "location": "path",
7831
- "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$",
8504
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
7832
8505
  "required": true,
7833
8506
  "type": "string"
8507
+ },
8508
+ "userStoreId": {
8509
+ "description": "Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.",
8510
+ "location": "query",
8511
+ "type": "string"
7834
8512
  }
7835
8513
  },
7836
- "path": "v1/{+parent}/userLicenses",
8514
+ "path": "v1/{+parent}/userStores",
8515
+ "request": {
8516
+ "$ref": "GoogleCloudDiscoveryengineV1UserStore"
8517
+ },
8518
+ "response": {
8519
+ "$ref": "GoogleCloudDiscoveryengineV1UserStore"
8520
+ },
8521
+ "scopes": [
8522
+ "https://www.googleapis.com/auth/cloud-platform",
8523
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
8524
+ ]
8525
+ },
8526
+ "delete": {
8527
+ "description": "Deletes the User Store.",
8528
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}",
8529
+ "httpMethod": "DELETE",
8530
+ "id": "discoveryengine.projects.locations.userStores.delete",
8531
+ "parameterOrder": [
8532
+ "name"
8533
+ ],
8534
+ "parameters": {
8535
+ "name": {
8536
+ "description": "Required. The name of the User Store to delete. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}`",
8537
+ "location": "path",
8538
+ "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$",
8539
+ "required": true,
8540
+ "type": "string"
8541
+ }
8542
+ },
8543
+ "path": "v1/{+name}",
8544
+ "response": {
8545
+ "$ref": "GoogleLongrunningOperation"
8546
+ },
8547
+ "scopes": [
8548
+ "https://www.googleapis.com/auth/cloud-platform",
8549
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
8550
+ ]
8551
+ },
8552
+ "get": {
8553
+ "description": "Gets the User Store.",
8554
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}",
8555
+ "httpMethod": "GET",
8556
+ "id": "discoveryengine.projects.locations.userStores.get",
8557
+ "parameterOrder": [
8558
+ "name"
8559
+ ],
8560
+ "parameters": {
8561
+ "name": {
8562
+ "description": "Required. The name of the User Store to get. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}`",
8563
+ "location": "path",
8564
+ "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$",
8565
+ "required": true,
8566
+ "type": "string"
8567
+ }
8568
+ },
8569
+ "path": "v1/{+name}",
8570
+ "response": {
8571
+ "$ref": "GoogleCloudDiscoveryengineV1UserStore"
8572
+ },
8573
+ "scopes": [
8574
+ "https://www.googleapis.com/auth/cloud-platform",
8575
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
8576
+ ]
8577
+ },
8578
+ "patch": {
8579
+ "description": "Updates the User Store.",
8580
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}",
8581
+ "httpMethod": "PATCH",
8582
+ "id": "discoveryengine.projects.locations.userStores.patch",
8583
+ "parameterOrder": [
8584
+ "name"
8585
+ ],
8586
+ "parameters": {
8587
+ "name": {
8588
+ "description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
8589
+ "location": "path",
8590
+ "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$",
8591
+ "required": true,
8592
+ "type": "string"
8593
+ },
8594
+ "updateMask": {
8595
+ "description": "Optional. The list of fields to update.",
8596
+ "format": "google-fieldmask",
8597
+ "location": "query",
8598
+ "type": "string"
8599
+ }
8600
+ },
8601
+ "path": "v1/{+name}",
8602
+ "request": {
8603
+ "$ref": "GoogleCloudDiscoveryengineV1UserStore"
8604
+ },
8605
+ "response": {
8606
+ "$ref": "GoogleCloudDiscoveryengineV1UserStore"
8607
+ },
8608
+ "scopes": [
8609
+ "https://www.googleapis.com/auth/cloud-platform",
8610
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
8611
+ ]
8612
+ }
8613
+ },
8614
+ "resources": {
8615
+ "licenseConfigsUsageStats": {
8616
+ "methods": {
8617
+ "list": {
8618
+ "description": "Lists all the LicenseConfigUsageStatss associated with the project.",
8619
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/licenseConfigsUsageStats",
8620
+ "httpMethod": "GET",
8621
+ "id": "discoveryengine.projects.locations.userStores.licenseConfigsUsageStats.list",
8622
+ "parameterOrder": [
8623
+ "parent"
8624
+ ],
8625
+ "parameters": {
8626
+ "parent": {
8627
+ "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/userStores/{user_store_id}`.",
8628
+ "location": "path",
8629
+ "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$",
8630
+ "required": true,
8631
+ "type": "string"
8632
+ }
8633
+ },
8634
+ "path": "v1/{+parent}/licenseConfigsUsageStats",
8635
+ "response": {
8636
+ "$ref": "GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse"
8637
+ },
8638
+ "scopes": [
8639
+ "https://www.googleapis.com/auth/cloud-platform",
8640
+ "https://www.googleapis.com/auth/discoveryengine.readwrite"
8641
+ ]
8642
+ }
8643
+ }
8644
+ },
8645
+ "userLicenses": {
8646
+ "methods": {
8647
+ "list": {
8648
+ "description": "Lists the User Licenses.",
8649
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/userLicenses",
8650
+ "httpMethod": "GET",
8651
+ "id": "discoveryengine.projects.locations.userStores.userLicenses.list",
8652
+ "parameterOrder": [
8653
+ "parent"
8654
+ ],
8655
+ "parameters": {
8656
+ "orderBy": {
8657
+ "description": "Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a \" desc\" suffix. Redundant space characters in the syntax are insignificant. Supported fields: * `license_assignment_state` * `user_principal` * `user_profile` * `last_login_date` * `update_time` If not set, the default ordering is by `user_principal`. Examples: * `user_principal desc` to order by `user_principal` in descending order. * `license_assignment_state` to order by `license_assignment_state` in ascending order. * `last_login_date desc` to order by `last_login_date` in descending order. * `update_time desc` to order by `update_time` in descending order. * `last_login_date desc, user_principal` to order by `last_login_date` in descending order and then by `user_principal` in ascending order.",
8658
+ "location": "query",
8659
+ "type": "string"
8660
+ },
8661
+ "pageSize": {
8662
+ "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.",
8663
+ "format": "int32",
8664
+ "location": "query",
8665
+ "type": "integer"
8666
+ },
8667
+ "pageToken": {
8668
+ "description": "Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token.",
8669
+ "location": "query",
8670
+ "type": "string"
8671
+ },
8672
+ "parent": {
8673
+ "description": "Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`.",
8674
+ "location": "path",
8675
+ "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$",
8676
+ "required": true,
8677
+ "type": "string"
8678
+ }
8679
+ },
8680
+ "path": "v1/{+parent}/userLicenses",
7837
8681
  "response": {
7838
8682
  "$ref": "GoogleCloudDiscoveryengineV1ListUserLicensesResponse"
7839
8683
  },
@@ -7938,7 +8782,7 @@
7938
8782
  "type": "string"
7939
8783
  },
7940
8784
  "returnPartialSuccess": {
7941
- "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
8785
+ "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
7942
8786
  "location": "query",
7943
8787
  "type": "boolean"
7944
8788
  }
@@ -7957,531 +8801,101 @@
7957
8801
  }
7958
8802
  }
7959
8803
  },
7960
- "revision": "20251017",
8804
+ "revision": "20260107",
7961
8805
  "rootUrl": "https://discoveryengine.googleapis.com/",
7962
8806
  "schemas": {
7963
- "GdataBlobstore2Info": {
7964
- "description": "Information to read/write to blobstore2.",
7965
- "id": "GdataBlobstore2Info",
8807
+ "GoogleApiDistribution": {
8808
+ "description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.",
8809
+ "id": "GoogleApiDistribution",
7966
8810
  "properties": {
7967
- "blobGeneration": {
7968
- "description": "The blob generation id.",
8811
+ "bucketCounts": {
8812
+ "description": "The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).",
8813
+ "items": {
7969
8814
  "format": "int64",
7970
8815
  "type": "string"
7971
8816
  },
7972
- "blobId": {
7973
- "description": "The blob id, e.g., /blobstore/prod/playground/scotty",
7974
- "type": "string"
7975
- },
7976
- "downloadReadHandle": {
7977
- "description": "Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.",
7978
- "format": "byte",
7979
- "type": "string"
7980
- },
7981
- "readToken": {
7982
- "description": "The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.",
7983
- "type": "string"
7984
- },
7985
- "uploadMetadataContainer": {
7986
- "description": "Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.",
7987
- "format": "byte",
7988
- "type": "string"
7989
- }
7990
- },
7991
- "type": "object"
7992
- },
7993
- "GdataCompositeMedia": {
7994
- "description": "A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.",
7995
- "id": "GdataCompositeMedia",
7996
- "properties": {
7997
- "blobRef": {
7998
- "deprecated": true,
7999
- "description": "Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.",
8000
- "format": "byte",
8001
- "type": "string"
8002
- },
8003
- "blobstore2Info": {
8004
- "$ref": "GdataBlobstore2Info",
8005
- "description": "Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob."
8006
- },
8007
- "cosmoBinaryReference": {
8008
- "description": "A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.",
8009
- "format": "byte",
8010
- "type": "string"
8011
- },
8012
- "crc32cHash": {
8013
- "description": "crc32.c hash for the payload.",
8014
- "format": "uint32",
8015
- "type": "integer"
8817
+ "type": "array"
8016
8818
  },
8017
- "inline": {
8018
- "description": "Media data, set if reference_type is INLINE",
8019
- "format": "byte",
8020
- "type": "string"
8819
+ "bucketOptions": {
8820
+ "$ref": "GoogleApiDistributionBucketOptions",
8821
+ "description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field."
8021
8822
  },
8022
- "length": {
8023
- "description": "Size of the data, in bytes",
8823
+ "count": {
8824
+ "description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.",
8024
8825
  "format": "int64",
8025
8826
  "type": "string"
8026
8827
  },
8027
- "md5Hash": {
8028
- "description": "MD5 hash for the payload.",
8029
- "format": "byte",
8030
- "type": "string"
8828
+ "exemplars": {
8829
+ "description": "Must be in increasing order of `value` field.",
8830
+ "items": {
8831
+ "$ref": "GoogleApiDistributionExemplar"
8031
8832
  },
8032
- "objectId": {
8033
- "$ref": "GdataObjectId",
8034
- "description": "Reference to a TI Blob, set if reference_type is BIGSTORE_REF."
8833
+ "type": "array"
8035
8834
  },
8036
- "path": {
8037
- "description": "Path to the data, set if reference_type is PATH",
8038
- "type": "string"
8835
+ "mean": {
8836
+ "description": "The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.",
8837
+ "format": "double",
8838
+ "type": "number"
8039
8839
  },
8040
- "referenceType": {
8041
- "description": "Describes what the field reference contains.",
8042
- "enum": [
8043
- "PATH",
8044
- "BLOB_REF",
8045
- "INLINE",
8046
- "BIGSTORE_REF",
8047
- "COSMO_BINARY_REFERENCE"
8048
- ],
8049
- "enumDescriptions": [
8050
- "Reference contains a GFS path or a local path.",
8051
- "Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.",
8052
- "Data is included into this proto buffer",
8053
- "Reference points to a bigstore object",
8054
- "Indicates the data is stored in cosmo_binary_reference."
8055
- ],
8056
- "type": "string"
8840
+ "range": {
8841
+ "$ref": "GoogleApiDistributionRange",
8842
+ "description": "If specified, contains the range of the population values. The field must not be present if the `count` is zero."
8057
8843
  },
8058
- "sha1Hash": {
8059
- "description": "SHA-1 hash for the payload.",
8060
- "format": "byte",
8061
- "type": "string"
8844
+ "sumOfSquaredDeviation": {
8845
+ "description": "The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, \"The Art of Computer Programming\", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.",
8846
+ "format": "double",
8847
+ "type": "number"
8062
8848
  }
8063
8849
  },
8064
8850
  "type": "object"
8065
8851
  },
8066
- "GdataContentTypeInfo": {
8067
- "description": "Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.",
8068
- "id": "GdataContentTypeInfo",
8852
+ "GoogleApiDistributionBucketOptions": {
8853
+ "description": "`BucketOptions` describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. `BucketOptions` does not include the number of values in each bucket. A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
8854
+ "id": "GoogleApiDistributionBucketOptions",
8069
8855
  "properties": {
8070
- "bestGuess": {
8071
- "description": "Scotty's best guess of what the content type of the file is.",
8072
- "type": "string"
8073
- },
8074
- "fromBytes": {
8075
- "description": "The content type of the file derived by looking at specific bytes (i.e. \"magic bytes\") of the actual file.",
8076
- "type": "string"
8077
- },
8078
- "fromFileName": {
8079
- "description": "The content type of the file derived from the file extension of the original file name used by the client.",
8080
- "type": "string"
8856
+ "explicitBuckets": {
8857
+ "$ref": "GoogleApiDistributionBucketOptionsExplicit",
8858
+ "description": "The explicit buckets."
8081
8859
  },
8082
- "fromHeader": {
8083
- "description": "The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.",
8084
- "type": "string"
8860
+ "exponentialBuckets": {
8861
+ "$ref": "GoogleApiDistributionBucketOptionsExponential",
8862
+ "description": "The exponential buckets."
8085
8863
  },
8086
- "fromUrlPath": {
8087
- "description": "The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).",
8088
- "type": "string"
8864
+ "linearBuckets": {
8865
+ "$ref": "GoogleApiDistributionBucketOptionsLinear",
8866
+ "description": "The linear bucket."
8089
8867
  }
8090
8868
  },
8091
8869
  "type": "object"
8092
8870
  },
8093
- "GdataDiffChecksumsResponse": {
8094
- "description": "Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.",
8095
- "id": "GdataDiffChecksumsResponse",
8871
+ "GoogleApiDistributionBucketOptionsExplicit": {
8872
+ "description": "Specifies a set of buckets with arbitrary widths. There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The `bounds` field must contain at least one element. If `bounds` has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
8873
+ "id": "GoogleApiDistributionBucketOptionsExplicit",
8096
8874
  "properties": {
8097
- "checksumsLocation": {
8098
- "$ref": "GdataCompositeMedia",
8099
- "description": "Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol."
8100
- },
8101
- "chunkSizeBytes": {
8102
- "description": "The chunk size of checksums. Must be a multiple of 256KB.",
8103
- "format": "int64",
8104
- "type": "string"
8105
- },
8106
- "objectLocation": {
8107
- "$ref": "GdataCompositeMedia",
8108
- "description": "If set, calculate the checksums based on the contents and return them to the caller."
8109
- },
8110
- "objectSizeBytes": {
8111
- "description": "The total size of the server object.",
8112
- "format": "int64",
8113
- "type": "string"
8114
- },
8115
- "objectVersion": {
8116
- "description": "The object version of the object the checksums are being returned for.",
8117
- "type": "string"
8118
- }
8119
- },
8120
- "type": "object"
8875
+ "bounds": {
8876
+ "description": "The values must be monotonically increasing.",
8877
+ "items": {
8878
+ "format": "double",
8879
+ "type": "number"
8121
8880
  },
8122
- "GdataDiffDownloadResponse": {
8123
- "description": "Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.",
8124
- "id": "GdataDiffDownloadResponse",
8125
- "properties": {
8126
- "objectLocation": {
8127
- "$ref": "GdataCompositeMedia",
8128
- "description": "The original object location."
8881
+ "type": "array"
8129
8882
  }
8130
8883
  },
8131
8884
  "type": "object"
8132
8885
  },
8133
- "GdataDiffUploadRequest": {
8134
- "description": "A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.",
8135
- "id": "GdataDiffUploadRequest",
8886
+ "GoogleApiDistributionBucketOptionsExponential": {
8887
+ "description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).",
8888
+ "id": "GoogleApiDistributionBucketOptionsExponential",
8136
8889
  "properties": {
8137
- "checksumsInfo": {
8138
- "$ref": "GdataCompositeMedia",
8139
- "description": "The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol."
8890
+ "growthFactor": {
8891
+ "description": "Must be greater than 1.",
8892
+ "format": "double",
8893
+ "type": "number"
8140
8894
  },
8141
- "objectInfo": {
8142
- "$ref": "GdataCompositeMedia",
8143
- "description": "The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received."
8144
- },
8145
- "objectVersion": {
8146
- "description": "The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.",
8147
- "type": "string"
8148
- }
8149
- },
8150
- "type": "object"
8151
- },
8152
- "GdataDiffUploadResponse": {
8153
- "description": "Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.",
8154
- "id": "GdataDiffUploadResponse",
8155
- "properties": {
8156
- "objectVersion": {
8157
- "description": "The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.",
8158
- "type": "string"
8159
- },
8160
- "originalObject": {
8161
- "$ref": "GdataCompositeMedia",
8162
- "description": "The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification."
8163
- }
8164
- },
8165
- "type": "object"
8166
- },
8167
- "GdataDiffVersionResponse": {
8168
- "description": "Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.",
8169
- "id": "GdataDiffVersionResponse",
8170
- "properties": {
8171
- "objectSizeBytes": {
8172
- "description": "The total size of the server object.",
8173
- "format": "int64",
8174
- "type": "string"
8175
- },
8176
- "objectVersion": {
8177
- "description": "The version of the object stored at the server.",
8178
- "type": "string"
8179
- }
8180
- },
8181
- "type": "object"
8182
- },
8183
- "GdataDownloadParameters": {
8184
- "description": "Parameters specific to media downloads.",
8185
- "id": "GdataDownloadParameters",
8186
- "properties": {
8187
- "allowGzipCompression": {
8188
- "description": "A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.",
8189
- "type": "boolean"
8190
- },
8191
- "ignoreRange": {
8192
- "description": "Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.",
8193
- "type": "boolean"
8194
- }
8195
- },
8196
- "type": "object"
8197
- },
8198
- "GdataMedia": {
8199
- "description": "A reference to data stored on the filesystem, on GFS or in blobstore.",
8200
- "id": "GdataMedia",
8201
- "properties": {
8202
- "algorithm": {
8203
- "deprecated": true,
8204
- "description": "Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, \"MD5\" is the only possible value for this field. New values may be added at any time.",
8205
- "type": "string"
8206
- },
8207
- "bigstoreObjectRef": {
8208
- "deprecated": true,
8209
- "description": "Use object_id instead.",
8210
- "format": "byte",
8211
- "type": "string"
8212
- },
8213
- "blobRef": {
8214
- "deprecated": true,
8215
- "description": "Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.",
8216
- "format": "byte",
8217
- "type": "string"
8218
- },
8219
- "blobstore2Info": {
8220
- "$ref": "GdataBlobstore2Info",
8221
- "description": "Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob."
8222
- },
8223
- "compositeMedia": {
8224
- "description": "A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.",
8225
- "items": {
8226
- "$ref": "GdataCompositeMedia"
8227
- },
8228
- "type": "array"
8229
- },
8230
- "contentType": {
8231
- "description": "MIME type of the data",
8232
- "type": "string"
8233
- },
8234
- "contentTypeInfo": {
8235
- "$ref": "GdataContentTypeInfo",
8236
- "description": "Extended content type information provided for Scotty uploads."
8237
- },
8238
- "cosmoBinaryReference": {
8239
- "description": "A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.",
8240
- "format": "byte",
8241
- "type": "string"
8242
- },
8243
- "crc32cHash": {
8244
- "description": "For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.",
8245
- "format": "uint32",
8246
- "type": "integer"
8247
- },
8248
- "diffChecksumsResponse": {
8249
- "$ref": "GdataDiffChecksumsResponse",
8250
- "description": "Set if reference_type is DIFF_CHECKSUMS_RESPONSE."
8251
- },
8252
- "diffDownloadResponse": {
8253
- "$ref": "GdataDiffDownloadResponse",
8254
- "description": "Set if reference_type is DIFF_DOWNLOAD_RESPONSE."
8255
- },
8256
- "diffUploadRequest": {
8257
- "$ref": "GdataDiffUploadRequest",
8258
- "description": "Set if reference_type is DIFF_UPLOAD_REQUEST."
8259
- },
8260
- "diffUploadResponse": {
8261
- "$ref": "GdataDiffUploadResponse",
8262
- "description": "Set if reference_type is DIFF_UPLOAD_RESPONSE."
8263
- },
8264
- "diffVersionResponse": {
8265
- "$ref": "GdataDiffVersionResponse",
8266
- "description": "Set if reference_type is DIFF_VERSION_RESPONSE."
8267
- },
8268
- "downloadParameters": {
8269
- "$ref": "GdataDownloadParameters",
8270
- "description": "Parameters for a media download."
8271
- },
8272
- "filename": {
8273
- "description": "Original file name",
8274
- "type": "string"
8275
- },
8276
- "hash": {
8277
- "deprecated": true,
8278
- "description": "Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.",
8279
- "type": "string"
8280
- },
8281
- "hashVerified": {
8282
- "description": "For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.",
8283
- "type": "boolean"
8284
- },
8285
- "inline": {
8286
- "description": "Media data, set if reference_type is INLINE",
8287
- "format": "byte",
8288
- "type": "string"
8289
- },
8290
- "isPotentialRetry": {
8291
- "description": "|is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.",
8292
- "type": "boolean"
8293
- },
8294
- "length": {
8295
- "description": "Size of the data, in bytes",
8296
- "format": "int64",
8297
- "type": "string"
8298
- },
8299
- "md5Hash": {
8300
- "description": "Scotty-provided MD5 hash for an upload.",
8301
- "format": "byte",
8302
- "type": "string"
8303
- },
8304
- "mediaId": {
8305
- "description": "Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.",
8306
- "format": "byte",
8307
- "type": "string"
8308
- },
8309
- "objectId": {
8310
- "$ref": "GdataObjectId",
8311
- "description": "Reference to a TI Blob, set if reference_type is BIGSTORE_REF."
8312
- },
8313
- "path": {
8314
- "description": "Path to the data, set if reference_type is PATH",
8315
- "type": "string"
8316
- },
8317
- "referenceType": {
8318
- "description": "Describes what the field reference contains.",
8319
- "enum": [
8320
- "PATH",
8321
- "BLOB_REF",
8322
- "INLINE",
8323
- "GET_MEDIA",
8324
- "COMPOSITE_MEDIA",
8325
- "BIGSTORE_REF",
8326
- "DIFF_VERSION_RESPONSE",
8327
- "DIFF_CHECKSUMS_RESPONSE",
8328
- "DIFF_DOWNLOAD_RESPONSE",
8329
- "DIFF_UPLOAD_REQUEST",
8330
- "DIFF_UPLOAD_RESPONSE",
8331
- "COSMO_BINARY_REFERENCE",
8332
- "ARBITRARY_BYTES"
8333
- ],
8334
- "enumDescriptions": [
8335
- "Reference contains a GFS path or a local path.",
8336
- "Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.",
8337
- "Data is included into this proto buffer",
8338
- "Data should be accessed from the current service using the operation GetMedia.",
8339
- "The content for this media object is stored across multiple partial media objects under the composite_media field.",
8340
- "Reference points to a bigstore object",
8341
- "Indicates the data is stored in diff_version_response.",
8342
- "Indicates the data is stored in diff_checksums_response.",
8343
- "Indicates the data is stored in diff_download_response.",
8344
- "Indicates the data is stored in diff_upload_request.",
8345
- "Indicates the data is stored in diff_upload_response.",
8346
- "Indicates the data is stored in cosmo_binary_reference.",
8347
- "Informs Scotty to generate a response payload with the size specified in the length field. The contents of the payload are generated by Scotty and are undefined. This is useful for testing download speeds between the user and Scotty without involving a real payload source. Note: range is not supported when using arbitrary_bytes."
8348
- ],
8349
- "type": "string"
8350
- },
8351
- "sha1Hash": {
8352
- "description": "Scotty-provided SHA1 hash for an upload.",
8353
- "format": "byte",
8354
- "type": "string"
8355
- },
8356
- "sha256Hash": {
8357
- "description": "Scotty-provided SHA256 hash for an upload.",
8358
- "format": "byte",
8359
- "type": "string"
8360
- },
8361
- "timestamp": {
8362
- "description": "Time at which the media data was last updated, in milliseconds since UNIX epoch",
8363
- "format": "uint64",
8364
- "type": "string"
8365
- },
8366
- "token": {
8367
- "description": "A unique fingerprint/version id for the media data",
8368
- "type": "string"
8369
- }
8370
- },
8371
- "type": "object"
8372
- },
8373
- "GdataObjectId": {
8374
- "description": "This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.",
8375
- "id": "GdataObjectId",
8376
- "properties": {
8377
- "bucketName": {
8378
- "description": "The name of the bucket to which this object belongs.",
8379
- "type": "string"
8380
- },
8381
- "generation": {
8382
- "description": "Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions",
8383
- "format": "int64",
8384
- "type": "string"
8385
- },
8386
- "objectName": {
8387
- "description": "The name of the object.",
8388
- "type": "string"
8389
- }
8390
- },
8391
- "type": "object"
8392
- },
8393
- "GoogleApiDistribution": {
8394
- "description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.",
8395
- "id": "GoogleApiDistribution",
8396
- "properties": {
8397
- "bucketCounts": {
8398
- "description": "The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).",
8399
- "items": {
8400
- "format": "int64",
8401
- "type": "string"
8402
- },
8403
- "type": "array"
8404
- },
8405
- "bucketOptions": {
8406
- "$ref": "GoogleApiDistributionBucketOptions",
8407
- "description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field."
8408
- },
8409
- "count": {
8410
- "description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.",
8411
- "format": "int64",
8412
- "type": "string"
8413
- },
8414
- "exemplars": {
8415
- "description": "Must be in increasing order of `value` field.",
8416
- "items": {
8417
- "$ref": "GoogleApiDistributionExemplar"
8418
- },
8419
- "type": "array"
8420
- },
8421
- "mean": {
8422
- "description": "The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.",
8423
- "format": "double",
8424
- "type": "number"
8425
- },
8426
- "range": {
8427
- "$ref": "GoogleApiDistributionRange",
8428
- "description": "If specified, contains the range of the population values. The field must not be present if the `count` is zero."
8429
- },
8430
- "sumOfSquaredDeviation": {
8431
- "description": "The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, \"The Art of Computer Programming\", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.",
8432
- "format": "double",
8433
- "type": "number"
8434
- }
8435
- },
8436
- "type": "object"
8437
- },
8438
- "GoogleApiDistributionBucketOptions": {
8439
- "description": "`BucketOptions` describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. `BucketOptions` does not include the number of values in each bucket. A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
8440
- "id": "GoogleApiDistributionBucketOptions",
8441
- "properties": {
8442
- "explicitBuckets": {
8443
- "$ref": "GoogleApiDistributionBucketOptionsExplicit",
8444
- "description": "The explicit buckets."
8445
- },
8446
- "exponentialBuckets": {
8447
- "$ref": "GoogleApiDistributionBucketOptionsExponential",
8448
- "description": "The exponential buckets."
8449
- },
8450
- "linearBuckets": {
8451
- "$ref": "GoogleApiDistributionBucketOptionsLinear",
8452
- "description": "The linear bucket."
8453
- }
8454
- },
8455
- "type": "object"
8456
- },
8457
- "GoogleApiDistributionBucketOptionsExplicit": {
8458
- "description": "Specifies a set of buckets with arbitrary widths. There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The `bounds` field must contain at least one element. If `bounds` has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
8459
- "id": "GoogleApiDistributionBucketOptionsExplicit",
8460
- "properties": {
8461
- "bounds": {
8462
- "description": "The values must be monotonically increasing.",
8463
- "items": {
8464
- "format": "double",
8465
- "type": "number"
8466
- },
8467
- "type": "array"
8468
- }
8469
- },
8470
- "type": "object"
8471
- },
8472
- "GoogleApiDistributionBucketOptionsExponential": {
8473
- "description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).",
8474
- "id": "GoogleApiDistributionBucketOptionsExponential",
8475
- "properties": {
8476
- "growthFactor": {
8477
- "description": "Must be greater than 1.",
8478
- "format": "double",
8479
- "type": "number"
8480
- },
8481
- "numFiniteBuckets": {
8482
- "description": "Must be greater than 0.",
8483
- "format": "int32",
8484
- "type": "integer"
8895
+ "numFiniteBuckets": {
8896
+ "description": "Must be greater than 0.",
8897
+ "format": "int32",
8898
+ "type": "integer"
8485
8899
  },
8486
8900
  "scale": {
8487
8901
  "description": "Must be greater than 0.",
@@ -8912,7 +9326,7 @@
8912
9326
  "description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info."
8913
9327
  },
8914
9328
  "userPseudoId": {
8915
- "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128",
9329
+ "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128",
8916
9330
  "type": "string"
8917
9331
  }
8918
9332
  },
@@ -10612,6 +11026,18 @@
10612
11026
  "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicy",
10613
11027
  "description": "Optional. Customer policy for the assistant."
10614
11028
  },
11029
+ "defaultWebGroundingToggleOff": {
11030
+ "description": "Optional. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.",
11031
+ "type": "boolean"
11032
+ },
11033
+ "description": {
11034
+ "description": "Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.",
11035
+ "type": "string"
11036
+ },
11037
+ "displayName": {
11038
+ "description": "Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters.",
11039
+ "type": "string"
11040
+ },
10615
11041
  "enabledTools": {
10616
11042
  "additionalProperties": {
10617
11043
  "$ref": "GoogleCloudDiscoveryengineV1AssistantToolList"
@@ -10830,10 +11256,21 @@
10830
11256
  "description": "Configuration for the generation of the assistant response.",
10831
11257
  "id": "GoogleCloudDiscoveryengineV1AssistantGenerationConfig",
10832
11258
  "properties": {
11259
+ "allowedModelIds": {
11260
+ "description": "Optional. The list of models that are allowed to be used for assistant.",
11261
+ "items": {
11262
+ "type": "string"
11263
+ },
11264
+ "type": "array"
11265
+ },
10833
11266
  "defaultLanguage": {
10834
11267
  "description": "The default language to use for the generation of the assistant response. Use an ISO 639-1 language code such as `en`. If not specified, the language will be automatically detected.",
10835
11268
  "type": "string"
10836
11269
  },
11270
+ "defaultModelId": {
11271
+ "description": "Optional. The default model to use for assistant.",
11272
+ "type": "string"
11273
+ },
10837
11274
  "systemInstruction": {
10838
11275
  "$ref": "GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction",
10839
11276
  "description": "System instruction, also known as the prompt preamble for LLM calls. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions"
@@ -12742,7 +13179,8 @@
12742
13179
  "NATIVE_CLOUD_IDENTITY",
12743
13180
  "THIRD_PARTY_FEDERATED",
12744
13181
  "THIRD_PARTY_EUA",
12745
- "GCNV"
13182
+ "GCNV",
13183
+ "GOOGLE_CHAT"
12746
13184
  ],
12747
13185
  "enumDescriptions": [
12748
13186
  "Default value.",
@@ -12756,7 +13194,8 @@
12756
13194
  "Native Cloud Identity connector for people search powered by People API.",
12757
13195
  "Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.",
12758
13196
  "Connector utilized for End User Authentication features.",
12759
- "Google Cloud NetApp Volumes connector."
13197
+ "Google Cloud NetApp Volumes connector.",
13198
+ "Google Chat connector."
12760
13199
  ],
12761
13200
  "readOnly": true,
12762
13201
  "type": "string"
@@ -13154,6 +13593,12 @@
13154
13593
  ],
13155
13594
  "type": "string"
13156
13595
  },
13596
+ "configurableBillingApproachUpdateTime": {
13597
+ "description": "Output only. The timestamp when configurable_billing_approach was last updated.",
13598
+ "format": "google-datetime",
13599
+ "readOnly": true,
13600
+ "type": "string"
13601
+ },
13157
13602
  "contentConfig": {
13158
13603
  "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.",
13159
13604
  "enum": [
@@ -13227,6 +13672,10 @@
13227
13672
  "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
13228
13673
  "type": "string"
13229
13674
  },
13675
+ "naturalLanguageQueryUnderstandingConfig": {
13676
+ "$ref": "GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig",
13677
+ "description": "Optional. Configuration for Natural Language Query Understanding."
13678
+ },
13230
13679
  "servingConfigDataStore": {
13231
13680
  "$ref": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore",
13232
13681
  "description": "Optional. Stores serving config at DataStore level."
@@ -13791,6 +14240,10 @@
13791
14240
  "description": "Optional. If true, the LLM based annotation is added to the image during parsing.",
13792
14241
  "type": "boolean"
13793
14242
  },
14243
+ "enableLlmLayoutParsing": {
14244
+ "description": "Optional. If true, the pdf layout will be refined using an LLM.",
14245
+ "type": "boolean"
14246
+ },
13794
14247
  "enableTableAnnotation": {
13795
14248
  "description": "Optional. If true, the LLM based annotation is added to the table during parsing.",
13796
14249
  "type": "boolean"
@@ -13914,6 +14367,11 @@
13914
14367
  "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.",
13915
14368
  "readOnly": true
13916
14369
  },
14370
+ "cmekConfig": {
14371
+ "$ref": "GoogleCloudDiscoveryengineV1CmekConfig",
14372
+ "description": "Output only. CMEK-related information for the Engine.",
14373
+ "readOnly": true
14374
+ },
13917
14375
  "commonConfig": {
13918
14376
  "$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig",
13919
14377
  "description": "Common config spec that specifies the metadata of the engine."
@@ -13988,6 +14446,23 @@
13988
14446
  "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig",
13989
14447
  "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical."
13990
14448
  },
14449
+ "modelConfigs": {
14450
+ "additionalProperties": {
14451
+ "enum": [
14452
+ "MODEL_STATE_UNSPECIFIED",
14453
+ "MODEL_ENABLED",
14454
+ "MODEL_DISABLED"
14455
+ ],
14456
+ "enumDescriptions": [
14457
+ "The model state is unspecified.",
14458
+ "The model is enabled by admin.",
14459
+ "The model is disabled by admin."
14460
+ ],
14461
+ "type": "string"
14462
+ },
14463
+ "description": "Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.",
14464
+ "type": "object"
14465
+ },
13991
14466
  "name": {
13992
14467
  "description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.",
13993
14468
  "type": "string"
@@ -14182,19 +14657,53 @@
14182
14657
  "description": "Configurations for a Search Engine.",
14183
14658
  "id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig",
14184
14659
  "properties": {
14185
- "searchAddOns": {
14186
- "description": "The add-on that this search engine enables.",
14187
- "items": {
14660
+ "requiredSubscriptionTier": {
14661
+ "description": "Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.",
14188
14662
  "enum": [
14189
- "SEARCH_ADD_ON_UNSPECIFIED",
14190
- "SEARCH_ADD_ON_LLM"
14191
- ],
14192
- "enumDescriptions": [
14193
- "Default value when the enum is unspecified. This is invalid to use.",
14194
- "Large language model add-on."
14195
- ],
14196
- "type": "string"
14197
- },
14663
+ "SUBSCRIPTION_TIER_UNSPECIFIED",
14664
+ "SUBSCRIPTION_TIER_SEARCH",
14665
+ "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT",
14666
+ "SUBSCRIPTION_TIER_NOTEBOOK_LM",
14667
+ "SUBSCRIPTION_TIER_FRONTLINE_WORKER",
14668
+ "SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
14669
+ "SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
14670
+ "SUBSCRIPTION_TIER_ENTERPRISE",
14671
+ "SUBSCRIPTION_TIER_EDU",
14672
+ "SUBSCRIPTION_TIER_EDU_PRO",
14673
+ "SUBSCRIPTION_TIER_EDU_EMERGING",
14674
+ "SUBSCRIPTION_TIER_EDU_PRO_EMERGING",
14675
+ "SUBSCRIPTION_TIER_FRONTLINE_STARTER"
14676
+ ],
14677
+ "enumDescriptions": [
14678
+ "Default value.",
14679
+ "Search tier. Search tier can access VAIS search features and NotebookLM features.",
14680
+ "Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
14681
+ "NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
14682
+ "Frontline worker tier.",
14683
+ "Agentspace Starter tier.",
14684
+ "Agentspace Business tier.",
14685
+ "Enterprise tier.",
14686
+ "EDU tier.",
14687
+ "EDU Pro tier.",
14688
+ "EDU emerging market tier.",
14689
+ "EDU Pro emerging market tier.",
14690
+ "Frontline starter tier."
14691
+ ],
14692
+ "type": "string"
14693
+ },
14694
+ "searchAddOns": {
14695
+ "description": "The add-on that this search engine enables.",
14696
+ "items": {
14697
+ "enum": [
14698
+ "SEARCH_ADD_ON_UNSPECIFIED",
14699
+ "SEARCH_ADD_ON_LLM"
14700
+ ],
14701
+ "enumDescriptions": [
14702
+ "Default value when the enum is unspecified. This is invalid to use.",
14703
+ "Large language model add-on."
14704
+ ],
14705
+ "type": "string"
14706
+ },
14198
14707
  "type": "array"
14199
14708
  },
14200
14709
  "searchTier": {
@@ -14409,6 +14918,10 @@
14409
14918
  "description": "Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters.",
14410
14919
  "type": "string"
14411
14920
  },
14921
+ "externalIdentityName": {
14922
+ "description": "Optional. The name of the external identity.",
14923
+ "type": "string"
14924
+ },
14412
14925
  "groupId": {
14413
14926
  "description": "Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider, group_id is the mapped group identifier configured during the workforcepool config.",
14414
14927
  "type": "string"
@@ -15058,7 +15571,8 @@
15058
15571
  "SUBSCRIPTION_TIER_EDU",
15059
15572
  "SUBSCRIPTION_TIER_EDU_PRO",
15060
15573
  "SUBSCRIPTION_TIER_EDU_EMERGING",
15061
- "SUBSCRIPTION_TIER_EDU_PRO_EMERGING"
15574
+ "SUBSCRIPTION_TIER_EDU_PRO_EMERGING",
15575
+ "SUBSCRIPTION_TIER_FRONTLINE_STARTER"
15062
15576
  ],
15063
15577
  "enumDescriptions": [
15064
15578
  "Default value.",
@@ -15072,13 +15586,48 @@
15072
15586
  "EDU tier.",
15073
15587
  "EDU Pro tier.",
15074
15588
  "EDU emerging market tier.",
15075
- "EDU Pro emerging market tier."
15589
+ "EDU Pro emerging market tier.",
15590
+ "Frontline starter tier."
15076
15591
  ],
15077
15592
  "type": "string"
15078
15593
  }
15079
15594
  },
15080
15595
  "type": "object"
15081
15596
  },
15597
+ "GoogleCloudDiscoveryengineV1LicenseConfigUsageStats": {
15598
+ "description": "Stats about users' licenses.",
15599
+ "id": "GoogleCloudDiscoveryengineV1LicenseConfigUsageStats",
15600
+ "properties": {
15601
+ "licenseConfig": {
15602
+ "description": "Required. The LicenseConfig name.",
15603
+ "type": "string"
15604
+ },
15605
+ "usedLicenseCount": {
15606
+ "description": "Required. The number of licenses used.",
15607
+ "format": "int64",
15608
+ "type": "string"
15609
+ }
15610
+ },
15611
+ "type": "object"
15612
+ },
15613
+ "GoogleCloudDiscoveryengineV1ListAssistantsResponse": {
15614
+ "description": "Response message for the AssistantService.ListAssistants method.",
15615
+ "id": "GoogleCloudDiscoveryengineV1ListAssistantsResponse",
15616
+ "properties": {
15617
+ "assistants": {
15618
+ "description": "All the customer's Assistants.",
15619
+ "items": {
15620
+ "$ref": "GoogleCloudDiscoveryengineV1Assistant"
15621
+ },
15622
+ "type": "array"
15623
+ },
15624
+ "nextPageToken": {
15625
+ "description": "A token that can be sent as ListAssistantsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
15626
+ "type": "string"
15627
+ }
15628
+ },
15629
+ "type": "object"
15630
+ },
15082
15631
  "GoogleCloudDiscoveryengineV1ListCmekConfigsResponse": {
15083
15632
  "description": "Response message for CmekConfigService.ListCmekConfigs method.",
15084
15633
  "id": "GoogleCloudDiscoveryengineV1ListCmekConfigsResponse",
@@ -15233,6 +15782,20 @@
15233
15782
  },
15234
15783
  "type": "object"
15235
15784
  },
15785
+ "GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse": {
15786
+ "description": "Response message for UserLicenseService.ListLicenseConfigUsageStats method.",
15787
+ "id": "GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse",
15788
+ "properties": {
15789
+ "licenseConfigUsageStats": {
15790
+ "description": "All the customer's LicenseConfigUsageStats.",
15791
+ "items": {
15792
+ "$ref": "GoogleCloudDiscoveryengineV1LicenseConfigUsageStats"
15793
+ },
15794
+ "type": "array"
15795
+ }
15796
+ },
15797
+ "type": "object"
15798
+ },
15236
15799
  "GoogleCloudDiscoveryengineV1ListSchemasResponse": {
15237
15800
  "description": "Response message for SchemaService.ListSchemas method.",
15238
15801
  "id": "GoogleCloudDiscoveryengineV1ListSchemasResponse",
@@ -15251,6 +15814,24 @@
15251
15814
  },
15252
15815
  "type": "object"
15253
15816
  },
15817
+ "GoogleCloudDiscoveryengineV1ListServingConfigsResponse": {
15818
+ "description": "Response for ListServingConfigs method.",
15819
+ "id": "GoogleCloudDiscoveryengineV1ListServingConfigsResponse",
15820
+ "properties": {
15821
+ "nextPageToken": {
15822
+ "description": "Pagination token, if not returned indicates the last page.",
15823
+ "type": "string"
15824
+ },
15825
+ "servingConfigs": {
15826
+ "description": "All the ServingConfigs for a given dataStore.",
15827
+ "items": {
15828
+ "$ref": "GoogleCloudDiscoveryengineV1ServingConfig"
15829
+ },
15830
+ "type": "array"
15831
+ }
15832
+ },
15833
+ "type": "object"
15834
+ },
15254
15835
  "GoogleCloudDiscoveryengineV1ListSessionsResponse": {
15255
15836
  "description": "Response for ListSessions method.",
15256
15837
  "id": "GoogleCloudDiscoveryengineV1ListSessionsResponse",
@@ -15327,6 +15908,27 @@
15327
15908
  },
15328
15909
  "type": "object"
15329
15910
  },
15911
+ "GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig": {
15912
+ "description": "Configuration for Natural Language Query Understanding.",
15913
+ "id": "GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig",
15914
+ "properties": {
15915
+ "mode": {
15916
+ "description": "Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.",
15917
+ "enum": [
15918
+ "MODE_UNSPECIFIED",
15919
+ "DISABLED",
15920
+ "ENABLED"
15921
+ ],
15922
+ "enumDescriptions": [
15923
+ "Default value.",
15924
+ "Natural Language Query Understanding is disabled.",
15925
+ "Natural Language Query Understanding is enabled."
15926
+ ],
15927
+ "type": "string"
15928
+ }
15929
+ },
15930
+ "type": "object"
15931
+ },
15330
15932
  "GoogleCloudDiscoveryengineV1PageInfo": {
15331
15933
  "description": "Detailed page information.",
15332
15934
  "id": "GoogleCloudDiscoveryengineV1PageInfo",
@@ -15405,6 +16007,11 @@
15405
16007
  "description": "Metadata and configurations for a Google Cloud project in the service.",
15406
16008
  "id": "GoogleCloudDiscoveryengineV1Project",
15407
16009
  "properties": {
16010
+ "configurableBillingStatus": {
16011
+ "$ref": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus",
16012
+ "description": "Output only. The current status of the project's configurable billing.",
16013
+ "readOnly": true
16014
+ },
15408
16015
  "createTime": {
15409
16016
  "description": "Output only. The timestamp when this project is created.",
15410
16017
  "format": "google-datetime",
@@ -15437,6 +16044,28 @@
15437
16044
  },
15438
16045
  "type": "object"
15439
16046
  },
16047
+ "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus": {
16048
+ "description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).",
16049
+ "id": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus",
16050
+ "properties": {
16051
+ "effectiveIndexingCoreThreshold": {
16052
+ "description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.",
16053
+ "format": "int64",
16054
+ "type": "string"
16055
+ },
16056
+ "effectiveSearchQpmThreshold": {
16057
+ "description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.",
16058
+ "format": "int64",
16059
+ "type": "string"
16060
+ },
16061
+ "startTime": {
16062
+ "description": "Optional. The start time of the currently active billing subscription.",
16063
+ "format": "google-datetime",
16064
+ "type": "string"
16065
+ }
16066
+ },
16067
+ "type": "object"
16068
+ },
15440
16069
  "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig": {
15441
16070
  "description": "Customer provided configurations.",
15442
16071
  "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig",
@@ -15455,6 +16084,10 @@
15455
16084
  "modelArmorConfig": {
15456
16085
  "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
15457
16086
  "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
16087
+ },
16088
+ "optOutNotebookSharing": {
16089
+ "description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.",
16090
+ "type": "boolean"
15458
16091
  }
15459
16092
  },
15460
16093
  "type": "object"
@@ -16176,6 +16809,13 @@
16176
16809
  "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec",
16177
16810
  "description": "A specification for configuring the behavior of content search."
16178
16811
  },
16812
+ "crowdingSpecs": {
16813
+ "description": "Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = \"color\" and `max_count` = 3, and the second CrowdingSpec has `field` = \"size\" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.",
16814
+ "items": {
16815
+ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec"
16816
+ },
16817
+ "type": "array"
16818
+ },
16179
16819
  "dataStoreSpecs": {
16180
16820
  "description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.",
16181
16821
  "items": {
@@ -16224,6 +16864,13 @@
16224
16864
  "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.",
16225
16865
  "type": "string"
16226
16866
  },
16867
+ "pageCategories": {
16868
+ "description": "Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '>' character to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders Edition` where \"RTX > 4090\" represents one level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition`",
16869
+ "items": {
16870
+ "type": "string"
16871
+ },
16872
+ "type": "array"
16873
+ },
16227
16874
  "pageSize": {
16228
16875
  "description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.",
16229
16876
  "format": "int32",
@@ -16282,7 +16929,7 @@ false
16282
16929
  "description": "Optional. The specification for returning the relevance score."
16283
16930
  },
16284
16931
  "relevanceThreshold": {
16285
- "description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.",
16932
+ "description": "The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.",
16286
16933
  "enum": [
16287
16934
  "RELEVANCE_THRESHOLD_UNSPECIFIED",
16288
16935
  "LOWEST",
@@ -16331,7 +16978,7 @@ false
16331
16978
  "type": "object"
16332
16979
  },
16333
16980
  "userPseudoId": {
16334
- "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
16981
+ "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
16335
16982
  "type": "string"
16336
16983
  }
16337
16984
  },
@@ -16608,6 +17255,36 @@ false
16608
17255
  },
16609
17256
  "type": "object"
16610
17257
  },
17258
+ "GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec": {
17259
+ "description": "Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.",
17260
+ "id": "GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec",
17261
+ "properties": {
17262
+ "field": {
17263
+ "description": "The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.",
17264
+ "type": "string"
17265
+ },
17266
+ "maxCount": {
17267
+ "description": "The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are \"crowded away\". If not specified, the default value is 1.",
17268
+ "format": "int32",
17269
+ "type": "integer"
17270
+ },
17271
+ "mode": {
17272
+ "description": "Mode to use for documents that are crowded away.",
17273
+ "enum": [
17274
+ "MODE_UNSPECIFIED",
17275
+ "DROP_CROWDED_RESULTS",
17276
+ "DEMOTE_CROWDED_RESULTS_TO_END"
17277
+ ],
17278
+ "enumDescriptions": [
17279
+ "Unspecified crowding mode. In this case, server behavior defaults to Mode.DROP_CROWDED_RESULTS.",
17280
+ "Drop crowded results.",
17281
+ "Demote crowded results to the later pages."
17282
+ ],
17283
+ "type": "string"
17284
+ }
17285
+ },
17286
+ "type": "object"
17287
+ },
16611
17288
  "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec": {
16612
17289
  "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.",
16613
17290
  "id": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec",
@@ -16927,6 +17604,21 @@ false
16927
17604
  },
16928
17605
  "type": "array"
16929
17606
  },
17607
+ "semanticState": {
17608
+ "description": "Output only. Indicates the semantic state of the search response.",
17609
+ "enum": [
17610
+ "SEMANTIC_STATE_UNSPECIFIED",
17611
+ "DISABLED",
17612
+ "ENABLED"
17613
+ ],
17614
+ "enumDescriptions": [
17615
+ "Default value. Should not be used.",
17616
+ "Semantic search was disabled for this search response.",
17617
+ "Semantic search was enabled for this search response."
17618
+ ],
17619
+ "readOnly": true,
17620
+ "type": "string"
17621
+ },
16930
17622
  "sessionInfo": {
16931
17623
  "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSessionInfo",
16932
17624
  "description": "Session information. Only set if SearchRequest.session is provided. See its description for more details."
@@ -17804,6 +18496,13 @@ false
17804
18496
  "description": "A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.",
17805
18497
  "type": "string"
17806
18498
  },
18499
+ "invocationTools": {
18500
+ "description": "The tool names of the tools that were invoked.",
18501
+ "items": {
18502
+ "type": "string"
18503
+ },
18504
+ "type": "array"
18505
+ },
17807
18506
  "sessionInfo": {
17808
18507
  "$ref": "GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo",
17809
18508
  "description": "Session information. Only included in the final StreamAssistResponse of the response stream."
@@ -18153,207 +18852,962 @@ false
18153
18852
  },
18154
18853
  "type": "object"
18155
18854
  },
18156
- "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": {
18157
- "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
18158
- "id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata",
18855
+ "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": {
18856
+ "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
18857
+ "id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata",
18858
+ "properties": {
18859
+ "createTime": {
18860
+ "description": "Operation create time.",
18861
+ "format": "google-datetime",
18862
+ "type": "string"
18863
+ },
18864
+ "updateTime": {
18865
+ "description": "Operation last update time. If the operation is done, this is also the finish time.",
18866
+ "format": "google-datetime",
18867
+ "type": "string"
18868
+ }
18869
+ },
18870
+ "type": "object"
18871
+ },
18872
+ "GoogleCloudDiscoveryengineV1UserEvent": {
18873
+ "description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.",
18874
+ "id": "GoogleCloudDiscoveryengineV1UserEvent",
18875
+ "properties": {
18876
+ "attributes": {
18877
+ "additionalProperties": {
18878
+ "$ref": "GoogleCloudDiscoveryengineV1CustomAttribute"
18879
+ },
18880
+ "description": "Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.",
18881
+ "type": "object"
18882
+ },
18883
+ "attributionToken": {
18884
+ "description": "Token to attribute an API response to user action(s) to trigger the event. Highly recommended for user events that are the result of RecommendationService.Recommend. This field enables accurate attribution of recommendation model performance. The value must be one of: * RecommendResponse.attribution_token for events that are the result of RecommendationService.Recommend. * SearchResponse.attribution_token for events that are the result of SearchService.Search. This token enables us to accurately attribute page view or conversion completion back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass RecommendResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the RecommendResponse.attribution_token to this field.",
18885
+ "type": "string"
18886
+ },
18887
+ "completionInfo": {
18888
+ "$ref": "GoogleCloudDiscoveryengineV1CompletionInfo",
18889
+ "description": "CompletionService.CompleteQuery details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search."
18890
+ },
18891
+ "conversionType": {
18892
+ "description": "Optional. Conversion type. Required if UserEvent.event_type is `conversion`. This is a customer-defined conversion name in lowercase letters or numbers separated by \"-\", such as \"watch\", \"good-visit\" etc. Do not set the field if UserEvent.event_type is not `conversion`. This mixes the custom conversion event with predefined events like `search`, `view-item` etc.",
18893
+ "type": "string"
18894
+ },
18895
+ "dataStore": {
18896
+ "description": "The DataStore resource full name, of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Optional. Only required for user events whose data store can't by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted.",
18897
+ "type": "string"
18898
+ },
18899
+ "directUserRequest": {
18900
+ "description": "Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.",
18901
+ "type": "boolean"
18902
+ },
18903
+ "documents": {
18904
+ "description": "List of Documents associated with this user event. This field is optional except for the following event types: * `view-item` * `add-to-cart` * `purchase` * `media-play` * `media-complete` In a `search` event, this field represents the documents returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new `search` event with different UserEvent.documents is desired.",
18905
+ "items": {
18906
+ "$ref": "GoogleCloudDiscoveryengineV1DocumentInfo"
18907
+ },
18908
+ "type": "array"
18909
+ },
18910
+ "engine": {
18911
+ "description": "The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search.",
18912
+ "type": "string"
18913
+ },
18914
+ "eventTime": {
18915
+ "description": "Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.",
18916
+ "format": "google-datetime",
18917
+ "type": "string"
18918
+ },
18919
+ "eventType": {
18920
+ "description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.",
18921
+ "type": "string"
18922
+ },
18923
+ "filter": {
18924
+ "description": "Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
18925
+ "type": "string"
18926
+ },
18927
+ "mediaInfo": {
18928
+ "$ref": "GoogleCloudDiscoveryengineV1MediaInfo",
18929
+ "description": "Media-specific info."
18930
+ },
18931
+ "pageInfo": {
18932
+ "$ref": "GoogleCloudDiscoveryengineV1PageInfo",
18933
+ "description": "Page metadata such as categories and other critical information for certain event types such as `view-category-page`."
18934
+ },
18935
+ "panel": {
18936
+ "$ref": "GoogleCloudDiscoveryengineV1PanelInfo",
18937
+ "description": "Panel metadata associated with this user event."
18938
+ },
18939
+ "panels": {
18940
+ "description": "Optional. List of panels associated with this event. Used for page-level impression data.",
18941
+ "items": {
18942
+ "$ref": "GoogleCloudDiscoveryengineV1PanelInfo"
18943
+ },
18944
+ "type": "array"
18945
+ },
18946
+ "promotionIds": {
18947
+ "description": "The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.",
18948
+ "items": {
18949
+ "type": "string"
18950
+ },
18951
+ "type": "array"
18952
+ },
18953
+ "searchInfo": {
18954
+ "$ref": "GoogleCloudDiscoveryengineV1SearchInfo",
18955
+ "description": "SearchService.Search details related to the event. This field should be set for `search` event."
18956
+ },
18957
+ "sessionId": {
18958
+ "description": "A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.",
18959
+ "type": "string"
18960
+ },
18961
+ "tagIds": {
18962
+ "description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.",
18963
+ "items": {
18964
+ "type": "string"
18965
+ },
18966
+ "type": "array"
18967
+ },
18968
+ "transactionInfo": {
18969
+ "$ref": "GoogleCloudDiscoveryengineV1TransactionInfo",
18970
+ "description": "The transaction metadata (if any) associated with this user event."
18971
+ },
18972
+ "userInfo": {
18973
+ "$ref": "GoogleCloudDiscoveryengineV1UserInfo",
18974
+ "description": "Information about the end user."
18975
+ },
18976
+ "userPseudoId": {
18977
+ "description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.",
18978
+ "type": "string"
18979
+ }
18980
+ },
18981
+ "type": "object"
18982
+ },
18983
+ "GoogleCloudDiscoveryengineV1UserInfo": {
18984
+ "description": "Information of an end user.",
18985
+ "id": "GoogleCloudDiscoveryengineV1UserInfo",
18986
+ "properties": {
18987
+ "timeZone": {
18988
+ "description": "Optional. IANA time zone, e.g. Europe/Budapest.",
18989
+ "type": "string"
18990
+ },
18991
+ "userAgent": {
18992
+ "description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.",
18993
+ "type": "string"
18994
+ },
18995
+ "userId": {
18996
+ "description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
18997
+ "type": "string"
18998
+ }
18999
+ },
19000
+ "type": "object"
19001
+ },
19002
+ "GoogleCloudDiscoveryengineV1UserLicense": {
19003
+ "description": "User License information assigned by the admin.",
19004
+ "id": "GoogleCloudDiscoveryengineV1UserLicense",
19005
+ "properties": {
19006
+ "createTime": {
19007
+ "description": "Output only. User created timestamp.",
19008
+ "format": "google-datetime",
19009
+ "readOnly": true,
19010
+ "type": "string"
19011
+ },
19012
+ "lastLoginTime": {
19013
+ "description": "Output only. User last logged in time. If the user has not logged in yet, this field will be empty.",
19014
+ "format": "google-datetime",
19015
+ "readOnly": true,
19016
+ "type": "string"
19017
+ },
19018
+ "licenseAssignmentState": {
19019
+ "description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user login will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;",
19020
+ "enum": [
19021
+ "LICENSE_ASSIGNMENT_STATE_UNSPECIFIED",
19022
+ "ASSIGNED",
19023
+ "UNASSIGNED",
19024
+ "NO_LICENSE",
19025
+ "NO_LICENSE_ATTEMPTED_LOGIN",
19026
+ "BLOCKED"
19027
+ ],
19028
+ "enumDescriptions": [
19029
+ "Default value.",
19030
+ "License assigned to the user.",
19031
+ "No license assigned to the user. Deprecated, translated to NO_LICENSE.",
19032
+ "No license assigned to the user.",
19033
+ "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).",
19034
+ "User is blocked from assigning a license."
19035
+ ],
19036
+ "readOnly": true,
19037
+ "type": "string"
19038
+ },
19039
+ "licenseConfig": {
19040
+ "description": "Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.",
19041
+ "type": "string"
19042
+ },
19043
+ "updateTime": {
19044
+ "description": "Output only. User update timestamp.",
19045
+ "format": "google-datetime",
19046
+ "readOnly": true,
19047
+ "type": "string"
19048
+ },
19049
+ "userPrincipal": {
19050
+ "description": "Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.",
19051
+ "type": "string"
19052
+ },
19053
+ "userProfile": {
19054
+ "description": "Optional. The user profile. We user user full name(First name + Last name) as user profile.",
19055
+ "type": "string"
19056
+ }
19057
+ },
19058
+ "type": "object"
19059
+ },
19060
+ "GoogleCloudDiscoveryengineV1UserStore": {
19061
+ "description": "Configures metadata that is used for End User entities.",
19062
+ "id": "GoogleCloudDiscoveryengineV1UserStore",
19063
+ "properties": {
19064
+ "defaultLicenseConfig": {
19065
+ "description": "Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.",
19066
+ "type": "string"
19067
+ },
19068
+ "displayName": {
19069
+ "description": "The display name of the User Store.",
19070
+ "type": "string"
19071
+ },
19072
+ "enableExpiredLicenseAutoUpdate": {
19073
+ "description": "Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.",
19074
+ "type": "boolean"
19075
+ },
19076
+ "enableLicenseAutoRegister": {
19077
+ "description": "Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.",
19078
+ "type": "boolean"
19079
+ },
19080
+ "name": {
19081
+ "description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
19082
+ "type": "string"
19083
+ }
19084
+ },
19085
+ "type": "object"
19086
+ },
19087
+ "GoogleCloudDiscoveryengineV1WidgetConfig": {
19088
+ "description": "WidgetConfig captures configs at the Widget level.",
19089
+ "id": "GoogleCloudDiscoveryengineV1WidgetConfig",
19090
+ "properties": {
19091
+ "accessSettings": {
19092
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings",
19093
+ "description": "Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties."
19094
+ },
19095
+ "allowPublicAccess": {
19096
+ "deprecated": true,
19097
+ "description": "Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server.",
19098
+ "type": "boolean"
19099
+ },
19100
+ "allowlistedDomains": {
19101
+ "deprecated": true,
19102
+ "description": "Allowlisted domains that can load this widget.",
19103
+ "items": {
19104
+ "type": "string"
19105
+ },
19106
+ "type": "array"
19107
+ },
19108
+ "assistantSettings": {
19109
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings",
19110
+ "description": "Optional. Output only. Describes the assistant settings of the widget.",
19111
+ "readOnly": true
19112
+ },
19113
+ "collectionComponents": {
19114
+ "description": "Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources.",
19115
+ "items": {
19116
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent"
19117
+ },
19118
+ "readOnly": true,
19119
+ "type": "array"
19120
+ },
19121
+ "configId": {
19122
+ "description": "Output only. Unique obfuscated identifier of a WidgetConfig.",
19123
+ "readOnly": true,
19124
+ "type": "string"
19125
+ },
19126
+ "contentSearchSpec": {
19127
+ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec",
19128
+ "deprecated": true,
19129
+ "description": "The content search spec that configs the desired behavior of content search."
19130
+ },
19131
+ "createTime": {
19132
+ "description": "Output only. Timestamp the WidgetConfig was created.",
19133
+ "format": "google-datetime",
19134
+ "readOnly": true,
19135
+ "type": "string"
19136
+ },
19137
+ "customerProvidedConfig": {
19138
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig",
19139
+ "description": "Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding.",
19140
+ "readOnly": true
19141
+ },
19142
+ "dataStoreType": {
19143
+ "description": "Output only. The type of the parent data store.",
19144
+ "enum": [
19145
+ "DATA_STORE_TYPE_UNSPECIFIED",
19146
+ "SITE_SEARCH",
19147
+ "STRUCTURED",
19148
+ "UNSTRUCTURED",
19149
+ "BLENDED"
19150
+ ],
19151
+ "enumDescriptions": [
19152
+ "Unspecified data store type.",
19153
+ "The parent data store contains a site search engine.",
19154
+ "The parent data store contains a search engine for structured data.",
19155
+ "The parent data store contains a search engine for unstructured data.",
19156
+ "The parent data store is served for blended search with multiple data stores."
19157
+ ],
19158
+ "readOnly": true,
19159
+ "type": "string"
19160
+ },
19161
+ "dataStoreUiConfigs": {
19162
+ "deprecated": true,
19163
+ "description": "Configurable UI configurations per data store.",
19164
+ "items": {
19165
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig"
19166
+ },
19167
+ "type": "array"
19168
+ },
19169
+ "defaultSearchRequestOrderBy": {
19170
+ "deprecated": true,
19171
+ "description": "The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body",
19172
+ "type": "string"
19173
+ },
19174
+ "displayName": {
19175
+ "description": "Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
19176
+ "type": "string"
19177
+ },
19178
+ "enableAutocomplete": {
19179
+ "deprecated": true,
19180
+ "description": "Whether or not to enable autocomplete.",
19181
+ "type": "boolean"
19182
+ },
19183
+ "enableConversationalSearch": {
19184
+ "deprecated": true,
19185
+ "description": "Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).",
19186
+ "type": "boolean"
19187
+ },
19188
+ "enablePrivateKnowledgeGraph": {
19189
+ "description": "Optional. Output only. Whether to enable private knowledge graph.",
19190
+ "readOnly": true,
19191
+ "type": "boolean"
19192
+ },
19193
+ "enableQualityFeedback": {
19194
+ "deprecated": true,
19195
+ "description": "Turn on or off collecting the search result quality feedback from end users.",
19196
+ "type": "boolean"
19197
+ },
19198
+ "enableResultScore": {
19199
+ "description": "Whether to show the result score.",
19200
+ "type": "boolean"
19201
+ },
19202
+ "enableSafeSearch": {
19203
+ "deprecated": true,
19204
+ "description": "Whether to enable safe search.",
19205
+ "type": "boolean"
19206
+ },
19207
+ "enableSearchAsYouType": {
19208
+ "deprecated": true,
19209
+ "description": "Whether to enable search-as-you-type behavior for the search widget",
19210
+ "type": "boolean"
19211
+ },
19212
+ "enableSnippetResultSummary": {
19213
+ "deprecated": true,
19214
+ "description": "Turn on or off summary for each snippets result.",
19215
+ "type": "boolean"
19216
+ },
19217
+ "enableSummarization": {
19218
+ "deprecated": true,
19219
+ "description": "Turn on or off summarization for the search response.",
19220
+ "type": "boolean"
19221
+ },
19222
+ "enableWebApp": {
19223
+ "deprecated": true,
19224
+ "description": "Whether to enable standalone web app.",
19225
+ "type": "boolean"
19226
+ },
19227
+ "facetField": {
19228
+ "deprecated": true,
19229
+ "description": "The configuration and appearance of facets in the end user view.",
19230
+ "items": {
19231
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigFacetField"
19232
+ },
19233
+ "type": "array"
19234
+ },
19235
+ "fieldsUiComponentsMap": {
19236
+ "additionalProperties": {
19237
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField"
19238
+ },
19239
+ "deprecated": true,
19240
+ "description": "The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.",
19241
+ "type": "object"
19242
+ },
19243
+ "geminiBundle": {
19244
+ "description": "Output only. Whether the subscription is gemini bundle or not.",
19245
+ "readOnly": true,
19246
+ "type": "boolean"
19247
+ },
19248
+ "homepageSetting": {
19249
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting",
19250
+ "description": "Optional. Describes the homepage settings of the widget."
19251
+ },
19252
+ "industryVertical": {
19253
+ "description": "Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.",
19254
+ "enum": [
19255
+ "INDUSTRY_VERTICAL_UNSPECIFIED",
19256
+ "GENERIC",
19257
+ "MEDIA",
19258
+ "HEALTHCARE_FHIR"
19259
+ ],
19260
+ "enumDescriptions": [
19261
+ "Value used when unset.",
19262
+ "The generic vertical for documents that are not specific to any industry vertical.",
19263
+ "The media industry vertical.",
19264
+ "The healthcare FHIR vertical."
19265
+ ],
19266
+ "readOnly": true,
19267
+ "type": "string"
19268
+ },
19269
+ "llmEnabled": {
19270
+ "description": "Output only. Whether LLM is enabled in the corresponding data store.",
19271
+ "readOnly": true,
19272
+ "type": "boolean"
19273
+ },
19274
+ "minimumDataTermAccepted": {
19275
+ "description": "Output only. Whether the customer accepted data use terms.",
19276
+ "readOnly": true,
19277
+ "type": "boolean"
19278
+ },
19279
+ "name": {
19280
+ "description": "Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
19281
+ "type": "string"
19282
+ },
19283
+ "resultDisplayType": {
19284
+ "deprecated": true,
19285
+ "description": "The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.",
19286
+ "enum": [
19287
+ "RESULT_DISPLAY_TYPE_UNSPECIFIED",
19288
+ "SNIPPET",
19289
+ "EXTRACTIVE_ANSWER"
19290
+ ],
19291
+ "enumDescriptions": [
19292
+ "Unspecified display type (default to showing snippet).",
19293
+ "Display results from the snippet field.",
19294
+ "Display results from extractive answers field."
19295
+ ],
19296
+ "type": "string"
19297
+ },
19298
+ "solutionType": {
19299
+ "description": "Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.",
19300
+ "enum": [
19301
+ "SOLUTION_TYPE_UNSPECIFIED",
19302
+ "SOLUTION_TYPE_RECOMMENDATION",
19303
+ "SOLUTION_TYPE_SEARCH",
19304
+ "SOLUTION_TYPE_CHAT",
19305
+ "SOLUTION_TYPE_GENERATIVE_CHAT"
19306
+ ],
19307
+ "enumDescriptions": [
19308
+ "Default value.",
19309
+ "Used for Recommendations AI.",
19310
+ "Used for Discovery Search.",
19311
+ "Used for use cases related to the Generative AI agent.",
19312
+ "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
19313
+ ],
19314
+ "type": "string"
19315
+ },
19316
+ "uiBranding": {
19317
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings",
19318
+ "description": "Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors."
19319
+ },
19320
+ "uiSettings": {
19321
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettings",
19322
+ "description": "Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties."
19323
+ },
19324
+ "updateTime": {
19325
+ "description": "Output only. Timestamp the WidgetConfig was updated.",
19326
+ "format": "google-datetime",
19327
+ "readOnly": true,
19328
+ "type": "string"
19329
+ }
19330
+ },
19331
+ "type": "object"
19332
+ },
19333
+ "GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings": {
19334
+ "description": "Describes widget access settings.",
19335
+ "id": "GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings",
19336
+ "properties": {
19337
+ "allowPublicAccess": {
19338
+ "description": "Whether public unauthenticated access is allowed.",
19339
+ "type": "boolean"
19340
+ },
19341
+ "allowlistedDomains": {
19342
+ "description": "List of domains that are allowed to integrate the search widget.",
19343
+ "items": {
19344
+ "type": "string"
19345
+ },
19346
+ "type": "array"
19347
+ },
19348
+ "enableWebApp": {
19349
+ "description": "Whether web app access is enabled.",
19350
+ "type": "boolean"
19351
+ },
19352
+ "languageCode": {
19353
+ "description": "Optional. Language code for user interface. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). If unset, the default language code is \"en-US\".",
19354
+ "type": "string"
19355
+ },
19356
+ "workforceIdentityPoolProvider": {
19357
+ "description": "Optional. The workforce identity pool provider used to access the widget.",
19358
+ "type": "string"
19359
+ }
19360
+ },
19361
+ "type": "object"
19362
+ },
19363
+ "GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings": {
19364
+ "description": "Describes the assistant settings of the widget.",
19365
+ "id": "GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings",
19366
+ "properties": {
19367
+ "defaultWebGroundingToggleOff": {
19368
+ "description": "Output only. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.",
19369
+ "readOnly": true,
19370
+ "type": "boolean"
19371
+ },
19372
+ "disableLocationContext": {
19373
+ "description": "Optional. Output only. Whether to disable user location context.",
19374
+ "readOnly": true,
19375
+ "type": "boolean"
19376
+ },
19377
+ "googleSearchGroundingEnabled": {
19378
+ "deprecated": true,
19379
+ "description": "Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead.",
19380
+ "type": "boolean"
19381
+ },
19382
+ "webGroundingType": {
19383
+ "description": "Optional. The type of web grounding to use.",
19384
+ "enum": [
19385
+ "WEB_GROUNDING_TYPE_UNSPECIFIED",
19386
+ "WEB_GROUNDING_TYPE_DISABLED",
19387
+ "WEB_GROUNDING_TYPE_GOOGLE_SEARCH",
19388
+ "WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH"
19389
+ ],
19390
+ "enumDescriptions": [
19391
+ "Default, unspecified setting. This is the same as disabled.",
19392
+ "Web grounding is disabled.",
19393
+ "Grounding with Google Search is enabled.",
19394
+ "Grounding with Enterprise Web Search is enabled."
19395
+ ],
19396
+ "type": "string"
19397
+ }
19398
+ },
19399
+ "type": "object"
19400
+ },
19401
+ "GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent": {
19402
+ "description": "Read-only collection component that contains data store collections fields that may be used for filtering",
19403
+ "id": "GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent",
19404
+ "properties": {
19405
+ "connectorIconLink": {
19406
+ "description": "Output only. The icon link of the connector source.",
19407
+ "readOnly": true,
19408
+ "type": "string"
19409
+ },
19410
+ "dataSource": {
19411
+ "description": "The name of the data source, retrieved from `Collection.data_connector.data_source`.",
19412
+ "type": "string"
19413
+ },
19414
+ "dataSourceDisplayName": {
19415
+ "description": "Output only. The display name of the data source.",
19416
+ "readOnly": true,
19417
+ "type": "string"
19418
+ },
19419
+ "dataStoreComponents": {
19420
+ "description": "For the data store collection, list of the children data stores.",
19421
+ "items": {
19422
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigDataStoreComponent"
19423
+ },
19424
+ "type": "array"
19425
+ },
19426
+ "displayName": {
19427
+ "description": "The display name of the collection.",
19428
+ "type": "string"
19429
+ },
19430
+ "id": {
19431
+ "description": "Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID.",
19432
+ "readOnly": true,
19433
+ "type": "string"
19434
+ },
19435
+ "name": {
19436
+ "description": "The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.",
19437
+ "type": "string"
19438
+ }
19439
+ },
19440
+ "type": "object"
19441
+ },
19442
+ "GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig": {
19443
+ "description": "Customer provided configurations.",
19444
+ "id": "GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig",
19445
+ "properties": {
19446
+ "customerType": {
19447
+ "description": "Customer type.",
19448
+ "enum": [
19449
+ "DEFAULT_CUSTOMER",
19450
+ "GOVERNMENT_CUSTOMER"
19451
+ ],
19452
+ "enumDescriptions": [
19453
+ "Default customer type.",
19454
+ "Government customer type. Some features are disabled for government customers due to legal requirements."
19455
+ ],
19456
+ "type": "string"
19457
+ }
19458
+ },
19459
+ "type": "object"
19460
+ },
19461
+ "GoogleCloudDiscoveryengineV1WidgetConfigDataStoreComponent": {
19462
+ "description": "Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.",
19463
+ "id": "GoogleCloudDiscoveryengineV1WidgetConfigDataStoreComponent",
19464
+ "properties": {
19465
+ "dataStoreConfigType": {
19466
+ "description": "Output only. The type of the data store config.",
19467
+ "enum": [
19468
+ "DATA_STORE_CONFIG_TYPE_UNSPECIFIED",
19469
+ "ALLOW_DB_CONFIG",
19470
+ "THIRD_PARTY_OAUTH_CONFIG",
19471
+ "NOTEBOOKLM_CONFIG"
19472
+ ],
19473
+ "enumDescriptions": [
19474
+ "Default value. This value is unused.",
19475
+ "The data store is connected to AlloyDB",
19476
+ "The data store is a connected to a third party data source.",
19477
+ "The data store is a connected to NotebookLM Enterprise."
19478
+ ],
19479
+ "readOnly": true,
19480
+ "type": "string"
19481
+ },
19482
+ "displayName": {
19483
+ "description": "The display name of the data store.",
19484
+ "type": "string"
19485
+ },
19486
+ "entityName": {
19487
+ "description": "The name of the entity, retrieved from `Collection.data_connector.entities.entityName`.",
19488
+ "type": "string"
19489
+ },
19490
+ "id": {
19491
+ "description": "Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.",
19492
+ "readOnly": true,
19493
+ "type": "string"
19494
+ },
19495
+ "name": {
19496
+ "description": "The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.",
19497
+ "type": "string"
19498
+ }
19499
+ },
19500
+ "type": "object"
19501
+ },
19502
+ "GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig": {
19503
+ "description": "UI component configuration for data store.",
19504
+ "id": "GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig",
19505
+ "properties": {
19506
+ "facetField": {
19507
+ "description": "Facet fields that store the mapping of fields to end user widget appearance.",
19508
+ "items": {
19509
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigFacetField"
19510
+ },
19511
+ "type": "array"
19512
+ },
19513
+ "fieldsUiComponentsMap": {
19514
+ "additionalProperties": {
19515
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField"
19516
+ },
19517
+ "description": "The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.",
19518
+ "type": "object"
19519
+ },
19520
+ "id": {
19521
+ "description": "Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.",
19522
+ "readOnly": true,
19523
+ "type": "string"
19524
+ },
19525
+ "name": {
19526
+ "description": "The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.",
19527
+ "type": "string"
19528
+ }
19529
+ },
19530
+ "type": "object"
19531
+ },
19532
+ "GoogleCloudDiscoveryengineV1WidgetConfigFacetField": {
19533
+ "description": "Facet fields that store the mapping of fields to end user widget appearance.",
19534
+ "id": "GoogleCloudDiscoveryengineV1WidgetConfigFacetField",
18159
19535
  "properties": {
18160
- "createTime": {
18161
- "description": "Operation create time.",
18162
- "format": "google-datetime",
19536
+ "displayName": {
19537
+ "description": "Optional. The field name that end users will see.",
18163
19538
  "type": "string"
18164
19539
  },
18165
- "updateTime": {
18166
- "description": "Operation last update time. If the operation is done, this is also the finish time.",
18167
- "format": "google-datetime",
19540
+ "field": {
19541
+ "description": "Required. Registered field name. The format is `field.abc`.",
18168
19542
  "type": "string"
18169
19543
  }
18170
19544
  },
18171
19545
  "type": "object"
18172
19546
  },
18173
- "GoogleCloudDiscoveryengineV1UserEvent": {
18174
- "description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.",
18175
- "id": "GoogleCloudDiscoveryengineV1UserEvent",
19547
+ "GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting": {
19548
+ "description": "Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts.",
19549
+ "id": "GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting",
18176
19550
  "properties": {
18177
- "attributes": {
18178
- "additionalProperties": {
18179
- "$ref": "GoogleCloudDiscoveryengineV1CustomAttribute"
19551
+ "shortcuts": {
19552
+ "description": "Optional. The shortcuts to display on the homepage.",
19553
+ "items": {
19554
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigHomepageSettingShortcut"
19555
+ },
19556
+ "type": "array"
19557
+ }
18180
19558
  },
18181
- "description": "Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.",
18182
19559
  "type": "object"
18183
19560
  },
18184
- "attributionToken": {
18185
- "description": "Token to attribute an API response to user action(s) to trigger the event. Highly recommended for user events that are the result of RecommendationService.Recommend. This field enables accurate attribution of recommendation model performance. The value must be one of: * RecommendResponse.attribution_token for events that are the result of RecommendationService.Recommend. * SearchResponse.attribution_token for events that are the result of SearchService.Search. This token enables us to accurately attribute page view or conversion completion back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass RecommendResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the RecommendResponse.attribution_token to this field.",
19561
+ "GoogleCloudDiscoveryengineV1WidgetConfigHomepageSettingShortcut": {
19562
+ "description": "Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.",
19563
+ "id": "GoogleCloudDiscoveryengineV1WidgetConfigHomepageSettingShortcut",
19564
+ "properties": {
19565
+ "destinationUri": {
19566
+ "description": "Optional. Destination URL of shortcut.",
18186
19567
  "type": "string"
18187
19568
  },
18188
- "completionInfo": {
18189
- "$ref": "GoogleCloudDiscoveryengineV1CompletionInfo",
18190
- "description": "CompletionService.CompleteQuery details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search."
19569
+ "icon": {
19570
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigImage",
19571
+ "description": "Optional. Icon URL of shortcut."
18191
19572
  },
18192
- "conversionType": {
18193
- "description": "Optional. Conversion type. Required if UserEvent.event_type is `conversion`. This is a customer-defined conversion name in lowercase letters or numbers separated by \"-\", such as \"watch\", \"good-visit\" etc. Do not set the field if UserEvent.event_type is not `conversion`. This mixes the custom conversion event with predefined events like `search`, `view-item` etc.",
19573
+ "title": {
19574
+ "description": "Optional. Title of the shortcut.",
18194
19575
  "type": "string"
19576
+ }
18195
19577
  },
18196
- "dataStore": {
18197
- "description": "The DataStore resource full name, of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Optional. Only required for user events whose data store can't by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted.",
19578
+ "type": "object"
19579
+ },
19580
+ "GoogleCloudDiscoveryengineV1WidgetConfigImage": {
19581
+ "description": "Options to store an image.",
19582
+ "id": "GoogleCloudDiscoveryengineV1WidgetConfigImage",
19583
+ "properties": {
19584
+ "url": {
19585
+ "description": "Image URL.",
18198
19586
  "type": "string"
19587
+ }
18199
19588
  },
18200
- "directUserRequest": {
18201
- "description": "Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.",
18202
- "type": "boolean"
19589
+ "type": "object"
18203
19590
  },
18204
- "documents": {
18205
- "description": "List of Documents associated with this user event. This field is optional except for the following event types: * `view-item` * `add-to-cart` * `purchase` * `media-play` * `media-complete` In a `search` event, this field represents the documents returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new `search` event with different UserEvent.documents is desired.",
19591
+ "GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField": {
19592
+ "description": "Facet field that maps to a UI Component.",
19593
+ "id": "GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField",
19594
+ "properties": {
19595
+ "deviceVisibility": {
19596
+ "description": "The field visibility on different types of devices.",
18206
19597
  "items": {
18207
- "$ref": "GoogleCloudDiscoveryengineV1DocumentInfo"
18208
- },
18209
- "type": "array"
18210
- },
18211
- "engine": {
18212
- "description": "The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search.",
19598
+ "enum": [
19599
+ "DEVICE_VISIBILITY_UNSPECIFIED",
19600
+ "MOBILE",
19601
+ "DESKTOP"
19602
+ ],
19603
+ "enumDescriptions": [
19604
+ "Default value when not specified. Server returns INVALID_ARGUMENT if used in requests.",
19605
+ "The UI component is visible on Mobile devices.",
19606
+ "The UI component is visible on Browser-based client."
19607
+ ],
18213
19608
  "type": "string"
18214
19609
  },
18215
- "eventTime": {
18216
- "description": "Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.",
18217
- "format": "google-datetime",
18218
- "type": "string"
19610
+ "type": "array"
18219
19611
  },
18220
- "eventType": {
18221
- "description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.",
19612
+ "displayTemplate": {
19613
+ "description": "The template to customize how the field is displayed. An example value would be a string that looks like: \"Price: {value}\".",
18222
19614
  "type": "string"
18223
19615
  },
18224
- "filter": {
18225
- "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
19616
+ "field": {
19617
+ "description": "Required. Registered field name. The format is `field.abc`.",
18226
19618
  "type": "string"
19619
+ }
18227
19620
  },
18228
- "mediaInfo": {
18229
- "$ref": "GoogleCloudDiscoveryengineV1MediaInfo",
18230
- "description": "Media-specific info."
19621
+ "type": "object"
18231
19622
  },
18232
- "pageInfo": {
18233
- "$ref": "GoogleCloudDiscoveryengineV1PageInfo",
18234
- "description": "Page metadata such as categories and other critical information for certain event types such as `view-category-page`."
19623
+ "GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings": {
19624
+ "description": "Describes widget UI branding settings.",
19625
+ "id": "GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings",
19626
+ "properties": {
19627
+ "logo": {
19628
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigImage",
19629
+ "description": "Logo image."
19630
+ }
18235
19631
  },
18236
- "panel": {
18237
- "$ref": "GoogleCloudDiscoveryengineV1PanelInfo",
18238
- "description": "Panel metadata associated with this user event."
19632
+ "type": "object"
18239
19633
  },
18240
- "panels": {
18241
- "description": "Optional. List of panels associated with this event. Used for page-level impression data.",
19634
+ "GoogleCloudDiscoveryengineV1WidgetConfigUiSettings": {
19635
+ "description": "Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page.",
19636
+ "id": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettings",
19637
+ "properties": {
19638
+ "dataStoreUiConfigs": {
19639
+ "description": "Per data store configuration.",
18242
19640
  "items": {
18243
- "$ref": "GoogleCloudDiscoveryengineV1PanelInfo"
19641
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig"
18244
19642
  },
18245
19643
  "type": "array"
18246
19644
  },
18247
- "promotionIds": {
18248
- "description": "The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.",
18249
- "items": {
19645
+ "defaultSearchRequestOrderBy": {
19646
+ "description": "The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body",
18250
19647
  "type": "string"
18251
19648
  },
18252
- "type": "array"
19649
+ "disableUserEventsCollection": {
19650
+ "description": "If set to true, the widget will not collect user events.",
19651
+ "type": "boolean"
18253
19652
  },
18254
- "searchInfo": {
18255
- "$ref": "GoogleCloudDiscoveryengineV1SearchInfo",
18256
- "description": "SearchService.Search details related to the event. This field should be set for `search` event."
19653
+ "enableAutocomplete": {
19654
+ "description": "Whether or not to enable autocomplete.",
19655
+ "type": "boolean"
18257
19656
  },
18258
- "sessionId": {
18259
- "description": "A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.",
18260
- "type": "string"
19657
+ "enableCreateAgentButton": {
19658
+ "description": "Optional. If set to true, the widget will enable the create agent button.",
19659
+ "type": "boolean"
18261
19660
  },
18262
- "tagIds": {
18263
- "description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.",
18264
- "items": {
18265
- "type": "string"
19661
+ "enablePeopleSearch": {
19662
+ "description": "Optional. If set to true, the widget will enable people search.",
19663
+ "type": "boolean"
18266
19664
  },
18267
- "type": "array"
19665
+ "enableQualityFeedback": {
19666
+ "description": "Turn on or off collecting the search result quality feedback from end users.",
19667
+ "type": "boolean"
18268
19668
  },
18269
- "transactionInfo": {
18270
- "$ref": "GoogleCloudDiscoveryengineV1TransactionInfo",
18271
- "description": "The transaction metadata (if any) associated with this user event."
19669
+ "enableSafeSearch": {
19670
+ "description": "Whether to enable safe search.",
19671
+ "type": "boolean"
18272
19672
  },
18273
- "userInfo": {
18274
- "$ref": "GoogleCloudDiscoveryengineV1UserInfo",
18275
- "description": "Information about the end user."
19673
+ "enableSearchAsYouType": {
19674
+ "description": "Whether to enable search-as-you-type behavior for the search widget.",
19675
+ "type": "boolean"
18276
19676
  },
18277
- "userPseudoId": {
18278
- "description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.",
19677
+ "enableVisualContentSummary": {
19678
+ "description": "If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.",
19679
+ "type": "boolean"
19680
+ },
19681
+ "features": {
19682
+ "additionalProperties": {
19683
+ "enum": [
19684
+ "FEATURE_STATE_UNSPECIFIED",
19685
+ "FEATURE_STATE_ON",
19686
+ "FEATURE_STATE_OFF"
19687
+ ],
19688
+ "enumDescriptions": [
19689
+ "The feature state is unspecified.",
19690
+ "The feature is turned on to be accessible.",
19691
+ "The feature is turned off to be inaccessible."
19692
+ ],
18279
19693
  "type": "string"
18280
- }
18281
19694
  },
19695
+ "description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`",
19696
+ "readOnly": true,
18282
19697
  "type": "object"
18283
19698
  },
18284
- "GoogleCloudDiscoveryengineV1UserInfo": {
18285
- "description": "Information of an end user.",
18286
- "id": "GoogleCloudDiscoveryengineV1UserInfo",
18287
- "properties": {
18288
- "timeZone": {
18289
- "description": "Optional. IANA time zone, e.g. Europe/Budapest.",
19699
+ "generativeAnswerConfig": {
19700
+ "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig",
19701
+ "description": "Describes generative answer configuration."
19702
+ },
19703
+ "interactionType": {
19704
+ "description": "Describes widget (or web app) interaction type",
19705
+ "enum": [
19706
+ "INTERACTION_TYPE_UNSPECIFIED",
19707
+ "SEARCH_ONLY",
19708
+ "SEARCH_WITH_ANSWER",
19709
+ "SEARCH_WITH_FOLLOW_UPS"
19710
+ ],
19711
+ "enumDescriptions": [
19712
+ "Not specified. Defaults to SEARCH_ONLY.",
19713
+ "Search without a generative answer.",
19714
+ "Search with the generative answer.",
19715
+ "Search with the generative answer that supports follow up questions. Also known as multi-turn search."
19716
+ ],
18290
19717
  "type": "string"
18291
19718
  },
18292
- "userAgent": {
18293
- "description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.",
19719
+ "modelConfigs": {
19720
+ "additionalProperties": {
19721
+ "enum": [
19722
+ "MODEL_STATE_UNSPECIFIED",
19723
+ "MODEL_ENABLED",
19724
+ "MODEL_DISABLED"
19725
+ ],
19726
+ "enumDescriptions": [
19727
+ "The model state is unspecified.",
19728
+ "The model is enabled by admin.",
19729
+ "The model is disabled by admin."
19730
+ ],
18294
19731
  "type": "string"
18295
19732
  },
18296
- "userId": {
18297
- "description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
19733
+ "description": "Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.",
19734
+ "readOnly": true,
19735
+ "type": "object"
19736
+ },
19737
+ "resultDescriptionType": {
19738
+ "description": "Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.",
19739
+ "enum": [
19740
+ "RESULT_DISPLAY_TYPE_UNSPECIFIED",
19741
+ "SNIPPET",
19742
+ "EXTRACTIVE_ANSWER"
19743
+ ],
19744
+ "enumDescriptions": [
19745
+ "Unspecified display type (default to showing snippet).",
19746
+ "Display results from the snippet field.",
19747
+ "Display results from extractive answers field."
19748
+ ],
18298
19749
  "type": "string"
18299
19750
  }
18300
19751
  },
18301
19752
  "type": "object"
18302
19753
  },
18303
- "GoogleCloudDiscoveryengineV1UserLicense": {
18304
- "description": "User License information assigned by the admin.",
18305
- "id": "GoogleCloudDiscoveryengineV1UserLicense",
19754
+ "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig": {
19755
+ "description": "Describes configuration for generative answer.",
19756
+ "id": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig",
18306
19757
  "properties": {
18307
- "createTime": {
18308
- "description": "Output only. User created timestamp.",
18309
- "format": "google-datetime",
18310
- "readOnly": true,
18311
- "type": "string"
19758
+ "disableRelatedQuestions": {
19759
+ "description": "Whether generated answer contains suggested related questions.",
19760
+ "type": "boolean"
18312
19761
  },
18313
- "lastLoginTime": {
18314
- "description": "Output only. User last logged in time. If the user has not logged in yet, this field will be empty.",
18315
- "format": "google-datetime",
18316
- "readOnly": true,
18317
- "type": "string"
19762
+ "ignoreAdversarialQuery": {
19763
+ "description": "Optional. Specifies whether to filter out queries that are adversarial.",
19764
+ "type": "boolean"
18318
19765
  },
18319
- "licenseAssignmentState": {
18320
- "description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user login will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;",
19766
+ "ignoreLowRelevantContent": {
19767
+ "description": "Optional. Specifies whether to filter out queries that are not relevant to the content.",
19768
+ "type": "boolean"
19769
+ },
19770
+ "ignoreNonAnswerSeekingQuery": {
19771
+ "description": "Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.",
19772
+ "type": "boolean"
19773
+ },
19774
+ "imageSource": {
19775
+ "description": "Optional. Source of image returned in the answer.",
18321
19776
  "enum": [
18322
- "LICENSE_ASSIGNMENT_STATE_UNSPECIFIED",
18323
- "ASSIGNED",
18324
- "UNASSIGNED",
18325
- "NO_LICENSE",
18326
- "NO_LICENSE_ATTEMPTED_LOGIN",
18327
- "BLOCKED"
19777
+ "IMAGE_SOURCE_UNSPECIFIED",
19778
+ "ALL_AVAILABLE_SOURCES",
19779
+ "CORPUS_IMAGE_ONLY",
19780
+ "FIGURE_GENERATION_ONLY"
18328
19781
  ],
18329
19782
  "enumDescriptions": [
18330
- "Default value.",
18331
- "License assigned to the user.",
18332
- "No license assigned to the user. Deprecated, translated to NO_LICENSE.",
18333
- "No license assigned to the user.",
18334
- "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).",
18335
- "User is blocked from assigning a license."
19783
+ "Unspecified image source (multimodal feature is disabled by default)",
19784
+ "Behavior when service determines the pick from all available sources.",
19785
+ "Include image from corpus in the answer.",
19786
+ "Triggers figure generation in the answer."
18336
19787
  ],
18337
- "readOnly": true,
18338
19788
  "type": "string"
18339
19789
  },
18340
- "licenseConfig": {
18341
- "description": "Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.",
19790
+ "languageCode": {
19791
+ "description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.",
18342
19792
  "type": "string"
18343
19793
  },
18344
- "updateTime": {
18345
- "description": "Output only. User update timestamp.",
18346
- "format": "google-datetime",
18347
- "readOnly": true,
18348
- "type": "string"
19794
+ "maxRephraseSteps": {
19795
+ "description": "Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.",
19796
+ "format": "int32",
19797
+ "type": "integer"
18349
19798
  },
18350
- "userPrincipal": {
18351
- "description": "Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.",
19799
+ "modelPromptPreamble": {
19800
+ "description": "Text at the beginning of the prompt that instructs the model that generates the answer.",
18352
19801
  "type": "string"
18353
19802
  },
18354
- "userProfile": {
18355
- "description": "Optional. The user profile. We user user full name(First name + Last name) as user profile.",
19803
+ "modelVersion": {
19804
+ "description": "The model version used to generate the answer.",
18356
19805
  "type": "string"
19806
+ },
19807
+ "resultCount": {
19808
+ "description": "The number of top results to generate the answer from. Up to 10.",
19809
+ "format": "int32",
19810
+ "type": "integer"
18357
19811
  }
18358
19812
  },
18359
19813
  "type": "object"
@@ -20582,7 +22036,8 @@ false
20582
22036
  "NATIVE_CLOUD_IDENTITY",
20583
22037
  "THIRD_PARTY_FEDERATED",
20584
22038
  "THIRD_PARTY_EUA",
20585
- "GCNV"
22039
+ "GCNV",
22040
+ "GOOGLE_CHAT"
20586
22041
  ],
20587
22042
  "enumDescriptions": [
20588
22043
  "Default value.",
@@ -20596,7 +22051,8 @@ false
20596
22051
  "Native Cloud Identity connector for people search powered by People API.",
20597
22052
  "Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.",
20598
22053
  "Connector utilized for End User Authentication features.",
20599
- "Google Cloud NetApp Volumes connector."
22054
+ "Google Cloud NetApp Volumes connector.",
22055
+ "Google Chat connector."
20600
22056
  ],
20601
22057
  "readOnly": true,
20602
22058
  "type": "string"
@@ -20994,6 +22450,12 @@ false
20994
22450
  ],
20995
22451
  "type": "string"
20996
22452
  },
22453
+ "configurableBillingApproachUpdateTime": {
22454
+ "description": "Output only. The timestamp when configurable_billing_approach was last updated.",
22455
+ "format": "google-datetime",
22456
+ "readOnly": true,
22457
+ "type": "string"
22458
+ },
20997
22459
  "contentConfig": {
20998
22460
  "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.",
20999
22461
  "enum": [
@@ -21187,6 +22649,23 @@ false
21187
22649
  },
21188
22650
  "type": "object"
21189
22651
  },
22652
+ "GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata": {
22653
+ "description": "Metadata related to the progress of the AgentService.DeleteAgent operation. This will be returned by the google.longrunning.Operation.metadata field.",
22654
+ "id": "GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata",
22655
+ "properties": {
22656
+ "createTime": {
22657
+ "description": "Operation create time.",
22658
+ "format": "google-datetime",
22659
+ "type": "string"
22660
+ },
22661
+ "updateTime": {
22662
+ "description": "Operation last update time. If the operation is done, this is also the finish time.",
22663
+ "format": "google-datetime",
22664
+ "type": "string"
22665
+ }
22666
+ },
22667
+ "type": "object"
22668
+ },
21190
22669
  "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata": {
21191
22670
  "description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.",
21192
22671
  "id": "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata",
@@ -21334,6 +22813,23 @@ false
21334
22813
  },
21335
22814
  "type": "object"
21336
22815
  },
22816
+ "GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata": {
22817
+ "description": "Metadata related to the progress of the UserStoreService.DeleteUserStore operation. This will be returned by the google.longrunning.Operation.metadata field. Delete UserStore will delete all the end users under the user store, return the number of end users successfully deleted or failed to delete in the metadata.",
22818
+ "id": "GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata",
22819
+ "properties": {
22820
+ "failureCount": {
22821
+ "description": "The number of end users under the user store that failed to be deleted.",
22822
+ "format": "int64",
22823
+ "type": "string"
22824
+ },
22825
+ "successCount": {
22826
+ "description": "The number of end users under the user store that were successfully deleted.",
22827
+ "format": "int64",
22828
+ "type": "string"
22829
+ }
22830
+ },
22831
+ "type": "object"
22832
+ },
21337
22833
  "GoogleCloudDiscoveryengineV1alphaDestinationConfig": {
21338
22834
  "description": "Defines target endpoints used to connect to third-party sources.",
21339
22835
  "id": "GoogleCloudDiscoveryengineV1alphaDestinationConfig",
@@ -21493,6 +22989,10 @@ false
21493
22989
  "description": "Optional. If true, the LLM based annotation is added to the image during parsing.",
21494
22990
  "type": "boolean"
21495
22991
  },
22992
+ "enableLlmLayoutParsing": {
22993
+ "description": "Optional. If true, the pdf layout will be refined using an LLM.",
22994
+ "type": "boolean"
22995
+ },
21496
22996
  "enableTableAnnotation": {
21497
22997
  "description": "Optional. If true, the LLM based annotation is added to the table during parsing.",
21498
22998
  "type": "boolean"
@@ -21595,6 +23095,11 @@ false
21595
23095
  "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.",
21596
23096
  "readOnly": true
21597
23097
  },
23098
+ "cmekConfig": {
23099
+ "$ref": "GoogleCloudDiscoveryengineV1alphaCmekConfig",
23100
+ "description": "Output only. CMEK-related information for the Engine.",
23101
+ "readOnly": true
23102
+ },
21598
23103
  "commonConfig": {
21599
23104
  "$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig",
21600
23105
  "description": "Common config spec that specifies the metadata of the engine."
@@ -21669,6 +23174,23 @@ false
21669
23174
  "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig",
21670
23175
  "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical."
21671
23176
  },
23177
+ "modelConfigs": {
23178
+ "additionalProperties": {
23179
+ "enum": [
23180
+ "MODEL_STATE_UNSPECIFIED",
23181
+ "MODEL_ENABLED",
23182
+ "MODEL_DISABLED"
23183
+ ],
23184
+ "enumDescriptions": [
23185
+ "The model state is unspecified.",
23186
+ "The model is enabled by admin.",
23187
+ "The model is disabled by admin."
23188
+ ],
23189
+ "type": "string"
23190
+ },
23191
+ "description": "Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.",
23192
+ "type": "object"
23193
+ },
21672
23194
  "name": {
21673
23195
  "description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.",
21674
23196
  "type": "string"
@@ -21928,6 +23450,40 @@ false
21928
23450
  "description": "Configurations for a Search Engine.",
21929
23451
  "id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig",
21930
23452
  "properties": {
23453
+ "requiredSubscriptionTier": {
23454
+ "description": "Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.",
23455
+ "enum": [
23456
+ "SUBSCRIPTION_TIER_UNSPECIFIED",
23457
+ "SUBSCRIPTION_TIER_SEARCH",
23458
+ "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT",
23459
+ "SUBSCRIPTION_TIER_NOTEBOOK_LM",
23460
+ "SUBSCRIPTION_TIER_FRONTLINE_WORKER",
23461
+ "SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
23462
+ "SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
23463
+ "SUBSCRIPTION_TIER_ENTERPRISE",
23464
+ "SUBSCRIPTION_TIER_EDU",
23465
+ "SUBSCRIPTION_TIER_EDU_PRO",
23466
+ "SUBSCRIPTION_TIER_EDU_EMERGING",
23467
+ "SUBSCRIPTION_TIER_EDU_PRO_EMERGING",
23468
+ "SUBSCRIPTION_TIER_FRONTLINE_STARTER"
23469
+ ],
23470
+ "enumDescriptions": [
23471
+ "Default value.",
23472
+ "Search tier. Search tier can access VAIS search features and NotebookLM features.",
23473
+ "Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
23474
+ "NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
23475
+ "Frontline worker tier.",
23476
+ "Agentspace Starter tier.",
23477
+ "Agentspace Business tier.",
23478
+ "Enterprise tier.",
23479
+ "EDU tier.",
23480
+ "EDU Pro tier.",
23481
+ "EDU emerging market tier.",
23482
+ "EDU Pro emerging market tier.",
23483
+ "Frontline starter tier."
23484
+ ],
23485
+ "type": "string"
23486
+ },
21931
23487
  "searchAddOns": {
21932
23488
  "description": "The add-on that this search engine enables.",
21933
23489
  "items": {
@@ -22791,7 +24347,8 @@ false
22791
24347
  "SUBSCRIPTION_TIER_EDU",
22792
24348
  "SUBSCRIPTION_TIER_EDU_PRO",
22793
24349
  "SUBSCRIPTION_TIER_EDU_EMERGING",
22794
- "SUBSCRIPTION_TIER_EDU_PRO_EMERGING"
24350
+ "SUBSCRIPTION_TIER_EDU_PRO_EMERGING",
24351
+ "SUBSCRIPTION_TIER_FRONTLINE_STARTER"
22795
24352
  ],
22796
24353
  "enumDescriptions": [
22797
24354
  "Default value.",
@@ -22805,7 +24362,8 @@ false
22805
24362
  "EDU tier.",
22806
24363
  "EDU Pro tier.",
22807
24364
  "EDU emerging market tier.",
22808
- "EDU Pro emerging market tier."
24365
+ "EDU Pro emerging market tier.",
24366
+ "Frontline starter tier."
22809
24367
  ],
22810
24368
  "type": "string"
22811
24369
  }
@@ -22932,6 +24490,11 @@ false
22932
24490
  "description": "Metadata and configurations for a Google Cloud project in the service.",
22933
24491
  "id": "GoogleCloudDiscoveryengineV1alphaProject",
22934
24492
  "properties": {
24493
+ "configurableBillingStatus": {
24494
+ "$ref": "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus",
24495
+ "description": "Output only. The current status of the project's configurable billing.",
24496
+ "readOnly": true
24497
+ },
22935
24498
  "createTime": {
22936
24499
  "description": "Output only. The timestamp when this project is created.",
22937
24500
  "format": "google-datetime",
@@ -22964,6 +24527,28 @@ false
22964
24527
  },
22965
24528
  "type": "object"
22966
24529
  },
24530
+ "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus": {
24531
+ "description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).",
24532
+ "id": "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus",
24533
+ "properties": {
24534
+ "effectiveIndexingCoreThreshold": {
24535
+ "description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.",
24536
+ "format": "int64",
24537
+ "type": "string"
24538
+ },
24539
+ "effectiveSearchQpmThreshold": {
24540
+ "description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.",
24541
+ "format": "int64",
24542
+ "type": "string"
24543
+ },
24544
+ "startTime": {
24545
+ "description": "Optional. The start time of the currently active billing subscription.",
24546
+ "format": "google-datetime",
24547
+ "type": "string"
24548
+ }
24549
+ },
24550
+ "type": "object"
24551
+ },
22967
24552
  "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig": {
22968
24553
  "description": "Customer provided configurations.",
22969
24554
  "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig",
@@ -22982,6 +24567,10 @@ false
22982
24567
  "modelArmorConfig": {
22983
24568
  "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
22984
24569
  "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
24570
+ },
24571
+ "optOutNotebookSharing": {
24572
+ "description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.",
24573
+ "type": "boolean"
22985
24574
  }
22986
24575
  },
22987
24576
  "type": "object"
@@ -23624,6 +25213,13 @@ false
23624
25213
  "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec",
23625
25214
  "description": "A specification for configuring the behavior of content search."
23626
25215
  },
25216
+ "crowdingSpecs": {
25217
+ "description": "Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = \"color\" and `max_count` = 3, and the second CrowdingSpec has `field` = \"size\" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.",
25218
+ "items": {
25219
+ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec"
25220
+ },
25221
+ "type": "array"
25222
+ },
23627
25223
  "customFineTuningSpec": {
23628
25224
  "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec",
23629
25225
  "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec."
@@ -23680,6 +25276,13 @@ false
23680
25276
  "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.",
23681
25277
  "type": "string"
23682
25278
  },
25279
+ "pageCategories": {
25280
+ "description": "Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '>' character to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders Edition` where \"RTX > 4090\" represents one level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition`",
25281
+ "items": {
25282
+ "type": "string"
25283
+ },
25284
+ "type": "array"
25285
+ },
23683
25286
  "pageSize": {
23684
25287
  "description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.",
23685
25288
  "format": "int32",
@@ -23741,12 +25344,16 @@ false
23741
25344
  "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.",
23742
25345
  "type": "string"
23743
25346
  },
25347
+ "relevanceFilterSpec": {
25348
+ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec",
25349
+ "description": "Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search."
25350
+ },
23744
25351
  "relevanceScoreSpec": {
23745
25352
  "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec",
23746
25353
  "description": "Optional. The specification for returning the relevance score."
23747
25354
  },
23748
25355
  "relevanceThreshold": {
23749
- "description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.",
25356
+ "description": "The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.",
23750
25357
  "enum": [
23751
25358
  "RELEVANCE_THRESHOLD_UNSPECIFIED",
23752
25359
  "LOWEST",
@@ -23807,7 +25414,7 @@ false
23807
25414
  "type": "object"
23808
25415
  },
23809
25416
  "userPseudoId": {
23810
- "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
25417
+ "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
23811
25418
  "type": "string"
23812
25419
  }
23813
25420
  },
@@ -24111,6 +25718,36 @@ false
24111
25718
  },
24112
25719
  "type": "object"
24113
25720
  },
25721
+ "GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec": {
25722
+ "description": "Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.",
25723
+ "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec",
25724
+ "properties": {
25725
+ "field": {
25726
+ "description": "The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.",
25727
+ "type": "string"
25728
+ },
25729
+ "maxCount": {
25730
+ "description": "The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are \"crowded away\". If not specified, the default value is 1.",
25731
+ "format": "int32",
25732
+ "type": "integer"
25733
+ },
25734
+ "mode": {
25735
+ "description": "Mode to use for documents that are crowded away.",
25736
+ "enum": [
25737
+ "MODE_UNSPECIFIED",
25738
+ "DROP_CROWDED_RESULTS",
25739
+ "DEMOTE_CROWDED_RESULTS_TO_END"
25740
+ ],
25741
+ "enumDescriptions": [
25742
+ "Unspecified crowding mode. In this case, server behavior defaults to Mode.DROP_CROWDED_RESULTS.",
25743
+ "Drop crowded results.",
25744
+ "Demote crowded results to the later pages."
25745
+ ],
25746
+ "type": "string"
25747
+ }
25748
+ },
25749
+ "type": "object"
25750
+ },
24114
25751
  "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": {
24115
25752
  "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.",
24116
25753
  "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec",
@@ -24368,6 +26005,51 @@ false
24368
26005
  },
24369
26006
  "type": "object"
24370
26007
  },
26008
+ "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec": {
26009
+ "description": "Relevance filtering specification.",
26010
+ "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec",
26011
+ "properties": {
26012
+ "keywordSearchThreshold": {
26013
+ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec",
26014
+ "description": "Optional. Relevance filtering threshold specification for keyword search."
26015
+ },
26016
+ "semanticSearchThreshold": {
26017
+ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec",
26018
+ "description": "Optional. Relevance filtering threshold specification for semantic search."
26019
+ }
26020
+ },
26021
+ "type": "object"
26022
+ },
26023
+ "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec": {
26024
+ "description": "Specification for relevance filtering on a specific sub-search.",
26025
+ "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec",
26026
+ "properties": {
26027
+ "relevanceThreshold": {
26028
+ "description": "Pre-defined relevance threshold for the sub-search.",
26029
+ "enum": [
26030
+ "RELEVANCE_THRESHOLD_UNSPECIFIED",
26031
+ "LOWEST",
26032
+ "LOW",
26033
+ "MEDIUM",
26034
+ "HIGH"
26035
+ ],
26036
+ "enumDescriptions": [
26037
+ "Default value. In this case, server behavior defaults to Google defined threshold.",
26038
+ "Lowest relevance threshold.",
26039
+ "Low relevance threshold.",
26040
+ "Medium relevance threshold.",
26041
+ "High relevance threshold."
26042
+ ],
26043
+ "type": "string"
26044
+ },
26045
+ "semanticRelevanceThreshold": {
26046
+ "description": "Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].",
26047
+ "format": "float",
26048
+ "type": "number"
26049
+ }
26050
+ },
26051
+ "type": "object"
26052
+ },
24371
26053
  "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec": {
24372
26054
  "description": "The specification for returning the document relevance score.",
24373
26055
  "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec",
@@ -25701,6 +27383,12 @@ false
25701
27383
  ],
25702
27384
  "type": "string"
25703
27385
  },
27386
+ "configurableBillingApproachUpdateTime": {
27387
+ "description": "Output only. The timestamp when configurable_billing_approach was last updated.",
27388
+ "format": "google-datetime",
27389
+ "readOnly": true,
27390
+ "type": "string"
27391
+ },
25704
27392
  "contentConfig": {
25705
27393
  "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.",
25706
27394
  "enum": [
@@ -26104,6 +27792,10 @@ false
26104
27792
  "description": "Optional. If true, the LLM based annotation is added to the image during parsing.",
26105
27793
  "type": "boolean"
26106
27794
  },
27795
+ "enableLlmLayoutParsing": {
27796
+ "description": "Optional. If true, the pdf layout will be refined using an LLM.",
27797
+ "type": "boolean"
27798
+ },
26107
27799
  "enableTableAnnotation": {
26108
27800
  "description": "Optional. If true, the LLM based annotation is added to the table during parsing.",
26109
27801
  "type": "boolean"
@@ -26206,6 +27898,11 @@ false
26206
27898
  "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.",
26207
27899
  "readOnly": true
26208
27900
  },
27901
+ "cmekConfig": {
27902
+ "$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig",
27903
+ "description": "Output only. CMEK-related information for the Engine.",
27904
+ "readOnly": true
27905
+ },
26209
27906
  "commonConfig": {
26210
27907
  "$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig",
26211
27908
  "description": "Common config spec that specifies the metadata of the engine."
@@ -26280,6 +27977,23 @@ false
26280
27977
  "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig",
26281
27978
  "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical."
26282
27979
  },
27980
+ "modelConfigs": {
27981
+ "additionalProperties": {
27982
+ "enum": [
27983
+ "MODEL_STATE_UNSPECIFIED",
27984
+ "MODEL_ENABLED",
27985
+ "MODEL_DISABLED"
27986
+ ],
27987
+ "enumDescriptions": [
27988
+ "The model state is unspecified.",
27989
+ "The model is enabled by admin.",
27990
+ "The model is disabled by admin."
27991
+ ],
27992
+ "type": "string"
27993
+ },
27994
+ "description": "Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.",
27995
+ "type": "object"
27996
+ },
26283
27997
  "name": {
26284
27998
  "description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.",
26285
27999
  "type": "string"
@@ -26474,6 +28188,40 @@ false
26474
28188
  "description": "Configurations for a Search Engine.",
26475
28189
  "id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig",
26476
28190
  "properties": {
28191
+ "requiredSubscriptionTier": {
28192
+ "description": "Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.",
28193
+ "enum": [
28194
+ "SUBSCRIPTION_TIER_UNSPECIFIED",
28195
+ "SUBSCRIPTION_TIER_SEARCH",
28196
+ "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT",
28197
+ "SUBSCRIPTION_TIER_NOTEBOOK_LM",
28198
+ "SUBSCRIPTION_TIER_FRONTLINE_WORKER",
28199
+ "SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
28200
+ "SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
28201
+ "SUBSCRIPTION_TIER_ENTERPRISE",
28202
+ "SUBSCRIPTION_TIER_EDU",
28203
+ "SUBSCRIPTION_TIER_EDU_PRO",
28204
+ "SUBSCRIPTION_TIER_EDU_EMERGING",
28205
+ "SUBSCRIPTION_TIER_EDU_PRO_EMERGING",
28206
+ "SUBSCRIPTION_TIER_FRONTLINE_STARTER"
28207
+ ],
28208
+ "enumDescriptions": [
28209
+ "Default value.",
28210
+ "Search tier. Search tier can access VAIS search features and NotebookLM features.",
28211
+ "Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
28212
+ "NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
28213
+ "Frontline worker tier.",
28214
+ "Agentspace Starter tier.",
28215
+ "Agentspace Business tier.",
28216
+ "Enterprise tier.",
28217
+ "EDU tier.",
28218
+ "EDU Pro tier.",
28219
+ "EDU emerging market tier.",
28220
+ "EDU Pro emerging market tier.",
28221
+ "Frontline starter tier."
28222
+ ],
28223
+ "type": "string"
28224
+ },
26477
28225
  "searchAddOns": {
26478
28226
  "description": "The add-on that this search engine enables.",
26479
28227
  "items": {
@@ -27069,7 +28817,8 @@ false
27069
28817
  "SUBSCRIPTION_TIER_EDU",
27070
28818
  "SUBSCRIPTION_TIER_EDU_PRO",
27071
28819
  "SUBSCRIPTION_TIER_EDU_EMERGING",
27072
- "SUBSCRIPTION_TIER_EDU_PRO_EMERGING"
28820
+ "SUBSCRIPTION_TIER_EDU_PRO_EMERGING",
28821
+ "SUBSCRIPTION_TIER_FRONTLINE_STARTER"
27073
28822
  ],
27074
28823
  "enumDescriptions": [
27075
28824
  "Default value.",
@@ -27083,7 +28832,8 @@ false
27083
28832
  "EDU tier.",
27084
28833
  "EDU Pro tier.",
27085
28834
  "EDU emerging market tier.",
27086
- "EDU Pro emerging market tier."
28835
+ "EDU Pro emerging market tier.",
28836
+ "Frontline starter tier."
27087
28837
  ],
27088
28838
  "type": "string"
27089
28839
  }
@@ -27164,6 +28914,11 @@ false
27164
28914
  "description": "Metadata and configurations for a Google Cloud project in the service.",
27165
28915
  "id": "GoogleCloudDiscoveryengineV1betaProject",
27166
28916
  "properties": {
28917
+ "configurableBillingStatus": {
28918
+ "$ref": "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus",
28919
+ "description": "Output only. The current status of the project's configurable billing.",
28920
+ "readOnly": true
28921
+ },
27167
28922
  "createTime": {
27168
28923
  "description": "Output only. The timestamp when this project is created.",
27169
28924
  "format": "google-datetime",
@@ -27196,6 +28951,28 @@ false
27196
28951
  },
27197
28952
  "type": "object"
27198
28953
  },
28954
+ "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus": {
28955
+ "description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).",
28956
+ "id": "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus",
28957
+ "properties": {
28958
+ "effectiveIndexingCoreThreshold": {
28959
+ "description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.",
28960
+ "format": "int64",
28961
+ "type": "string"
28962
+ },
28963
+ "effectiveSearchQpmThreshold": {
28964
+ "description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.",
28965
+ "format": "int64",
28966
+ "type": "string"
28967
+ },
28968
+ "startTime": {
28969
+ "description": "Optional. The start time of the currently active billing subscription.",
28970
+ "format": "google-datetime",
28971
+ "type": "string"
28972
+ }
28973
+ },
28974
+ "type": "object"
28975
+ },
27199
28976
  "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig": {
27200
28977
  "description": "Customer provided configurations.",
27201
28978
  "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig",
@@ -27214,6 +28991,10 @@ false
27214
28991
  "modelArmorConfig": {
27215
28992
  "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
27216
28993
  "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
28994
+ },
28995
+ "optOutNotebookSharing": {
28996
+ "description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.",
28997
+ "type": "boolean"
27217
28998
  }
27218
28999
  },
27219
29000
  "type": "object"
@@ -27538,6 +29319,13 @@ false
27538
29319
  "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec",
27539
29320
  "description": "A specification for configuring the behavior of content search."
27540
29321
  },
29322
+ "crowdingSpecs": {
29323
+ "description": "Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = \"color\" and `max_count` = 3, and the second CrowdingSpec has `field` = \"size\" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.",
29324
+ "items": {
29325
+ "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec"
29326
+ },
29327
+ "type": "array"
29328
+ },
27541
29329
  "dataStoreSpecs": {
27542
29330
  "description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.",
27543
29331
  "items": {
@@ -27590,6 +29378,13 @@ false
27590
29378
  "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.",
27591
29379
  "type": "string"
27592
29380
  },
29381
+ "pageCategories": {
29382
+ "description": "Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '>' character to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders Edition` where \"RTX > 4090\" represents one level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition`",
29383
+ "items": {
29384
+ "type": "string"
29385
+ },
29386
+ "type": "array"
29387
+ },
27593
29388
  "pageSize": {
27594
29389
  "description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.",
27595
29390
  "format": "int32",
@@ -27651,12 +29446,16 @@ false
27651
29446
  "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.",
27652
29447
  "type": "string"
27653
29448
  },
29449
+ "relevanceFilterSpec": {
29450
+ "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec",
29451
+ "description": "Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search."
29452
+ },
27654
29453
  "relevanceScoreSpec": {
27655
29454
  "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec",
27656
29455
  "description": "Optional. The specification for returning the relevance score."
27657
29456
  },
27658
29457
  "relevanceThreshold": {
27659
- "description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.",
29458
+ "description": "The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.",
27660
29459
  "enum": [
27661
29460
  "RELEVANCE_THRESHOLD_UNSPECIFIED",
27662
29461
  "LOWEST",
@@ -27713,7 +29512,7 @@ false
27713
29512
  "type": "object"
27714
29513
  },
27715
29514
  "userPseudoId": {
27716
- "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
29515
+ "description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
27717
29516
  "type": "string"
27718
29517
  }
27719
29518
  },
@@ -28017,6 +29816,36 @@ false
28017
29816
  },
28018
29817
  "type": "object"
28019
29818
  },
29819
+ "GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec": {
29820
+ "description": "Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.",
29821
+ "id": "GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec",
29822
+ "properties": {
29823
+ "field": {
29824
+ "description": "The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.",
29825
+ "type": "string"
29826
+ },
29827
+ "maxCount": {
29828
+ "description": "The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are \"crowded away\". If not specified, the default value is 1.",
29829
+ "format": "int32",
29830
+ "type": "integer"
29831
+ },
29832
+ "mode": {
29833
+ "description": "Mode to use for documents that are crowded away.",
29834
+ "enum": [
29835
+ "MODE_UNSPECIFIED",
29836
+ "DROP_CROWDED_RESULTS",
29837
+ "DEMOTE_CROWDED_RESULTS_TO_END"
29838
+ ],
29839
+ "enumDescriptions": [
29840
+ "Unspecified crowding mode. In this case, server behavior defaults to Mode.DROP_CROWDED_RESULTS.",
29841
+ "Drop crowded results.",
29842
+ "Demote crowded results to the later pages."
29843
+ ],
29844
+ "type": "string"
29845
+ }
29846
+ },
29847
+ "type": "object"
29848
+ },
28020
29849
  "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": {
28021
29850
  "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.",
28022
29851
  "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec",
@@ -28274,6 +30103,51 @@ false
28274
30103
  },
28275
30104
  "type": "object"
28276
30105
  },
30106
+ "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec": {
30107
+ "description": "Relevance filtering specification.",
30108
+ "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec",
30109
+ "properties": {
30110
+ "keywordSearchThreshold": {
30111
+ "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec",
30112
+ "description": "Optional. Relevance filtering threshold specification for keyword search."
30113
+ },
30114
+ "semanticSearchThreshold": {
30115
+ "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec",
30116
+ "description": "Optional. Relevance filtering threshold specification for semantic search."
30117
+ }
30118
+ },
30119
+ "type": "object"
30120
+ },
30121
+ "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec": {
30122
+ "description": "Specification for relevance filtering on a specific sub-search.",
30123
+ "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec",
30124
+ "properties": {
30125
+ "relevanceThreshold": {
30126
+ "description": "Pre-defined relevance threshold for the sub-search.",
30127
+ "enum": [
30128
+ "RELEVANCE_THRESHOLD_UNSPECIFIED",
30129
+ "LOWEST",
30130
+ "LOW",
30131
+ "MEDIUM",
30132
+ "HIGH"
30133
+ ],
30134
+ "enumDescriptions": [
30135
+ "Default value. In this case, server behavior defaults to Google defined threshold.",
30136
+ "Lowest relevance threshold.",
30137
+ "Low relevance threshold.",
30138
+ "Medium relevance threshold.",
30139
+ "High relevance threshold."
30140
+ ],
30141
+ "type": "string"
30142
+ },
30143
+ "semanticRelevanceThreshold": {
30144
+ "description": "Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].",
30145
+ "format": "float",
30146
+ "type": "number"
30147
+ }
30148
+ },
30149
+ "type": "object"
30150
+ },
28277
30151
  "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec": {
28278
30152
  "description": "The specification for returning the document relevance score.",
28279
30153
  "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec",
@@ -28753,6 +30627,33 @@ false
28753
30627
  },
28754
30628
  "type": "object"
28755
30629
  },
30630
+ "GoogleCloudDiscoveryengineV1betaUserStore": {
30631
+ "description": "Configures metadata that is used for End User entities.",
30632
+ "id": "GoogleCloudDiscoveryengineV1betaUserStore",
30633
+ "properties": {
30634
+ "defaultLicenseConfig": {
30635
+ "description": "Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.",
30636
+ "type": "string"
30637
+ },
30638
+ "displayName": {
30639
+ "description": "The display name of the User Store.",
30640
+ "type": "string"
30641
+ },
30642
+ "enableExpiredLicenseAutoUpdate": {
30643
+ "description": "Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.",
30644
+ "type": "boolean"
30645
+ },
30646
+ "enableLicenseAutoRegister": {
30647
+ "description": "Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.",
30648
+ "type": "boolean"
30649
+ },
30650
+ "name": {
30651
+ "description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
30652
+ "type": "string"
30653
+ }
30654
+ },
30655
+ "type": "object"
30656
+ },
28756
30657
  "GoogleCloudDiscoveryengineV1betaWorkspaceConfig": {
28757
30658
  "description": "Config to store data store type configuration for workspace data",
28758
30659
  "id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig",
@@ -28820,7 +30721,7 @@ false
28820
30721
  "type": "array"
28821
30722
  },
28822
30723
  "unreachable": {
28823
- "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.",
30724
+ "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.",
28824
30725
  "items": {
28825
30726
  "type": "string"
28826
30727
  },