google-api-python-client 2.153.0__py2.py3-none-any.whl → 2.155.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 (216) hide show
  1. {google_api_python_client-2.153.0.dist-info → google_api_python_client-2.155.0.dist-info}/METADATA +1 -1
  2. {google_api_python_client-2.153.0.dist-info → google_api_python_client-2.155.0.dist-info}/RECORD +216 -211
  3. googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +11 -3
  4. googleapiclient/discovery_cache/documents/addressvalidation.v1.json +8 -8
  5. googleapiclient/discovery_cache/documents/admin.directory_v1.json +6 -2
  6. googleapiclient/discovery_cache/documents/admin.directoryv1.json +6 -2
  7. googleapiclient/discovery_cache/documents/adsense.v2.json +3 -3
  8. googleapiclient/discovery_cache/documents/adsenseplatform.v1.json +3 -3
  9. googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json +3 -3
  10. googleapiclient/discovery_cache/documents/aiplatform.v1.json +3479 -185
  11. googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +1607 -308
  12. googleapiclient/discovery_cache/documents/alloydb.v1.json +81 -1
  13. googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +112 -1
  14. googleapiclient/discovery_cache/documents/alloydb.v1beta.json +112 -1
  15. googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json +5 -1
  16. googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json +11 -1
  17. googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json +3 -3
  18. googleapiclient/discovery_cache/documents/androidenterprise.v1.json +66 -4
  19. googleapiclient/discovery_cache/documents/androidmanagement.v1.json +28 -12
  20. googleapiclient/discovery_cache/documents/androidpublisher.v3.json +37 -1
  21. googleapiclient/discovery_cache/documents/apigee.v1.json +32 -1
  22. googleapiclient/discovery_cache/documents/appengine.v1.json +67 -1
  23. googleapiclient/discovery_cache/documents/appengine.v1alpha.json +20 -1
  24. googleapiclient/discovery_cache/documents/appengine.v1beta.json +67 -1
  25. googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json +3 -3
  26. googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json +3 -3
  27. googleapiclient/discovery_cache/documents/backupdr.v1.json +2 -2
  28. googleapiclient/discovery_cache/documents/batch.v1.json +10 -10
  29. googleapiclient/discovery_cache/documents/beyondcorp.v1.json +1 -69
  30. googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +1 -69
  31. googleapiclient/discovery_cache/documents/bigquery.v2.json +20 -6
  32. googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +8 -8
  33. googleapiclient/discovery_cache/documents/binaryauthorization.v1.json +1 -2
  34. googleapiclient/discovery_cache/documents/chat.v1.json +5 -5
  35. googleapiclient/discovery_cache/documents/checks.v1alpha.json +496 -6
  36. googleapiclient/discovery_cache/documents/chromemanagement.v1.json +763 -1
  37. googleapiclient/discovery_cache/documents/chromepolicy.v1.json +2 -2
  38. googleapiclient/discovery_cache/documents/classroom.v1.json +399 -1
  39. googleapiclient/discovery_cache/documents/cloudasset.v1.json +11 -7
  40. googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +5 -1
  41. googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +5 -1
  42. googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +5 -1
  43. googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +5 -1
  44. googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json +2 -2
  45. googleapiclient/discovery_cache/documents/cloudchannel.v1.json +13 -13
  46. googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +2 -2
  47. googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +2 -2
  48. googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +2 -2
  49. googleapiclient/discovery_cache/documents/cloudidentity.v1.json +33 -7
  50. googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +53 -13
  51. googleapiclient/discovery_cache/documents/cloudkms.v1.json +2 -2
  52. googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +3 -3
  53. googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +2 -2
  54. googleapiclient/discovery_cache/documents/cloudsearch.v1.json +1 -63
  55. googleapiclient/discovery_cache/documents/cloudshell.v1.json +2 -2
  56. googleapiclient/discovery_cache/documents/cloudtasks.v2.json +2 -2
  57. googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +3 -3
  58. googleapiclient/discovery_cache/documents/compute.alpha.json +1170 -164
  59. googleapiclient/discovery_cache/documents/compute.beta.json +935 -72
  60. googleapiclient/discovery_cache/documents/compute.v1.json +2980 -1157
  61. googleapiclient/discovery_cache/documents/config.v1.json +3 -3
  62. googleapiclient/discovery_cache/documents/connectors.v1.json +334 -48
  63. googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +21 -5
  64. googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +108 -963
  65. googleapiclient/discovery_cache/documents/container.v1.json +2 -2
  66. googleapiclient/discovery_cache/documents/container.v1beta1.json +6 -4
  67. googleapiclient/discovery_cache/documents/content.v2.1.json +7 -3
  68. googleapiclient/discovery_cache/documents/contentwarehouse.v1.json +8 -8
  69. googleapiclient/discovery_cache/documents/css.v1.json +12 -12
  70. googleapiclient/discovery_cache/documents/datacatalog.v1.json +2 -2
  71. googleapiclient/discovery_cache/documents/dataform.v1beta1.json +6 -225
  72. googleapiclient/discovery_cache/documents/datafusion.v1.json +31 -362
  73. googleapiclient/discovery_cache/documents/datafusion.v1beta1.json +15 -347
  74. googleapiclient/discovery_cache/documents/datalabeling.v1beta1.json +2 -2
  75. googleapiclient/discovery_cache/documents/datalineage.v1.json +13 -3
  76. googleapiclient/discovery_cache/documents/datamigration.v1.json +330 -7
  77. googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +2 -2
  78. googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +16 -7
  79. googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +16 -7
  80. googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +16 -7
  81. googleapiclient/discovery_cache/documents/developerconnect.v1.json +2 -2
  82. googleapiclient/discovery_cache/documents/dialogflow.v2.json +20 -20
  83. googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +11 -11
  84. googleapiclient/discovery_cache/documents/dialogflow.v3.json +8 -8
  85. googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +11 -11
  86. googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +4 -115
  87. googleapiclient/discovery_cache/documents/discoveryengine.v1.json +867 -107
  88. googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +884 -130
  89. googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +940 -116
  90. googleapiclient/discovery_cache/documents/displayvideo.v2.json +19 -7
  91. googleapiclient/discovery_cache/documents/displayvideo.v3.json +25 -11
  92. googleapiclient/discovery_cache/documents/dlp.v2.json +13 -5
  93. googleapiclient/discovery_cache/documents/drive.v3.json +148 -107
  94. googleapiclient/discovery_cache/documents/eventarc.v1.json +23 -9
  95. googleapiclient/discovery_cache/documents/fcm.v1.json +2 -2
  96. googleapiclient/discovery_cache/documents/file.v1.json +2 -2
  97. googleapiclient/discovery_cache/documents/file.v1beta1.json +3 -3
  98. googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +2 -2
  99. googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +216 -6
  100. googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json +2 -2
  101. googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json +2 -1
  102. googleapiclient/discovery_cache/documents/firebasehosting.v1.json +2 -2
  103. googleapiclient/discovery_cache/documents/firebaseml.v1.json +2 -2
  104. googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +181 -1
  105. googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json +112 -1
  106. googleapiclient/discovery_cache/documents/forms.v1.json +33 -1
  107. googleapiclient/discovery_cache/documents/gkebackup.v1.json +2 -2
  108. googleapiclient/discovery_cache/documents/gkehub.v1.json +11 -1
  109. googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +11 -1
  110. googleapiclient/discovery_cache/documents/gkehub.v1beta.json +11 -1
  111. googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +11 -1
  112. googleapiclient/discovery_cache/documents/gkeonprem.v1.json +7 -2
  113. googleapiclient/discovery_cache/documents/healthcare.v1.json +22 -22
  114. googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +3 -3
  115. googleapiclient/discovery_cache/documents/iam.v1.json +15 -15
  116. googleapiclient/discovery_cache/documents/iam.v2.json +2 -2
  117. googleapiclient/discovery_cache/documents/iam.v2beta.json +2 -2
  118. googleapiclient/discovery_cache/documents/iap.v1.json +2 -2
  119. googleapiclient/discovery_cache/documents/integrations.v1.json +107 -19
  120. googleapiclient/discovery_cache/documents/language.v1beta2.json +4 -4
  121. googleapiclient/discovery_cache/documents/language.v2.json +10 -10
  122. googleapiclient/discovery_cache/documents/localservices.v1.json +3 -3
  123. googleapiclient/discovery_cache/documents/looker.v1.json +2 -2
  124. googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +23 -23
  125. googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json +2 -2
  126. googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +4 -4
  127. googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +3 -3
  128. googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json +2 -2
  129. googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json +2 -2
  130. googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +7 -3
  131. googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json +2 -2
  132. googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json +2 -2
  133. googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json +2 -2
  134. googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json +2 -2
  135. googleapiclient/discovery_cache/documents/metastore.v1.json +3 -3
  136. googleapiclient/discovery_cache/documents/metastore.v1alpha.json +3 -3
  137. googleapiclient/discovery_cache/documents/metastore.v1beta.json +3 -3
  138. googleapiclient/discovery_cache/documents/metastore.v2.json +1813 -0
  139. googleapiclient/discovery_cache/documents/metastore.v2alpha.json +2313 -0
  140. googleapiclient/discovery_cache/documents/metastore.v2beta.json +2313 -0
  141. googleapiclient/discovery_cache/documents/migrationcenter.v1.json +720 -7
  142. googleapiclient/discovery_cache/documents/ml.v1.json +3 -3
  143. googleapiclient/discovery_cache/documents/monitoring.v3.json +8 -4
  144. googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json +6 -6
  145. googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +6 -6
  146. googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json +6 -6
  147. googleapiclient/discovery_cache/documents/netapp.v1.json +256 -8
  148. googleapiclient/discovery_cache/documents/netapp.v1beta1.json +256 -8
  149. googleapiclient/discovery_cache/documents/networkmanagement.v1.json +22 -7
  150. googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +22 -7
  151. googleapiclient/discovery_cache/documents/networksecurity.v1.json +562 -8
  152. googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +2223 -1040
  153. googleapiclient/discovery_cache/documents/networkservices.v1.json +572 -37
  154. googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +273 -37
  155. googleapiclient/discovery_cache/documents/notebooks.v1.json +6 -6
  156. googleapiclient/discovery_cache/documents/notebooks.v2.json +2 -2
  157. googleapiclient/discovery_cache/documents/orgpolicy.v2.json +13 -1
  158. googleapiclient/discovery_cache/documents/osconfig.v1.json +4 -4
  159. googleapiclient/discovery_cache/documents/osconfig.v1alpha.json +2 -2
  160. googleapiclient/discovery_cache/documents/osconfig.v1beta.json +3 -3
  161. googleapiclient/discovery_cache/documents/osconfig.v2beta.json +4 -4
  162. googleapiclient/discovery_cache/documents/parallelstore.v1.json +975 -0
  163. googleapiclient/discovery_cache/documents/parallelstore.v1beta.json +980 -0
  164. googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +4 -4
  165. googleapiclient/discovery_cache/documents/places.v1.json +4 -4
  166. googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json +13 -13
  167. googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json +13 -13
  168. googleapiclient/discovery_cache/documents/playintegrity.v1.json +38 -1
  169. googleapiclient/discovery_cache/documents/policysimulator.v1.json +9 -1
  170. googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +9 -1
  171. googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +9 -1
  172. googleapiclient/discovery_cache/documents/privateca.v1.json +8 -8
  173. googleapiclient/discovery_cache/documents/pubsublite.v1.json +2 -2
  174. googleapiclient/discovery_cache/documents/redis.v1.json +628 -2
  175. googleapiclient/discovery_cache/documents/redis.v1beta1.json +629 -3
  176. googleapiclient/discovery_cache/documents/retail.v2.json +30 -12
  177. googleapiclient/discovery_cache/documents/retail.v2alpha.json +30 -12
  178. googleapiclient/discovery_cache/documents/retail.v2beta.json +30 -12
  179. googleapiclient/discovery_cache/documents/run.v2.json +27 -4
  180. googleapiclient/discovery_cache/documents/secretmanager.v1.json +2 -2
  181. googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +2 -2
  182. googleapiclient/discovery_cache/documents/securitycenter.v1.json +540 -4
  183. googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +463 -4
  184. googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +462 -3
  185. googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +14 -3
  186. googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +19 -4
  187. googleapiclient/discovery_cache/documents/servicemanagement.v1.json +17 -2
  188. googleapiclient/discovery_cache/documents/servicenetworking.v1.json +9 -2
  189. googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +8 -1
  190. googleapiclient/discovery_cache/documents/serviceusage.v1.json +14 -3
  191. googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +13 -2
  192. googleapiclient/discovery_cache/documents/spanner.v1.json +6 -6
  193. googleapiclient/discovery_cache/documents/speech.v1.json +21 -1
  194. googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +21 -1
  195. googleapiclient/discovery_cache/documents/sqladmin.v1.json +157 -84
  196. googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +157 -96
  197. googleapiclient/discovery_cache/documents/storage.v1.json +23 -2
  198. googleapiclient/discovery_cache/documents/sts.v1.json +9 -2
  199. googleapiclient/discovery_cache/documents/sts.v1beta.json +8 -1
  200. googleapiclient/discovery_cache/documents/tagmanager.v2.json +5 -1
  201. googleapiclient/discovery_cache/documents/texttospeech.v1.json +2 -2
  202. googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +2 -1
  203. googleapiclient/discovery_cache/documents/vault.v1.json +2 -2
  204. googleapiclient/discovery_cache/documents/verifiedaccess.v2.json +2 -2
  205. googleapiclient/discovery_cache/documents/vision.v1.json +2 -2
  206. googleapiclient/discovery_cache/documents/vmmigration.v1.json +2 -2
  207. googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +2 -2
  208. googleapiclient/discovery_cache/documents/walletobjects.v1.json +121 -2
  209. googleapiclient/discovery_cache/documents/webrisk.v1.json +2 -2
  210. googleapiclient/discovery_cache/documents/workstations.v1.json +6 -6
  211. googleapiclient/discovery_cache/documents/workstations.v1beta.json +6 -6
  212. googleapiclient/discovery_cache/documents/youtube.v3.json +28 -62
  213. googleapiclient/version.py +1 -1
  214. {google_api_python_client-2.153.0.dist-info → google_api_python_client-2.155.0.dist-info}/LICENSE +0 -0
  215. {google_api_python_client-2.153.0.dist-info → google_api_python_client-2.155.0.dist-info}/WHEEL +0 -0
  216. {google_api_python_client-2.153.0.dist-info → google_api_python_client-2.155.0.dist-info}/top_level.txt +0 -0
