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",
@@ -757,7 +779,7 @@
757
779
  "operations": {
758
780
  "methods": {
759
781
  "cancel": {
760
- "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`.",
782
+ "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`.",
761
783
  "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel",
762
784
  "httpMethod": "POST",
763
785
  "id": "discoveryengine.projects.locations.collections.dataStores.branches.operations.cancel",
@@ -1907,6 +1929,34 @@
1907
1929
  "scopes": [
1908
1930
  "https://www.googleapis.com/auth/cloud-platform"
1909
1931
  ]
1932
+ },
1933
+ "streamAnswer": {
1934
+ "description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.",
1935
+ "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:streamAnswer",
1936
+ "httpMethod": "POST",
1937
+ "id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.streamAnswer",
1938
+ "parameterOrder": [
1939
+ "servingConfig"
1940
+ ],
1941
+ "parameters": {
1942
+ "servingConfig": {
1943
+ "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.",
1944
+ "location": "path",
1945
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
1946
+ "required": true,
1947
+ "type": "string"
1948
+ }
1949
+ },
1950
+ "path": "v1beta/{+servingConfig}:streamAnswer",
1951
+ "request": {
1952
+ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest"
1953
+ },
1954
+ "response": {
1955
+ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse"
1956
+ },
1957
+ "scopes": [
1958
+ "https://www.googleapis.com/auth/cloud-platform"
1959
+ ]
1910
1960
  }
1911
1961
  }
1912
1962
  },
@@ -1974,6 +2024,11 @@
1974
2024
  "name"
1975
2025
  ],
1976
2026
  "parameters": {
2027
+ "includeAnswerDetails": {
2028
+ "description": "Optional. If set to true, the full session including all answer details will be returned.",
2029
+ "location": "query",
2030
+ "type": "boolean"
2031
+ },
1977
2032
  "name": {
1978
2033
  "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
1979
2034
  "location": "path",
@@ -2005,7 +2060,7 @@
2005
2060
  "type": "string"
2006
2061
  },
2007
2062
  "orderBy": {
2008
- "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\"",
2063
+ "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.",
2009
2064
  "location": "query",
2010
2065
  "type": "string"
2011
2066
  },
@@ -2708,7 +2763,7 @@
2708
2763
  "type": "string"
2709
2764
  },
2710
2765
  "parent": {
2711
- "description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.",
2766
+ "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}`.",
2712
2767
  "location": "path",
2713
2768
  "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
2714
2769
  "required": true,
@@ -3734,6 +3789,34 @@
3734
3789
  "scopes": [
3735
3790
  "https://www.googleapis.com/auth/cloud-platform"
3736
3791
  ]
3792
+ },
3793
+ "streamAnswer": {
3794
+ "description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.",
3795
+ "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:streamAnswer",
3796
+ "httpMethod": "POST",
3797
+ "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.streamAnswer",
3798
+ "parameterOrder": [
3799
+ "servingConfig"
3800
+ ],
3801
+ "parameters": {
3802
+ "servingConfig": {
3803
+ "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.",
3804
+ "location": "path",
3805
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
3806
+ "required": true,
3807
+ "type": "string"
3808
+ }
3809
+ },
3810
+ "path": "v1beta/{+servingConfig}:streamAnswer",
3811
+ "request": {
3812
+ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest"
3813
+ },
3814
+ "response": {
3815
+ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse"
3816
+ },
3817
+ "scopes": [
3818
+ "https://www.googleapis.com/auth/cloud-platform"
3819
+ ]
3737
3820
  }
3738
3821
  }
3739
3822
  },
@@ -3801,6 +3884,11 @@
3801
3884
  "name"
3802
3885
  ],
3803
3886
  "parameters": {
3887
+ "includeAnswerDetails": {
3888
+ "description": "Optional. If set to true, the full session including all answer details will be returned.",
3889
+ "location": "query",
3890
+ "type": "boolean"
3891
+ },
3804
3892
  "name": {
3805
3893
  "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
3806
3894
  "location": "path",
@@ -3832,7 +3920,7 @@
3832
3920
  "type": "string"
3833
3921
  },
3834
3922
  "orderBy": {
3835
- "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\"",
3923
+ "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.",
3836
3924
  "location": "query",
3837
3925
  "type": "string"
3838
3926
  },
@@ -4518,7 +4606,7 @@
4518
4606
  "operations": {
4519
4607
  "methods": {
4520
4608
  "cancel": {
4521
- "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`.",
4609
+ "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`.",
4522
4610
  "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel",
4523
4611
  "httpMethod": "POST",
4524
4612
  "id": "discoveryengine.projects.locations.dataStores.branches.operations.cancel",
@@ -5567,6 +5655,34 @@
5567
5655
  "scopes": [
5568
5656
  "https://www.googleapis.com/auth/cloud-platform"
5569
5657
  ]
5658
+ },
5659
+ "streamAnswer": {
5660
+ "description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.",
5661
+ "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:streamAnswer",
5662
+ "httpMethod": "POST",
5663
+ "id": "discoveryengine.projects.locations.dataStores.servingConfigs.streamAnswer",
5664
+ "parameterOrder": [
5665
+ "servingConfig"
5666
+ ],
5667
+ "parameters": {
5668
+ "servingConfig": {
5669
+ "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.",
5670
+ "location": "path",
5671
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
5672
+ "required": true,
5673
+ "type": "string"
5674
+ }
5675
+ },
5676
+ "path": "v1beta/{+servingConfig}:streamAnswer",
5677
+ "request": {
5678
+ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest"
5679
+ },
5680
+ "response": {
5681
+ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse"
5682
+ },
5683
+ "scopes": [
5684
+ "https://www.googleapis.com/auth/cloud-platform"
5685
+ ]
5570
5686
  }
5571
5687
  }
5572
5688
  },
@@ -5634,6 +5750,11 @@
5634
5750
  "name"
5635
5751
  ],
5636
5752
  "parameters": {
5753
+ "includeAnswerDetails": {
5754
+ "description": "Optional. If set to true, the full session including all answer details will be returned.",
5755
+ "location": "query",
5756
+ "type": "boolean"
5757
+ },
5637
5758
  "name": {
5638
5759
  "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
5639
5760
  "location": "path",
@@ -5665,7 +5786,7 @@
5665
5786
  "type": "string"
5666
5787
  },
5667
5788
  "orderBy": {
5668
- "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\"",
5789
+ "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.",
5669
5790
  "location": "query",
5670
5791
  "type": "string"
5671
5792
  },
@@ -6193,7 +6314,7 @@
6193
6314
  "type": "string"
6194
6315
  },
