google-api-python-client 2.161.0__py2.py3-none-any.whl → 2.163.0__py2.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 (205) hide show
  1. {google_api_python_client-2.161.0.dist-info → google_api_python_client-2.163.0.dist-info}/METADATA +1 -1
  2. {google_api_python_client-2.161.0.dist-info → google_api_python_client-2.163.0.dist-info}/RECORD +205 -205
  3. googleapiclient/discovery_cache/documents/accessapproval.v1.json +7 -3
  4. googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +2 -2
  5. googleapiclient/discovery_cache/documents/admin.directory_v1.json +3 -3
  6. googleapiclient/discovery_cache/documents/admin.directoryv1.json +3 -3
  7. googleapiclient/discovery_cache/documents/adsense.v2.json +123 -4
  8. googleapiclient/discovery_cache/documents/aiplatform.v1.json +217 -13
  9. googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +288 -29
  10. googleapiclient/discovery_cache/documents/alloydb.v1.json +576 -12
  11. googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +468 -12
  12. googleapiclient/discovery_cache/documents/alloydb.v1beta.json +492 -12
  13. googleapiclient/discovery_cache/documents/analyticshub.v1.json +19 -6
  14. googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +6 -1
  15. googleapiclient/discovery_cache/documents/androidenterprise.v1.json +29 -1
  16. googleapiclient/discovery_cache/documents/androidmanagement.v1.json +46 -1
  17. googleapiclient/discovery_cache/documents/androidpublisher.v3.json +5 -1
  18. googleapiclient/discovery_cache/documents/apigee.v1.json +28 -4
  19. googleapiclient/discovery_cache/documents/appengine.v1.json +3 -3
  20. googleapiclient/discovery_cache/documents/appengine.v1beta.json +3 -3
  21. googleapiclient/discovery_cache/documents/areainsights.v1.json +8 -8
  22. googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +2 -2
  23. googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +2 -2
  24. googleapiclient/discovery_cache/documents/backupdr.v1.json +3 -3
  25. googleapiclient/discovery_cache/documents/beyondcorp.v1.json +5 -3
  26. googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +11 -7
  27. googleapiclient/discovery_cache/documents/bigquery.v2.json +62 -13
  28. googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +57 -1
  29. googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +104 -1
  30. googleapiclient/discovery_cache/documents/certificatemanager.v1.json +5 -3
  31. googleapiclient/discovery_cache/documents/chat.v1.json +51 -13
  32. googleapiclient/discovery_cache/documents/chromemanagement.v1.json +69 -1
  33. googleapiclient/discovery_cache/documents/cloudasset.v1.json +7 -7
  34. googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +2 -2
  35. googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +3 -3
  36. googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +2 -2
  37. googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +4 -4
  38. googleapiclient/discovery_cache/documents/cloudbuild.v1.json +70 -1
  39. googleapiclient/discovery_cache/documents/cloudbuild.v2.json +25 -1
  40. googleapiclient/discovery_cache/documents/clouddeploy.v1.json +8 -8
  41. googleapiclient/discovery_cache/documents/cloudkms.v1.json +76 -10
  42. googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +2 -2
  43. googleapiclient/discovery_cache/documents/composer.v1.json +2 -2
  44. googleapiclient/discovery_cache/documents/composer.v1beta1.json +2 -2
  45. googleapiclient/discovery_cache/documents/compute.alpha.json +3412 -296
  46. googleapiclient/discovery_cache/documents/compute.beta.json +1452 -40
  47. googleapiclient/discovery_cache/documents/compute.v1.json +1098 -12
  48. googleapiclient/discovery_cache/documents/config.v1.json +2 -2
  49. googleapiclient/discovery_cache/documents/connectors.v1.json +11 -3
  50. googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +1 -5
  51. googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +97 -17
  52. googleapiclient/discovery_cache/documents/container.v1.json +34 -11
  53. googleapiclient/discovery_cache/documents/container.v1beta1.json +41 -13
  54. googleapiclient/discovery_cache/documents/containeranalysis.v1.json +71 -2
  55. googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +70 -1
  56. googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +70 -1
  57. googleapiclient/discovery_cache/documents/css.v1.json +5 -5
  58. googleapiclient/discovery_cache/documents/datacatalog.v1.json +58 -4
  59. googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json +46 -4
  60. googleapiclient/discovery_cache/documents/dataform.v1beta1.json +115 -8
  61. googleapiclient/discovery_cache/documents/datafusion.v1.json +22 -2
  62. googleapiclient/discovery_cache/documents/datafusion.v1beta1.json +22 -2
  63. googleapiclient/discovery_cache/documents/datalineage.v1.json +3 -3
  64. googleapiclient/discovery_cache/documents/datamigration.v1.json +58 -10
  65. googleapiclient/discovery_cache/documents/dataplex.v1.json +73 -10
  66. googleapiclient/discovery_cache/documents/dataportability.v1.json +140 -1
  67. googleapiclient/discovery_cache/documents/dataportability.v1beta.json +140 -1
  68. googleapiclient/discovery_cache/documents/dataproc.v1.json +95 -1
  69. googleapiclient/discovery_cache/documents/datastore.v1.json +2 -2
  70. googleapiclient/discovery_cache/documents/datastore.v1beta1.json +2 -2
  71. googleapiclient/discovery_cache/documents/datastore.v1beta3.json +2 -2
  72. googleapiclient/discovery_cache/documents/datastream.v1.json +212 -2
  73. googleapiclient/discovery_cache/documents/dfareporting.v4.json +9 -5
  74. googleapiclient/discovery_cache/documents/dialogflow.v2.json +21 -23
  75. googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +350 -21
  76. googleapiclient/discovery_cache/documents/dialogflow.v3.json +14 -14
  77. googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +14 -14
  78. googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +105 -1
  79. googleapiclient/discovery_cache/documents/discoveryengine.v1.json +732 -91
  80. googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +9493 -7537
  81. googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +755 -68
  82. googleapiclient/discovery_cache/documents/displayvideo.v2.json +93 -93
  83. googleapiclient/discovery_cache/documents/displayvideo.v3.json +120 -188
  84. googleapiclient/discovery_cache/documents/displayvideo.v4.json +21293 -106
  85. googleapiclient/discovery_cache/documents/dlp.v2.json +212 -6
  86. googleapiclient/discovery_cache/documents/docs.v1.json +5 -5
  87. googleapiclient/discovery_cache/documents/documentai.v1beta3.json +3 -3
  88. googleapiclient/discovery_cache/documents/drive.v2.json +41 -5
  89. googleapiclient/discovery_cache/documents/drive.v3.json +63 -16
  90. googleapiclient/discovery_cache/documents/eventarc.v1.json +3 -3
  91. googleapiclient/discovery_cache/documents/fcm.v1.json +5 -1
  92. googleapiclient/discovery_cache/documents/file.v1.json +11 -4
  93. googleapiclient/discovery_cache/documents/file.v1beta1.json +11 -4
  94. googleapiclient/discovery_cache/documents/firebase.v1beta1.json +1 -1
  95. googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +51 -1
  96. googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +29 -5
  97. googleapiclient/discovery_cache/documents/firestore.v1.json +3 -25
  98. googleapiclient/discovery_cache/documents/forms.v1.json +7 -7
  99. googleapiclient/discovery_cache/documents/gkebackup.v1.json +2 -2
  100. googleapiclient/discovery_cache/documents/gkehub.v1.json +7 -5
  101. googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +128 -5
  102. googleapiclient/discovery_cache/documents/gkehub.v1beta.json +7 -5
  103. googleapiclient/discovery_cache/documents/gkehub.v2.json +5 -3
  104. googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +5 -3
  105. googleapiclient/discovery_cache/documents/gkehub.v2beta.json +5 -3
  106. googleapiclient/discovery_cache/documents/gkeonprem.v1.json +2 -2
  107. googleapiclient/discovery_cache/documents/healthcare.v1.json +171 -3
  108. googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +171 -3
  109. googleapiclient/discovery_cache/documents/iam.v1.json +5 -3
  110. googleapiclient/discovery_cache/documents/iam.v2.json +2 -2
  111. googleapiclient/discovery_cache/documents/iam.v2beta.json +2 -2
  112. googleapiclient/discovery_cache/documents/ids.v1.json +3 -3
  113. googleapiclient/discovery_cache/documents/integrations.v1.json +29 -6
  114. googleapiclient/discovery_cache/documents/kmsinventory.v1.json +13 -5
  115. googleapiclient/discovery_cache/documents/logging.v2.json +6 -61
  116. googleapiclient/discovery_cache/documents/looker.v1.json +165 -267
  117. googleapiclient/discovery_cache/documents/memcache.v1.json +2 -2
  118. googleapiclient/discovery_cache/documents/memcache.v1beta2.json +2 -390
  119. googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +22 -8
  120. googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json +6 -1
  121. googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +6 -1
  122. googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +6 -1
  123. googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json +6 -1
  124. googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json +6 -1
  125. googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +6 -1
  126. googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json +6 -1
  127. googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json +6 -1
  128. googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json +6 -1
  129. googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json +6 -1
  130. googleapiclient/discovery_cache/documents/migrationcenter.v1.json +43 -6
  131. googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +47 -6
  132. googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +3 -2
  133. googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +27 -15
  134. googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +9 -5
  135. googleapiclient/discovery_cache/documents/networkmanagement.v1.json +58 -3
  136. googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +268 -10
  137. googleapiclient/discovery_cache/documents/networksecurity.v1.json +1828 -534
  138. googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +735 -322
  139. googleapiclient/discovery_cache/documents/networkservices.v1.json +39 -63
  140. googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +39 -63
  141. googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +105 -1
  142. googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +105 -1
  143. googleapiclient/discovery_cache/documents/oracledatabase.v1.json +7 -5
  144. googleapiclient/discovery_cache/documents/oslogin.v1alpha.json +44 -1
  145. googleapiclient/discovery_cache/documents/oslogin.v1beta.json +44 -1
  146. googleapiclient/discovery_cache/documents/parallelstore.v1.json +10 -4
  147. googleapiclient/discovery_cache/documents/parallelstore.v1beta.json +10 -4
  148. googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +16 -1
  149. googleapiclient/discovery_cache/documents/places.v1.json +9 -5
  150. googleapiclient/discovery_cache/documents/playintegrity.v1.json +1 -43
  151. googleapiclient/discovery_cache/documents/privateca.v1.json +9 -4
  152. googleapiclient/discovery_cache/documents/pubsub.v1.json +7 -7
  153. googleapiclient/discovery_cache/documents/rapidmigrationassessment.v1.json +2 -2
  154. googleapiclient/discovery_cache/documents/realtimebidding.v1.json +3 -2
  155. googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +3 -3
  156. googleapiclient/discovery_cache/documents/redis.v1.json +138 -18
  157. googleapiclient/discovery_cache/documents/redis.v1beta1.json +137 -17
  158. googleapiclient/discovery_cache/documents/retail.v2.json +10 -2
  159. googleapiclient/discovery_cache/documents/retail.v2alpha.json +10 -2
  160. googleapiclient/discovery_cache/documents/retail.v2beta.json +10 -2
  161. googleapiclient/discovery_cache/documents/run.v1.json +74 -2
  162. googleapiclient/discovery_cache/documents/run.v2.json +755 -9
  163. googleapiclient/discovery_cache/documents/secretmanager.v1.json +31 -1
  164. googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +31 -1
  165. googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +31 -1
  166. googleapiclient/discovery_cache/documents/securitycenter.v1.json +366 -2
  167. googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +366 -2
  168. googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +366 -2
  169. googleapiclient/discovery_cache/documents/securityposture.v1.json +5 -5
  170. googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +37 -3
  171. googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +37 -3
  172. googleapiclient/discovery_cache/documents/servicemanagement.v1.json +33 -3
  173. googleapiclient/discovery_cache/documents/servicenetworking.v1.json +7 -3
  174. googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +7 -3
  175. googleapiclient/discovery_cache/documents/serviceusage.v1.json +38 -4
  176. googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +38 -4
  177. googleapiclient/discovery_cache/documents/sheets.v4.json +2 -2
  178. googleapiclient/discovery_cache/documents/slides.v1.json +12 -12
  179. googleapiclient/discovery_cache/documents/spanner.v1.json +116 -5
  180. googleapiclient/discovery_cache/documents/sqladmin.v1.json +446 -4
  181. googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +446 -4
  182. googleapiclient/discovery_cache/documents/storage.v1.json +6 -6
  183. googleapiclient/discovery_cache/documents/storagetransfer.v1.json +3 -3
  184. googleapiclient/discovery_cache/documents/sts.v1.json +41 -1
  185. googleapiclient/discovery_cache/documents/sts.v1beta.json +41 -1
  186. googleapiclient/discovery_cache/documents/tagmanager.v2.json +5 -1
  187. googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +9 -2
  188. googleapiclient/discovery_cache/documents/trafficdirector.v3.json +41 -15
  189. googleapiclient/discovery_cache/documents/transcoder.v1.json +2 -2
  190. googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +2 -2
  191. googleapiclient/discovery_cache/documents/vault.v1.json +40 -5
  192. googleapiclient/discovery_cache/documents/vmmigration.v1.json +3 -3
  193. googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +3 -3
  194. googleapiclient/discovery_cache/documents/vmwareengine.v1.json +665 -1
  195. googleapiclient/discovery_cache/documents/workflowexecutions.v1.json +5 -5
  196. googleapiclient/discovery_cache/documents/workflows.v1.json +2 -2
  197. googleapiclient/discovery_cache/documents/workloadmanager.v1.json +1102 -24
  198. googleapiclient/discovery_cache/documents/workspaceevents.v1.json +2 -2
  199. googleapiclient/discovery_cache/documents/workstations.v1.json +4 -4
  200. googleapiclient/discovery_cache/documents/workstations.v1beta.json +4 -4
  201. googleapiclient/discovery_cache/documents/youtube.v3.json +11 -3
  202. googleapiclient/version.py +1 -1
  203. {google_api_python_client-2.161.0.dist-info → google_api_python_client-2.163.0.dist-info}/LICENSE +0 -0
  204. {google_api_python_client-2.161.0.dist-info → google_api_python_client-2.163.0.dist-info}/WHEEL +0 -0
  205. {google_api_python_client-2.161.0.dist-info → google_api_python_client-2.163.0.dist-info}/top_level.txt +0 -0