@@ -15,6 +15,28 @@
15
15
  "description": "Discovery Engine API.",
16
16
  "discoveryVersion": "v1",
17
17
  "documentationLink": "https://cloud.google.com/generative-ai-app-builder/docs/",
18
+ "endpoints": [
19
+ {
20
+ "description": "Regional Endpoint",
21
+ "endpointUrl": "https://discoveryengine.asia-northeast1.rep.googleapis.com/",
22
+ "location": "asia-northeast1"
23
+ },
24
+ {
25
+ "description": "Regional Endpoint",
26
+ "endpointUrl": "https://discoveryengine.europe-west2.rep.googleapis.com/",
27
+ "location": "europe-west2"
28
+ },
29
+ {
30
+ "description": "Regional Endpoint",
31
+ "endpointUrl": "https://discoveryengine.us.rep.googleapis.com/",
32
+ "location": "us"
33
+ },
34
+ {
35
+ "description": "Regional Endpoint",
36
+ "endpointUrl": "https://discoveryengine.eu.rep.googleapis.com/",
37
+ "location": "eu"
38
+ }
39
+ ],
18
40
  "fullyEncodeReservedExpansion": true,
19
41
  "icons": {
20
42
  "x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -1219,7 +1241,7 @@
1219
1241
  "operations": {
1220
1242
  "methods": {
1221
1243
  "cancel": {
1222
- "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
1244
+ "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
1223
1245
  "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel",
1224
1246
  "httpMethod": "POST",
1225
1247
  "id": "discoveryengine.projects.locations.collections.dataStores.branches.operations.cancel",
@@ -2369,6 +2391,34 @@
2369
2391
  "scopes": [
2370
2392
  "https://www.googleapis.com/auth/cloud-platform"
2371
2393
  ]
2394
+ },
2395
+ "streamAnswer": {
2396
+ "description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.",
2397
+ "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:streamAnswer",
2398
+ "httpMethod": "POST",
2399
+ "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.streamAnswer",
2400
+ "parameterOrder": [
2401
+ "servingConfig"
2402
+ ],
2403
+ "parameters": {
2404
+ "servingConfig": {
2405
+ "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
2406
+ "location": "path",
2407
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
2408
+ "required": true,
2409
+ "type": "string"
2410
+ }
2411
+ },
2412
+ "path": "v1alpha/{+servingConfig}:streamAnswer",
2413
+ "request": {
2414
+ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest"
2415
+ },
2416
+ "response": {
2417
+ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse"
2418
+ },
2419
+ "scopes": [
2420
+ "https://www.googleapis.com/auth/cloud-platform"
2421
+ ]
2372
2422
  }
2373
2423
  }
2374
2424
  },
@@ -2436,6 +2486,11 @@
2436
2486
  "name"
2437
2487
  ],