6195
6316
  "parent": {
6196
- "description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.",
6317
+ "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}`.",
6197
6318
  "location": "path",
6198
6319
  "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
6199
6320
  "required": true,
@@ -7070,7 +7191,7 @@
7070
7191
  "type": "string"
7071
7192
  },
7072
7193
  "parent": {
7073
- "description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.",
7194
+ "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}`.",
7074
7195
  "location": "path",
7075
7196
  "pattern": "^projects/[^/]+/locations/[^/]+$",
7076
7197
  "required": true,
@@ -7095,6 +7216,34 @@
7095
7216
  "https://www.googleapis.com/auth/cloud-platform"
7096
7217
  ]
7097
7218
  },
7219
+ "import": {
7220
+ "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.",
7221
+ "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:import",
7222
+ "httpMethod": "POST",
7223
+ "id": "discoveryengine.projects.locations.userEvents.import",
7224
+ "parameterOrder": [
7225
+ "parent"
7226
+ ],
7227
+ "parameters": {
7228
+ "parent": {
7229
+ "description": "Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`",
7230
+ "location": "path",
7231
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
7232
+ "required": true,
7233
+ "type": "string"
7234
+ }
7235
+ },
7236
+ "path": "v1beta/{+parent}/userEvents:import",
7237
+ "request": {
7238
+ "$ref": "GoogleCloudDiscoveryengineV1betaImportUserEventsRequest"
7239
+ },
7240
+ "response": {
7241
+ "$ref": "GoogleLongrunningOperation"
7242
+ },
7243
+ "scopes": [
7244
+ "https://www.googleapis.com/auth/cloud-platform"
7245
+ ]
7246
+ },
7098
7247
  "write": {
7099
7248
  "description": "Writes a single user event.",
7100
7249
  "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:write",
@@ -7205,7 +7354,7 @@
7205
7354
  }
7206
7355
  }
7207
7356
  },
7208
- "revision": "20241031",
7357
+ "revision": "20241206",
7209
7358
  "rootUrl": "https://discoveryengine.googleapis.com/",
7210
7359
  "schemas": {
7211
7360
  "GoogleApiDistribution": {
@@ -7762,6 +7911,10 @@
7762
7911
  "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
7763
7912
  "type": "string"
7764
7913
  },
7914
+ "promoteAction": {
7915
+ "$ref": "GoogleCloudDiscoveryengineV1ControlPromoteAction",
7916
+ "description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
7917
+ },
7765
7918
  "redirectAction": {
7766
7919
  "$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction",
7767
7920
  "description": "Defines a redirect-type control."
@@ -7843,6 +7996,21 @@
7843
7996
  },
7844
7997
  "type": "object"
7845
7998
  },
7999
+ "GoogleCloudDiscoveryengineV1ControlPromoteAction": {
8000
+ "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.",
8001
+ "id": "GoogleCloudDiscoveryengineV1ControlPromoteAction",
8002
+ "properties": {
8003
+ "dataStore": {
8004
+ "description": "Required. Data store with which this promotion is attached to.",
8005
+ "type": "string"
8006
+ },
8007
+ "searchLinkPromotion": {
8008
+ "$ref": "GoogleCloudDiscoveryengineV1SearchLinkPromotion",
8009
+ "description": "Required. Promotion attached to this action."
8010
+ }
8011
+ },
8012
+ "type": "object"
8013
+ },
7846
8014
  "GoogleCloudDiscoveryengineV1ControlRedirectAction": {
7847
8015
  "description": "Redirects a shopper to the provided URI.",
7848
8016
  "id": "GoogleCloudDiscoveryengineV1ControlRedirectAction",
@@ -8927,6 +9095,380 @@
8927
9095
  },
8928
9096
  "type": "object"
8929
9097
  },