@@ -2317,6 +2317,94 @@
2317
2317
  }
2318
2318
  }
2319
2319
  },
2320
+ "sitemaps": {
2321
+ "methods": {
2322
+ "create": {
2323
+ "description": "Creates a Sitemap.",
2324
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps",
2325
+ "httpMethod": "POST",
2326
+ "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.create",
2327
+ "parameterOrder": [
2328
+ "parent"
2329
+ ],
2330
+ "parameters": {
2331
+ "parent": {
2332
+ "description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
2333
+ "location": "path",
2334
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
2335
+ "required": true,
2336
+ "type": "string"
2337
+ }
2338
+ },
2339
+ "path": "v1/{+parent}/sitemaps",
2340
+ "request": {
2341
+ "$ref": "GoogleCloudDiscoveryengineV1Sitemap"
2342
+ },
2343
+ "response": {
2344
+ "$ref": "GoogleLongrunningOperation"
2345
+ },
2346
+ "scopes": [
2347
+ "https://www.googleapis.com/auth/cloud-platform"
2348
+ ]
2349
+ },
2350
+ "delete": {
2351
+ "description": "Deletes a Sitemap.",
2352
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}",
2353
+ "httpMethod": "DELETE",
2354
+ "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.delete",
2355
+ "parameterOrder": [
2356
+ "name"
2357
+ ],
2358
+ "parameters": {
2359
+ "name": {
2360
+ "description": "Required. Full resource name of Sitemap, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned.",
2361
+ "location": "path",
2362
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/sitemaps/[^/]+$",
2363
+ "required": true,
2364
+ "type": "string"
2365
+ }
2366
+ },
2367
+ "path": "v1/{+name}",
2368
+ "response": {
2369
+ "$ref": "GoogleLongrunningOperation"
2370
+ },
2371
+ "scopes": [
2372
+ "https://www.googleapis.com/auth/cloud-platform"
2373
+ ]
2374
+ },
2375
+ "fetch": {
2376
+ "description": "Fetch Sitemaps in a DataStore.",
2377
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch",
2378
+ "httpMethod": "GET",
2379
+ "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.fetch",
2380
+ "parameterOrder": [
2381
+ "parent"
2382
+ ],
2383
+ "parameters": {
2384
+ "matcher.urisMatcher.uris": {
2385
+ "description": "The Sitemap uris.",
2386
+ "location": "query",
2387
+ "repeated": true,
2388
+ "type": "string"
2389
+ },
2390
+ "parent": {
2391
+ "description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
2392
+ "location": "path",
2393
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
2394
+ "required": true,
2395
+ "type": "string"
2396
+ }
2397
+ },
2398
+ "path": "v1/{+parent}/sitemaps:fetch",
2399
+ "response": {
2400
+ "$ref": "GoogleCloudDiscoveryengineV1FetchSitemapsResponse"
2401
+ },
2402
+ "scopes": [
2403
+ "https://www.googleapis.com/auth/cloud-platform"
2404
+ ]
2405
+ }
2406
+ }
2407
+ },
2320
2408
  "targetSites": {
2321
2409
  "methods": {
2322
2410
  "batchCreate": {
@@ -5582,6 +5670,94 @@
5582
5670
  }
5583
5671
  },
5584
5672
  "resources": {
5673
+ "sitemaps": {
5674
+ "methods": {
5675
+ "create": {
5676
+ "description": "Creates a Sitemap.",
5677
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps",
5678
+ "httpMethod": "POST",
5679
+ "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.create",
5680
+ "parameterOrder": [
5681
+ "parent"
5682
+ ],
5683
+ "parameters": {
5684
+ "parent": {
5685
+ "description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
5686
+ "location": "path",
5687
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
5688
+ "required": true,
5689
+ "type": "string"
5690
+ }
5691
+ },
5692
+ "path": "v1/{+parent}/sitemaps",
5693
+ "request": {
5694
+ "$ref": "GoogleCloudDiscoveryengineV1Sitemap"
5695
+ },
5696
+ "response": {
5697
+ "$ref": "GoogleLongrunningOperation"
5698
+ },
5699
+ "scopes": [
5700
+ "https://www.googleapis.com/auth/cloud-platform"
5701
+ ]
5702
+ },
5703
+ "delete": {
5704
+ "description": "Deletes a Sitemap.",
5705
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}",
5706
+ "httpMethod": "DELETE",
5707
+ "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.delete",
5708
+ "parameterOrder": [
5709
+ "name"
5710
+ ],
5711
+ "parameters": {
5712
+ "name": {
5713
+ "description": "Required. Full resource name of Sitemap, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned.",
5714
+ "location": "path",
5715
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/sitemaps/[^/]+$",
5716
+ "required": true,
5717
+ "type": "string"
5718
+ }
5719
+ },
5720
+ "path": "v1/{+name}",
5721
+ "response": {
5722
+ "$ref": "GoogleLongrunningOperation"
5723
+ },
5724
+ "scopes": [
5725
+ "https://www.googleapis.com/auth/cloud-platform"
5726
+ ]
5727
+ },
5728
+ "fetch": {
5729
+ "description": "Fetch Sitemaps in a DataStore.",
5730
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch",
5731
+ "httpMethod": "GET",
5732
+ "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.fetch",
5733
+ "parameterOrder": [
5734
+ "parent"
5735
+ ],
5736
+ "parameters": {
5737
+ "matcher.urisMatcher.uris": {
5738
+ "description": "The Sitemap uris.",
5739
+ "location": "query",
5740
+ "repeated": true,
5741
+ "type": "string"
5742
+ },
5743
+ "parent": {
5744
+ "description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
5745
+ "location": "path",
5746
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
5747
+ "required": true,
5748
+ "type": "string"
5749
+ }
5750
+ },
5751
+ "path": "v1/{+parent}/sitemaps:fetch",
5752
+ "response": {
5753
+ "$ref": "GoogleCloudDiscoveryengineV1FetchSitemapsResponse"
5754
+ },
5755
+ "scopes": [
5756
+ "https://www.googleapis.com/auth/cloud-platform"
5757
+ ]
5758
+ }
5759
+ }
5760
+ },
5585
5761
  "targetSites": {
5586
5762
  "methods": {
5587
5763
  "batchCreate": {
@@ -6594,7 +6770,7 @@
6594
6770
  }
6595
6771
  }
6596
6772
  },
6597
- "revision": "20250130",
6773
+ "revision": "20250226",
6598
6774
  "rootUrl": "https://discoveryengine.googleapis.com/",
6599
6775
  "schemas": {
6600
6776
  "GoogleApiDistribution": {
@@ -6850,6 +7026,43 @@
6850
7026
  },
6851
7027
  "type": "object"
6852
7028
  },
7029
+ "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext": {
7030
+ "description": "The error payload that is populated on LRO sync APIs, including the following: * `google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector` * `google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun`",
7031
+ "id": "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext",
7032
+ "properties": {
7033
+ "connectorRun": {
7034
+ "description": "The full resource name of the Connector Run. Format: `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. The `connector_run_id` is system-generated.",
7035
+ "type": "string"
7036
+ },
7037
+ "dataConnector": {
7038
+ "description": "The full resource name of the DataConnector. Format: `projects/*/locations/*/collections/*/dataConnector`.",
7039
+ "type": "string"
7040
+ },
7041
+ "endTime": {
7042
+ "description": "The time when the connector run ended.",
7043
+ "format": "google-datetime",
7044
+ "type": "string"
7045
+ },
7046
+ "entity": {
7047
+ "description": "The entity to sync for the connector run.",
7048
+ "type": "string"
7049
+ },
7050
+ "operation": {
7051
+ "description": "The operation resource name of the LRO to sync the connector.",
7052
+ "type": "string"
7053
+ },
7054
+ "startTime": {
7055
+ "description": "The time when the connector run started.",
7056
+ "format": "google-datetime",
7057
+ "type": "string"
7058
+ },
7059
+ "syncType": {
7060
+ "description": "The type of sync run. Can be one of the following: * `FULL` * `INCREMENTAL`",
7061
+ "type": "string"
7062
+ }
7063
+ },
7064
+ "type": "object"
7065
+ },
6853
7066
  "GoogleCloudDiscoveryengineLoggingErrorContext": {
6854
7067
  "description": "A description of the context in which an error occurred.",
6855
7068
  "id": "GoogleCloudDiscoveryengineLoggingErrorContext",
@@ -6869,6 +7082,10 @@
6869
7082
  "description": "An error log which is reported to the Error Reporting system.",
6870
7083
  "id": "GoogleCloudDiscoveryengineLoggingErrorLog",
6871
7084
  "properties": {
7085
+ "connectorRunPayload": {
7086
+ "$ref": "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext",
7087
+ "description": "The error payload that is populated on LRO connector sync APIs."
7088
+ },
6872
7089
  "context": {
6873
7090
  "$ref": "GoogleCloudDiscoveryengineLoggingErrorContext",
6874
7091
  "description": "A description of the context in which the error occurred."
@@ -7147,7 +7364,7 @@
7147
7364
  "id": "GoogleCloudDiscoveryengineV1AnswerCitation",
7148
7365
  "properties": {
7149
7366
  "endIndex": {
7150
- "description": "End of the attributed segment, exclusive.",
7367
+ "description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.",
7151
7368
  "format": "int64",
7152
7369
  "type": "string"
7153
7370
  },
@@ -7159,7 +7376,7 @@
7159
7376
  "type": "array"
7160
7377
  },
7161
7378
  "startIndex": {
7162
- "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).",
7379
+ "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.",
7163
7380
  "format": "int64",
7164
7381
  "type": "string"
7165
7382
  }
@@ -7926,6 +8143,16 @@
7926
8143
  },
7927
8144
  "description": "Structured search data.",
7928
8145
  "type": "object"
8146
+ },
8147
+ "title": {
8148
+ "description": "Output only. The title of the document.",
8149
+ "readOnly": true,
8150
+ "type": "string"
8151
+ },
8152
+ "uri": {
8153
+ "description": "Output only. The URI of the document.",
8154
+ "readOnly": true,
8155
+ "type": "string"
7929
8156
  }
7930
8157
  },
7931
8158
  "type": "object"
@@ -8702,11 +8929,11 @@
8702
8929
  "type": "boolean"
8703
8930
  },