2438
2488
  "parameters": {
2489
+ "includeAnswerDetails": {
2490
+ "description": "Optional. If set to true, the full session including all answer details will be returned.",
2491
+ "location": "query",
2492
+ "type": "boolean"
2493
+ },
2439
2494
  "name": {
2440
2495
  "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
2441
2496
  "location": "path",
@@ -2467,7 +2522,7 @@
2467
2522
  "type": "string"
2468
2523
  },
2469
2524
  "orderBy": {
2470
- "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: \"update_time desc\" \"create_time\"",
2525
+ "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * \"update_time desc\" * \"create_time\" * \"is_pinned desc,update_time desc\": list sessions by is_pinned first, then by update_time.",
2471
2526
  "location": "query",
2472
2527
  "type": "string"
2473
2528
  },
@@ -3223,7 +3278,7 @@
3223
3278
  "type": "string"
3224
3279
  },
3225
3280
  "parent": {
3226
- "description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.",
3281
+ "description": "Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.",
3227
3282
  "location": "path",
3228
3283
  "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
3229
3284
  "required": true,
@@ -4249,6 +4304,34 @@
4249
4304
  "scopes": [
4250
4305
  "https://www.googleapis.com/auth/cloud-platform"
4251
4306
  ]
4307
+ },
4308
+ "streamAnswer": {
4309
+ "description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.",
4310
+ "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:streamAnswer",
4311
+ "httpMethod": "POST",
4312
+ "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.streamAnswer",
4313
+ "parameterOrder": [
4314
+ "servingConfig"
4315
+ ],
4316
+ "parameters": {
4317
+ "servingConfig": {
4318
+ "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
4319
+ "location": "path",
4320
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
4321
+ "required": true,
4322
+ "type": "string"
4323
+ }
4324
+ },
4325
+ "path": "v1alpha/{+servingConfig}:streamAnswer",
4326
+ "request": {
4327
+ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest"
4328
+ },
4329
+ "response": {
4330
+ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse"
4331
+ },
4332
+ "scopes": [
4333
+ "https://www.googleapis.com/auth/cloud-platform"
4334
+ ]
4252
4335
  }
4253
4336
  }
4254
4337
  },
@@ -4316,6 +4399,11 @@
4316
4399
  "name"
4317
4400
  ],
4318
4401
  "parameters": {
4402
+ "includeAnswerDetails": {
4403
+ "description": "Optional. If set to true, the full session including all answer details will be returned.",
4404
+ "location": "query",
4405
+ "type": "boolean"
4406
+ },
4319
4407
  "name": {
4320
4408
  "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
4321
4409
  "location": "path",
@@ -4347,7 +4435,7 @@
4347
4435
  "type": "string"
4348
4436
  },
4349
4437
  "orderBy": {
4350
- "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: \"update_time desc\" \"create_time\"",
4438
+ "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * \"update_time desc\" * \"create_time\" * \"is_pinned desc,update_time desc\": list sessions by is_pinned first, then by update_time.",
4351
4439
  "location": "query",
4352
4440
  "type": "string"
4353
4441
  },
@@ -5214,7 +5302,7 @@
5214
5302
  "operations": {
5215
5303
  "methods": {
5216
5304
  "cancel": {
5217
- "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
5305
+ "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
5218
5306
  "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel",
5219
5307
  "httpMethod": "POST",
5220
5308
  "id": "discoveryengine.projects.locations.dataStores.branches.operations.cancel",
@@ -6263,6 +6351,34 @@
6263
6351
  "scopes": [
6264
6352
  "https://www.googleapis.com/auth/cloud-platform"
6265
6353
  ]
6354
+ },
6355
+ "streamAnswer": {
6356
+ "description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.",
6357
+ "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:streamAnswer",
6358
+ "httpMethod": "POST",
6359
+ "id": "discoveryengine.projects.locations.dataStores.servingConfigs.streamAnswer",
6360
+ "parameterOrder": [
6361
+ "servingConfig"
6362
+ ],
6363
+ "parameters": {
6364
+ "servingConfig": {
6365
+ "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
6366
+ "location": "path",
6367
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
6368
+ "required": true,
6369
+ "type": "string"
6370
+ }
6371
+ },
6372
+ "path": "v1alpha/{+servingConfig}:streamAnswer",
6373
+ "request": {
6374
+ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest"
6375
+ },
6376
+ "response": {
6377
+ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse"
6378
+ },
6379
+ "scopes": [
6380
+ "https://www.googleapis.com/auth/cloud-platform"
6381
+ ]
6266
6382
  }
6267
6383
  }
6268
6384
  },
@@ -6330,6 +6446,11 @@
6330
6446
  "name"
6331
6447
  ],
6332
6448
  "parameters": {
6449
+ "includeAnswerDetails": {
6450
+ "description": "Optional. If set to true, the full session including all answer details will be returned.",
6451
+ "location": "query",
6452
+ "type": "boolean"
6453
+ },
6333
6454
  "name": {
6334
6455
  "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
6335
6456
  "location": "path",
@@ -6361,7 +6482,7 @@
6361
6482
  "type": "string"
6362
6483
  },
6363
6484
  "orderBy": {
6364
- "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: \"update_time desc\" \"create_time\"",
6485
+ "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * \"update_time desc\" * \"create_time\" * \"is_pinned desc,update_time desc\": list sessions by is_pinned first, then by update_time.",
6365
6486
  "location": "query",
6366
6487
  "type": "string"
6367
6488
  },
@@ -6889,7 +7010,7 @@
6889
7010
  "type": "string"
6890
7011
  },
6891
7012
  "parent": {
6892
- "description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.",
7013
+ "description": "Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.",
6893
7014
  "location": "path",
6894
7015
  "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
6895
7016
  "required": true,
@@ -7798,7 +7919,7 @@
7798
7919
  "type": "string"
7799
7920
  },
7800
7921
  "parent": {
7801
- "description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.",
7922
+ "description": "Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.",
7802
7923
  "location": "path",
7803
7924
  "pattern": "^projects/[^/]+/locations/[^/]+$",
7804
7925
  "required": true,
@@ -7823,6 +7944,34 @@
7823
7944
  "https://www.googleapis.com/auth/cloud-platform"
7824
7945
  ]
7825
7946
  },
7947
+ "import": {
7948
+ "description": "Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.",
7949
+ "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:import",
7950
+ "httpMethod": "POST",
7951
+ "id": "discoveryengine.projects.locations.userEvents.import",
7952
+ "parameterOrder": [
7953
+ "parent"
7954
+ ],
7955
+ "parameters": {
7956
+ "parent": {
7957
+ "description": "Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`",
7958
+ "location": "path",
7959
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
7960
+ "required": true,
7961
+ "type": "string"
7962
+ }
7963
+ },
7964
+ "path": "v1alpha/{+parent}/userEvents:import",
7965
+ "request": {
7966
+ "$ref": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest"
7967
+ },
7968
+ "response": {
7969
+ "$ref": "GoogleLongrunningOperation"
7970
+ },
7971
+ "scopes": [
7972
+ "https://www.googleapis.com/auth/cloud-platform"
7973
+ ]
7974
+ },
7826
7975
  "write": {
7827
7976
  "description": "Writes a single user event.",
7828
7977
  "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:write",
@@ -8007,7 +8156,7 @@
8007
8156
  }
8008
8157
  }
8009
8158
  },
8010
- "revision": "20241031",
8159
+ "revision": "20241206",
8011
8160
  "rootUrl": "https://discoveryengine.googleapis.com/",
8012
8161
  "schemas": {
8013
8162
  "GoogleApiDistribution": {
@@ -8564,6 +8713,10 @@
8564
8713
  "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
8565
8714
  "type": "string"
8566
8715
  },
8716
+ "promoteAction": {
8717
+ "$ref": "GoogleCloudDiscoveryengineV1ControlPromoteAction",
8718
+ "description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
8719
+ },
8567
8720
  "redirectAction": {
8568
8721
  "$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction",
8569
8722
  "description": "Defines a redirect-type control."
@@ -8645,6 +8798,21 @@
8645
8798
  },
8646
8799
  "type": "object"
8647
8800
  },