9098
+ "GoogleCloudDiscoveryengineV1SearchLinkPromotion": {
9099
+ "description": "Promotion proto includes uri and other helping information to display the promotion.",
9100
+ "id": "GoogleCloudDiscoveryengineV1SearchLinkPromotion",
9101
+ "properties": {
9102
+ "description": {
9103
+ "description": "Optional. The Promotion description. Maximum length: 200 characters.",
9104
+ "type": "string"
9105
+ },
9106
+ "enabled": {
9107
+ "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.",
9108
+ "type": "boolean"
9109
+ },
9110
+ "imageUri": {
9111
+ "description": "Optional. The promotion thumbnail image url.",
9112
+ "type": "string"
9113
+ },
9114
+ "title": {
9115
+ "description": "Required. The title of the promotion. Maximum length: 160 characters.",
9116
+ "type": "string"
9117
+ },
9118
+ "uri": {
9119
+ "description": "Required. The URL for the page the user wants to promote.",
9120
+ "type": "string"
9121
+ }
9122
+ },
9123
+ "type": "object"
9124
+ },
9125
+ "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec": {
9126
+ "description": "A specification for configuring the behavior of content search.",
9127
+ "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec",
9128
+ "properties": {
9129
+ "chunkSpec": {
9130
+ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec",
9131
+ "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"
9132
+ },
9133
+ "extractiveContentSpec": {
9134
+ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec",
9135
+ "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response."
9136
+ },
9137
+ "searchResultMode": {
9138
+ "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.",
9139
+ "enum": [
9140
+ "SEARCH_RESULT_MODE_UNSPECIFIED",
9141
+ "DOCUMENTS",
9142
+ "CHUNKS"
9143
+ ],
9144
+ "enumDescriptions": [
9145
+ "Default value.",
9146
+ "Returns documents in the search result.",
9147
+ "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
9148
+ ],
9149
+ "type": "string"
9150
+ },
9151
+ "snippetSpec": {
9152
+ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec",
9153
+ "description": "If `snippetSpec` is not specified, snippets are not included in the search response."
9154
+ },
9155
+ "summarySpec": {
9156
+ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec",
9157
+ "description": "If `summarySpec` is not specified, summaries are not included in the search response."
9158
+ }
9159
+ },
9160
+ "type": "object"
9161
+ },
9162
+ "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec": {
9163
+ "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",
9164
+ "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec",
9165
+ "properties": {
9166
+ "numNextChunks": {
9167
+ "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.",
9168
+ "format": "int32",
9169
+ "type": "integer"
9170
+ },
9171
+ "numPreviousChunks": {
9172
+ "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.",
9173
+ "format": "int32",
9174
+ "type": "integer"
9175
+ }
9176
+ },
9177
+ "type": "object"
9178
+ },
9179
+ "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec": {
9180
+ "description": "A specification for configuring the extractive content in a search response.",
9181
+ "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec",
9182
+ "properties": {
9183
+ "maxExtractiveAnswerCount": {
9184
+ "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.",
9185
+ "format": "int32",
9186
+ "type": "integer"
9187
+ },
9188
+ "maxExtractiveSegmentCount": {
9189
+ "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`.",
9190
+ "format": "int32",
9191
+ "type": "integer"
9192
+ },
9193
+ "numNextSegments": {
9194
+ "description": "Return at most `num_next_segments` segments after each selected segments.",
9195
+ "format": "int32",
9196
+ "type": "integer"
9197
+ },
9198
+ "numPreviousSegments": {
9199
+ "description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.",
9200
+ "format": "int32",
9201
+ "type": "integer"
9202
+ },
9203
+ "returnExtractiveSegmentScore": {
9204
+ "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`.",
9205
+ "type": "boolean"
9206
+ }
9207
+ },
9208
+ "type": "object"
9209
+ },
9210
+ "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec": {
9211
+ "description": "A specification for configuring snippets in a search response.",
9212
+ "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec",
9213
+ "properties": {
9214
+ "maxSnippetCount": {
9215
+ "deprecated": true,
9216
+ "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.",
9217
+ "format": "int32",
9218
+ "type": "integer"
9219
+ },
9220
+ "referenceOnly": {
9221
+ "deprecated": true,
9222
+ "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.",
9223
+ "type": "boolean"
9224
+ },
9225
+ "returnSnippet": {
9226
+ "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.",
9227
+ "type": "boolean"
9228
+ }
9229
+ },
9230
+ "type": "object"
9231
+ },
9232
+ "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec": {
9233
+ "description": "A specification for configuring a summary returned in a search response.",
9234
+ "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec",
9235
+ "properties": {
9236
+ "ignoreAdversarialQuery": {
9237
+ "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.",
9238
+ "type": "boolean"
9239
+ },
9240
+ "ignoreJailBreakingQuery": {
9241
+ "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.",
9242
+ "type": "boolean"
9243
+ },
9244
+ "ignoreLowRelevantContent": {
9245
+ "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.",
9246
+ "type": "boolean"
9247
+ },
9248
+ "ignoreNonSummarySeekingQuery": {
9249
+ "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.",
9250
+ "type": "boolean"
9251
+ },
9252
+ "includeCitations": {
9253
+ "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.",
9254
+ "type": "boolean"
9255
+ },
9256
+ "languageCode": {
9257
+ "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.",
9258
+ "type": "string"
9259
+ },
9260
+ "modelPromptSpec": {
9261
+ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec",
9262
+ "description": "If specified, the spec will be used to modify the prompt provided to the LLM."
9263
+ },
9264
+ "modelSpec": {
9265
+ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec",
9266
+ "description": "If specified, the spec will be used to modify the model specification provided to the LLM."
9267
+ },
9268
+ "summaryResultCount": {
9269
+ "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.",
9270
+ "format": "int32",
9271
+ "type": "integer"
9272
+ },
9273
+ "useSemanticChunks": {
9274
+ "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.",
9275
+ "type": "boolean"
9276
+ }
9277
+ },
9278
+ "type": "object"
9279
+ },
9280
+ "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec": {
9281
+ "description": "Specification of the prompt to use with the model.",
9282
+ "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec",
9283
+ "properties": {
9284
+ "preamble": {
9285
+ "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.",
9286
+ "type": "string"
9287
+ }
9288
+ },
9289
+ "type": "object"
9290
+ },
9291
+ "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec": {
9292
+ "description": "Specification of the model.",
9293
+ "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec",
9294
+ "properties": {
9295
+ "version": {
9296
+ "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).",
9297
+ "type": "string"
9298
+ }
9299
+ },
9300
+ "type": "object"
9301
+ },
9302
+ "GoogleCloudDiscoveryengineV1ServingConfig": {
9303
+ "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.",
9304
+ "id": "GoogleCloudDiscoveryengineV1ServingConfig",
9305
+ "properties": {
9306
+ "boostControlIds": {
9307
+ "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.",
9308
+ "items": {
9309
+ "type": "string"
9310
+ },
9311
+ "type": "array"
9312
+ },
9313
+ "createTime": {
9314
+ "description": "Output only. ServingConfig created timestamp.",
9315
+ "format": "google-datetime",
9316
+ "readOnly": true,
9317
+ "type": "string"
9318
+ },
9319
+ "displayName": {
9320
+ "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.",
9321
+ "type": "string"
9322
+ },
9323
+ "dissociateControlIds": {
9324
+ "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.",
9325
+ "items": {
9326
+ "type": "string"
9327
+ },
9328
+ "type": "array"
9329
+ },
9330
+ "diversityLevel": {
9331
+ "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.",
9332
+ "type": "string"
9333
+ },
9334
+ "filterControlIds": {
9335
+ "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.",
9336
+ "items": {
9337
+ "type": "string"
9338
+ },
9339
+ "type": "array"
9340
+ },
9341
+ "genericConfig": {
9342
+ "$ref": "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig",
9343
+ "description": "The GenericConfig of the serving configuration."
9344
+ },
9345
+ "ignoreControlIds": {
9346
+ "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.",
9347
+ "items": {
9348
+ "type": "string"
9349
+ },
9350
+ "type": "array"
9351
+ },
9352
+ "mediaConfig": {
9353
+ "$ref": "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig",
9354
+ "description": "The MediaConfig of the serving configuration."
9355
+ },
9356
+ "modelId": {
9357
+ "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.",
9358
+ "type": "string"
9359
+ },
9360
+ "name": {
9361
+ "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`",
9362
+ "type": "string"
9363
+ },
9364
+ "onewaySynonymsControlIds": {
9365
+ "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.",
9366
+ "items": {
9367
+ "type": "string"
9368
+ },
9369
+ "type": "array"
9370
+ },
9371
+ "promoteControlIds": {
9372
+ "description": "Condition promote specifications. Maximum number of specifications is 100.",
9373
+ "items": {
9374
+ "type": "string"
9375
+ },
9376
+ "type": "array"
9377
+ },
9378
+ "rankingExpression": {
9379
+ "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)`.",
9380
+ "type": "string"
9381
+ },
9382
+ "redirectControlIds": {
9383
+ "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.",
9384
+ "items": {
9385
+ "type": "string"
9386
+ },
9387
+ "type": "array"
9388
+ },
9389
+ "replacementControlIds": {
9390
+ "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.",
9391
+ "items": {
9392
+ "type": "string"
9393
+ },
9394
+ "type": "array"
9395
+ },
9396
+ "solutionType": {
9397
+ "description": "Required. Immutable. Specifies the solution type that a serving config can be associated with.",
9398
+ "enum": [
9399
+ "SOLUTION_TYPE_UNSPECIFIED",
9400
+ "SOLUTION_TYPE_RECOMMENDATION",
9401
+ "SOLUTION_TYPE_SEARCH",
9402
+ "SOLUTION_TYPE_CHAT",
9403
+ "SOLUTION_TYPE_GENERATIVE_CHAT"
9404
+ ],
9405
+ "enumDescriptions": [
9406
+ "Default value.",
9407
+ "Used for Recommendations AI.",
9408
+ "Used for Discovery Search.",
9409
+ "Used for use cases related to the Generative AI agent.",
9410
+ "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."
9411
+ ],
9412
+ "type": "string"
9413
+ },
9414
+ "synonymsControlIds": {
9415
+ "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.",
9416
+ "items": {
9417
+ "type": "string"
9418
+ },
9419
+ "type": "array"
9420
+ },
9421
+ "updateTime": {
9422
+ "description": "Output only. ServingConfig updated timestamp.",
9423
+ "format": "google-datetime",
9424
+ "readOnly": true,
9425
+ "type": "string"
9426
+ }
9427
+ },
9428
+ "type": "object"
9429
+ },
9430
+ "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig": {
9431
+ "description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.",
9432
+ "id": "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig",
9433
+ "properties": {
9434
+ "contentSearchSpec": {
9435
+ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec",
9436
+ "description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store."
9437
+ }
9438
+ },
9439
+ "type": "object"
9440
+ },
9441
+ "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig": {
9442
+ "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.",
9443
+ "id": "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig",
9444
+ "properties": {
9445
+ "contentFreshnessCutoffDays": {
9446
+ "description": "Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.",
9447
+ "format": "int32",
9448
+ "type": "integer"
9449
+ },
9450
+ "contentWatchedPercentageThreshold": {
9451
+ "description": "Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.",
9452
+ "format": "float",
9453
+ "type": "number"
9454
+ },
9455
+ "contentWatchedSecondsThreshold": {
9456
+ "description": "Specifies the content watched minutes threshold for demotion.",
9457
+ "format": "float",
9458
+ "type": "number"
9459
+ },
9460
+ "demoteContentWatchedPastDays": {
9461
+ "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.",
9462
+ "format": "int32",
9463
+ "type": "integer"
9464
+ },
9465
+ "demotionEventType": {
9466
+ "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.",
9467
+ "type": "string"
9468
+ }
9469
+ },
9470
+ "type": "object"
9471
+ },
8930
9472
  "GoogleCloudDiscoveryengineV1SiteVerificationInfo": {
8931
9473
  "description": "Verification information for target sites in advanced site search.",
8932
9474
  "id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo",
@@ -9290,6 +9832,18 @@
9290
9832
  "readOnly": true,
9291
9833
  "type": "string"
9292
9834
  },