8704
8931
  "kmsKey": {
8705
- "description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
8932
+ "description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
8706
8933
  "type": "string"
8707
8934
  },
8708
8935
  "kmsKeyVersion": {
8709
- "description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
8936
+ "description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
8710
8937
  "type": "string"
8711
8938
  },
8712
8939
  "lastRotationTimestampMicros": {
@@ -8716,7 +8943,7 @@
8716
8943
  "type": "string"
8717
8944
  },
8718
8945
  "name": {
8719
- "description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
8946
+ "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
8720
8947
  "type": "string"
8721
8948
  },
8722
8949
  "singleRegionKeys": {
@@ -8727,7 +8954,7 @@
8727
8954
  "type": "array"
8728
8955
  },
8729
8956
  "state": {
8730
- "description": "Output only. State of the CmekConfig.",
8957
+ "description": "Output only. The states of the CmekConfig.",
8731
8958
  "enum": [
8732
8959
  "STATE_UNSPECIFIED",
8733
8960
  "CREATING",
@@ -9336,6 +9563,23 @@
9336
9563
  },
9337
9564
  "type": "object"
9338
9565
  },
9566
+ "GoogleCloudDiscoveryengineV1CreateSitemapMetadata": {
9567
+ "description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
9568
+ "id": "GoogleCloudDiscoveryengineV1CreateSitemapMetadata",
9569
+ "properties": {
9570
+ "createTime": {
9571
+ "description": "Operation create time.",
9572
+ "format": "google-datetime",
9573
+ "type": "string"
9574
+ },
9575
+ "updateTime": {
9576
+ "description": "Operation last update time. If the operation is done, this is also the finish time.",
9577
+ "format": "google-datetime",
9578
+ "type": "string"
9579
+ }
9580
+ },
9581
+ "type": "object"
9582
+ },
9339
9583
  "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": {
9340
9584
  "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
9341
9585
  "id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata",
@@ -9500,7 +9744,7 @@
9500
9744
  "type": "string"
9501
9745
  },