8801
+ "GoogleCloudDiscoveryengineV1ControlPromoteAction": {
8802
+ "description": "Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store.",
8803
+ "id": "GoogleCloudDiscoveryengineV1ControlPromoteAction",
8804
+ "properties": {
8805
+ "dataStore": {
8806
+ "description": "Required. Data store with which this promotion is attached to.",
8807
+ "type": "string"
8808
+ },
8809
+ "searchLinkPromotion": {
8810
+ "$ref": "GoogleCloudDiscoveryengineV1SearchLinkPromotion",
8811
+ "description": "Required. Promotion attached to this action."
8812
+ }
8813
+ },
8814
+ "type": "object"
8815
+ },
8648
8816
  "GoogleCloudDiscoveryengineV1ControlRedirectAction": {
8649
8817
  "description": "Redirects a shopper to the provided URI.",
8650
8818
  "id": "GoogleCloudDiscoveryengineV1ControlRedirectAction",
@@ -9718,13 +9886,387 @@
9718
9886
  "description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
9719
9887
  "type": "string"
9720
9888
  },
9721
- "structSchema": {
9722
- "additionalProperties": {
9723
- "description": "Properties of the object.",
9724
- "type": "any"
9889
+ "structSchema": {
9890
+ "additionalProperties": {
9891
+ "description": "Properties of the object.",
9892
+ "type": "any"
9893
+ },
9894
+ "description": "The structured representation of the schema.",
9895
+ "type": "object"
9896
+ }
9897
+ },
9898
+ "type": "object"
9899
+ },
9900
+ "GoogleCloudDiscoveryengineV1SearchLinkPromotion": {
9901
+ "description": "Promotion proto includes uri and other helping information to display the promotion.",
9902
+ "id": "GoogleCloudDiscoveryengineV1SearchLinkPromotion",
9903
+ "properties": {
9904
+ "description": {
9905
+ "description": "Optional. The Promotion description. Maximum length: 200 characters.",
9906
+ "type": "string"
9907
+ },
9908
+ "enabled": {
9909
+ "description": "Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.",
9910
+ "type": "boolean"
9911
+ },
9912
+ "imageUri": {
9913
+ "description": "Optional. The promotion thumbnail image url.",
9914
+ "type": "string"
9915
+ },
9916
+ "title": {
9917
+ "description": "Required. The title of the promotion. Maximum length: 160 characters.",
9918
+ "type": "string"
9919
+ },
9920
+ "uri": {
9921
+ "description": "Required. The URL for the page the user wants to promote.",
9922
+ "type": "string"
9923
+ }
9924
+ },
9925
+ "type": "object"
9926
+ },
9927
+ "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec": {
9928
+ "description": "A specification for configuring the behavior of content search.",
9929
+ "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec",
9930
+ "properties": {
9931
+ "chunkSpec": {
9932
+ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec",
9933
+ "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS"
9934
+ },
9935
+ "extractiveContentSpec": {
9936
+ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec",
9937
+ "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response."
9938
+ },
9939
+ "searchResultMode": {
9940
+ "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.",
9941
+ "enum": [
9942
+ "SEARCH_RESULT_MODE_UNSPECIFIED",
9943
+ "DOCUMENTS",
9944
+ "CHUNKS"
9945
+ ],
9946
+ "enumDescriptions": [
9947
+ "Default value.",
9948
+ "Returns documents in the search result.",
9949
+ "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
9950
+ ],
9951
+ "type": "string"
9952
+ },
9953
+ "snippetSpec": {
9954
+ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec",
9955
+ "description": "If `snippetSpec` is not specified, snippets are not included in the search response."
9956
+ },
9957
+ "summarySpec": {
9958
+ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec",
9959
+ "description": "If `summarySpec` is not specified, summaries are not included in the search response."
9960
+ }
9961
+ },
9962
+ "type": "object"
9963
+ },
9964
+ "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec": {
9965
+ "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS",
9966
+ "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec",
9967
+ "properties": {
9968
+ "numNextChunks": {
9969
+ "description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.",
9970
+ "format": "int32",
9971
+ "type": "integer"
9972
+ },
9973
+ "numPreviousChunks": {
9974
+ "description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.",
9975
+ "format": "int32",
9976
+ "type": "integer"
9977
+ }
9978
+ },
9979
+ "type": "object"
9980
+ },
9981
+ "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec": {
9982
+ "description": "A specification for configuring the extractive content in a search response.",
9983
+ "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec",
9984
+ "properties": {
9985
+ "maxExtractiveAnswerCount": {
9986
+ "description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.",
9987
+ "format": "int32",
9988
+ "type": "integer"
9989
+ },
9990
+ "maxExtractiveSegmentCount": {
9991
+ "description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.",
9992
+ "format": "int32",
9993
+ "type": "integer"
9994
+ },
9995
+ "numNextSegments": {
9996
+ "description": "Return at most `num_next_segments` segments after each selected segments.",
9997
+ "format": "int32",
9998
+ "type": "integer"
9999
+ },
10000
+ "numPreviousSegments": {
10001
+ "description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.",
10002
+ "format": "int32",
10003
+ "type": "integer"
10004
+ },
10005
+ "returnExtractiveSegmentScore": {
10006
+ "description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.",
10007
+ "type": "boolean"
10008
+ }
10009
+ },
10010
+ "type": "object"
10011
+ },
10012
+ "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec": {
10013
+ "description": "A specification for configuring snippets in a search response.",
10014
+ "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec",
10015
+ "properties": {
10016
+ "maxSnippetCount": {
10017
+ "deprecated": true,
10018
+ "description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.",
10019
+ "format": "int32",
10020
+ "type": "integer"
10021
+ },
10022
+ "referenceOnly": {
10023
+ "deprecated": true,
10024
+ "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.",
10025
+ "type": "boolean"
10026
+ },
10027
+ "returnSnippet": {
10028
+ "description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.",
10029
+ "type": "boolean"
10030
+ }
10031
+ },
10032
+ "type": "object"
10033
+ },
10034
+ "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec": {
10035
+ "description": "A specification for configuring a summary returned in a search response.",
10036
+ "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec",
10037
+ "properties": {
10038
+ "ignoreAdversarialQuery": {
10039
+ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.",
10040
+ "type": "boolean"
10041
+ },
10042
+ "ignoreJailBreakingQuery": {
10043
+ "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.",
10044
+ "type": "boolean"
10045
+ },
10046
+ "ignoreLowRelevantContent": {
10047
+ "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.",
10048
+ "type": "boolean"
10049
+ },
10050
+ "ignoreNonSummarySeekingQuery": {
10051
+ "description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.",
10052
+ "type": "boolean"
10053
+ },
10054
+ "includeCitations": {
10055
+ "description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.",
10056
+ "type": "boolean"
10057
+ },
10058
+ "languageCode": {
10059
+ "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.",
10060
+ "type": "string"
10061
+ },
10062
+ "modelPromptSpec": {
10063
+ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec",
10064
+ "description": "If specified, the spec will be used to modify the prompt provided to the LLM."
10065
+ },
10066
+ "modelSpec": {
10067
+ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec",
10068
+ "description": "If specified, the spec will be used to modify the model specification provided to the LLM."
10069
+ },
10070
+ "summaryResultCount": {
10071
+ "description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.",
10072
+ "format": "int32",
10073
+ "type": "integer"
10074
+ },
10075
+ "useSemanticChunks": {
10076
+ "description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.",
10077
+ "type": "boolean"
10078
+ }
10079
+ },
10080
+ "type": "object"
10081
+ },
10082
+ "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec": {
10083
+ "description": "Specification of the prompt to use with the model.",
10084
+ "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec",
10085
+ "properties": {
10086
+ "preamble": {
10087
+ "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.",
10088
+ "type": "string"
10089
+ }
10090
+ },
10091
+ "type": "object"
10092
+ },
10093
+ "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec": {
10094
+ "description": "Specification of the model.",
10095
+ "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec",
10096
+ "properties": {
10097
+ "version": {
10098
+ "description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).",
10099
+ "type": "string"
10100
+ }
10101
+ },
10102
+ "type": "object"
10103
+ },
10104
+ "GoogleCloudDiscoveryengineV1ServingConfig": {
10105
+ "description": "Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.",
10106
+ "id": "GoogleCloudDiscoveryengineV1ServingConfig",
10107
+ "properties": {
10108
+ "boostControlIds": {
10109
+ "description": "Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.",
10110
+ "items": {
10111
+ "type": "string"
10112
+ },
10113
+ "type": "array"
10114
+ },
10115
+ "createTime": {
10116
+ "description": "Output only. ServingConfig created timestamp.",
10117
+ "format": "google-datetime",
10118
+ "readOnly": true,
10119
+ "type": "string"
10120
+ },
10121
+ "displayName": {
10122
+ "description": "Required. The human readable serving 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.",
10123
+ "type": "string"
10124
+ },
10125
+ "dissociateControlIds": {
10126
+ "description": "Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
10127
+ "items": {
10128
+ "type": "string"
10129
+ },
10130
+ "type": "array"
10131
+ },
10132
+ "diversityLevel": {
10133
+ "description": "How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
10134
+ "type": "string"
10135
+ },
10136
+ "filterControlIds": {
10137
+ "description": "Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.",
10138
+ "items": {
10139
+ "type": "string"
10140
+ },
10141
+ "type": "array"
10142
+ },
10143
+ "genericConfig": {
10144
+ "$ref": "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig",
10145
+ "description": "The GenericConfig of the serving configuration."
10146
+ },
10147
+ "ignoreControlIds": {
10148
+ "description": "Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.",
10149
+ "items": {
10150
+ "type": "string"
10151
+ },
10152
+ "type": "array"
10153
+ },
10154
+ "mediaConfig": {
10155
+ "$ref": "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig",
10156
+ "description": "The MediaConfig of the serving configuration."
10157
+ },
10158
+ "modelId": {
10159
+ "description": "The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
10160
+ "type": "string"
10161
+ },
10162
+ "name": {
10163
+ "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`",
10164
+ "type": "string"
10165
+ },
10166
+ "onewaySynonymsControlIds": {
10167
+ "description": "Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
10168
+ "items": {
10169
+ "type": "string"
10170
+ },
10171
+ "type": "array"
10172
+ },
10173
+ "promoteControlIds": {
10174
+ "description": "Condition promote specifications. Maximum number of specifications is 100.",
10175
+ "items": {
10176
+ "type": "string"
10177
+ },
10178
+ "type": "array"
10179
+ },
10180
+ "rankingExpression": {
10181
+ "description": "The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the 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)`.",
10182
+ "type": "string"
10183
+ },
10184
+ "redirectControlIds": {
10185
+ "description": "IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
10186
+ "items": {
10187
+ "type": "string"
10188
+ },
10189
+ "type": "array"
10190
+ },
10191
+ "replacementControlIds": {
10192
+ "description": "Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
10193
+ "items": {
10194
+ "type": "string"
10195
+ },
10196
+ "type": "array"
10197
+ },
10198
+ "solutionType": {
10199
+ "description": "Required. Immutable. Specifies the solution type that a serving config can be associated with.",
10200
+ "enum": [
10201
+ "SOLUTION_TYPE_UNSPECIFIED",
10202
+ "SOLUTION_TYPE_RECOMMENDATION",
10203
+ "SOLUTION_TYPE_SEARCH",
10204
+ "SOLUTION_TYPE_CHAT",
10205
+ "SOLUTION_TYPE_GENERATIVE_CHAT"
10206
+ ],
10207
+ "enumDescriptions": [
10208
+ "Default value.",
10209
+ "Used for Recommendations AI.",
10210
+ "Used for Discovery Search.",
10211
+ "Used for use cases related to the Generative AI agent.",
10212
+ "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."
10213
+ ],
10214
+ "type": "string"
10215
+ },
10216
+ "synonymsControlIds": {
10217
+ "description": "Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
10218
+ "items": {
10219
+ "type": "string"
10220
+ },
10221
+ "type": "array"
10222
+ },
10223
+ "updateTime": {
10224
+ "description": "Output only. ServingConfig updated timestamp.",
10225
+ "format": "google-datetime",
10226
+ "readOnly": true,
10227
+ "type": "string"
10228
+ }
10229
+ },
10230
+ "type": "object"
10231
+ },
10232
+ "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig": {
10233
+ "description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.",
10234
+ "id": "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig",
10235
+ "properties": {
10236
+ "contentSearchSpec": {
10237
+ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec",
10238
+ "description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store."
10239
+ }
10240
+ },
10241
+ "type": "object"
10242
+ },
10243
+ "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig": {
10244
+ "description": "Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
10245
+ "id": "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig",
10246
+ "properties": {
10247
+ "contentFreshnessCutoffDays": {
10248
+ "description": "Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.",
10249
+ "format": "int32",
10250
+ "type": "integer"
10251
+ },
10252
+ "contentWatchedPercentageThreshold": {
10253
+ "description": "Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.",
10254
+ "format": "float",
10255
+ "type": "number"
10256
+ },
10257
+ "contentWatchedSecondsThreshold": {
10258
+ "description": "Specifies the content watched minutes threshold for demotion.",
10259
+ "format": "float",
10260
+ "type": "number"
10261
+ },
10262
+ "demoteContentWatchedPastDays": {
10263
+ "description": "Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days.",
10264
+ "format": "int32",
10265
+ "type": "integer"
9725
10266
  },
9726
- "description": "The structured representation of the schema.",
9727
- "type": "object"
10267
+ "demotionEventType": {
10268
+ "description": "Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.",
10269
+ "type": "string"
9728
10270
  }
9729
10271
  },
9730
10272
  "type": "object"
@@ -10353,6 +10895,18 @@
10353
10895
  "readOnly": true,
10354
10896
  "type": "string"
10355
10897
  },