9835
+ "groundingScore": {
9836
+ "description": "A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.",
9837
+ "format": "double",
9838
+ "type": "number"
9839
+ },
9840
+ "groundingSupports": {
9841
+ "description": "Optional. Grounding supports.",
9842
+ "items": {
9843
+ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport"
9844
+ },
9845
+ "type": "array"
9846
+ },
9293
9847
  "name": {
9294
9848
  "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`",
9295
9849
  "type": "string"
@@ -9318,13 +9872,15 @@
9318
9872
  "STATE_UNSPECIFIED",
9319
9873
  "IN_PROGRESS",
9320
9874
  "FAILED",
9321
- "SUCCEEDED"
9875
+ "SUCCEEDED",
9876
+ "STREAMING"
9322
9877
  ],
9323
9878
  "enumDescriptions": [
9324
9879
  "Unknown.",
9325
9880
  "Answer generation is currently in progress.",
9326
9881
  "Answer generation currently failed.",
9327
- "Answer generation has succeeded."
9882
+ "Answer generation has succeeded.",
9883
+ "Answer generation is currently in progress."
9328
9884
  ],
9329
9885
  "type": "string"
9330
9886
  },
@@ -9348,31 +9904,64 @@
9348
9904
  "type": "string"
9349
9905
  },
9350
9906
  "sources": {
9351
- "description": "Citation sources for the attributed segment.",
9907
+ "description": "Citation sources for the attributed segment.",
9908
+ "items": {
9909
+ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource"
9910
+ },
9911
+ "type": "array"
9912
+ },
9913
+ "startIndex": {
9914
+ "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).",
9915
+ "format": "int64",
9916
+ "type": "string"
9917
+ }
9918
+ },
9919
+ "type": "object"
9920
+ },
9921
+ "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": {
9922
+ "description": "Citation source.",
9923
+ "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource",
9924
+ "properties": {
9925
+ "referenceId": {
9926
+ "description": "ID of the citation source.",
9927
+ "type": "string"
9928
+ }
9929
+ },
9930
+ "type": "object"
9931
+ },
9932
+ "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport": {
9933
+ "description": "Grounding support for a claim in `answer_text`.",
9934
+ "id": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport",
9935
+ "properties": {
9936
+ "endIndex": {
9937
+ "description": "Required. End of the claim, exclusive.",
9938
+ "format": "int64",
9939
+ "type": "string"
9940
+ },
9941
+ "groundingCheckRequired": {
9942
+ "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.",
9943
+ "type": "boolean"
9944
+ },
9945
+ "groundingScore": {
9946
+ "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.",
9947
+ "format": "double",
9948
+ "type": "number"
9949
+ },
9950
+ "sources": {
9951
+ "description": "Optional. Citation sources for the claim.",
9352
9952
  "items": {
9353
9953
  "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource"
9354
9954
  },
9355
9955
  "type": "array"
9356
9956
  },
9357
9957
  "startIndex": {
9358
- "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).",
9958
+ "description": "Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).",
9359
9959
  "format": "int64",
9360
9960
  "type": "string"
9361
9961
  }
9362
9962
  },
9363
9963
  "type": "object"
9364
9964
  },