9502
9746
  "defaultSchemaId": {
9503
- "description": "Output only. The id of the default Schema asscociated to this data store.",
9747
+ "description": "Output only. The id of the default Schema associated to this data store.",
9504
9748
  "readOnly": true,
9505
9749
  "type": "string"
9506
9750
  },
@@ -9516,6 +9760,10 @@
9516
9760
  "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig",
9517
9761
  "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
9518
9762
  },
9763
+ "identityMappingStore": {
9764
+ "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.",
9765
+ "type": "string"
9766
+ },
9519
9767
  "industryVertical": {
9520
9768
  "description": "Immutable. The industry vertical that the data store registers.",
9521
9769
  "enum": [
@@ -9713,6 +9961,23 @@
9713
9961
  },
9714
9962
  "type": "object"
9715
9963
  },
9964
+ "GoogleCloudDiscoveryengineV1DeleteSitemapMetadata": {
9965
+ "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
9966
+ "id": "GoogleCloudDiscoveryengineV1DeleteSitemapMetadata",
9967
+ "properties": {
9968
+ "createTime": {
9969
+ "description": "Operation create time.",
9970
+ "format": "google-datetime",
9971
+ "type": "string"
9972
+ },
9973
+ "updateTime": {
9974
+ "description": "Operation last update time. If the operation is done, this is also the finish time.",
9975
+ "format": "google-datetime",
9976
+ "type": "string"
9977
+ }
9978
+ },
9979
+ "type": "object"
9980
+ },
9716
9981
  "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": {
9717
9982
  "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
9718
9983
  "id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata",
@@ -10005,6 +10270,21 @@
10005
10270
  },
10006
10271
  "type": "object"
10007
10272
  },
10273
+ "GoogleCloudDiscoveryengineV1DoubleList": {
10274
+ "description": "Double list.",
10275
+ "id": "GoogleCloudDiscoveryengineV1DoubleList",
10276
+ "properties": {
10277
+ "values": {
10278
+ "description": "Double values.",
10279
+ "items": {
10280
+ "format": "double",
10281
+ "type": "number"
10282
+ },
10283
+ "type": "array"
10284
+ }
10285
+ },
10286
+ "type": "object"
10287
+ },
10008
10288
  "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": {
10009
10289
  "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.",
10010
10290
  "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata",
@@ -10131,6 +10411,10 @@
10131
10411
  "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig",
10132
10412
  "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation."
10133
10413
  },
10414
+ "allowCrossRegion": {
10415
+ "description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.",
10416
+ "type": "boolean"
10417
+ },
10134
10418
  "dialogflowAgentToLink": {
10135
10419
  "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.",
10136
10420
  "type": "string"
@@ -10269,6 +10553,31 @@
10269
10553
  },
10270
10554
  "type": "object"
10271
10555
  },
10556
+ "GoogleCloudDiscoveryengineV1FetchSitemapsResponse": {
10557
+ "description": "Response message for SiteSearchEngineService.FetchSitemaps method.",
10558
+ "id": "GoogleCloudDiscoveryengineV1FetchSitemapsResponse",
10559
+ "properties": {
10560
+ "sitemapsMetadata": {
10561
+ "description": "List of Sitemaps fetched.",
10562
+ "items": {
10563
+ "$ref": "GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata"
10564
+ },
10565
+ "type": "array"
10566
+ }
10567
+ },
10568
+ "type": "object"
10569
+ },
10570
+ "GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata": {
10571
+ "description": "Contains a Sitemap and its metadata.",
10572
+ "id": "GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata",
10573
+ "properties": {
10574
+ "sitemap": {
10575
+ "$ref": "GoogleCloudDiscoveryengineV1Sitemap",
10576
+ "description": "The Sitemap."
10577
+ }
10578
+ },
10579
+ "type": "object"
10580
+ },
10272
10581
  "GoogleCloudDiscoveryengineV1FhirStoreSource": {
10273
10582
  "description": "Cloud FhirStore source import data from.",
10274
10583
  "id": "GoogleCloudDiscoveryengineV1FhirStoreSource",
@@ -10807,7 +11116,7 @@
10807
11116
  "type": "object"
10808
11117
  },