10898
+ "groundingScore": {
10899
+ "description": "A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.",
10900
+ "format": "double",
10901
+ "type": "number"
10902
+ },
10903
+ "groundingSupports": {
10904
+ "description": "Optional. Grounding supports.",
10905
+ "items": {
10906
+ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport"
10907
+ },
10908
+ "type": "array"
10909
+ },
10356
10910
  "name": {
10357
10911
  "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`",
10358
10912
  "type": "string"
@@ -10381,13 +10935,15 @@
10381
10935
  "STATE_UNSPECIFIED",
10382
10936
  "IN_PROGRESS",
10383
10937
  "FAILED",
10384
- "SUCCEEDED"
10938
+ "SUCCEEDED",
10939
+ "STREAMING"
10385
10940
  ],
10386
10941
  "enumDescriptions": [
10387
10942
  "Unknown.",
10388
10943
  "Answer generation is currently in progress.",
10389
10944
  "Answer generation currently failed.",
10390
- "Answer generation has succeeded."
10945
+ "Answer generation has succeeded.",
10946
+ "Answer generation is currently in progress."
10391
10947
  ],
10392
10948
  "type": "string"
10393
10949
  },
@@ -10436,6 +10992,39 @@
10436
10992
  },
10437
10993
  "type": "object"
10438
10994
  },
10995
+ "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport": {
10996
+ "description": "Grounding support for a claim in `answer_text`.",
10997
+ "id": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport",
10998
+ "properties": {
10999
+ "endIndex": {
11000
+ "description": "Required. End of the claim, exclusive.",
11001
+ "format": "int64",
11002
+ "type": "string"
11003
+ },
11004
+ "groundingCheckRequired": {
11005
+ "description": "Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore `grounding_score`, `sources` is not returned.",
11006
+ "type": "boolean"
11007
+ },
11008
+ "groundingScore": {
11009
+ "description": "A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks.",
11010
+ "format": "double",
11011
+ "type": "number"
11012
+ },
11013
+ "sources": {
11014
+ "description": "Optional. Citation sources for the claim.",
11015
+ "items": {
11016
+ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource"
11017
+ },
11018
+ "type": "array"
11019
+ },
11020
+ "startIndex": {
11021
+ "description": "Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).",
11022
+ "format": "int64",
11023
+ "type": "string"
11024
+ }
11025
+ },
11026
+ "type": "object"
11027
+ },
10439
11028
  "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest": {
10440
11029
  "description": "Request message for ConversationalSearchService.AnswerQuery method.",
10441
11030
  "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest",
@@ -10632,6 +11221,31 @@
10632
11221
  "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.",
10633
11222
  "format": "int32",
10634
11223
  "type": "integer"
11224
+ },
11225
+ "modelSpec": {
11226
+ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec",
11227
+ "description": "Optional. Query Rephraser Model specification."
11228
+ }
11229
+ },
11230
+ "type": "object"
11231
+ },
11232
+ "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec": {
11233
+ "description": "Query Rephraser Model specification.",
11234
+ "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec",
11235
+ "properties": {
11236
+ "modelType": {
11237
+ "description": "Optional. Enabled query rephraser model type. If not set, it will use LARGE by default.",
11238
+ "enum": [
11239
+ "MODEL_TYPE_UNSPECIFIED",
11240
+ "SMALL",
11241
+ "LARGE"
11242
+ ],
11243
+ "enumDescriptions": [
11244
+ "Unspecified model type.",
11245
+ "Small query rephraser model. Gemini 1.0 XS model.",
11246
+ "Large query rephraser model. Gemini 1.0 Pro model."
11247
+ ],
11248
+ "type": "string"
10635
11249
  }
10636
11250
  },
10637
11251
  "type": "object"
@@ -10648,7 +11262,7 @@
10648
11262
  "type": "object"
10649
11263
  },