9365
- "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": {
9366
- "description": "Citation source.",
9367
- "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource",
9368
- "properties": {
9369
- "referenceId": {
9370
- "description": "ID of the citation source.",
9371
- "type": "string"
9372
- }
9373
- },
9374
- "type": "object"
9375
- },
9376
9965
  "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": {
9377
9966
  "description": "Query understanding information.",
9378
9967
  "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo",
@@ -9892,6 +10481,10 @@
9892
10481
  "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
9893
10482
  "type": "string"
9894
10483
  },
10484
+ "promoteAction": {
10485
+ "$ref": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction",
10486
+ "description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
10487
+ },
9895
10488
  "redirectAction": {
9896
10489
  "$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction",
9897
10490
  "description": "Defines a redirect-type control."
@@ -9973,6 +10566,21 @@
9973
10566
  },
9974
10567
  "type": "object"
9975
10568
  },
10569
+ "GoogleCloudDiscoveryengineV1alphaControlPromoteAction": {
10570
+ "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.",
10571
+ "id": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction",
10572
+ "properties": {
10573
+ "dataStore": {
10574
+ "description": "Required. Data store with which this promotion is attached to.",
10575
+ "type": "string"
10576
+ },
10577
+ "searchLinkPromotion": {
10578
+ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion",
10579
+ "description": "Required. Promotion attached to this action."
10580
+ }
10581
+ },
10582
+ "type": "object"
10583
+ },
9976
10584
  "GoogleCloudDiscoveryengineV1alphaControlRedirectAction": {
9977
10585
  "description": "Redirects a shopper to the provided URI.",
9978
10586
  "id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction",
@@ -10424,6 +11032,17 @@
10424
11032
  },
10425
11033
  "type": "object"
10426
11034
  },
11035
+ "GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest": {
11036
+ "description": "Request for DeleteSession method.",
11037
+ "id": "GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest",
11038
+ "properties": {
11039
+ "name": {
11040
+ "description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
11041
+ "type": "string"
11042
+ }
11043
+ },
11044
+ "type": "object"
11045
+ },
10427
11046
  "GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata": {
10428
11047
  "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
10429
11048
  "id": "GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata",
@@ -11211,6 +11830,21 @@
11211
11830
  },
11212
11831
  "type": "object"
11213
11832
  },
11833
+ "GoogleCloudDiscoveryengineV1alphaGetSessionRequest": {
11834
+ "description": "Request for GetSession method.",
11835
+ "id": "GoogleCloudDiscoveryengineV1alphaGetSessionRequest",
11836
+ "properties": {
11837
+ "includeAnswerDetails": {
11838
+ "description": "Optional. If set to true, the full session including all answer details will be returned.",
11839
+ "type": "boolean"
11840
+ },
11841
+ "name": {
11842
+ "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
11843
+ "type": "string"
11844
+ }
11845
+ },
11846
+ "type": "object"
11847
+ },
11214
11848
  "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": {
11215
11849
  "description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.",
11216
11850
  "id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse",
@@ -11584,6 +12218,52 @@
11584
12218
  },
11585
12219
  "type": "object"
11586
12220
  },
12221
+ "GoogleCloudDiscoveryengineV1alphaListSessionsRequest": {
12222
+ "description": "Request for ListSessions method.",
12223
+ "id": "GoogleCloudDiscoveryengineV1alphaListSessionsRequest",
12224
+ "properties": {
12225
+ "filter": {
12226
+ "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
12227
+ "type": "string"
12228
+ },
12229
+ "orderBy": {
12230
+ "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.",
12231
+ "type": "string"
12232
+ },
12233
+ "pageSize": {
12234
+ "description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
12235
+ "format": "int32",
12236
+ "type": "integer"
12237
+ },
12238
+ "pageToken": {
12239
+ "description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.",
12240
+ "type": "string"
12241
+ },
12242
+ "parent": {
12243
+ "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`",
12244
+ "type": "string"
12245
+ }
12246
+ },
12247
+ "type": "object"
12248
+ },
12249
+ "GoogleCloudDiscoveryengineV1alphaListSessionsResponse": {
12250
+ "description": "Response for ListSessions method.",
12251
+ "id": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse",
12252
+ "properties": {
12253
+ "nextPageToken": {
12254
+ "description": "Pagination token, if not returned indicates the last page.",
12255
+ "type": "string"
12256
+ },
12257
+ "sessions": {
12258
+ "description": "All the Sessions for a given data store.",
12259
+ "items": {
12260
+ "$ref": "GoogleCloudDiscoveryengineV1alphaSession"
12261
+ },
12262
+ "type": "array"
12263
+ }
12264
+ },
12265
+ "type": "object"
12266
+ },
11587
12267
  "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig": {
11588
12268
  "description": "Configuration for Natural Language Query Understanding.",
11589
12269
  "id": "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig",
@@ -12119,6 +12799,33 @@
12119
12799
  },
12120
12800
  "type": "object"
12121
12801
  },
12802
+ "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion": {
12803
+ "description": "Promotion proto includes uri and other helping information to display the promotion.",
12804
+ "id": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion",
12805
+ "properties": {
12806
+ "description": {
12807
+ "description": "Optional. The Promotion description. Maximum length: 200 characters.",
12808
+ "type": "string"
12809
+ },
12810
+ "enabled": {
12811
+ "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.",
12812
+ "type": "boolean"
12813
+ },
12814
+ "imageUri": {
12815
+ "description": "Optional. The promotion thumbnail image url.",
12816
+ "type": "string"
12817
+ },
12818
+ "title": {
12819
+ "description": "Required. The title of the promotion. Maximum length: 160 characters.",
12820
+ "type": "string"
12821
+ },
12822
+ "uri": {
12823
+ "description": "Required. The URL for the page the user wants to promote.",
12824
+ "type": "string"
12825
+ }
12826
+ },
12827
+ "type": "object"
12828
+ },
12122
12829
  "GoogleCloudDiscoveryengineV1alphaSearchRequest": {
12123
12830
  "description": "Request message for SearchService.Search method.",
12124
12831
  "id": "GoogleCloudDiscoveryengineV1alphaSearchRequest",
@@ -12144,7 +12851,7 @@
12144
12851
  "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec."
12145
12852
  },