10809
11118
  "GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata": {
10810
- "description": "IdentityMappingEntry LongRunningOperation metadata for [IdentityMappingStoreService.ImportIdentityMappings] and [IdentityMappingStoreService.PurgeIdentityMappings]",
11119
+ "description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings",
10811
11120
  "id": "GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata",
10812
11121
  "properties": {
10813
11122
  "failureCount": {
@@ -12095,7 +12404,7 @@
12095
12404
  "id": "GoogleCloudDiscoveryengineV1RecrawlUrisRequest",
12096
12405
  "properties": {
12097
12406
  "siteCredential": {
12098
- "description": "Optional. Full resource name of the `SiteCredential`, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`. Only set to crawl private URIs.",
12407
+ "description": "Optional. Credential id to use for crawling.",
12099
12408
  "type": "string"
12100
12409
  },
12101
12410
  "uris": {
@@ -12356,6 +12665,28 @@
12356
12665
  "$ref": "GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec",
12357
12666
  "description": "The query expansion specification that specifies the conditions under which query expansion occurs."
12358
12667
  },
12668
+ "relevanceScoreSpec": {
12669
+ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec",
12670
+ "description": "Optional. The specification for returning the relevance score."
12671
+ },
12672
+ "relevanceThreshold": {
12673
+ "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.",
12674
+ "enum": [
12675
+ "RELEVANCE_THRESHOLD_UNSPECIFIED",
12676
+ "LOWEST",
12677
+ "LOW",
12678
+ "MEDIUM",
12679
+ "HIGH"
12680
+ ],
12681
+ "enumDescriptions": [
12682
+ "Default value. In this case, server behavior defaults to Google defined threshold.",
12683
+ "Lowest relevance threshold.",
12684
+ "Low relevance threshold.",
12685
+ "Medium relevance threshold.",
12686
+ "High relevance threshold."
12687
+ ],
12688
+ "type": "string"
12689
+ },
12359
12690
  "safeSearch": {
12360
12691
  "description": "Whether to turn on safe search. This is only supported for website search.",
12361
12692
  "type": "boolean"
@@ -12794,8 +13125,19 @@
12794
13125
  },
12795
13126
  "type": "object"
12796
13127
  },
12797
- "GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec": {
12798
- "description": "Specification for search as you type in search requests.",
13128
+ "GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec": {
13129
+ "description": "The specification for returning the document relevance score.",
13130
+ "id": "GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec",
13131
+ "properties": {
13132
+ "returnRelevanceScore": {
13133
+ "description": "Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.",
13134
+ "type": "boolean"
13135
+ }
13136
+ },
13137
+ "type": "object"
13138
+ },
13139
+ "GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec": {
13140
+ "description": "Specification for search as you type in search requests.",
12799
13141
  "id": "GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec",
12800
13142
  "properties": {
12801
13143
  "condition": {
@@ -12803,12 +13145,14 @@
12803
13145
  "enum": [
12804
13146
  "CONDITION_UNSPECIFIED",
12805
13147
  "DISABLED",
12806
- "ENABLED"
13148
+ "ENABLED",
13149
+ "AUTO"
12807
13150
  ],
12808
13151
  "enumDescriptions": [
12809
13152
  "Server behavior defaults to Condition.DISABLED.",
12810
13153
  "Disables Search As You Type.",
12811
- "Enables Search As You Type."
13154
+ "Enables Search As You Type.",
13155
+ "Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)."
12812
13156
  ],
12813
13157
  "type": "string"
12814
13158
  }
@@ -12824,7 +13168,7 @@
12824
13168
  "type": "string"
12825
13169
  },
12826
13170
  "searchResultPersistenceCount": {
12827
- "description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.",
13171
+ "description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.",
12828
13172
  "format": "int32",
12829
13173
  "type": "integer"
12830
13174
  }
@@ -12986,6 +13330,14 @@
12986
13330
  "id": {
12987
13331
  "description": "Document.id of the searched Document.",
12988
13332
  "type": "string"
13333
+ },
13334
+ "modelScores": {
13335
+ "additionalProperties": {
13336
+ "$ref": "GoogleCloudDiscoveryengineV1DoubleList"
13337
+ },
13338
+ "description": "Output only. Google provided available scores.",
13339
+ "readOnly": true,
13340
+ "type": "object"
12989
13341
  }
12990
13342
  },
12991
13343
  "type": "object"
@@ -13484,6 +13836,28 @@
13484
13836
  },
13485
13837
  "type": "object"
13486
13838
  },
13839
+ "GoogleCloudDiscoveryengineV1Sitemap": {
13840
+ "description": "A sitemap for the SiteSearchEngine.",
13841
+ "id": "GoogleCloudDiscoveryengineV1Sitemap",
13842
+ "properties": {
13843
+ "createTime": {
13844
+ "description": "Output only. The sitemap's creation time.",
13845
+ "format": "google-datetime",
13846
+ "readOnly": true,
13847
+ "type": "string"
13848
+ },
13849
+ "name": {
13850
+ "description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.",
13851
+ "readOnly": true,
13852
+ "type": "string"
13853
+ },
13854
+ "uri": {
13855
+ "description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.",
13856
+ "type": "string"
13857
+ }
13858
+ },
13859
+ "type": "object"
13860
+ },
13487
13861
  "GoogleCloudDiscoveryengineV1SpannerSource": {
13488
13862
  "description": "The Spanner source for importing data",
13489
13863
  "id": "GoogleCloudDiscoveryengineV1SpannerSource",
@@ -14189,7 +14563,7 @@
14189
14563
  "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation",
14190
14564
  "properties": {
14191
14565
  "endIndex": {
14192
- "description": "End of the attributed segment, exclusive.",
14566
+ "description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.",
14193
14567
  "format": "int64",
14194
14568
  "type": "string"
14195
14569
  },
@@ -14201,7 +14575,7 @@
14201
14575
  "type": "array"
14202
14576
  },
14203
14577
  "startIndex": {
14204
- "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).",
14578
+ "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.",
14205
14579
  "format": "int64",
14206
14580
  "type": "string"
14207
14581
  }
@@ -14384,6 +14758,16 @@
14384
14758
  },
14385
14759
  "description": "Structured search data.",
14386
14760
  "type": "object"
14761
+ },
14762
+ "title": {
14763
+ "description": "Output only. The title of the document.",
14764
+ "readOnly": true,
14765
+ "type": "string"
14766
+ },
14767
+ "uri": {
14768
+ "description": "Output only. The URI of the document.",
14769
+ "readOnly": true,
14770
+ "type": "string"
14387
14771
  }
14388
14772
  },
14389
14773
  "type": "object"
@@ -14595,6 +14979,30 @@
14595
14979
  },
14596
14980
  "type": "object"
14597
14981
  },
14982
+ "GoogleCloudDiscoveryengineV1alphaBAPConfig": {
14983
+ "description": "The configuration for the BAP connector.",
14984
+ "id": "GoogleCloudDiscoveryengineV1alphaBAPConfig",
14985
+ "properties": {
14986
+ "supportedConnectorModes": {
14987
+ "description": "Required. The supported connector modes for the associated BAP connection.",
14988
+ "items": {
14989
+ "enum": [
14990
+ "CONNECTOR_MODE_UNSPECIFIED",
14991
+ "DATA_INGESTION",
14992
+ "ACTIONS"
14993
+ ],
14994
+ "enumDescriptions": [
14995
+ "Connector mode unspecified.",
14996
+ "Connector utilized for data ingestion.",
14997
+ "Connector utilized for Actions"
14998
+ ],
14999
+ "type": "string"
15000
+ },
15001
+ "type": "array"
15002
+ }
15003
+ },
15004
+ "type": "object"
15005
+ },
14598
15006
  "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": {
14599
15007
  "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.",
14600
15008
  "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata",
@@ -14636,11 +15044,11 @@
14636
15044
  "type": "boolean"
14637
15045
  },
14638
15046
  "kmsKey": {
14639
- "description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
15047
+ "description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
14640
15048
  "type": "string"
14641
15049
  },
14642
15050
  "kmsKeyVersion": {
14643
- "description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
15051
+ "description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
14644
15052
  "type": "string"
14645
15053
  },
14646
15054
  "lastRotationTimestampMicros": {
@@ -14650,7 +15058,7 @@
14650
15058
  "type": "string"
14651
15059
  },