10650
11264
  "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec": {
10651
- "description": "Safety specification.",
11265
+ "description": "Safety specification. There are two use cases: 1. when only safety_spec.enable is set, the BLOCK_LOW_AND_ABOVE threshold will be applied for all categories. 2. when safety_spec.enable is set and some safety_settings are set, only specified safety_settings are applied.",
10652
11266
  "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec",
10653
11267
  "properties": {
10654
11268
  "enable": {
@@ -10719,7 +11333,7 @@
10719
11333
  "enumDescriptions": [
10720
11334
  "Default value.",
10721
11335
  "Returns documents in the search result.",
10722
- "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified."
11336
+ "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
10723
11337
  ],
10724
11338
  "type": "string"
10725
11339
  }
@@ -11630,7 +12244,7 @@
11630
12244
  "type": "integer"
11631
12245
  },
11632
12246
  "groundingCheckRequired": {
11633
- "description": "Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, anti_citation_indices, and score should not be returned.",
12247
+ "description": "Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices should not be returned.",
11634
12248
  "type": "boolean"
11635
12249
  },
11636
12250
  "startPos": {
@@ -11662,7 +12276,7 @@
11662
12276
  "type": "string"
11663
12277
  },
11664
12278
  "resources": {
11665
- "description": "The type needed for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * The labels needed for this resource: * `project`_`number` * `location`_`id` * `collection`_`id` * `datastore`_`id` * `branch`_`id` * `discoveryengine.googleapis.com/DataStore` * The labels needed for this resource: * `project`_`number` * `location`_`id` * `collection`_`id` * `datastore`_`id`",
12279
+ "description": "The resources to be checked for this requirement. The type needed for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * The labels needed for this resource: * `project_number` * `location_id` * `collection_id` * `datastore_id` * `branch_id` * `discoveryengine.googleapis.com/DataStore` * The labels needed for this resource: * `project_number` * `location_id` * `collection_id` * `datastore_id`",
11666
12280
  "items": {
11667
12281
  "$ref": "GoogleApiMonitoredResource"
11668
12282
  },
@@ -11683,7 +12297,7 @@
11683
12297
  "type": "array"
11684
12298
  },
11685
12299
  "oldestMetricTimestamp": {
11686
- "description": "Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the `requirement_result` may not accurately reflect any Event and Product Catalog updates performed after this time.",
12300
+ "description": "Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the `result` may not accurately reflect any Event and Product Catalog updates performed after this time.",
11687
12301
  "format": "google-datetime",
11688
12302
  "type": "string"
11689
12303
  },
@@ -11695,20 +12309,8 @@
11695
12309
  "$ref": "GoogleTypeExpr",
11696
12310
  "description": "The condition for evaluating the requirement result."
11697
12311
  },
11698
- "requirementResult": {
11699
- "description": "Requirement result, e.g. pass or fail.",
11700
- "enum": [
11701
- "UNKNOWN",
11702
- "SUCCESS",
11703
- "FAILURE",
11704
- "WARNING"
11705
- ],
11706
- "enumDescriptions": [
11707
- "The requirement is unknown.",
11708
- "The requirement check is passed.",
11709
- "The requirement check fails to meet at least one blocking threshold.",
11710
- "The requirement check fails at least one warning threshold, but passes all blocking thresholds."
11711
- ],
12312
+ "result": {
12313
+ "description": "The result of the requirement. It should be one of the `severity` fields in the requirement definition. If any error happens during the evaluation, it will be `UNKNOWN`.",
11712
12314
  "type": "string"
11713
12315
  }
11714
12316
  },
@@ -11781,7 +12383,7 @@
11781
12383
  "description": "Page span of the chunk."
11782
12384
  },
11783
12385
  "relevanceScore": {
11784
- "description": "Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse.",
12386
+ "description": "Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchResponse.",
11785
12387
  "format": "double",
11786
12388
  "readOnly": true,
11787
12389
  "type": "number"
@@ -12119,6 +12721,10 @@
12119
12721
  "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
12120
12722
  "type": "string"
12121
12723
  },
12724
+ "promoteAction": {
12725
+ "$ref": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction",
12726
+ "description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
12727
+ },
12122
12728
  "redirectAction": {
12123
12729
  "$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction",
12124
12730
  "description": "Defines a redirect-type control."
@@ -12200,6 +12806,21 @@
12200
12806
  },
12201
12807
  "type": "object"
12202
12808
  },
12809
+ "GoogleCloudDiscoveryengineV1alphaControlPromoteAction": {
12810
+ "description": "Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store.",
12811
+ "id": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction",
12812
+ "properties": {
12813
+ "dataStore": {
12814
+ "description": "Required. Data store with which this promotion is attached to.",
12815
+ "type": "string"
12816
+ },
12817
+ "searchLinkPromotion": {
12818
+ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion",
12819
+ "description": "Required. Promotion attached to this action."
12820
+ }
12821
+ },
12822
+ "type": "object"
12823
+ },
12203
12824
  "GoogleCloudDiscoveryengineV1alphaControlRedirectAction": {
12204
12825
  "description": "Redirects a shopper to the provided URI.",
12205
12826
  "id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction",
@@ -12846,6 +13467,17 @@
12846
13467
  },
12847
13468
  "type": "object"
12848
13469
  },
13470
+ "GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest": {
13471
+ "description": "Request for DeleteSession method.",
13472
+ "id": "GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest",
13473
+ "properties": {
13474
+ "name": {
13475
+ "description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
13476
+ "type": "string"
13477
+ }
13478
+ },
13479
+ "type": "object"
13480
+ },
12849
13481
  "GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata": {
12850
13482
  "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
12851
13483
  "id": "GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata",
@@ -13047,6 +13679,11 @@
13047
13679
  "description": "Detailed document information associated with a user event.",
13048
13680
  "id": "GoogleCloudDiscoveryengineV1alphaDocumentInfo",
13049
13681
  "properties": {
13682
+ "conversionValue": {
13683
+ "description": "Optional. The conversion value associated with this Document. Must be set if UserEvent.event_type is \"conversion\". For example, a value of 1000 signifies that 1000 seconds were spent viewing a Document for the `watch` conversion type.",
13684
+ "format": "float",
13685
+ "type": "number"
13686
+ },
13050
13687
  "id": {
13051
13688
  "description": "The Document resource ID.",
13052
13689
  "type": "string"
@@ -13749,80 +14386,6 @@
13749
14386
  },
13750
14387
  "type": "object"
13751
14388
  },
13752
- "GoogleCloudDiscoveryengineV1alphaFeedback": {
13753
- "description": "Information about the user feedback. This information will be used for logging and metrics purpose.",
13754
- "id": "GoogleCloudDiscoveryengineV1alphaFeedback",
13755
- "properties": {
13756
- "comment": {
13757
- "description": "Optional. The additional user comment of the feedback if user gives a thumb down.",
13758
- "type": "string"
13759
- },
13760
- "conversationInfo": {
13761
- "$ref": "GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo",
13762
- "description": "The related conversation information when user gives feedback."
13763
- },
13764
- "feedbackType": {
13765
- "description": "Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details.",
13766
- "enum": [
13767
- "FEEDBACK_TYPE_UNSPECIFIED",
13768
- "LIKE",
13769
- "DISLIKE"
13770
- ],
13771
- "enumDescriptions": [
13772
- "Unspecified feedback type.",
13773
- "The user gives a positive feedback.",
13774
- "The user gives a negative feedback."
13775
- ],
13776
- "type": "string"
13777
- },
13778
- "llmModelVersion": {
13779
- "description": "The version of the LLM model that was used to generate the response.",
13780
- "type": "string"
13781
- },
13782
- "reasons": {
13783
- "description": "Optional. The reason if user gives a thumb down.",
13784
- "items": {
13785
- "enum": [
13786
- "REASON_UNSPECIFIED",
13787
- "INACCURATE_RESPONSE",
13788
- "NOT_RELEVANT",
13789
- "INCOMPREHENSIVE",
13790
- "OFFENSIVE_OR_UNSAFE",
13791
- "BAD_CIATION",
13792
- "FORMAT_AND_STYLES"
13793
- ],
13794
- "enumDescriptions": [
13795
- "Unspecified reason.",
13796
- "The response is inaccurate.",
13797
- "The response is not relevant.",
13798
- "The response is incomprehensive.",
13799
- "The response is offensive or unsafe.",
13800
- "The response is not well-associated with the query.",
13801
- "The response is not well-formatted."
13802
- ],
13803
- "type": "string"
13804
- },
13805
- "type": "array"
13806
- }
13807
- },
13808
- "type": "object"
13809
- },
13810
- "GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo": {
13811
- "description": "The conversation information such as the question index and session name.",
13812
- "id": "GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo",
13813
- "properties": {
13814
- "questionIndex": {
13815
- "description": "The index of the user input within the conversation messages.",
13816
- "format": "int32",
13817
- "type": "integer"
13818
- },
13819
- "session": {
13820
- "description": "Name of the newly generated or continued session.",
13821
- "type": "string"
13822
- }
13823
- },
13824
- "type": "object"
13825
- },
13826
14389
  "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse": {
13827
14390
  "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.",
13828
14391
  "id": "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse",
@@ -13889,6 +14452,10 @@
13889
14452
  "type": "string"
13890
14453
  },
13891
14454
  "type": "array"
14455
+ },
14456
+ "updateFromLatestPredefinedSchema": {
14457
+ "description": "Optional. Whether to update the DataStore schema to the latest predefined schema. If true, the DataStore schema will be updated to include any FHIR fields or resource types that have been added since the last import and corresponding FHIR resources will be imported from the FHIR store. Note this field cannot be used in conjunction with `resource_types`. It should be used after initial import.",
14458
+ "type": "boolean"
13892
14459
  }