12146
12853
  "dataStoreSpecs": {
12147
- "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.",
12854
+ "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.",
12148
12855
  "items": {
12149
12856
  "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec"
12150
12857
  },
@@ -12403,7 +13110,7 @@
12403
13110
  "enumDescriptions": [
12404
13111
  "Default value.",
12405
13112
  "Returns documents in the search result.",
12406
- "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified."
13113
+ "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
12407
13114
  ],
12408
13115
  "type": "string"
12409
13116
  },
@@ -12562,6 +13269,10 @@
12562
13269
  "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.",
12563
13270
  "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec",
12564
13271
  "properties": {
13272
+ "boostSpec": {
13273
+ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec",
13274
+ "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)"
13275
+ },
12565
13276
  "dataStore": {
12566
13277
  "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
12567
13278
  "type": "string"
@@ -12827,12 +13538,20 @@
12827
13538
  "description": "External session proto definition.",
12828
13539
  "id": "GoogleCloudDiscoveryengineV1alphaSession",
12829
13540
  "properties": {
13541
+ "displayName": {
13542
+ "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.",
13543
+ "type": "string"
13544
+ },
12830
13545
  "endTime": {
12831
13546
  "description": "Output only. The time the session finished.",
12832
13547
  "format": "google-datetime",
12833
13548
  "readOnly": true,
12834
13549
  "type": "string"
12835
13550
  },
13551
+ "isPinned": {
13552
+ "description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.",
13553
+ "type": "boolean"
13554
+ },
12836
13555
  "name": {
12837
13556
  "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
12838
13557
  "type": "string"
@@ -12877,6 +13596,11 @@
12877
13596
  "description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
12878
13597
  "type": "string"
12879
13598
  },
13599
+ "detailedAnswer": {
13600
+ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer",
13601
+ "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.",
13602
+ "readOnly": true
13603
+ },
12880
13604
  "query": {
12881
13605
  "$ref": "GoogleCloudDiscoveryengineV1alphaQuery",
12882
13606
  "description": "The user query."
@@ -13161,6 +13885,22 @@
13161
13885
  },
13162
13886
  "type": "object"
13163
13887
  },
13888
+ "GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest": {
13889
+ "description": "Request for UpdateSession method.",
13890
+ "id": "GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest",
13891
+ "properties": {
13892
+ "session": {
13893
+ "$ref": "GoogleCloudDiscoveryengineV1alphaSession",
13894
+ "description": "Required. The Session to update."
13895
+ },
13896
+ "updateMask": {
13897
+ "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.",
13898
+ "format": "google-fieldmask",
13899
+ "type": "string"
13900
+ }
13901
+ },
13902
+ "type": "object"
13903
+ },
13164
13904
  "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": {
13165
13905
  "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
13166
13906
  "id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata",
@@ -13561,6 +14301,18 @@
13561
14301
  "readOnly": true,
13562
14302
  "type": "string"
13563
14303
  },
14304
+ "groundingScore": {
14305
+ "description": "A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.",
14306
+ "format": "double",
14307
+ "type": "number"
14308
+ },
14309
+ "groundingSupports": {
14310
+ "description": "Optional. Grounding supports.",
14311
+ "items": {
14312
+ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerGroundingSupport"
14313
+ },
14314
+ "type": "array"
14315
+ },
13564
14316
  "name": {
13565
14317
  "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`",
13566
14318
  "type": "string"
@@ -13589,13 +14341,15 @@
13589
14341
  "STATE_UNSPECIFIED",
13590
14342
  "IN_PROGRESS",
13591
14343
  "FAILED",
13592
- "SUCCEEDED"
14344
+ "SUCCEEDED",
14345
+ "STREAMING"
13593
14346
  ],
13594
14347
  "enumDescriptions": [
13595
14348
  "Unknown.",
13596
14349
  "Answer generation is currently in progress.",
13597
14350
  "Answer generation currently failed.",
13598
- "Answer generation has succeeded."
14351
+ "Answer generation has succeeded.",
14352
+ "Answer generation is currently in progress."
13599
14353
  ],
13600
14354
  "type": "string"
13601
14355
  },
@@ -13644,6 +14398,39 @@
13644
14398
  },
13645
14399
  "type": "object"
13646
14400
  },
14401
+ "GoogleCloudDiscoveryengineV1betaAnswerGroundingSupport": {
14402
+ "description": "Grounding support for a claim in `answer_text`.",
14403
+ "id": "GoogleCloudDiscoveryengineV1betaAnswerGroundingSupport",
14404
+ "properties": {
14405
+ "endIndex": {
14406
+ "description": "Required. End of the claim, exclusive.",
14407
+ "format": "int64",
14408
+ "type": "string"
14409
+ },
14410
+ "groundingCheckRequired": {
14411
+ "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.",
14412
+ "type": "boolean"
14413
+ },
14414
+ "groundingScore": {
14415
+ "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.",
14416
+ "format": "double",
14417
+ "type": "number"
14418
+ },
14419
+ "sources": {
14420
+ "description": "Optional. Citation sources for the claim.",
14421
+ "items": {
14422
+ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerCitationSource"
14423
+ },
14424
+ "type": "array"
14425
+ },
14426
+ "startIndex": {
14427
+ "description": "Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).",
14428
+ "format": "int64",
14429
+ "type": "string"
14430
+ }
14431
+ },
14432
+ "type": "object"
14433
+ },
13647
14434
  "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest": {
13648
14435
  "description": "Request message for ConversationalSearchService.AnswerQuery method.",
13649
14436
  "id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest",
@@ -13840,6 +14627,31 @@
13840
14627
  "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.",
13841
14628
  "format": "int32",
13842
14629
  "type": "integer"
14630
+ },
14631
+ "modelSpec": {
14632
+ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec",
14633
+ "description": "Optional. Query Rephraser Model specification."
14634
+ }
14635
+ },
14636
+ "type": "object"
14637
+ },
14638
+ "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec": {
14639
+ "description": "Query Rephraser Model specification.",
14640
+ "id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec",
14641
+ "properties": {
14642
+ "modelType": {
14643
+ "description": "Optional. Enabled query rephraser model type. If not set, it will use LARGE by default.",
14644
+ "enum": [
14645
+ "MODEL_TYPE_UNSPECIFIED",
14646
+ "SMALL",
14647
+ "LARGE"
14648
+ ],
14649
+ "enumDescriptions": [
14650
+ "Unspecified model type.",
14651
+ "Small query rephraser model. Gemini 1.0 XS model.",
14652
+ "Large query rephraser model. Gemini 1.0 Pro model."
14653
+ ],
14654
+ "type": "string"
13843
14655
  }
13844
14656
  },
13845
14657
  "type": "object"
@@ -13856,7 +14668,7 @@
13856
14668
  "type": "object"
13857
14669
  },