14652
15060
  "name": {
14653
- "description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
15061
+ "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
14654
15062
  "type": "string"
14655
15063
  },
14656
15064
  "singleRegionKeys": {
@@ -14661,7 +15069,7 @@
14661
15069
  "type": "array"
14662
15070
  },
14663
15071
  "state": {
14664
- "description": "Output only. State of the CmekConfig.",
15072
+ "description": "Output only. The states of the CmekConfig.",
14665
15073
  "enum": [
14666
15074
  "STATE_UNSPECIFIED",
14667
15075
  "CREATING",
@@ -14869,6 +15277,11 @@
14869
15277
  "description": "Represents an entity that was synced in this ConnectorRun.",
14870
15278
  "id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun",
14871
15279
  "properties": {
15280
+ "deletedRecordCount": {
15281
+ "description": "The number of documents deleted.",
15282
+ "format": "int64",
15283
+ "type": "string"
15284
+ },
14872
15285
  "entityName": {
14873
15286
  "description": "The name of the source entity.",
14874
15287
  "type": "string"
@@ -15306,6 +15719,10 @@
15306
15719
  "description": "Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync.",
15307
15720
  "type": "boolean"
15308
15721
  },
15722
+ "bapConfig": {
15723
+ "$ref": "GoogleCloudDiscoveryengineV1alphaBAPConfig",
15724
+ "description": "Optional. The configuration for establishing a BAP connection."
15725
+ },
15309
15726
  "blockingReasons": {
15310
15727
  "description": "Output only. User actions that must be completed before the connector can start syncing data.",
15311
15728
  "items": {
@@ -15447,10 +15864,12 @@
15447
15864
  "syncMode": {
15448
15865
  "description": "The data synchronization mode supported by the data connector.",
15449
15866
  "enum": [
15450
- "PERIODIC"
15867
+ "PERIODIC",
15868
+ "STREAMING"
15451
15869
  ],
15452
15870
  "enumDescriptions": [
15453
- "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync."
15871
+ "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.",
15872
+ "The data will be synced in real time."
15454
15873
  ],
15455
15874
  "type": "string"
15456
15875
  },
@@ -15476,6 +15895,10 @@
15476
15895
  "description": "The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`",
15477
15896
  "type": "string"
15478
15897
  },
15898
+ "healthcareFhirConfig": {
15899
+ "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig",
15900
+ "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
15901
+ },
15479
15902
  "keyPropertyMappings": {
15480
15903
  "additionalProperties": {
15481
15904
  "type": "string"
@@ -15490,6 +15913,10 @@
15490
15913
  },
15491
15914
  "description": "The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.",
15492
15915
  "type": "object"
15916
+ },
15917
+ "startingSchema": {
15918
+ "$ref": "GoogleCloudDiscoveryengineV1alphaSchema",
15919
+ "description": "Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)."
15493
15920
  }
15494
15921
  },
15495
15922
  "type": "object"
@@ -15541,7 +15968,7 @@
15541
15968
  "type": "string"
15542
15969
  },
15543
15970
  "defaultSchemaId": {
15544
- "description": "Output only. The id of the default Schema asscociated to this data store.",
15971
+ "description": "Output only. The id of the default Schema associated to this data store.",
15545
15972
  "readOnly": true,
15546
15973
  "type": "string"
15547
15974
  },
@@ -15557,6 +15984,10 @@
15557
15984
  "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig",
15558
15985
  "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
15559
15986
  },
15987
+ "identityMappingStore": {
15988
+ "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.",
15989
+ "type": "string"
15990
+ },
15560
15991
  "idpConfig": {
15561
15992
  "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig",
15562
15993
  "description": "Output only. Data store level identity provider config.",
@@ -16145,6 +16576,10 @@
16145
16576
  "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig",
16146
16577
  "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation."
16147
16578
  },
16579
+ "allowCrossRegion": {
16580
+ "description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.",
16581
+ "type": "boolean"
16582
+ },
16148
16583
  "dialogflowAgentToLink": {
16149
16584
  "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.",
16150
16585
  "type": "string"
@@ -16457,31 +16892,6 @@
16457
16892
  },
16458
16893
  "type": "object"
16459
16894
  },
16460
- "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse": {
16461
- "description": "Response message for SiteSearchEngineService.FetchSitemaps method.",
16462
- "id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse",
16463
- "properties": {
16464
- "sitemapsMetadata": {
16465
- "description": "List of Sitemaps fetched.",
16466
- "items": {
16467
- "$ref": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata"
16468
- },
16469
- "type": "array"
16470
- }
16471
- },
16472
- "type": "object"
16473
- },
16474
- "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata": {
16475
- "description": "Contains a Sitemap and its metadata.",
16476
- "id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata",
16477
- "properties": {
16478
- "sitemap": {
16479
- "$ref": "GoogleCloudDiscoveryengineV1alphaSitemap",
16480
- "description": "The Sitemap."
16481
- }
16482
- },
16483
- "type": "object"
16484
- },
16485
16895
  "GoogleCloudDiscoveryengineV1alphaFieldConfig": {
16486
16896
  "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.",
16487
16897
  "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig",
@@ -16688,7 +17098,7 @@
16688
17098
  "type": "object"
16689
17099
  },
16690
17100
  "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata": {
16691
- "description": "IdentityMappingEntry LongRunningOperation metadata for [IdentityMappingStoreService.ImportIdentityMappings] and [IdentityMappingStoreService.PurgeIdentityMappings]",
17101
+ "description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings",
16692
17102
  "id": "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata",
16693
17103
  "properties": {
16694
17104
  "failureCount": {
@@ -17857,6 +18267,10 @@
17857
18267
  },
17858
18268
  "type": "array"
17859
18269
  },
18270
+ "displaySpec": {
18271
+ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec",
18272
+ "description": "Optional. Config for display feature, like match highlighting on search results."
18273
+ },
17860
18274
  "embeddingSpec": {
17861
18275
  "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec",
17862
18276
  "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path."
@@ -17927,15 +18341,33 @@
17927
18341
  "description": "The query expansion specification that specifies the conditions under which query expansion occurs."
17928
18342
  },
17929
18343
  "rankingExpression": {
17930
- "description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.",
18344
+ "description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking expression is not provided or set to BYOE, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result",
18345
+ "type": "string"
18346
+ },
18347
+ "rankingExpressionBackend": {
18348
+ "description": "Optional. The backend to use for the ranking expression evaluation.",
18349
+ "enum": [
18350
+ "UNKNOWN",
18351
+ "BYOE",
18352
+ "CLEARBOX"
18353
+ ],
18354
+ "enumDescriptions": [
18355
+ "Default option for unspecified/unknown values.",
18356
+ "Bring your own embedding (BYOE), the default way to evaluate the ranking expression.",
18357
+ "The expression is compiled into a Clearbox formula."
18358
+ ],
17931
18359
  "type": "string"
17932
18360
  },
17933
18361
  "regionCode": {
17934
18362
  "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.",
17935
18363
  "type": "string"
17936
18364
  },
18365
+ "relevanceScoreSpec": {
18366
+ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec",
18367
+ "description": "Optional. The specification for returning the relevance score."
18368
+ },
17937
18369
  "relevanceThreshold": {
17938
- "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.",
18370
+ "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.",
17939
18371
  "enum": [
17940
18372
  "RELEVANCE_THRESHOLD_UNSPECIFIED",
17941
18373
  "LOWEST",
@@ -18284,6 +18716,27 @@
18284
18716
  },
18285
18717
  "type": "object"
18286
18718
  },
18719
+ "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec": {
18720
+ "description": "Specifies features for display, like match highlighting.",
18721
+ "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec",
18722
+ "properties": {
18723
+ "matchHighlightingCondition": {
18724
+ "description": "The condition under which match highlighting should occur.",
18725
+ "enum": [
18726
+ "MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED",
18727
+ "MATCH_HIGHLIGHTING_DISABLED",
18728
+ "MATCH_HIGHLIGHTING_ENABLED"
18729
+ ],
18730
+ "enumDescriptions": [
18731
+ "Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.",
18732
+ "Disables match highlighting on all documents.",
18733
+ "Enables match highlighting on all documents."
18734
+ ],
18735
+ "type": "string"
18736
+ }
18737
+ },
18738
+ "type": "object"
18739
+ },
18287
18740
  "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": {
18288
18741
  "description": "The specification that uses customized query embedding vector to do semantic document retrieval.",
18289
18742
  "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec",
@@ -18476,6 +18929,17 @@
18476
18929
  },
18477
18930
  "type": "object"
18478
18931
  },