13893
14460
  },
13894
14461
  "type": "object"
@@ -14091,6 +14658,21 @@
14091
14658
  },
14092
14659
  "type": "object"
14093
14660
  },
14661
+ "GoogleCloudDiscoveryengineV1alphaGetSessionRequest": {
14662
+ "description": "Request for GetSession method.",
14663
+ "id": "GoogleCloudDiscoveryengineV1alphaGetSessionRequest",
14664
+ "properties": {
14665
+ "includeAnswerDetails": {
14666
+ "description": "Optional. If set to true, the full session including all answer details will be returned.",
14667
+ "type": "boolean"
14668
+ },
14669
+ "name": {
14670
+ "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
14671
+ "type": "string"
14672
+ }
14673
+ },
14674
+ "type": "object"
14675
+ },
14094
14676
  "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": {
14095
14677
  "description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.",
14096
14678
  "id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse",
@@ -14977,6 +15559,34 @@
14977
15559
  },
14978
15560
  "type": "object"
14979
15561
  },
15562
+ "GoogleCloudDiscoveryengineV1alphaListSessionsRequest": {
15563
+ "description": "Request for ListSessions method.",
15564
+ "id": "GoogleCloudDiscoveryengineV1alphaListSessionsRequest",
15565
+ "properties": {
15566
+ "filter": {
15567
+ "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
15568
+ "type": "string"
15569
+ },
15570
+ "orderBy": {
15571
+ "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * \"update_time desc\" * \"create_time\" * \"is_pinned desc,update_time desc\": list sessions by is_pinned first, then by update_time.",
15572
+ "type": "string"
15573
+ },
15574
+ "pageSize": {
15575
+ "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
15576
+ "format": "int32",
15577
+ "type": "integer"
15578
+ },
15579
+ "pageToken": {
15580
+ "description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.",
15581
+ "type": "string"
15582
+ },
15583
+ "parent": {
15584
+ "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`",
15585
+ "type": "string"
15586
+ }
15587
+ },
15588
+ "type": "object"
15589
+ },
14980
15590
  "GoogleCloudDiscoveryengineV1alphaListSessionsResponse": {
14981
15591
  "description": "Response for ListSessions method.",
14982
15592
  "id": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse",
@@ -15508,7 +16118,7 @@
15508
16118
  "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest",
15509
16119
  "properties": {
15510
16120
  "filter": {
15511
- "description": "Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType: `eventType = \"search\"` * Deleting all events for a specific visitor: `userPseudoId = \"visitor1024\"` * Deleting all events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.",
16121
+ "description": "Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Note: This API only supports purging a max range of 30 days. Examples: * Deleting all events in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\" eventType = \"search\"` * Deleting all events for a specific visitor in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\" userPseudoId = \"visitor1024\"` * Deleting the past 30 days of events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.",
15512
16122
  "type": "string"
15513
16123
  },
15514
16124
  "force": {
@@ -15664,7 +16274,7 @@
15664
16274
  "type": "string"
15665
16275
  },
15666
16276
  "score": {
15667
- "description": "The score of this record based on the given query and selected model.",
16277
+ "description": "The score of this record based on the given query and selected model. The score will be rounded to 2 decimal places. If the score is close to 0, it will be rounded to 0.0001 to avoid returning unset.",
15668
16278
  "format": "float",
15669
16279
  "type": "number"
15670
16280
  },
@@ -15680,7 +16290,7 @@
15680
16290
  "id": "GoogleCloudDiscoveryengineV1alphaRecommendRequest",
15681
16291
  "properties": {
15682
16292
  "filter": {
15683
- "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (launguage: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.",
16293
+ "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (language: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (language: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.",
15684
16294
  "type": "string"
15685
16295
  },
15686
16296
  "pageSize": {
@@ -16007,6 +16617,13 @@
16007
16617
  },
16008
16618
  "type": "array"
16009
16619
  },
16620
+ "severity": {
16621
+ "description": "The severity of errors if the requirement is not met. It must be ordered from the most strict to the least strict. Examples: * `BLOCKING` * `CRITICAL` * `WARNING` All thresholds in the requirement must have all the severity here.",
16622
+ "items": {
16623
+ "type": "string"
16624
+ },
16625
+ "type": "array"
16626
+ },
16010
16627
  "thresholdBindings": {
16011
16628
  "description": "A list of threshold bindings to be used in `condition`.",
16012
16629
  "items": {
@@ -16059,21 +16676,34 @@
16059
16676
  "description": "Specifies a multi-level threshold to apply to apply to a `metric_bindings` in the `condition` CEL expression.",
16060
16677
  "id": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding",
16061
16678
  "properties": {
16062
- "blockingThreshold": {
16063
- "description": "Threshold to trigger a blocking failure. If not met, the requirement will evaluate as a `FAILURE`.",
16064
- "format": "double",
16065
- "type": "number"
16066
- },
16067
16679
  "description": {
16068
16680
  "description": "Human readable description of the corresponding threshold and sub-requirement.",
16069
16681
  "type": "string"
16070
16682
  },
16683
+ "thresholdValues": {
16684
+ "description": "The values of the threshold. The values should be ordered from the most strict to the least strict.",
16685
+ "items": {
16686
+ "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBindingThresholdValue"
16687
+ },
16688
+ "type": "array"
16689
+ },
16071
16690
  "variableId": {
16072
16691
  "description": "The variable id to be referenced in `condition`. Must be unique across all `metric_bindings` and `threshold_bindings`.",
16073
16692
  "type": "string"
16693
+ }
16694
+ },
16695
+ "type": "object"
16696
+ },
16697
+ "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBindingThresholdValue": {
16698
+ "description": "Specifies a threshold value for a given severity.",
16699
+ "id": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBindingThresholdValue",
16700
+ "properties": {
16701
+ "severity": {
16702
+ "description": "The severity of errors if the threshold is not met. It should be one of the `severity` fields in the requirement.",
16703
+ "type": "string"
16074
16704
  },
16075
- "warningThreshold": {
16076
- "description": "Threshold to trigger a warning. If not met, the requirement will evaluate as a `WARNING`.",
16705
+ "value": {
16706
+ "description": "The value of the threshold.",
16077
16707
  "format": "double",
16078
16708
  "type": "number"
16079
16709
  }
@@ -16244,6 +16874,33 @@
16244
16874
  },
16245
16875
  "type": "object"
16246
16876
  },
16877
+ "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion": {
16878
+ "description": "Promotion proto includes uri and other helping information to display the promotion.",
16879
+ "id": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion",
16880
+ "properties": {
16881
+ "description": {
16882
+ "description": "Optional. The Promotion description. Maximum length: 200 characters.",
16883
+ "type": "string"
16884
+ },
16885
+ "enabled": {
16886
+ "description": "Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.",
16887
+ "type": "boolean"
16888
+ },
16889
+ "imageUri": {
16890
+ "description": "Optional. The promotion thumbnail image url.",
16891
+ "type": "string"
16892
+ },
16893
+ "title": {
16894
+ "description": "Required. The title of the promotion. Maximum length: 160 characters.",
16895
+ "type": "string"
16896
+ },
16897
+ "uri": {
16898
+ "description": "Required. The URL for the page the user wants to promote.",
16899
+ "type": "string"
16900
+ }
16901
+ },
16902
+ "type": "object"
16903
+ },
16247
16904
  "GoogleCloudDiscoveryengineV1alphaSearchRequest": {
16248
16905
  "description": "Request message for SearchService.Search method.",
16249
16906
  "id": "GoogleCloudDiscoveryengineV1alphaSearchRequest",
@@ -16269,7 +16926,7 @@
16269
16926
  "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec."
16270
16927
  },
16271
16928
  "dataStoreSpecs": {
16272
- "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.",
16929
+ "description": "Specs defining DataStores to filter on in a search call and 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.",
16273
16930
  "items": {
16274
16931
  "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec"
16275
16932
  },
@@ -16528,7 +17185,7 @@
16528
17185
  "enumDescriptions": [
16529
17186
  "Default value.",
16530
17187
  "Returns documents in the search result.",
16531
- "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified."
17188
+ "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
16532
17189
  ],
16533
17190
  "type": "string"
16534
17191
  },
@@ -16687,6 +17344,10 @@
16687
17344
  "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.",
16688
17345
  "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec",
16689
17346
  "properties": {
17347
+ "boostSpec": {
17348
+ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec",
17349
+ "description": "Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)"
17350
+ },
16690
17351
  "dataStore": {
16691
17352
  "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
16692
17353
  "type": "string"
@@ -17014,6 +17675,13 @@
17014
17675
  },
17015
17676
  "type": "array"
17016
17677
  },
17678
+ "searchLinkPromotions": {
17679
+ "description": "Promotions for site search.",
17680
+ "items": {
17681
+ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion"
17682
+ },
17683
+ "type": "array"
17684
+ },
17017
17685
  "sessionInfo": {
17018
17686
  "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo",
17019
17687
  "description": "Session information. Only set if SearchRequest.session is provided. See its description for more details."
@@ -17659,6 +18327,13 @@
17659
18327
  "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec",
17660
18328
  "description": "The specification for personalization spec. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec."
17661
18329
  },
18330
+ "promoteControlIds": {
18331
+ "description": "Condition promote specifications. Maximum number of specifications is 100.",
18332
+ "items": {
18333
+ "type": "string"
18334
+ },
18335
+ "type": "array"
18336
+ },
17662
18337
  "rankingExpression": {
17663
18338
  "description": "The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the 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)`.",
17664
18339
  "type": "string"
@@ -17757,12 +18432,20 @@
17757
18432
  "description": "External session proto definition.",
17758
18433
  "id": "GoogleCloudDiscoveryengineV1alphaSession",
17759
18434
  "properties": {
18435
+ "displayName": {
18436
+ "description": "Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.",
18437
+ "type": "string"
18438
+ },
17760
18439
  "endTime": {
17761
18440
  "description": "Output only. The time the session finished.",
17762
18441
  "format": "google-datetime",
17763
18442
  "readOnly": true,
17764
18443
  "type": "string"
17765
18444
  },
18445
+ "isPinned": {
18446
+ "description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.",
18447
+ "type": "boolean"
18448
+ },
17766
18449
  "name": {
17767
18450
  "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
17768
18451
  "type": "string"
@@ -17807,6 +18490,11 @@
17807
18490
  "description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
17808
18491
  "type": "string"
17809
18492
  },
18493
+ "detailedAnswer": {
18494
+ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer",
18495
+ "description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.",
18496
+ "readOnly": true
18497
+ },
17810
18498
  "query": {
17811
18499
  "$ref": "GoogleCloudDiscoveryengineV1alphaQuery",
17812
18500
  "description": "The user query."
@@ -18286,6 +18974,22 @@
18286
18974
  },
18287
18975
  "type": "object"
18288
18976
  },
18977
+ "GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest": {
18978
+ "description": "Request for UpdateSession method.",
18979
+ "id": "GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest",
18980
+ "properties": {
18981
+ "session": {
18982
+ "$ref": "GoogleCloudDiscoveryengineV1alphaSession",
18983
+ "description": "Required. The Session to update."
18984
+ },
18985
+ "updateMask": {
18986
+ "description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.",
18987
+ "format": "google-fieldmask",
18988
+ "type": "string"
18989
+ }
18990
+ },
18991
+ "type": "object"
18992
+ },
18289
18993
  "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": {
18290
18994
  "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
18291
18995
  "id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata",
@@ -18322,6 +19026,10 @@
18322
19026
  "$ref": "GoogleCloudDiscoveryengineV1alphaCompletionInfo",
18323
19027
  "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."
18324
19028
  },
19029
+ "conversionType": {
19030
+ "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.",
19031
+ "type": "string"
19032
+ },
18325
19033
  "dataStore": {
18326
19034
  "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.",
18327
19035
  "type": "string"
@@ -18347,13 +19055,9 @@
18347
19055
  "type": "string"
18348
19056
  },
18349
19057
  "eventType": {
18350
- "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 * `add-feedback`: Add a user feedback. 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.",
19058
+ "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 * `add-feedback`: Add a user feedback. 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.",
18351
19059
  "type": "string"
18352
19060
  },
18353
- "feedback": {
18354
- "$ref": "GoogleCloudDiscoveryengineV1alphaFeedback",
18355
- "description": "Optional. This field is optional except for the `add-feedback` event types."
18356
- },
18357
19061
  "filter": {
18358
19062
  "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.",
18359
19063
  "type": "string"
@@ -18654,6 +19358,10 @@
18654
19358
  "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
18655
19359
  "type": "string"
18656
19360
  },
19361
+ "promoteAction": {
19362
+ "$ref": "GoogleCloudDiscoveryengineV1betaControlPromoteAction",
19363
+ "description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
19364
+ },
18657
19365
  "redirectAction": {
18658
19366
  "$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction",
18659
19367
  "description": "Defines a redirect-type control."
@@ -18735,6 +19443,21 @@
18735
19443
  },
18736
19444
  "type": "object"
18737
19445
  },
19446
+ "GoogleCloudDiscoveryengineV1betaControlPromoteAction": {
19447
+ "description": "Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store.",
19448
+ "id": "GoogleCloudDiscoveryengineV1betaControlPromoteAction",
19449
+ "properties": {
19450
+ "dataStore": {
19451
+ "description": "Required. Data store with which this promotion is attached to.",
19452
+ "type": "string"
19453
+ },
19454
+ "searchLinkPromotion": {
19455
+ "$ref": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion",
19456
+ "description": "Required. Promotion attached to this action."
19457
+ }
19458
+ },
19459
+ "type": "object"
19460
+ },
18738
19461
  "GoogleCloudDiscoveryengineV1betaControlRedirectAction": {
18739
19462
  "description": "Redirects a shopper to the provided URI.",
18740
19463
  "id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction",
@@ -20206,6 +20929,33 @@
20206
20929
  },
20207
20930
  "type": "object"
20208
20931
  },
20932
+ "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion": {
20933
+ "description": "Promotion proto includes uri and other helping information to display the promotion.",
20934
+ "id": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion",
20935
+ "properties": {
20936
+ "description": {
20937
+ "description": "Optional. The Promotion description. Maximum length: 200 characters.",
20938
+ "type": "string"
20939
+ },
20940
+ "enabled": {
20941
+ "description": "Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.",
20942
+ "type": "boolean"
20943
+ },
20944
+ "imageUri": {
20945
+ "description": "Optional. The promotion thumbnail image url.",
20946
+ "type": "string"
20947
+ },
20948
+ "title": {
20949
+ "description": "Required. The title of the promotion. Maximum length: 160 characters.",
20950
+ "type": "string"
20951
+ },
20952
+ "uri": {
20953
+ "description": "Required. The URL for the page the user wants to promote.",
20954
+ "type": "string"
20955
+ }
20956
+ },
20957
+ "type": "object"
20958
+ },
20209
20959
  "GoogleCloudDiscoveryengineV1betaSearchRequest": {
20210
20960
  "description": "Request message for SearchService.Search method.",
20211
20961
  "id": "GoogleCloudDiscoveryengineV1betaSearchRequest",
@@ -20227,7 +20977,7 @@
20227
20977
  "description": "A specification for configuring the behavior of content search."
20228
20978
  },
20229
20979
  "dataStoreSpecs": {
20230
- "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.",
20980
+ "description": "Specs defining DataStores to filter on in a search call and 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.",
20231
20981
  "items": {
20232
20982
  "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec"
20233
20983
  },
@@ -20486,7 +21236,7 @@
20486
21236
  "enumDescriptions": [
20487
21237
  "Default value.",
20488
21238
  "Returns documents in the search result.",
20489
- "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified."
21239
+ "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
20490
21240
  ],
20491
21241
  "type": "string"
20492
21242
  },
@@ -20645,6 +21395,10 @@
20645
21395
  "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.",
20646
21396
  "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec",
20647
21397
  "properties": {
21398
+ "boostSpec": {
21399
+ "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
21400
+ "description": "Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)"
21401
+ },
20648
21402
  "dataStore": {
20649
21403
  "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
20650
21404
  "type": "string"