13858
14670
  "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec": {
13859
- "description": "Safety specification.",
14671
+ "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.",
13860
14672
  "id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec",
13861
14673
  "properties": {
13862
14674
  "enable": {
@@ -13923,7 +14735,7 @@
13923
14735
  "enumDescriptions": [
13924
14736
  "Default value.",
13925
14737
  "Returns documents in the search result.",
13926
- "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified."
14738
+ "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
13927
14739
  ],
13928
14740
  "type": "string"
13929
14741
  }
@@ -14834,7 +15646,7 @@
14834
15646
  "type": "integer"
14835
15647
  },
14836
15648
  "groundingCheckRequired": {
14837
- "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.",
15649
+ "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.",
14838
15650
  "type": "boolean"
14839
15651
  },
14840
15652
  "startPos": {
@@ -14896,7 +15708,7 @@
14896
15708
  "description": "Page span of the chunk."
14897
15709
  },
14898
15710
  "relevanceScore": {
14899
- "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.",
15711
+ "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.",
14900
15712
  "format": "double",
14901
15713
  "readOnly": true,
14902
15714
  "type": "number"
@@ -15234,6 +16046,10 @@
15234
16046
  "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
15235
16047
  "type": "string"
15236
16048
  },
16049
+ "promoteAction": {
16050
+ "$ref": "GoogleCloudDiscoveryengineV1betaControlPromoteAction",
16051
+ "description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
16052
+ },
15237
16053
  "redirectAction": {
15238
16054
  "$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction",
15239
16055
  "description": "Defines a redirect-type control."
@@ -15315,6 +16131,21 @@
15315
16131
  },
15316
16132
  "type": "object"
15317
16133
  },
16134
+ "GoogleCloudDiscoveryengineV1betaControlPromoteAction": {
16135
+ "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.",
16136
+ "id": "GoogleCloudDiscoveryengineV1betaControlPromoteAction",
16137
+ "properties": {
16138
+ "dataStore": {
16139
+ "description": "Required. Data store with which this promotion is attached to.",
16140
+ "type": "string"
16141
+ },
16142
+ "searchLinkPromotion": {
16143
+ "$ref": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion",
16144
+ "description": "Required. Promotion attached to this action."
16145
+ }
16146
+ },
16147
+ "type": "object"
16148
+ },
15318
16149
  "GoogleCloudDiscoveryengineV1betaControlRedirectAction": {
15319
16150
  "description": "Redirects a shopper to the provided URI.",
15320
16151
  "id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction",
@@ -16080,6 +16911,11 @@
16080
16911
  "description": "Detailed document information associated with a user event.",
16081
16912
  "id": "GoogleCloudDiscoveryengineV1betaDocumentInfo",
16082
16913
  "properties": {
16914
+ "conversionValue": {
16915
+ "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.",
16916
+ "format": "float",
16917
+ "type": "number"
16918
+ },
16083
16919
  "id": {
16084
16920
  "description": "The Document resource ID.",
16085
16921
  "type": "string"
@@ -16572,80 +17408,6 @@
16572
17408
  },
16573
17409
  "type": "object"
16574
17410
  },
16575
- "GoogleCloudDiscoveryengineV1betaFeedback": {
16576
- "description": "Information about the user feedback. This information will be used for logging and metrics purpose.",
16577
- "id": "GoogleCloudDiscoveryengineV1betaFeedback",
16578
- "properties": {
16579
- "comment": {
16580
- "description": "Optional. The additional user comment of the feedback if user gives a thumb down.",
16581
- "type": "string"
16582
- },
16583
- "conversationInfo": {
16584
- "$ref": "GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo",
16585
- "description": "The related conversation information when user gives feedback."
16586
- },
16587
- "feedbackType": {
16588
- "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.",
16589
- "enum": [
16590
- "FEEDBACK_TYPE_UNSPECIFIED",
16591
- "LIKE",
16592
- "DISLIKE"
16593
- ],
16594
- "enumDescriptions": [
16595
- "Unspecified feedback type.",
16596
- "The user gives a positive feedback.",
16597
- "The user gives a negative feedback."
16598
- ],
16599
- "type": "string"
16600
- },
16601
- "llmModelVersion": {
16602
- "description": "The version of the LLM model that was used to generate the response.",
16603
- "type": "string"
16604
- },
16605
- "reasons": {
16606
- "description": "Optional. The reason if user gives a thumb down.",
16607
- "items": {
16608
- "enum": [
16609
- "REASON_UNSPECIFIED",
16610
- "INACCURATE_RESPONSE",
16611
- "NOT_RELEVANT",
16612
- "INCOMPREHENSIVE",
16613
- "OFFENSIVE_OR_UNSAFE",
16614
- "BAD_CIATION",
16615
- "FORMAT_AND_STYLES"
16616
- ],
16617
- "enumDescriptions": [
16618
- "Unspecified reason.",
16619
- "The response is inaccurate.",
16620
- "The response is not relevant.",
16621
- "The response is incomprehensive.",
16622
- "The response is offensive or unsafe.",
16623
- "The response is not well-associated with the query.",
16624
- "The response is not well-formatted."
16625
- ],
16626
- "type": "string"
16627
- },
16628
- "type": "array"
16629
- }
16630
- },
16631
- "type": "object"
16632
- },
16633
- "GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo": {
16634
- "description": "The conversation information such as the question index and session name.",
16635
- "id": "GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo",
16636
- "properties": {
16637
- "questionIndex": {
16638
- "description": "The index of the user input within the conversation messages.",
16639
- "format": "int32",
16640
- "type": "integer"
16641
- },
16642
- "session": {
16643
- "description": "Name of the newly generated or continued session.",
16644
- "type": "string"
16645
- }
16646
- },
16647
- "type": "object"
16648
- },
16649
17411
  "GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse": {
16650
17412
  "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.",
16651
17413
  "id": "GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse",
@@ -16712,6 +17474,10 @@
16712
17474
  "type": "string"
16713
17475
  },
16714
17476
  "type": "array"
17477
+ },
17478
+ "updateFromLatestPredefinedSchema": {
17479
+ "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.",
17480
+ "type": "boolean"
16715
17481
  }
16716
17482
  },