18932
+ "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec": {
18933
+ "description": "The specification for returning the document relevance score.",
18934
+ "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec",
18935
+ "properties": {
18936
+ "returnRelevanceScore": {
18937
+ "description": "Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.",
18938
+ "type": "boolean"
18939
+ }
18940
+ },
18941
+ "type": "object"
18942
+ },
18479
18943
  "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": {
18480
18944
  "description": "Specification for search as you type in search requests.",
18481
18945
  "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec",
@@ -18485,12 +18949,14 @@
18485
18949
  "enum": [
18486
18950
  "CONDITION_UNSPECIFIED",
18487
18951
  "DISABLED",
18488
- "ENABLED"
18952
+ "ENABLED",
18953
+ "AUTO"
18489
18954
  ],
18490
18955
  "enumDescriptions": [
18491
18956
  "Server behavior defaults to Condition.DISABLED.",
18492
18957
  "Disables Search As You Type.",
18493
- "Enables Search As You Type."
18958
+ "Enables Search As You Type.",
18959
+ "Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)."
18494
18960
  ],
18495
18961
  "type": "string"
18496
18962
  }
@@ -18506,7 +18972,7 @@
18506
18972
  "type": "string"
18507
18973
  },
18508
18974
  "searchResultPersistenceCount": {
18509
- "description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.",
18975
+ "description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.",
18510
18976
  "format": "int32",
18511
18977
  "type": "integer"
18512
18978
  }
@@ -19111,11 +19577,11 @@
19111
19577
  "type": "boolean"
19112
19578
  },
19113
19579
  "kmsKey": {
19114
- "description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
19580
+ "description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
19115
19581
  "type": "string"
19116
19582
  },
19117
19583
  "kmsKeyVersion": {
19118
- "description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
19584
+ "description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
19119
19585
  "type": "string"
19120
19586
  },
19121
19587
  "lastRotationTimestampMicros": {
@@ -19125,7 +19591,7 @@
19125
19591
  "type": "string"
19126
19592
  },
19127
19593
  "name": {
19128
- "description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
19594
+ "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
19129
19595
  "type": "string"
19130
19596
  },
19131
19597
  "singleRegionKeys": {
@@ -19136,7 +19602,7 @@
19136
19602
  "type": "array"
19137
19603
  },
19138
19604
  "state": {
19139
- "description": "Output only. State of the CmekConfig.",
19605
+ "description": "Output only. The states of the CmekConfig.",
19140
19606
  "enum": [
19141
19607
  "STATE_UNSPECIFIED",
19142
19608
  "CREATING",
@@ -19450,6 +19916,17 @@
19450
19916
  },
19451
19917
  "type": "object"
19452
19918
  },
19919
+ "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries": {
19920
+ "description": "The historical crawl rate timeseries data, used for monitoring.",
19921
+ "id": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
19922
+ "properties": {
19923
+ "qpsTimeSeries": {
19924
+ "$ref": "GoogleMonitoringV3TimeSeries",
19925
+ "description": "The QPS of the crawl rate."
19926
+ }
19927
+ },
19928
+ "type": "object"
19929
+ },
19453
19930
  "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": {
19454
19931
  "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
19455
19932
  "id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata",
@@ -19584,7 +20061,7 @@
19584
20061
  "type": "string"
19585
20062
  },
19586
20063
  "defaultSchemaId": {
19587
- "description": "Output only. The id of the default Schema asscociated to this data store.",
20064
+ "description": "Output only. The id of the default Schema associated to this data store.",
19588
20065
  "readOnly": true,
19589
20066
  "type": "string"
19590
20067
  },
@@ -19600,6 +20077,10 @@
19600
20077
  "$ref": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig",
19601
20078
  "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
19602
20079
  },
20080
+ "identityMappingStore": {
20081
+ "description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.",
20082
+ "type": "string"
20083
+ },
19603
20084
  "industryVertical": {
19604
20085
  "description": "Immutable. The industry vertical that the data store registers.",
19605
20086
  "enum": [
@@ -19720,6 +20201,21 @@
19720
20201
  },
19721
20202
  "type": "object"
19722
20203
  },
20204
+ "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries": {
20205
+ "description": "The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.",
20206
+ "id": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries",
20207
+ "properties": {
20208
+ "autoRefreshCrawlRate": {
20209
+ "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
20210
+ "description": "Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically."
20211
+ },
20212
+ "userTriggeredCrawlRate": {
20213
+ "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
20214
+ "description": "Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users."
20215
+ }
20216
+ },
20217
+ "type": "object"
20218
+ },
19723
20219
  "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": {
19724
20220
  "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
19725
20221
  "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata",
@@ -20068,6 +20564,10 @@
20068
20564
  "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig",
20069
20565
  "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation."
20070
20566
  },
20567
+ "allowCrossRegion": {
20568
+ "description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.",
20569
+ "type": "boolean"
20570
+ },
20071
20571
  "dialogflowAgentToLink": {
20072
20572
  "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.",
20073
20573
  "type": "string"
@@ -20246,31 +20746,6 @@
20246
20746
  },
20247
20747
  "type": "object"
20248
20748
  },
20249
- "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse": {
20250
- "description": "Response message for SiteSearchEngineService.FetchSitemaps method.",
20251
- "id": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse",
20252
- "properties": {
20253
- "sitemapsMetadata": {
20254
- "description": "List of Sitemaps fetched.",
20255
- "items": {
20256
- "$ref": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata"
20257
- },
20258
- "type": "array"
20259
- }
20260
- },
20261
- "type": "object"
20262
- },
20263
- "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata": {
20264
- "description": "Contains a Sitemap and its metadata.",
20265
- "id": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata",
20266
- "properties": {
20267
- "sitemap": {
20268
- "$ref": "GoogleCloudDiscoveryengineV1betaSitemap",
20269
- "description": "The Sitemap."
20270
- }
20271
- },
20272
- "type": "object"
20273
- },
20274
20749
  "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig": {
20275
20750
  "description": "Config to data store for `HEALTHCARE_FHIR` vertical.",
20276
20751
  "id": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig",
@@ -20287,7 +20762,7 @@
20287
20762
  "type": "object"
20288
20763
  },