16717
17483
  "type": "object"
@@ -17927,7 +18693,7 @@
17927
18693
  "id": "GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest",
17928
18694
  "properties": {
17929
18695
  "filter": {
17930
- "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.",
18696
+ "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.",
17931
18697
  "type": "string"
17932
18698
  },
17933
18699
  "force": {
@@ -18071,7 +18837,7 @@
18071
18837
  "type": "string"
18072
18838
  },
18073
18839
  "score": {
18074
- "description": "The score of this record based on the given query and selected model.",
18840
+ "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.",
18075
18841
  "format": "float",
18076
18842
  "type": "number"
18077
18843
  },
@@ -18087,7 +18853,7 @@
18087
18853
  "id": "GoogleCloudDiscoveryengineV1betaRecommendRequest",
18088
18854
  "properties": {
18089
18855
  "filter": {
18090
- "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.",
18856
+ "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.",
18091
18857
  "type": "string"
18092
18858
  },
18093
18859
  "pageSize": {
@@ -18376,6 +19142,33 @@
18376
19142
  },
18377
19143
  "type": "object"
18378
19144
  },
19145
+ "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion": {
19146
+ "description": "Promotion proto includes uri and other helping information to display the promotion.",
19147
+ "id": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion",
19148
+ "properties": {
19149
+ "description": {
19150
+ "description": "Optional. The Promotion description. Maximum length: 200 characters.",
19151
+ "type": "string"
19152
+ },
19153
+ "enabled": {
19154
+ "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.",
19155
+ "type": "boolean"
19156
+ },
19157
+ "imageUri": {
19158
+ "description": "Optional. The promotion thumbnail image url.",
19159
+ "type": "string"
19160
+ },
19161
+ "title": {
19162
+ "description": "Required. The title of the promotion. Maximum length: 160 characters.",
19163
+ "type": "string"
19164
+ },
19165
+ "uri": {
19166
+ "description": "Required. The URL for the page the user wants to promote.",
19167
+ "type": "string"
19168
+ }
19169
+ },
19170
+ "type": "object"
19171
+ },
18379
19172
  "GoogleCloudDiscoveryengineV1betaSearchRequest": {
18380
19173
  "description": "Request message for SearchService.Search method.",
18381
19174
  "id": "GoogleCloudDiscoveryengineV1betaSearchRequest",
@@ -18397,7 +19190,7 @@
18397
19190
  "description": "A specification for configuring the behavior of content search."
18398
19191
  },
18399
19192
  "dataStoreSpecs": {
18400
- "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.",
19193
+ "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.",
18401
19194
  "items": {
18402
19195
  "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec"
18403
19196
  },
@@ -18656,7 +19449,7 @@
18656
19449
  "enumDescriptions": [
18657
19450
  "Default value.",
18658
19451
  "Returns documents in the search result.",
18659
- "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified."
19452
+ "Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
18660
19453
  ],
18661
19454
  "type": "string"
18662
19455
  },
@@ -18815,6 +19608,10 @@
18815
19608
  "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.",
18816
19609
  "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec",
18817
19610
  "properties": {
19611
+ "boostSpec": {
19612
+ "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
19613
+ "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)"
19614
+ },
18818
19615
  "dataStore": {
18819
19616
  "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
18820
19617
  "type": "string"
@@ -19142,6 +19939,13 @@
19142
19939
  },
19143
19940
  "type": "array"
19144
19941
  },
19942
+ "searchLinkPromotions": {
19943
+ "description": "Promotions for site search.",
19944
+ "items": {
19945
+ "$ref": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion"
19946
+ },
19947
+ "type": "array"
19948
+ },
19145
19949
  "sessionInfo": {
19146
19950
  "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo",
19147
19951
  "description": "Session information. Only set if SearchRequest.session is provided. See its description for more details."
@@ -19779,6 +20583,13 @@
19779
20583
  "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec",
19780
20584
  "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."
19781
20585
  },
20586
+ "promoteControlIds": {
20587
+ "description": "Condition promote specifications. Maximum number of specifications is 100.",
20588
+ "items": {
20589
+ "type": "string"
20590
+ },
20591
+ "type": "array"
20592
+ },
19782
20593
  "rankingExpression": {
19783
20594
  "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)`.",
19784
20595
  "type": "string"
@@ -19877,12 +20688,20 @@
19877
20688
  "description": "External session proto definition.",
19878
20689
  "id": "GoogleCloudDiscoveryengineV1betaSession",
19879
20690
  "properties": {
20691
+ "displayName": {
20692
+ "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.",
20693
+ "type": "string"
20694
+ },
19880
20695
  "endTime": {
19881
20696
  "description": "Output only. The time the session finished.",
19882
20697
  "format": "google-datetime",
19883
20698
  "readOnly": true,
19884
20699
  "type": "string"
19885
20700
  },
20701
+ "isPinned": {
20702
+ "description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.",
20703
+ "type": "boolean"
20704
+ },
19886
20705
  "name": {
19887
20706
  "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
19888
20707
  "type": "string"
@@ -19927,6 +20746,11 @@
19927
20746
  "description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
19928
20747
  "type": "string"
19929
20748
  },
20749
+ "detailedAnswer": {
20750
+ "$ref": "GoogleCloudDiscoveryengineV1betaAnswer",
20751
+ "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.",
20752
+ "readOnly": true
20753
+ },
19930
20754
  "query": {
19931
20755
  "$ref": "GoogleCloudDiscoveryengineV1betaQuery",
19932
20756
  "description": "The user query."
@@ -20372,6 +21196,10 @@
20372
21196
  "$ref": "GoogleCloudDiscoveryengineV1betaCompletionInfo",
20373
21197
  "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."
20374
21198
  },
21199
+ "conversionType": {
21200
+ "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.",
21201
+ "type": "string"
21202
+ },
20375
21203
  "dataStore": {
20376
21204
  "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.",
20377
21205
  "type": "string"
@@ -20397,13 +21225,9 @@
20397
21225
  "type": "string"
20398
21226
  },
20399
21227
  "eventType": {
20400
- "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.",
21228
+ "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.",
20401
21229
  "type": "string"
20402
21230
  },
20403
- "feedback": {
20404
- "$ref": "GoogleCloudDiscoveryengineV1betaFeedback",
20405
- "description": "Optional. This field is optional except for the `add-feedback` event types."
20406
- },
20407
21231
  "filter": {
20408
21232
  "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.",
20409
21233
  "type": "string"