20289
20764
  "GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata": {
20290
- "description": "IdentityMappingEntry LongRunningOperation metadata for [IdentityMappingStoreService.ImportIdentityMappings] and [IdentityMappingStoreService.PurgeIdentityMappings]",
20765
+ "description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings",
20291
20766
  "id": "GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata",
20292
20767
  "properties": {
20293
20768
  "failureCount": {
@@ -20648,6 +21123,55 @@
20648
21123
  },
20649
21124
  "type": "object"
20650
21125
  },
21126
+ "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse": {
21127
+ "description": "Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.",
21128
+ "id": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse",
21129
+ "properties": {
21130
+ "dedicatedCrawlRateTimeSeries": {
21131
+ "$ref": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries",
21132
+ "description": "The historical dedicated crawl rate timeseries data, used for monitoring."
21133
+ },
21134
+ "error": {
21135
+ "$ref": "GoogleRpcStatus",
21136
+ "description": "Errors from service when handling the request."
21137
+ },
21138
+ "organicCrawlRateTimeSeries": {
21139
+ "$ref": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries",
21140
+ "description": "The historical organic crawl rate timeseries data, used for monitoring."
21141
+ },
21142
+ "state": {
21143
+ "description": "Output only. The state of the response.",
21144
+ "enum": [
21145
+ "STATE_UNSPECIFIED",
21146
+ "SUCCEEDED",
21147
+ "FAILED"
21148
+ ],
21149
+ "enumDescriptions": [
21150
+ "The state is unspecified.",
21151
+ "The state is successful.",
21152
+ "The state is failed."
21153
+ ],
21154
+ "readOnly": true,
21155
+ "type": "string"
21156
+ }
21157
+ },
21158
+ "type": "object"
21159
+ },
21160
+ "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries": {
21161
+ "description": "The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website.",
21162
+ "id": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries",
21163
+ "properties": {
21164
+ "googleOrganicCrawlRate": {
21165
+ "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
21166
+ "description": "Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots."
21167
+ },
21168
+ "vertexAiOrganicCrawlRate": {
21169
+ "$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
21170
+ "description": "Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot."
21171
+ }
21172
+ },
21173
+ "type": "object"
21174
+ },
20651
21175
  "GoogleCloudDiscoveryengineV1betaProject": {
20652
21176
  "description": "Metadata and configurations for a Google Cloud project in the service.",
20653
21177
  "id": "GoogleCloudDiscoveryengineV1betaProject",
@@ -20868,6 +21392,49 @@
20868
21392
  },
20869
21393
  "type": "object"
20870
21394
  },
21395
+ "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata": {
21396
+ "description": "Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.",
21397
+ "id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata",
21398
+ "properties": {
21399
+ "createTime": {
21400
+ "description": "Operation create time.",
21401
+ "format": "google-datetime",
21402
+ "type": "string"
21403
+ },
21404
+ "updateTime": {
21405
+ "description": "Operation last update time. If the operation is done, this is also the finish time.",
21406
+ "format": "google-datetime",
21407
+ "type": "string"
21408
+ }
21409
+ },
21410
+ "type": "object"
21411
+ },
21412
+ "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse": {
21413
+ "description": "Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.",
21414
+ "id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse",
21415
+ "properties": {
21416
+ "error": {
21417
+ "$ref": "GoogleRpcStatus",
21418
+ "description": "Errors from service when handling the request."
21419
+ },
21420
+ "state": {
21421
+ "description": "Output only. The state of the response.",
21422
+ "enum": [
21423
+ "STATE_UNSPECIFIED",
21424
+ "SUCCEEDED",
21425
+ "FAILED"
21426
+ ],
21427
+ "enumDescriptions": [
21428
+ "The state is unspecified.",
21429
+ "The state is successful.",
21430
+ "The state is failed."
21431
+ ],
21432
+ "readOnly": true,
21433
+ "type": "string"
21434
+ }
21435
+ },
21436
+ "type": "object"
21437
+ },
20871
21438
  "GoogleCloudDiscoveryengineV1betaSchema": {
20872
21439
  "description": "Defines the structure and layout of a type of document data.",
20873
21440
  "id": "GoogleCloudDiscoveryengineV1betaSchema",
@@ -21015,15 +21582,33 @@
21015
21582
  "description": "The query expansion specification that specifies the conditions under which query expansion occurs."
21016
21583
  },
21017
21584
  "rankingExpression": {
21018
- "description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.",
21585
+ "description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking expression is not provided or set to BYOE, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result",
21586
+ "type": "string"
21587
+ },
21588
+ "rankingExpressionBackend": {
21589
+ "description": "Optional. The backend to use for the ranking expression evaluation.",
21590
+ "enum": [
21591
+ "UNKNOWN",
21592
+ "BYOE",
21593
+ "CLEARBOX"
21594
+ ],
21595
+ "enumDescriptions": [
21596
+ "Default option for unspecified/unknown values.",
21597
+ "Bring your own embedding (BYOE), the default way to evaluate the ranking expression.",
21598
+ "The expression is compiled into a Clearbox formula."
21599
+ ],
21019
21600
  "type": "string"
21020
21601
  },
21021
21602
  "regionCode": {
21022
21603
  "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.",
21023
21604
  "type": "string"
21024
21605
  },
21606
+ "relevanceScoreSpec": {
21607
+ "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec",
21608
+ "description": "Optional. The specification for returning the relevance score."
21609
+ },
21025
21610
  "relevanceThreshold": {
21026
- "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.",
21611
+ "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.",
21027
21612
  "enum": [
21028
21613
  "RELEVANCE_THRESHOLD_UNSPECIFIED",
21029
21614
  "LOWEST",
@@ -21564,6 +22149,17 @@
21564
22149
  },
21565
22150
  "type": "object"
21566
22151
  },
22152
+ "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec": {
22153
+ "description": "The specification for returning the document relevance score.",
22154
+ "id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec",
22155
+ "properties": {
22156
+ "returnRelevanceScore": {
22157
+ "description": "Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.",
22158
+ "type": "boolean"
22159
+ }
22160
+ },
22161
+ "type": "object"
22162
+ },
21567
22163
  "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": {
21568
22164
  "description": "Specification for search as you type in search requests.",
21569
22165
  "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec",
@@ -21573,12 +22169,14 @@
21573
22169
  "enum": [
21574
22170
  "CONDITION_UNSPECIFIED",
21575
22171
  "DISABLED",
21576
- "ENABLED"
22172
+ "ENABLED",
22173
+ "AUTO"
21577
22174
  ],
21578
22175
  "enumDescriptions": [
21579
22176
  "Server behavior defaults to Condition.DISABLED.",
21580
22177
  "Disables Search As You Type.",
21581
- "Enables Search As You Type."
22178
+ "Enables Search As You Type.",
22179
+ "Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)."
21582
22180
  ],
21583
22181
  "type": "string"
21584
22182
  }
@@ -21594,7 +22192,7 @@
21594
22192
  "type": "string"
21595
22193
  },
21596
22194
  "searchResultPersistenceCount": {
21597
- "description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.",
22195
+ "description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.",
21598
22196
  "format": "int32",
21599
22197
  "type": "integer"
21600
22198
  }
@@ -21622,6 +22220,49 @@
21622
22220
  },
21623
22221
  "type": "object"
21624
22222
  },
22223
+ "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata": {
22224
+ "description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.",
22225
+ "id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata",
22226
+ "properties": {
22227
+ "createTime": {
22228
+ "description": "Operation create time.",
22229
+ "format": "google-datetime",
22230
+ "type": "string"
22231
+ },
22232
+ "updateTime": {
22233
+ "description": "Operation last update time. If the operation is done, this is also the finish time.",
22234
+ "format": "google-datetime",
22235
+ "type": "string"
22236
+ }
22237
+ },
22238
+ "type": "object"
22239
+ },
22240
+ "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse": {
22241
+ "description": "Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.",
22242
+ "id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse",
22243
+ "properties": {
22244
+ "error": {
22245
+ "$ref": "GoogleRpcStatus",
22246
+ "description": "Errors from service when handling the request."
22247
+ },
22248
+ "state": {
22249
+ "description": "Output only. The state of the response.",
22250
+ "enum": [
22251
+ "STATE_UNSPECIFIED",
22252
+ "SUCCEEDED",
22253
+ "FAILED"
22254
+ ],
22255
+ "enumDescriptions": [
22256
+ "The state is unspecified.",
22257
+ "The state is successful.",
22258
+ "The state is failed."
22259
+ ],
22260
+ "readOnly": true,
22261
+ "type": "string"
22262
+ }
22263
+ },
22264
+ "type": "object"
22265
+ },
21625
22266
  "GoogleCloudDiscoveryengineV1betaSingleRegionKey": {
21626
22267
  "description": "Metadata for single-regional CMEKs.",
21627
22268
  "id": "GoogleCloudDiscoveryengineV1betaSingleRegionKey",