google-api-python-client 2.176.0__py3-none-any.whl → 2.178.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (169) hide show
  1. {google_api_python_client-2.176.0.dist-info → google_api_python_client-2.178.0.dist-info}/METADATA +1 -1
  2. {google_api_python_client-2.176.0.dist-info → google_api_python_client-2.178.0.dist-info}/RECORD +169 -167
  3. googleapiclient/discovery_cache/documents/accessapproval.v1.json +7 -1
  4. googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +2 -2
  5. googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json +4 -4
  6. googleapiclient/discovery_cache/documents/admin.datatransferv1.json +4 -4
  7. googleapiclient/discovery_cache/documents/admin.directory_v1.json +86 -86
  8. googleapiclient/discovery_cache/documents/admin.directoryv1.json +86 -86
  9. googleapiclient/discovery_cache/documents/admin.reports_v1.json +31 -3
  10. googleapiclient/discovery_cache/documents/admin.reportsv1.json +31 -3
  11. googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json +4 -4
  12. googleapiclient/discovery_cache/documents/aiplatform.v1.json +379 -31
  13. googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +717 -47
  14. googleapiclient/discovery_cache/documents/alloydb.v1.json +144 -9
  15. googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +144 -9
  16. googleapiclient/discovery_cache/documents/alloydb.v1beta.json +144 -9
  17. googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +46 -227
  18. googleapiclient/discovery_cache/documents/androidenterprise.v1.json +30 -1
  19. googleapiclient/discovery_cache/documents/androidmanagement.v1.json +3 -3
  20. googleapiclient/discovery_cache/documents/androidpublisher.v3.json +2136 -300
  21. googleapiclient/discovery_cache/documents/apigee.v1.json +6 -6
  22. googleapiclient/discovery_cache/documents/apihub.v1.json +535 -7
  23. googleapiclient/discovery_cache/documents/apphub.v1alpha.json +1 -68
  24. googleapiclient/discovery_cache/documents/artifactregistry.v1.json +7 -7
  25. googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +6 -6
  26. googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +6 -6
  27. googleapiclient/discovery_cache/documents/backupdr.v1.json +65 -21
  28. googleapiclient/discovery_cache/documents/batch.v1.json +13 -7
  29. googleapiclient/discovery_cache/documents/beyondcorp.v1.json +61 -9
  30. googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +61 -9
  31. googleapiclient/discovery_cache/documents/biglake.v1.json +1 -1
  32. googleapiclient/discovery_cache/documents/bigquery.v2.json +73 -7
  33. googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +56 -1
  34. googleapiclient/discovery_cache/documents/chat.v1.json +105 -31
  35. googleapiclient/discovery_cache/documents/chromemanagement.v1.json +325 -6
  36. googleapiclient/discovery_cache/documents/civicinfo.v2.json +7 -1
  37. googleapiclient/discovery_cache/documents/cloudasset.v1.json +31 -1
  38. googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json +9 -1168
  39. googleapiclient/discovery_cache/documents/cloudbuild.v1.json +2 -2
  40. googleapiclient/discovery_cache/documents/cloudbuild.v2.json +1 -26
  41. googleapiclient/discovery_cache/documents/compute.alpha.json +1044 -105
  42. googleapiclient/discovery_cache/documents/compute.beta.json +416 -85
  43. googleapiclient/discovery_cache/documents/compute.v1.json +262 -26
  44. googleapiclient/discovery_cache/documents/connectors.v1.json +29 -1
  45. googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +6 -1
  46. googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +73 -9
  47. googleapiclient/discovery_cache/documents/container.v1.json +257 -3
  48. googleapiclient/discovery_cache/documents/container.v1beta1.json +258 -14
  49. googleapiclient/discovery_cache/documents/containeranalysis.v1.json +2 -2
  50. googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +2 -2
  51. googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +2 -2
  52. googleapiclient/discovery_cache/documents/content.v2.1.json +2 -2
  53. googleapiclient/discovery_cache/documents/datacatalog.v1.json +1 -2
  54. googleapiclient/discovery_cache/documents/dataflow.v1b3.json +43 -36
  55. googleapiclient/discovery_cache/documents/dataform.v1beta1.json +35 -1
  56. googleapiclient/discovery_cache/documents/datalineage.v1.json +6 -1
  57. googleapiclient/discovery_cache/documents/dataplex.v1.json +214 -30
  58. googleapiclient/discovery_cache/documents/dataportability.v1.json +1 -10
  59. googleapiclient/discovery_cache/documents/dataportability.v1beta.json +1 -10
  60. googleapiclient/discovery_cache/documents/datastream.v1.json +63 -1
  61. googleapiclient/discovery_cache/documents/developerconnect.v1.json +2 -2
  62. googleapiclient/discovery_cache/documents/dfareporting.v4.json +1210 -70
  63. googleapiclient/discovery_cache/documents/dialogflow.v2.json +286 -1
  64. googleapiclient/discovery_cache/documents/discoveryengine.v1.json +1715 -185
  65. googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +1488 -62
  66. googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +1377 -244
  67. googleapiclient/discovery_cache/documents/displayvideo.v2.json +1376 -213
  68. googleapiclient/discovery_cache/documents/displayvideo.v3.json +27 -4
  69. googleapiclient/discovery_cache/documents/displayvideo.v4.json +1377 -202
  70. googleapiclient/discovery_cache/documents/dlp.v2.json +33 -12
  71. googleapiclient/discovery_cache/documents/documentai.v1.json +15 -8
  72. googleapiclient/discovery_cache/documents/documentai.v1beta3.json +15 -8
  73. googleapiclient/discovery_cache/documents/drive.v3.json +3 -109
  74. googleapiclient/discovery_cache/documents/fcm.v1.json +3 -3
  75. googleapiclient/discovery_cache/documents/file.v1.json +7 -1
  76. googleapiclient/discovery_cache/documents/file.v1beta1.json +7 -1
  77. googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json +5 -1
  78. googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json +6 -2
  79. googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json +6 -2
  80. googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +145 -27
  81. googleapiclient/discovery_cache/documents/gkebackup.v1.json +28 -1
  82. googleapiclient/discovery_cache/documents/gkehub.v1.json +30 -9
  83. googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +30 -9
  84. googleapiclient/discovery_cache/documents/gkehub.v1beta.json +30 -9
  85. googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +14 -1
  86. googleapiclient/discovery_cache/documents/gkehub.v2.json +17 -9
  87. googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +17 -9
  88. googleapiclient/discovery_cache/documents/gkehub.v2beta.json +17 -9
  89. googleapiclient/discovery_cache/documents/healthcare.v1.json +61 -5
  90. googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +24 -6
  91. googleapiclient/discovery_cache/documents/homegraph.v1.json +2 -2
  92. googleapiclient/discovery_cache/documents/iam.v1.json +524 -1
  93. googleapiclient/discovery_cache/documents/iamcredentials.v1.json +21 -1
  94. googleapiclient/discovery_cache/documents/integrations.v1.json +1 -363
  95. googleapiclient/discovery_cache/documents/kmsinventory.v1.json +17 -3
  96. googleapiclient/discovery_cache/documents/logging.v2.json +11 -1
  97. googleapiclient/discovery_cache/documents/looker.v1.json +15 -1
  98. googleapiclient/discovery_cache/documents/managedkafka.v1.json +11 -1
  99. googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +131 -8
  100. googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +3 -4
  101. googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +9 -7
  102. googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1beta.json +5 -5
  103. googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +22 -14
  104. googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json +2 -2
  105. googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json +17 -9
  106. googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +7 -3
  107. googleapiclient/discovery_cache/documents/monitoring.v1.json +4 -4
  108. googleapiclient/discovery_cache/documents/monitoring.v3.json +4 -4
  109. googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +6 -1
  110. googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json +76 -1
  111. googleapiclient/discovery_cache/documents/netapp.v1beta1.json +51 -1
  112. googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +4 -4
  113. googleapiclient/discovery_cache/documents/networkmanagement.v1.json +965 -14
  114. googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +10 -5
  115. googleapiclient/discovery_cache/documents/networksecurity.v1.json +39 -5
  116. googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +270 -5
  117. googleapiclient/discovery_cache/documents/networkservices.v1.json +15 -13
  118. googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +15 -13
  119. googleapiclient/discovery_cache/documents/notebooks.v2.json +131 -1
  120. googleapiclient/discovery_cache/documents/oracledatabase.v1.json +478 -1
  121. googleapiclient/discovery_cache/documents/osconfig.v1.json +24 -1
  122. googleapiclient/discovery_cache/documents/osconfig.v1alpha.json +24 -1
  123. googleapiclient/discovery_cache/documents/parametermanager.v1.json +982 -0
  124. googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +5 -5
  125. googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +41 -5
  126. googleapiclient/discovery_cache/documents/redis.v1.json +166 -13
  127. googleapiclient/discovery_cache/documents/redis.v1beta1.json +166 -13
  128. googleapiclient/discovery_cache/documents/retail.v2.json +45 -2
  129. googleapiclient/discovery_cache/documents/retail.v2alpha.json +147 -2
  130. googleapiclient/discovery_cache/documents/retail.v2beta.json +45 -2
  131. googleapiclient/discovery_cache/documents/run.v1.json +2 -2
  132. googleapiclient/discovery_cache/documents/run.v2.json +19 -14
  133. googleapiclient/discovery_cache/documents/searchads360.v0.json +38 -4
  134. googleapiclient/discovery_cache/documents/searchconsole.v1.json +20 -1
  135. googleapiclient/discovery_cache/documents/secretmanager.v1.json +16 -1
  136. googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +16 -1
  137. googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +16 -1
  138. googleapiclient/discovery_cache/documents/securesourcemanager.v1.json +3568 -0
  139. googleapiclient/discovery_cache/documents/securitycenter.v1.json +290 -12
  140. googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +287 -9
  141. googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +287 -9
  142. googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +5 -1
  143. googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +5 -1
  144. googleapiclient/discovery_cache/documents/servicenetworking.v1.json +22 -11
  145. googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +21 -10
  146. googleapiclient/discovery_cache/documents/serviceusage.v1.json +5 -1
  147. googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +5 -1
  148. googleapiclient/discovery_cache/documents/spanner.v1.json +4 -4
  149. googleapiclient/discovery_cache/documents/storage.v1.json +71 -2
  150. googleapiclient/discovery_cache/documents/testing.v1.json +21 -5
  151. googleapiclient/discovery_cache/documents/texttospeech.v1.json +2 -2
  152. googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +2 -2
  153. googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +2 -2
  154. googleapiclient/discovery_cache/documents/transcoder.v1.json +54 -1
  155. googleapiclient/discovery_cache/documents/videointelligence.v1.json +11 -11
  156. googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json +11 -11
  157. googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json +11 -11
  158. googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json +11 -11
  159. googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json +11 -11
  160. googleapiclient/discovery_cache/documents/vmmigration.v1.json +9 -4
  161. googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +9 -4
  162. googleapiclient/discovery_cache/documents/workloadmanager.v1.json +45 -225
  163. googleapiclient/discovery_cache/documents/workspaceevents.v1.json +4 -4
  164. googleapiclient/discovery_cache/documents/workstations.v1beta.json +8 -3
  165. googleapiclient/discovery_cache/documents/youtube.v3.json +67 -1
  166. googleapiclient/version.py +1 -1
  167. {google_api_python_client-2.176.0.dist-info → google_api_python_client-2.178.0.dist-info}/WHEEL +0 -0
  168. {google_api_python_client-2.176.0.dist-info → google_api_python_client-2.178.0.dist-info}/licenses/LICENSE +0 -0
  169. {google_api_python_client-2.176.0.dist-info → google_api_python_client-2.178.0.dist-info}/top_level.txt +0 -0
@@ -4,6 +4,9 @@
4
4
  "scopes": {
5
5
  "https://www.googleapis.com/auth/cloud-platform": {
6
6
  "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
7
+ },
8
+ "https://www.googleapis.com/auth/cloud_search.query": {
9
+ "description": "Search your organization's data in the Cloud Search index"
7
10
  }
8
11
  }
9
12
  }
@@ -35,6 +38,11 @@
35
38
  "description": "Regional Endpoint",
36
39
  "endpointUrl": "https://discoveryengine.eu.rep.googleapis.com/",
37
40
  "location": "eu"
41
+ },
42
+ {
43
+ "description": "Regional Endpoint",
44
+ "endpointUrl": "https://discoveryengine.in.rep.googleapis.com/",
45
+ "location": "in"
38
46
  }
39
47
  ],
40
48
  "fullyEncodeReservedExpansion": true,
@@ -127,6 +135,47 @@
127
135
  },
128
136
  "protocol": "rest",
129
137
  "resources": {
138
+ "media": {
139
+ "methods": {
140
+ "download": {
141
+ "description": "Downloads a file from the session.",
142
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}:downloadFile",
143
+ "httpMethod": "GET",
144
+ "id": "discoveryengine.media.download",
145
+ "parameterOrder": [
146
+ "name"
147
+ ],
148
+ "parameters": {
149
+ "fileId": {
150
+ "description": "Required. The ID of the file to be downloaded.",
151
+ "location": "query",
152
+ "type": "string"
153
+ },
154
+ "name": {
155
+ "description": "Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`",
156
+ "location": "path",
157
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$",
158
+ "required": true,
159
+ "type": "string"
160
+ },
161
+ "viewId": {
162
+ "description": "Optional. The ID of the view to be downloaded.",
163
+ "location": "query",
164
+ "type": "string"
165
+ }
166
+ },
167
+ "path": "v1/{+name}:downloadFile",
168
+ "response": {
169
+ "$ref": "GdataMedia"
170
+ },
171
+ "scopes": [
172
+ "https://www.googleapis.com/auth/cloud-platform"
173
+ ],
174
+ "supportsMediaDownload": true,
175
+ "useMediaDownloadService": true
176
+ }
177
+ }
178
+ },
130
179
  "projects": {
131
180
  "methods": {
132
181
  "provision": {
@@ -1048,6 +1097,39 @@
1048
1097
  }
1049
1098
  }
1050
1099
  },
1100
+ "completionConfig": {
1101
+ "methods": {
1102
+ "completeQuery": {
1103
+ "description": "Completes the user input with advanced keyword suggestions.",
1104
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/completionConfig:completeQuery",
1105
+ "httpMethod": "POST",
1106
+ "id": "discoveryengine.projects.locations.collections.dataStores.completionConfig.completeQuery",
1107
+ "parameterOrder": [
1108
+ "completionConfig"
1109
+ ],
1110
+ "parameters": {
1111
+ "completionConfig": {
1112
+ "description": "Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.",
1113
+ "location": "path",
1114
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/completionConfig$",
1115
+ "required": true,
1116
+ "type": "string"
1117
+ }
1118
+ },
1119
+ "path": "v1/{+completionConfig}:completeQuery",
1120
+ "request": {
1121
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest"
1122
+ },
1123
+ "response": {
1124
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse"
1125
+ },
1126
+ "scopes": [
1127
+ "https://www.googleapis.com/auth/cloud-platform",
1128
+ "https://www.googleapis.com/auth/cloud_search.query"
1129
+ ]
1130
+ }
1131
+ }
1132
+ },
1051
1133
  "completionSuggestions": {
1052
1134
  "methods": {
1053
1135
  "import": {
@@ -2134,7 +2216,7 @@
2134
2216
  ],
2135
2217
  "parameters": {
2136
2218
  "filter": {
2137
- "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
2219
+ "description": "A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = \"some_name\"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > \"1970-01-01T12:00:00Z\"`",
2138
2220
  "location": "query",
2139
2221
  "type": "string"
2140
2222
  },
@@ -3153,6 +3235,130 @@
3153
3235
  }
3154
3236
  },
3155
3237
  "resources": {
3238
+ "assistants": {
3239
+ "methods": {
3240
+ "get": {
3241
+ "description": "Gets an Assistant.",
3242
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}",
3243
+ "httpMethod": "GET",
3244
+ "id": "discoveryengine.projects.locations.collections.engines.assistants.get",
3245
+ "parameterOrder": [
3246
+ "name"
3247
+ ],
3248
+ "parameters": {
3249
+ "name": {
3250
+ "description": "Required. Resource name of Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`",
3251
+ "location": "path",
3252
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$",
3253
+ "required": true,
3254
+ "type": "string"
3255
+ }
3256
+ },
3257
+ "path": "v1/{+name}",
3258
+ "response": {
3259
+ "$ref": "GoogleCloudDiscoveryengineV1Assistant"
3260
+ },
3261
+ "scopes": [
3262
+ "https://www.googleapis.com/auth/cloud-platform"
3263
+ ]
3264
+ },
3265
+ "patch": {
3266
+ "description": "Updates an Assistant",
3267
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}",
3268
+ "httpMethod": "PATCH",
3269
+ "id": "discoveryengine.projects.locations.collections.engines.assistants.patch",
3270
+ "parameterOrder": [
3271
+ "name"
3272
+ ],
3273
+ "parameters": {
3274
+ "name": {
3275
+ "description": "Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.",
3276
+ "location": "path",
3277
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$",
3278
+ "required": true,
3279
+ "type": "string"
3280
+ },
3281
+ "updateMask": {
3282
+ "description": "The list of fields to update.",
3283
+ "format": "google-fieldmask",
3284
+ "location": "query",
3285
+ "type": "string"
3286
+ }
3287
+ },
3288
+ "path": "v1/{+name}",
3289
+ "request": {
3290
+ "$ref": "GoogleCloudDiscoveryengineV1Assistant"
3291
+ },
3292
+ "response": {
3293
+ "$ref": "GoogleCloudDiscoveryengineV1Assistant"
3294
+ },
3295
+ "scopes": [
3296
+ "https://www.googleapis.com/auth/cloud-platform"
3297
+ ]
3298
+ },
3299
+ "streamAssist": {
3300
+ "description": "Assists the user with a query in a streaming fashion.",
3301
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}:streamAssist",
3302
+ "httpMethod": "POST",
3303
+ "id": "discoveryengine.projects.locations.collections.engines.assistants.streamAssist",
3304
+ "parameterOrder": [
3305
+ "name"
3306
+ ],
3307
+ "parameters": {
3308
+ "name": {
3309
+ "description": "Required. The resource name of the Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`",
3310
+ "location": "path",
3311
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$",
3312
+ "required": true,
3313
+ "type": "string"
3314
+ }
3315
+ },
3316
+ "path": "v1/{+name}:streamAssist",
3317
+ "request": {
3318
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequest"
3319
+ },
3320
+ "response": {
3321
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistResponse"
3322
+ },
3323
+ "scopes": [
3324
+ "https://www.googleapis.com/auth/cloud-platform"
3325
+ ]
3326
+ }
3327
+ }
3328
+ },
3329
+ "completionConfig": {
3330
+ "methods": {
3331
+ "completeQuery": {
3332
+ "description": "Completes the user input with advanced keyword suggestions.",
3333
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/completionConfig:completeQuery",
3334
+ "httpMethod": "POST",
3335
+ "id": "discoveryengine.projects.locations.collections.engines.completionConfig.completeQuery",
3336
+ "parameterOrder": [
3337
+ "completionConfig"
3338
+ ],
3339
+ "parameters": {
3340
+ "completionConfig": {
3341
+ "description": "Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.",
3342
+ "location": "path",
3343
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig$",
3344
+ "required": true,
3345
+ "type": "string"
3346
+ }
3347
+ },
3348
+ "path": "v1/{+completionConfig}:completeQuery",
3349
+ "request": {
3350
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest"
3351
+ },
3352
+ "response": {
3353
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse"
3354
+ },
3355
+ "scopes": [
3356
+ "https://www.googleapis.com/auth/cloud-platform",
3357
+ "https://www.googleapis.com/auth/cloud_search.query"
3358
+ ]
3359
+ }
3360
+ }
3361
+ },
3156
3362
  "controls": {
3157
3363
  "methods": {
3158
3364
  "create": {
@@ -3876,7 +4082,7 @@
3876
4082
  ],
3877
4083
  "parameters": {
3878
4084
  "filter": {
3879
- "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
4085
+ "description": "A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = \"some_name\"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > \"1970-01-01T12:00:00Z\"`",
3880
4086
  "location": "query",
3881
4087
  "type": "string"
3882
4088
  },
@@ -4664,6 +4870,39 @@
4664
4870
  }
4665
4871
  }
4666
4872
  },
4873
+ "completionConfig": {
4874
+ "methods": {
4875
+ "completeQuery": {
4876
+ "description": "Completes the user input with advanced keyword suggestions.",
4877
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionConfig:completeQuery",
4878
+ "httpMethod": "POST",
4879
+ "id": "discoveryengine.projects.locations.dataStores.completionConfig.completeQuery",
4880
+ "parameterOrder": [
4881
+ "completionConfig"
4882
+ ],
4883
+ "parameters": {
4884
+ "completionConfig": {
4885
+ "description": "Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.",
4886
+ "location": "path",
4887
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/completionConfig$",
4888
+ "required": true,
4889
+ "type": "string"
4890
+ }
4891
+ },
4892
+ "path": "v1/{+completionConfig}:completeQuery",
4893
+ "request": {
4894
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest"
4895
+ },
4896
+ "response": {
4897
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse"
4898
+ },
4899
+ "scopes": [
4900
+ "https://www.googleapis.com/auth/cloud-platform",
4901
+ "https://www.googleapis.com/auth/cloud_search.query"
4902
+ ]
4903
+ }
4904
+ }
4905
+ },
4667
4906
  "completionSuggestions": {
4668
4907
  "methods": {
4669
4908
  "import": {
@@ -5649,7 +5888,7 @@
5649
5888
  ],
5650
5889
  "parameters": {
5651
5890
  "filter": {
5652
- "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
5891
+ "description": "A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = \"some_name\"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > \"1970-01-01T12:00:00Z\"`",
5653
5892
  "location": "query",
5654
5893
  "type": "string"
5655
5894
  },
@@ -7052,87 +7291,517 @@
7052
7291
  }
7053
7292
  }
7054
7293
  },
7055
- "revision": "20250701",
7294
+ "revision": "20250728",
7056
7295
  "rootUrl": "https://discoveryengine.googleapis.com/",
7057
7296
  "schemas": {
7058
- "GoogleApiDistribution": {
7059
- "description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.",
7060
- "id": "GoogleApiDistribution",
7297
+ "GdataBlobstore2Info": {
7298
+ "description": "Information to read/write to blobstore2.",
7299
+ "id": "GdataBlobstore2Info",
7061
7300
  "properties": {
7062
- "bucketCounts": {
7063
- "description": "The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).",
7064
- "items": {
7301
+ "blobGeneration": {
7302
+ "description": "The blob generation id.",
7065
7303
  "format": "int64",
7066
7304
  "type": "string"
7067
7305
  },
7068
- "type": "array"
7306
+ "blobId": {
7307
+ "description": "The blob id, e.g., /blobstore/prod/playground/scotty",
7308
+ "type": "string"
7069
7309
  },
7070
- "bucketOptions": {
7071
- "$ref": "GoogleApiDistributionBucketOptions",
7072
- "description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field."
7310
+ "downloadReadHandle": {
7311
+ "description": "Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.",
7312
+ "format": "byte",
7313
+ "type": "string"
7073
7314
  },
7074
- "count": {
7075
- "description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.",
7315
+ "readToken": {
7316
+ "description": "The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.",
7317
+ "type": "string"
7318
+ },
7319
+ "uploadMetadataContainer": {
7320
+ "description": "Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.",
7321
+ "format": "byte",
7322
+ "type": "string"
7323
+ }
7324
+ },
7325
+ "type": "object"
7326
+ },
7327
+ "GdataCompositeMedia": {
7328
+ "description": "A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.",
7329
+ "id": "GdataCompositeMedia",
7330
+ "properties": {
7331
+ "blobRef": {
7332
+ "deprecated": true,
7333
+ "description": "Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.",
7334
+ "format": "byte",
7335
+ "type": "string"
7336
+ },
7337
+ "blobstore2Info": {
7338
+ "$ref": "GdataBlobstore2Info",
7339
+ "description": "Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob."
7340
+ },
7341
+ "cosmoBinaryReference": {
7342
+ "description": "A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.",
7343
+ "format": "byte",
7344
+ "type": "string"
7345
+ },
7346
+ "crc32cHash": {
7347
+ "description": "crc32.c hash for the payload.",
7348
+ "format": "uint32",
7349
+ "type": "integer"
7350
+ },
7351
+ "inline": {
7352
+ "description": "Media data, set if reference_type is INLINE",
7353
+ "format": "byte",
7354
+ "type": "string"
7355
+ },
7356
+ "length": {
7357
+ "description": "Size of the data, in bytes",
7076
7358
  "format": "int64",
7077
7359
  "type": "string"
7078
7360
  },
7079
- "exemplars": {
7080
- "description": "Must be in increasing order of `value` field.",
7081
- "items": {
7082
- "$ref": "GoogleApiDistributionExemplar"
7361
+ "md5Hash": {
7362
+ "description": "MD5 hash for the payload.",
7363
+ "format": "byte",
7364
+ "type": "string"
7083
7365
  },
7084
- "type": "array"
7366
+ "objectId": {
7367
+ "$ref": "GdataObjectId",
7368
+ "description": "Reference to a TI Blob, set if reference_type is BIGSTORE_REF."
7085
7369
  },
7086
- "mean": {
7087
- "description": "The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.",
7088
- "format": "double",
7089
- "type": "number"
7370
+ "path": {
7371
+ "description": "Path to the data, set if reference_type is PATH",
7372
+ "type": "string"
7090
7373
  },
7091
- "range": {
7092
- "$ref": "GoogleApiDistributionRange",
7093
- "description": "If specified, contains the range of the population values. The field must not be present if the `count` is zero."
7374
+ "referenceType": {
7375
+ "description": "Describes what the field reference contains.",
7376
+ "enum": [
7377
+ "PATH",
7378
+ "BLOB_REF",
7379
+ "INLINE",
7380
+ "BIGSTORE_REF",
7381
+ "COSMO_BINARY_REFERENCE"
7382
+ ],
7383
+ "enumDescriptions": [
7384
+ "Reference contains a GFS path or a local path.",
7385
+ "Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.",
7386
+ "Data is included into this proto buffer",
7387
+ "Reference points to a bigstore object",
7388
+ "Indicates the data is stored in cosmo_binary_reference."
7389
+ ],
7390
+ "type": "string"
7094
7391
  },
7095
- "sumOfSquaredDeviation": {
7096
- "description": "The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, \"The Art of Computer Programming\", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.",
7097
- "format": "double",
7098
- "type": "number"
7392
+ "sha1Hash": {
7393
+ "description": "SHA-1 hash for the payload.",
7394
+ "format": "byte",
7395
+ "type": "string"
7099
7396
  }
7100
7397
  },
7101
7398
  "type": "object"
7102
7399
  },
7103
- "GoogleApiDistributionBucketOptions": {
7104
- "description": "`BucketOptions` describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. `BucketOptions` does not include the number of values in each bucket. A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
7105
- "id": "GoogleApiDistributionBucketOptions",
7400
+ "GdataContentTypeInfo": {
7401
+ "description": "Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.",
7402
+ "id": "GdataContentTypeInfo",
7106
7403
  "properties": {
7107
- "explicitBuckets": {
7108
- "$ref": "GoogleApiDistributionBucketOptionsExplicit",
7109
- "description": "The explicit buckets."
7404
+ "bestGuess": {
7405
+ "description": "Scotty's best guess of what the content type of the file is.",
7406
+ "type": "string"
7110
7407
  },
7111
- "exponentialBuckets": {
7112
- "$ref": "GoogleApiDistributionBucketOptionsExponential",
7113
- "description": "The exponential buckets."
7408
+ "fromBytes": {
7409
+ "description": "The content type of the file derived by looking at specific bytes (i.e. \"magic bytes\") of the actual file.",
7410
+ "type": "string"
7114
7411
  },
7115
- "linearBuckets": {
7116
- "$ref": "GoogleApiDistributionBucketOptionsLinear",
7117
- "description": "The linear bucket."
7412
+ "fromFileName": {
7413
+ "description": "The content type of the file derived from the file extension of the original file name used by the client.",
7414
+ "type": "string"
7415
+ },
7416
+ "fromHeader": {
7417
+ "description": "The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.",
7418
+ "type": "string"
7419
+ },
7420
+ "fromUrlPath": {
7421
+ "description": "The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).",
7422
+ "type": "string"
7118
7423
  }
7119
7424
  },
7120
7425
  "type": "object"
7121
7426
  },
7122
- "GoogleApiDistributionBucketOptionsExplicit": {
7123
- "description": "Specifies a set of buckets with arbitrary widths. There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The `bounds` field must contain at least one element. If `bounds` has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
7124
- "id": "GoogleApiDistributionBucketOptionsExplicit",
7427
+ "GdataDiffChecksumsResponse": {
7428
+ "description": "Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.",
7429
+ "id": "GdataDiffChecksumsResponse",
7125
7430
  "properties": {
7126
- "bounds": {
7127
- "description": "The values must be monotonically increasing.",
7128
- "items": {
7129
- "format": "double",
7130
- "type": "number"
7431
+ "checksumsLocation": {
7432
+ "$ref": "GdataCompositeMedia",
7433
+ "description": "Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol."
7131
7434
  },
7132
- "type": "array"
7133
- }
7435
+ "chunkSizeBytes": {
7436
+ "description": "The chunk size of checksums. Must be a multiple of 256KB.",
7437
+ "format": "int64",
7438
+ "type": "string"
7134
7439
  },
7135
- "type": "object"
7440
+ "objectLocation": {
7441
+ "$ref": "GdataCompositeMedia",
7442
+ "description": "If set, calculate the checksums based on the contents and return them to the caller."
7443
+ },
7444
+ "objectSizeBytes": {
7445
+ "description": "The total size of the server object.",
7446
+ "format": "int64",
7447
+ "type": "string"
7448
+ },
7449
+ "objectVersion": {
7450
+ "description": "The object version of the object the checksums are being returned for.",
7451
+ "type": "string"
7452
+ }
7453
+ },
7454
+ "type": "object"
7455
+ },
7456
+ "GdataDiffDownloadResponse": {
7457
+ "description": "Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.",
7458
+ "id": "GdataDiffDownloadResponse",
7459
+ "properties": {
7460
+ "objectLocation": {
7461
+ "$ref": "GdataCompositeMedia",
7462
+ "description": "The original object location."
7463
+ }
7464
+ },
7465
+ "type": "object"
7466
+ },
7467
+ "GdataDiffUploadRequest": {
7468
+ "description": "A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.",
7469
+ "id": "GdataDiffUploadRequest",
7470
+ "properties": {
7471
+ "checksumsInfo": {
7472
+ "$ref": "GdataCompositeMedia",
7473
+ "description": "The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol."
7474
+ },
7475
+ "objectInfo": {
7476
+ "$ref": "GdataCompositeMedia",
7477
+ "description": "The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received."
7478
+ },
7479
+ "objectVersion": {
7480
+ "description": "The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.",
7481
+ "type": "string"
7482
+ }
7483
+ },
7484
+ "type": "object"
7485
+ },
7486
+ "GdataDiffUploadResponse": {
7487
+ "description": "Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.",
7488
+ "id": "GdataDiffUploadResponse",
7489
+ "properties": {
7490
+ "objectVersion": {
7491
+ "description": "The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.",
7492
+ "type": "string"
7493
+ },
7494
+ "originalObject": {
7495
+ "$ref": "GdataCompositeMedia",
7496
+ "description": "The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification."
7497
+ }
7498
+ },
7499
+ "type": "object"
7500
+ },
7501
+ "GdataDiffVersionResponse": {
7502
+ "description": "Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.",
7503
+ "id": "GdataDiffVersionResponse",
7504
+ "properties": {
7505
+ "objectSizeBytes": {
7506
+ "description": "The total size of the server object.",
7507
+ "format": "int64",
7508
+ "type": "string"
7509
+ },
7510
+ "objectVersion": {
7511
+ "description": "The version of the object stored at the server.",
7512
+ "type": "string"
7513
+ }
7514
+ },
7515
+ "type": "object"
7516
+ },
7517
+ "GdataDownloadParameters": {
7518
+ "description": "Parameters specific to media downloads.",
7519
+ "id": "GdataDownloadParameters",
7520
+ "properties": {
7521
+ "allowGzipCompression": {
7522
+ "description": "A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.",
7523
+ "type": "boolean"
7524
+ },
7525
+ "ignoreRange": {
7526
+ "description": "Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.",
7527
+ "type": "boolean"
7528
+ }
7529
+ },
7530
+ "type": "object"
7531
+ },
7532
+ "GdataMedia": {
7533
+ "description": "A reference to data stored on the filesystem, on GFS or in blobstore.",
7534
+ "id": "GdataMedia",
7535
+ "properties": {
7536
+ "algorithm": {
7537
+ "deprecated": true,
7538
+ "description": "Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, \"MD5\" is the only possible value for this field. New values may be added at any time.",
7539
+ "type": "string"
7540
+ },
7541
+ "bigstoreObjectRef": {
7542
+ "deprecated": true,
7543
+ "description": "Use object_id instead.",
7544
+ "format": "byte",
7545
+ "type": "string"
7546
+ },
7547
+ "blobRef": {
7548
+ "deprecated": true,
7549
+ "description": "Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.",
7550
+ "format": "byte",
7551
+ "type": "string"
7552
+ },
7553
+ "blobstore2Info": {
7554
+ "$ref": "GdataBlobstore2Info",
7555
+ "description": "Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob."
7556
+ },
7557
+ "compositeMedia": {
7558
+ "description": "A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.",
7559
+ "items": {
7560
+ "$ref": "GdataCompositeMedia"
7561
+ },
7562
+ "type": "array"
7563
+ },
7564
+ "contentType": {
7565
+ "description": "MIME type of the data",
7566
+ "type": "string"
7567
+ },
7568
+ "contentTypeInfo": {
7569
+ "$ref": "GdataContentTypeInfo",
7570
+ "description": "Extended content type information provided for Scotty uploads."
7571
+ },
7572
+ "cosmoBinaryReference": {
7573
+ "description": "A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.",
7574
+ "format": "byte",
7575
+ "type": "string"
7576
+ },
7577
+ "crc32cHash": {
7578
+ "description": "For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.",
7579
+ "format": "uint32",
7580
+ "type": "integer"
7581
+ },
7582
+ "diffChecksumsResponse": {
7583
+ "$ref": "GdataDiffChecksumsResponse",
7584
+ "description": "Set if reference_type is DIFF_CHECKSUMS_RESPONSE."
7585
+ },
7586
+ "diffDownloadResponse": {
7587
+ "$ref": "GdataDiffDownloadResponse",
7588
+ "description": "Set if reference_type is DIFF_DOWNLOAD_RESPONSE."
7589
+ },
7590
+ "diffUploadRequest": {
7591
+ "$ref": "GdataDiffUploadRequest",
7592
+ "description": "Set if reference_type is DIFF_UPLOAD_REQUEST."
7593
+ },
7594
+ "diffUploadResponse": {
7595
+ "$ref": "GdataDiffUploadResponse",
7596
+ "description": "Set if reference_type is DIFF_UPLOAD_RESPONSE."
7597
+ },
7598
+ "diffVersionResponse": {
7599
+ "$ref": "GdataDiffVersionResponse",
7600
+ "description": "Set if reference_type is DIFF_VERSION_RESPONSE."
7601
+ },
7602
+ "downloadParameters": {
7603
+ "$ref": "GdataDownloadParameters",
7604
+ "description": "Parameters for a media download."
7605
+ },
7606
+ "filename": {
7607
+ "description": "Original file name",
7608
+ "type": "string"
7609
+ },
7610
+ "hash": {
7611
+ "deprecated": true,
7612
+ "description": "Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.",
7613
+ "type": "string"
7614
+ },
7615
+ "hashVerified": {
7616
+ "description": "For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.",
7617
+ "type": "boolean"
7618
+ },
7619
+ "inline": {
7620
+ "description": "Media data, set if reference_type is INLINE",
7621
+ "format": "byte",
7622
+ "type": "string"
7623
+ },
7624
+ "isPotentialRetry": {
7625
+ "description": "|is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.",
7626
+ "type": "boolean"
7627
+ },
7628
+ "length": {
7629
+ "description": "Size of the data, in bytes",
7630
+ "format": "int64",
7631
+ "type": "string"
7632
+ },
7633
+ "md5Hash": {
7634
+ "description": "Scotty-provided MD5 hash for an upload.",
7635
+ "format": "byte",
7636
+ "type": "string"
7637
+ },
7638
+ "mediaId": {
7639
+ "description": "Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.",
7640
+ "format": "byte",
7641
+ "type": "string"
7642
+ },
7643
+ "objectId": {
7644
+ "$ref": "GdataObjectId",
7645
+ "description": "Reference to a TI Blob, set if reference_type is BIGSTORE_REF."
7646
+ },
7647
+ "path": {
7648
+ "description": "Path to the data, set if reference_type is PATH",
7649
+ "type": "string"
7650
+ },
7651
+ "referenceType": {
7652
+ "description": "Describes what the field reference contains.",
7653
+ "enum": [
7654
+ "PATH",
7655
+ "BLOB_REF",
7656
+ "INLINE",
7657
+ "GET_MEDIA",
7658
+ "COMPOSITE_MEDIA",
7659
+ "BIGSTORE_REF",
7660
+ "DIFF_VERSION_RESPONSE",
7661
+ "DIFF_CHECKSUMS_RESPONSE",
7662
+ "DIFF_DOWNLOAD_RESPONSE",
7663
+ "DIFF_UPLOAD_REQUEST",
7664
+ "DIFF_UPLOAD_RESPONSE",
7665
+ "COSMO_BINARY_REFERENCE",
7666
+ "ARBITRARY_BYTES"
7667
+ ],
7668
+ "enumDescriptions": [
7669
+ "Reference contains a GFS path or a local path.",
7670
+ "Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.",
7671
+ "Data is included into this proto buffer",
7672
+ "Data should be accessed from the current service using the operation GetMedia.",
7673
+ "The content for this media object is stored across multiple partial media objects under the composite_media field.",
7674
+ "Reference points to a bigstore object",
7675
+ "Indicates the data is stored in diff_version_response.",
7676
+ "Indicates the data is stored in diff_checksums_response.",
7677
+ "Indicates the data is stored in diff_download_response.",
7678
+ "Indicates the data is stored in diff_upload_request.",
7679
+ "Indicates the data is stored in diff_upload_response.",
7680
+ "Indicates the data is stored in cosmo_binary_reference.",
7681
+ "Informs Scotty to generate a response payload with the size specified in the length field. The contents of the payload are generated by Scotty and are undefined. This is useful for testing download speeds between the user and Scotty without involving a real payload source. Note: range is not supported when using arbitrary_bytes."
7682
+ ],
7683
+ "type": "string"
7684
+ },
7685
+ "sha1Hash": {
7686
+ "description": "Scotty-provided SHA1 hash for an upload.",
7687
+ "format": "byte",
7688
+ "type": "string"
7689
+ },
7690
+ "sha256Hash": {
7691
+ "description": "Scotty-provided SHA256 hash for an upload.",
7692
+ "format": "byte",
7693
+ "type": "string"
7694
+ },
7695
+ "timestamp": {
7696
+ "description": "Time at which the media data was last updated, in milliseconds since UNIX epoch",
7697
+ "format": "uint64",
7698
+ "type": "string"
7699
+ },
7700
+ "token": {
7701
+ "description": "A unique fingerprint/version id for the media data",
7702
+ "type": "string"
7703
+ }
7704
+ },
7705
+ "type": "object"
7706
+ },
7707
+ "GdataObjectId": {
7708
+ "description": "This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.",
7709
+ "id": "GdataObjectId",
7710
+ "properties": {
7711
+ "bucketName": {
7712
+ "description": "The name of the bucket to which this object belongs.",
7713
+ "type": "string"
7714
+ },
7715
+ "generation": {
7716
+ "description": "Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions",
7717
+ "format": "int64",
7718
+ "type": "string"
7719
+ },
7720
+ "objectName": {
7721
+ "description": "The name of the object.",
7722
+ "type": "string"
7723
+ }
7724
+ },
7725
+ "type": "object"
7726
+ },
7727
+ "GoogleApiDistribution": {
7728
+ "description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.",
7729
+ "id": "GoogleApiDistribution",
7730
+ "properties": {
7731
+ "bucketCounts": {
7732
+ "description": "The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).",
7733
+ "items": {
7734
+ "format": "int64",
7735
+ "type": "string"
7736
+ },
7737
+ "type": "array"
7738
+ },
7739
+ "bucketOptions": {
7740
+ "$ref": "GoogleApiDistributionBucketOptions",
7741
+ "description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field."
7742
+ },
7743
+ "count": {
7744
+ "description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.",
7745
+ "format": "int64",
7746
+ "type": "string"
7747
+ },
7748
+ "exemplars": {
7749
+ "description": "Must be in increasing order of `value` field.",
7750
+ "items": {
7751
+ "$ref": "GoogleApiDistributionExemplar"
7752
+ },
7753
+ "type": "array"
7754
+ },
7755
+ "mean": {
7756
+ "description": "The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.",
7757
+ "format": "double",
7758
+ "type": "number"
7759
+ },
7760
+ "range": {
7761
+ "$ref": "GoogleApiDistributionRange",
7762
+ "description": "If specified, contains the range of the population values. The field must not be present if the `count` is zero."
7763
+ },
7764
+ "sumOfSquaredDeviation": {
7765
+ "description": "The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, \"The Art of Computer Programming\", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.",
7766
+ "format": "double",
7767
+ "type": "number"
7768
+ }
7769
+ },
7770
+ "type": "object"
7771
+ },
7772
+ "GoogleApiDistributionBucketOptions": {
7773
+ "description": "`BucketOptions` describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. `BucketOptions` does not include the number of values in each bucket. A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
7774
+ "id": "GoogleApiDistributionBucketOptions",
7775
+ "properties": {
7776
+ "explicitBuckets": {
7777
+ "$ref": "GoogleApiDistributionBucketOptionsExplicit",
7778
+ "description": "The explicit buckets."
7779
+ },
7780
+ "exponentialBuckets": {
7781
+ "$ref": "GoogleApiDistributionBucketOptionsExponential",
7782
+ "description": "The exponential buckets."
7783
+ },
7784
+ "linearBuckets": {
7785
+ "$ref": "GoogleApiDistributionBucketOptionsLinear",
7786
+ "description": "The linear bucket."
7787
+ }
7788
+ },
7789
+ "type": "object"
7790
+ },
7791
+ "GoogleApiDistributionBucketOptionsExplicit": {
7792
+ "description": "Specifies a set of buckets with arbitrary widths. There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The `bounds` field must contain at least one element. If `bounds` has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
7793
+ "id": "GoogleApiDistributionBucketOptionsExplicit",
7794
+ "properties": {
7795
+ "bounds": {
7796
+ "description": "The values must be monotonically increasing.",
7797
+ "items": {
7798
+ "format": "double",
7799
+ "type": "number"
7800
+ },
7801
+ "type": "array"
7802
+ }
7803
+ },
7804
+ "type": "object"
7136
7805
  },
7137
7806
  "GoogleApiDistributionBucketOptionsExponential": {
7138
7807
  "description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).",
@@ -7427,42 +8096,354 @@
7427
8096
  "description": "The detailed content which caused the error on importing a document.",
7428
8097
  "type": "string"
7429
8098
  },
7430
- "gcsPath": {
7431
- "description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.",
7432
- "type": "string"
8099
+ "gcsPath": {
8100
+ "description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.",
8101
+ "type": "string"
8102
+ },
8103
+ "lineNumber": {
8104
+ "description": "Line number of the content in file. Should be empty for permission or batch operation error.",
8105
+ "type": "string"
8106
+ },
8107
+ "operation": {
8108
+ "description": "The operation resource name of the LRO.",
8109
+ "type": "string"
8110
+ },
8111
+ "userEvent": {
8112
+ "description": "The detailed content which caused the error on importing a user event.",
8113
+ "type": "string"
8114
+ }
8115
+ },
8116
+ "type": "object"
8117
+ },
8118
+ "GoogleCloudDiscoveryengineLoggingServiceContext": {
8119
+ "description": "Describes a running service that sends errors.",
8120
+ "id": "GoogleCloudDiscoveryengineLoggingServiceContext",
8121
+ "properties": {
8122
+ "service": {
8123
+ "description": "An identifier of the service\u2014for example, `discoveryengine.googleapis.com`.",
8124
+ "type": "string"
8125
+ }
8126
+ },
8127
+ "type": "object"
8128
+ },
8129
+ "GoogleCloudDiscoveryengineLoggingSourceLocation": {
8130
+ "description": "Indicates a location in the source code of the service for which errors are reported.",
8131
+ "id": "GoogleCloudDiscoveryengineLoggingSourceLocation",
8132
+ "properties": {
8133
+ "functionName": {
8134
+ "description": "Human-readable name of a function or method\u2014for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.",
8135
+ "type": "string"
8136
+ }
8137
+ },
8138
+ "type": "object"
8139
+ },
8140
+ "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest": {
8141
+ "description": "Request message for CompletionService.AdvancedCompleteQuery method. .",
8142
+ "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest",
8143
+ "properties": {
8144
+ "boostSpec": {
8145
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec",
8146
+ "description": "Optional. Specification to boost suggestions matching the condition."
8147
+ },
8148
+ "experimentIds": {
8149
+ "description": "Optional. Experiment ids for this request.",
8150
+ "items": {
8151
+ "type": "string"
8152
+ },
8153
+ "type": "array"
8154
+ },
8155
+ "includeTailSuggestions": {
8156
+ "description": "Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.",
8157
+ "type": "boolean"
8158
+ },
8159
+ "query": {
8160
+ "description": "Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called \"zero prefix\" feature, which returns user's recently searched queries given the empty query.",
8161
+ "type": "string"
8162
+ },
8163
+ "queryModel": {
8164
+ "description": "Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.",
8165
+ "type": "string"
8166
+ },
8167
+ "suggestionTypeSpecs": {
8168
+ "description": "Optional. Specification of each suggestion type.",
8169
+ "items": {
8170
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec"
8171
+ },
8172
+ "type": "array"
8173
+ },
8174
+ "suggestionTypes": {
8175
+ "description": "Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.",
8176
+ "items": {
8177
+ "enum": [
8178
+ "SUGGESTION_TYPE_UNSPECIFIED",
8179
+ "QUERY",
8180
+ "PEOPLE",
8181
+ "CONTENT",
8182
+ "RECENT_SEARCH",
8183
+ "GOOGLE_WORKSPACE"
8184
+ ],
8185
+ "enumDescriptions": [
8186
+ "Default value.",
8187
+ "Returns query suggestions.",
8188
+ "Returns people suggestions.",
8189
+ "Returns content suggestions.",
8190
+ "Returns recent search suggestions.",
8191
+ "Returns Google Workspace suggestions."
8192
+ ],
8193
+ "type": "string"
8194
+ },
8195
+ "type": "array"
8196
+ },
8197
+ "userInfo": {
8198
+ "$ref": "GoogleCloudDiscoveryengineV1UserInfo",
8199
+ "description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info."
8200
+ },
8201
+ "userPseudoId": {
8202
+ "description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128",
8203
+ "type": "string"
8204
+ }
8205
+ },
8206
+ "type": "object"
8207
+ },
8208
+ "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec": {
8209
+ "description": "Specification to boost suggestions based on the condtion of the suggestion.",
8210
+ "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec",
8211
+ "properties": {
8212
+ "conditionBoostSpecs": {
8213
+ "description": "Condition boost specifications. If a suggestion matches multiple conditions in the specifications, boost values from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. Note: Currently only support language condition boost.",
8214
+ "items": {
8215
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec"
8216
+ },
8217
+ "type": "array"
8218
+ }
8219
+ },
8220
+ "type": "object"
8221
+ },
8222
+ "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec": {
8223
+ "description": "Boost applies to suggestions which match a condition.",
8224
+ "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec",
8225
+ "properties": {
8226
+ "boost": {
8227
+ "description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.",
8228
+ "format": "float",
8229
+ "type": "number"
8230
+ },
8231
+ "condition": {
8232
+ "description": "An expression which specifies a boost condition. The syntax is the same as [filter expression syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax). Currently, the only supported condition is a list of BCP-47 lang codes. Example: * To boost suggestions in languages `en` or `fr`: `(lang_code: ANY(\"en\", \"fr\"))`",
8233
+ "type": "string"
8234
+ }
8235
+ },
8236
+ "type": "object"
8237
+ },
8238
+ "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec": {
8239
+ "description": "Specification of each suggestion type.",
8240
+ "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec",
8241
+ "properties": {
8242
+ "maxSuggestions": {
8243
+ "description": "Optional. Maximum number of suggestions to return for each suggestion type.",
8244
+ "format": "int32",
8245
+ "type": "integer"
8246
+ },
8247
+ "suggestionType": {
8248
+ "description": "Optional. Suggestion type.",
8249
+ "enum": [
8250
+ "SUGGESTION_TYPE_UNSPECIFIED",
8251
+ "QUERY",
8252
+ "PEOPLE",
8253
+ "CONTENT",
8254
+ "RECENT_SEARCH",
8255
+ "GOOGLE_WORKSPACE"
8256
+ ],
8257
+ "enumDescriptions": [
8258
+ "Default value.",
8259
+ "Returns query suggestions.",
8260
+ "Returns people suggestions.",
8261
+ "Returns content suggestions.",
8262
+ "Returns recent search suggestions.",
8263
+ "Returns Google Workspace suggestions."
8264
+ ],
8265
+ "type": "string"
8266
+ }
8267
+ },
8268
+ "type": "object"
8269
+ },
8270
+ "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse": {
8271
+ "description": "Response message for CompletionService.AdvancedCompleteQuery method.",
8272
+ "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse",
8273
+ "properties": {
8274
+ "contentSuggestions": {
8275
+ "description": "Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion.",
8276
+ "items": {
8277
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion"
8278
+ },
8279
+ "type": "array"
8280
+ },
8281
+ "peopleSuggestions": {
8282
+ "description": "Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion.",
8283
+ "items": {
8284
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion"
8285
+ },
8286
+ "type": "array"
8287
+ },
8288
+ "querySuggestions": {
8289
+ "description": "Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.",
8290
+ "items": {
8291
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion"
8292
+ },
8293
+ "type": "array"
8294
+ },
8295
+ "recentSearchSuggestions": {
8296
+ "description": "Results of the matched \"recent search\" suggestions. The result list is ordered and the first result is the top suggestion.",
8297
+ "items": {
8298
+ "$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion"
8299
+ },
8300
+ "type": "array"
8301
+ },
8302
+ "tailMatchTriggered": {
8303
+ "description": "True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.",
8304
+ "type": "boolean"
8305
+ }
8306
+ },
8307
+ "type": "object"
8308
+ },
8309
+ "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion": {
8310
+ "description": "Suggestions as content.",
8311
+ "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion",
8312
+ "properties": {
8313
+ "contentType": {
8314
+ "description": "The type of the content suggestion.",
8315
+ "enum": [
8316
+ "CONTENT_TYPE_UNSPECIFIED",
8317
+ "GOOGLE_WORKSPACE",
8318
+ "THIRD_PARTY"
8319
+ ],
8320
+ "enumDescriptions": [
8321
+ "Default value.",
8322
+ "The suggestion is from a Google Workspace source.",
8323
+ "The suggestion is from a third party source."
8324
+ ],
8325
+ "type": "string"
8326
+ },
8327
+ "dataStore": {
8328
+ "description": "The name of the dataStore that this suggestion belongs to.",
8329
+ "type": "string"
8330
+ },
8331
+ "destinationUri": {
8332
+ "description": "The destination uri of the content suggestion.",
8333
+ "type": "string"
8334
+ },
8335
+ "document": {
8336
+ "$ref": "GoogleCloudDiscoveryengineV1Document",
8337
+ "description": "The document data snippet in the suggestion. Only a subset of fields will be populated."
8338
+ },
8339
+ "iconUri": {
8340
+ "description": "The icon uri of the content suggestion.",
8341
+ "type": "string"
8342
+ },
8343
+ "score": {
8344
+ "description": "The score of each suggestion. The score is in the range of [0, 1].",
8345
+ "format": "double",
8346
+ "type": "number"
8347
+ },
8348
+ "suggestion": {
8349
+ "description": "The suggestion for the query.",
8350
+ "type": "string"
8351
+ }
8352
+ },
8353
+ "type": "object"
8354
+ },
8355
+ "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion": {
8356
+ "description": "Suggestions as people.",
8357
+ "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion",
8358
+ "properties": {
8359
+ "dataStore": {
8360
+ "description": "The name of the dataStore that this suggestion belongs to.",
8361
+ "type": "string"
8362
+ },
8363
+ "destinationUri": {
8364
+ "description": "The destination uri of the person suggestion.",
8365
+ "type": "string"
8366
+ },
8367
+ "displayPhotoUri": {
8368
+ "description": "The photo uri of the person suggestion.",
8369
+ "type": "string"
8370
+ },
8371
+ "document": {
8372
+ "$ref": "GoogleCloudDiscoveryengineV1Document",
8373
+ "description": "The document data snippet in the suggestion. Only a subset of fields is populated."
8374
+ },
8375
+ "personType": {
8376
+ "description": "The type of the person.",
8377
+ "enum": [
8378
+ "PERSON_TYPE_UNSPECIFIED",
8379
+ "CLOUD_IDENTITY",
8380
+ "THIRD_PARTY_IDENTITY"
8381
+ ],
8382
+ "enumDescriptions": [
8383
+ "Default value.",
8384
+ "The suggestion is from a GOOGLE_IDENTITY source.",
8385
+ "The suggestion is from a THIRD_PARTY_IDENTITY source."
8386
+ ],
8387
+ "type": "string"
8388
+ },
8389
+ "score": {
8390
+ "description": "The score of each suggestion. The score is in the range of [0, 1].",
8391
+ "format": "double",
8392
+ "type": "number"
8393
+ },
8394
+ "suggestion": {
8395
+ "description": "The suggestion for the query.",
8396
+ "type": "string"
8397
+ }
8398
+ },
8399
+ "type": "object"
8400
+ },
8401
+ "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion": {
8402
+ "description": "Suggestions as search queries.",
8403
+ "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion",
8404
+ "properties": {
8405
+ "completableFieldPaths": {
8406
+ "description": "The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model.",
8407
+ "items": {
8408
+ "type": "string"
8409
+ },
8410
+ "type": "array"
7433
8411
  },
7434
- "lineNumber": {
7435
- "description": "Line number of the content in file. Should be empty for permission or batch operation error.",
8412
+ "dataStore": {
8413
+ "description": "The name of the dataStore that this suggestion belongs to.",
8414
+ "items": {
7436
8415
  "type": "string"
7437
8416
  },
7438
- "operation": {
7439
- "description": "The operation resource name of the LRO.",
7440
- "type": "string"
8417
+ "type": "array"
7441
8418
  },
7442
- "userEvent": {
7443
- "description": "The detailed content which caused the error on importing a user event.",
8419
+ "score": {
8420
+ "description": "The score of each suggestion. The score is in the range of [0, 1].",
8421
+ "format": "double",
8422
+ "type": "number"
8423
+ },
8424
+ "suggestion": {
8425
+ "description": "The suggestion for the query.",
7444
8426
  "type": "string"
7445
8427
  }
7446
8428
  },
7447
8429
  "type": "object"
7448
8430
  },
7449
- "GoogleCloudDiscoveryengineLoggingServiceContext": {
7450
- "description": "Describes a running service that sends errors.",
7451
- "id": "GoogleCloudDiscoveryengineLoggingServiceContext",
8431
+ "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion": {
8432
+ "description": "Suggestions from recent search history.",
8433
+ "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion",
7452
8434
  "properties": {
7453
- "service": {
7454
- "description": "An identifier of the service\u2014for example, `discoveryengine.googleapis.com`.",
8435
+ "recentSearchTime": {
8436
+ "description": "The time when this recent rearch happened.",
8437
+ "format": "google-datetime",
7455
8438
  "type": "string"
7456
- }
7457
8439
  },
7458
- "type": "object"
8440
+ "score": {
8441
+ "description": "The score of each suggestion. The score is in the range of [0, 1].",
8442
+ "format": "double",
8443
+ "type": "number"
7459
8444
  },
7460
- "GoogleCloudDiscoveryengineLoggingSourceLocation": {
7461
- "description": "Indicates a location in the source code of the service for which errors are reported.",
7462
- "id": "GoogleCloudDiscoveryengineLoggingSourceLocation",
7463
- "properties": {
7464
- "functionName": {
7465
- "description": "Human-readable name of a function or method\u2014for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.",
8445
+ "suggestion": {
8446
+ "description": "The suggestion for the query.",
7466
8447
  "type": "string"
7467
8448
  }
7468
8449
  },
@@ -8574,139 +9555,445 @@
8574
9555
  "description": "The description of the step.",
8575
9556
  "type": "string"
8576
9557
  },
8577
- "state": {
8578
- "description": "The state of the step.",
9558
+ "state": {
9559
+ "description": "The state of the step.",
9560
+ "enum": [
9561
+ "STATE_UNSPECIFIED",
9562
+ "IN_PROGRESS",
9563
+ "FAILED",
9564
+ "SUCCEEDED"
9565
+ ],
9566
+ "enumDescriptions": [
9567
+ "Unknown.",
9568
+ "Step is currently in progress.",
9569
+ "Step currently failed.",
9570
+ "Step has succeeded."
9571
+ ],
9572
+ "type": "string"
9573
+ },
9574
+ "thought": {
9575
+ "description": "The thought of the step.",
9576
+ "type": "string"
9577
+ }
9578
+ },
9579
+ "type": "object"
9580
+ },
9581
+ "GoogleCloudDiscoveryengineV1AnswerStepAction": {
9582
+ "description": "Action.",
9583
+ "id": "GoogleCloudDiscoveryengineV1AnswerStepAction",
9584
+ "properties": {
9585
+ "observation": {
9586
+ "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservation",
9587
+ "description": "Observation."
9588
+ },
9589
+ "searchAction": {
9590
+ "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction",
9591
+ "description": "Search action."
9592
+ }
9593
+ },
9594
+ "type": "object"
9595
+ },
9596
+ "GoogleCloudDiscoveryengineV1AnswerStepActionObservation": {
9597
+ "description": "Observation.",
9598
+ "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservation",
9599
+ "properties": {
9600
+ "searchResults": {
9601
+ "description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.",
9602
+ "items": {
9603
+ "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult"
9604
+ },
9605
+ "type": "array"
9606
+ }
9607
+ },
9608
+ "type": "object"
9609
+ },
9610
+ "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult": {
9611
+ "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult",
9612
+ "properties": {
9613
+ "chunkInfo": {
9614
+ "description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.",
9615
+ "items": {
9616
+ "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo"
9617
+ },
9618
+ "type": "array"
9619
+ },
9620
+ "document": {
9621
+ "description": "Document resource name.",
9622
+ "type": "string"
9623
+ },
9624
+ "snippetInfo": {
9625
+ "description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.",
9626
+ "items": {
9627
+ "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo"
9628
+ },
9629
+ "type": "array"
9630
+ },
9631
+ "structData": {
9632
+ "additionalProperties": {
9633
+ "description": "Properties of the object.",
9634
+ "type": "any"
9635
+ },
9636
+ "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.",
9637
+ "type": "object"
9638
+ },
9639
+ "title": {
9640
+ "description": "Title.",
9641
+ "type": "string"
9642
+ },
9643
+ "uri": {
9644
+ "description": "URI for the document.",
9645
+ "type": "string"
9646
+ }
9647
+ },
9648
+ "type": "object"
9649
+ },
9650
+ "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo": {
9651
+ "description": "Chunk information.",
9652
+ "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo",
9653
+ "properties": {
9654
+ "chunk": {
9655
+ "description": "Chunk resource name.",
9656
+ "type": "string"
9657
+ },
9658
+ "content": {
9659
+ "description": "Chunk textual content.",
9660
+ "type": "string"
9661
+ },
9662
+ "relevanceScore": {
9663
+ "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.",
9664
+ "format": "float",
9665
+ "type": "number"
9666
+ }
9667
+ },
9668
+ "type": "object"
9669
+ },
9670
+ "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo": {
9671
+ "description": "Snippet information.",
9672
+ "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo",
9673
+ "properties": {
9674
+ "snippet": {
9675
+ "description": "Snippet content.",
9676
+ "type": "string"
9677
+ },
9678
+ "snippetStatus": {
9679
+ "description": "Status of the snippet defined by the search team.",
9680
+ "type": "string"
9681
+ }
9682
+ },
9683
+ "type": "object"
9684
+ },
9685
+ "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction": {
9686
+ "description": "Search action.",
9687
+ "id": "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction",
9688
+ "properties": {
9689
+ "query": {
9690
+ "description": "The query to search.",
9691
+ "type": "string"
9692
+ }
9693
+ },
9694
+ "type": "object"
9695
+ },
9696
+ "GoogleCloudDiscoveryengineV1AssistAnswer": {
9697
+ "description": "AssistAnswer resource, main part of AssistResponse.",
9698
+ "id": "GoogleCloudDiscoveryengineV1AssistAnswer",
9699
+ "properties": {
9700
+ "assistSkippedReasons": {
9701
+ "description": "Reasons for not answering the assist call.",
9702
+ "items": {
9703
+ "enum": [
9704
+ "ASSIST_SKIPPED_REASON_UNSPECIFIED",
9705
+ "NON_ASSIST_SEEKING_QUERY_IGNORED",
9706
+ "CUSTOMER_POLICY_VIOLATION"
9707
+ ],
9708
+ "enumDescriptions": [
9709
+ "Default value. Skip reason is not specified.",
9710
+ "The assistant ignored the query, because it did not appear to be answer-seeking.",
9711
+ "The assistant ignored the query or refused to answer because of a customer policy violation (e.g., the query or the answer contained a banned phrase)."
9712
+ ],
9713
+ "type": "string"
9714
+ },
9715
+ "type": "array"
9716
+ },
9717
+ "name": {
9718
+ "description": "Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
9719
+ "type": "string"
9720
+ },
9721
+ "replies": {
9722
+ "description": "Replies of the assistant.",
9723
+ "items": {
9724
+ "$ref": "GoogleCloudDiscoveryengineV1AssistAnswerReply"
9725
+ },
9726
+ "type": "array"
9727
+ },
9728
+ "state": {
9729
+ "description": "State of the answer generation.",
9730
+ "enum": [
9731
+ "STATE_UNSPECIFIED",
9732
+ "IN_PROGRESS",
9733
+ "FAILED",
9734
+ "SUCCEEDED",
9735
+ "SKIPPED"
9736
+ ],
9737
+ "enumDescriptions": [
9738
+ "Unknown.",
9739
+ "Assist operation is currently in progress.",
9740
+ "Assist operation has failed.",
9741
+ "Assist operation has succeeded.",
9742
+ "Assist operation has been skipped."
9743
+ ],
9744
+ "type": "string"
9745
+ }
9746
+ },
9747
+ "type": "object"
9748
+ },
9749
+ "GoogleCloudDiscoveryengineV1AssistAnswerReply": {
9750
+ "description": "One part of the multi-part response of the assist call.",
9751
+ "id": "GoogleCloudDiscoveryengineV1AssistAnswerReply",
9752
+ "properties": {
9753
+ "groundedContent": {
9754
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContent",
9755
+ "description": "Possibly grounded response text or media from the assistant."
9756
+ }
9757
+ },
9758
+ "type": "object"
9759
+ },
9760
+ "GoogleCloudDiscoveryengineV1AssistUserMetadata": {
9761
+ "description": "User metadata of the request.",
9762
+ "id": "GoogleCloudDiscoveryengineV1AssistUserMetadata",
9763
+ "properties": {
9764
+ "preferredLanguageCode": {
9765
+ "description": "Optional. Preferred language to be used for answering if language detection fails. Also used as the language of error messages created by actions, regardless of language detection results.",
9766
+ "type": "string"
9767
+ },
9768
+ "timeZone": {
9769
+ "description": "Optional. IANA time zone, e.g. Europe/Budapest.",
9770
+ "type": "string"
9771
+ }
9772
+ },
9773
+ "type": "object"
9774
+ },
9775
+ "GoogleCloudDiscoveryengineV1Assistant": {
9776
+ "description": "Discovery Engine Assistant resource.",
9777
+ "id": "GoogleCloudDiscoveryengineV1Assistant",
9778
+ "properties": {
9779
+ "name": {
9780
+ "description": "Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.",
9781
+ "type": "string"
9782
+ }
9783
+ },
9784
+ "type": "object"
9785
+ },
9786
+ "GoogleCloudDiscoveryengineV1AssistantContent": {
9787
+ "description": "Multi-modal content.",
9788
+ "id": "GoogleCloudDiscoveryengineV1AssistantContent",
9789
+ "properties": {
9790
+ "codeExecutionResult": {
9791
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantContentCodeExecutionResult",
9792
+ "description": "Result of executing an ExecutableCode."
9793
+ },
9794
+ "executableCode": {
9795
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantContentExecutableCode",
9796
+ "description": "Code generated by the model that is meant to be executed."
9797
+ },
9798
+ "file": {
9799
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantContentFile",
9800
+ "description": "A file, e.g., an audio summary."
9801
+ },
9802
+ "inlineData": {
9803
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantContentBlob",
9804
+ "description": "Inline binary data."
9805
+ },
9806
+ "role": {
9807
+ "description": "The producer of the content. Can be \"model\" or \"user\".",
9808
+ "type": "string"
9809
+ },
9810
+ "text": {
9811
+ "description": "Inline text.",
9812
+ "type": "string"
9813
+ },
9814
+ "thought": {
9815
+ "description": "Optional. Indicates if the part is thought from the model.",
9816
+ "type": "boolean"
9817
+ }
9818
+ },
9819
+ "type": "object"
9820
+ },
9821
+ "GoogleCloudDiscoveryengineV1AssistantContentBlob": {
9822
+ "description": "Inline blob.",
9823
+ "id": "GoogleCloudDiscoveryengineV1AssistantContentBlob",
9824
+ "properties": {
9825
+ "data": {
9826
+ "description": "Required. Raw bytes.",
9827
+ "format": "byte",
9828
+ "type": "string"
9829
+ },
9830
+ "mimeType": {
9831
+ "description": "Required. The media type (MIME type) of the generated data.",
9832
+ "type": "string"
9833
+ }
9834
+ },
9835
+ "type": "object"
9836
+ },
9837
+ "GoogleCloudDiscoveryengineV1AssistantContentCodeExecutionResult": {
9838
+ "description": "Result of executing ExecutableCode.",
9839
+ "id": "GoogleCloudDiscoveryengineV1AssistantContentCodeExecutionResult",
9840
+ "properties": {
9841
+ "outcome": {
9842
+ "description": "Required. Outcome of the code execution.",
8579
9843
  "enum": [
8580
- "STATE_UNSPECIFIED",
8581
- "IN_PROGRESS",
8582
- "FAILED",
8583
- "SUCCEEDED"
9844
+ "OUTCOME_UNSPECIFIED",
9845
+ "OUTCOME_OK",
9846
+ "OUTCOME_FAILED",
9847
+ "OUTCOME_DEADLINE_EXCEEDED"
8584
9848
  ],
8585
9849
  "enumDescriptions": [
8586
- "Unknown.",
8587
- "Step is currently in progress.",
8588
- "Step currently failed.",
8589
- "Step has succeeded."
9850
+ "Unspecified status. This value should not be used.",
9851
+ "Code execution completed successfully.",
9852
+ "Code execution finished but with a failure. `stderr` should contain the reason.",
9853
+ "Code execution ran for too long, and was cancelled. There may or may not be a partial output present."
8590
9854
  ],
8591
9855
  "type": "string"
8592
9856
  },
8593
- "thought": {
8594
- "description": "The thought of the step.",
9857
+ "output": {
9858
+ "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.",
8595
9859
  "type": "string"
8596
9860
  }
8597
9861
  },
8598
9862
  "type": "object"
8599
9863
  },
8600
- "GoogleCloudDiscoveryengineV1AnswerStepAction": {
8601
- "description": "Action.",
8602
- "id": "GoogleCloudDiscoveryengineV1AnswerStepAction",
9864
+ "GoogleCloudDiscoveryengineV1AssistantContentExecutableCode": {
9865
+ "description": "Code generated by the model that is meant to be executed by the model.",
9866
+ "id": "GoogleCloudDiscoveryengineV1AssistantContentExecutableCode",
8603
9867
  "properties": {
8604
- "observation": {
8605
- "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservation",
8606
- "description": "Observation."
9868
+ "code": {
9869
+ "description": "Required. The code content. Currently only supports Python.",
9870
+ "type": "string"
9871
+ }
8607
9872
  },
8608
- "searchAction": {
8609
- "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction",
8610
- "description": "Search action."
9873
+ "type": "object"
9874
+ },
9875
+ "GoogleCloudDiscoveryengineV1AssistantContentFile": {
9876
+ "description": "A file, e.g., an audio summary.",
9877
+ "id": "GoogleCloudDiscoveryengineV1AssistantContentFile",
9878
+ "properties": {
9879
+ "fileId": {
9880
+ "description": "Required. The file ID.",
9881
+ "type": "string"
9882
+ },
9883
+ "mimeType": {
9884
+ "description": "Required. The media type (MIME type) of the file.",
9885
+ "type": "string"
8611
9886
  }
8612
9887
  },
8613
9888
  "type": "object"
8614
9889
  },
8615
- "GoogleCloudDiscoveryengineV1AnswerStepActionObservation": {
8616
- "description": "Observation.",
8617
- "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservation",
9890
+ "GoogleCloudDiscoveryengineV1AssistantGroundedContent": {
9891
+ "description": "A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like \"Of course, I will gladly search it for you.\" do not need grounding.",
9892
+ "id": "GoogleCloudDiscoveryengineV1AssistantGroundedContent",
8618
9893
  "properties": {
8619
- "searchResults": {
8620
- "description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.",
8621
- "items": {
8622
- "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult"
9894
+ "content": {
9895
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantContent",
9896
+ "description": "The content."
8623
9897
  },
8624
- "type": "array"
9898
+ "textGroundingMetadata": {
9899
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadata",
9900
+ "description": "Metadata for grounding based on text sources."
8625
9901
  }
8626
9902
  },
8627
9903
  "type": "object"
8628
9904
  },
8629
- "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult": {
8630
- "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult",
9905
+ "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadata": {
9906
+ "description": "Grounding details for text sources.",
9907
+ "id": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadata",
8631
9908
  "properties": {
8632
- "chunkInfo": {
8633
- "description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.",
9909
+ "references": {
9910
+ "description": "References for the grounded text.",
8634
9911
  "items": {
8635
- "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo"
9912
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference"
8636
9913
  },
8637
9914
  "type": "array"
8638
9915
  },
8639
- "document": {
8640
- "description": "Document resource name.",
8641
- "type": "string"
8642
- },
8643
- "snippetInfo": {
8644
- "description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.",
9916
+ "segments": {
9917
+ "description": "Grounding information for parts of the text.",
8645
9918
  "items": {
8646
- "$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo"
9919
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataSegment"
8647
9920
  },
8648
9921
  "type": "array"
9922
+ }
8649
9923
  },
8650
- "structData": {
8651
- "additionalProperties": {
8652
- "description": "Properties of the object.",
8653
- "type": "any"
9924
+ "type": "object"
9925
+ },
9926
+ "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference": {
9927
+ "description": "Referenced content and related document metadata.",
9928
+ "id": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference",
9929
+ "properties": {
9930
+ "content": {
9931
+ "description": "Referenced text content.",
9932
+ "type": "string"
9933
+ },
9934
+ "documentMetadata": {
9935
+ "$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata",
9936
+ "description": "Document metadata."
9937
+ }
8654
9938
  },
8655
- "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.",
8656
9939
  "type": "object"
8657
9940
  },
9941
+ "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata": {
9942
+ "description": "Document metadata.",
9943
+ "id": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata",
9944
+ "properties": {
9945
+ "document": {
9946
+ "description": "Document resource name.",
9947
+ "type": "string"
9948
+ },
9949
+ "domain": {
9950
+ "description": "Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.",
9951
+ "type": "string"
9952
+ },
9953
+ "pageIdentifier": {
9954
+ "description": "Page identifier.",
9955
+ "type": "string"
9956
+ },
8658
9957
  "title": {
8659
9958
  "description": "Title.",
8660
9959
  "type": "string"
8661
9960
  },
8662
9961
  "uri": {
8663
- "description": "URI for the document.",
9962
+ "description": "URI for the document. It may contain a URL that redirects to the actual website.",
8664
9963
  "type": "string"
8665
9964
  }
8666
9965
  },
8667
9966
  "type": "object"
8668
9967
  },
8669
- "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo": {
8670
- "description": "Chunk information.",
8671
- "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo",
9968
+ "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataSegment": {
9969
+ "description": "Grounding information for a segment of the text.",
9970
+ "id": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataSegment",
8672
9971
  "properties": {
8673
- "chunk": {
8674
- "description": "Chunk resource name.",
8675
- "type": "string"
8676
- },
8677
- "content": {
8678
- "description": "Chunk textual content.",
9972
+ "endIndex": {
9973
+ "description": "End of the segment, exclusive.",
9974
+ "format": "int64",
8679
9975
  "type": "string"
8680
9976
  },
8681
- "relevanceScore": {
8682
- "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.",
9977
+ "groundingScore": {
9978
+ "description": "Score for the segment.",
8683
9979
  "format": "float",
8684
9980
  "type": "number"
8685
- }
8686
9981
  },
8687
- "type": "object"
9982
+ "referenceIndices": {
9983
+ "description": "References for the segment.",
9984
+ "items": {
9985
+ "format": "int32",
9986
+ "type": "integer"
8688
9987
  },
8689
- "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo": {
8690
- "description": "Snippet information.",
8691
- "id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo",
8692
- "properties": {
8693
- "snippet": {
8694
- "description": "Snippet content.",
8695
- "type": "string"
9988
+ "type": "array"
8696
9989
  },
8697
- "snippetStatus": {
8698
- "description": "Status of the snippet defined by the search team.",
9990
+ "startIndex": {
9991
+ "description": "Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one).",
9992
+ "format": "int64",
8699
9993
  "type": "string"
8700
- }
8701
- },
8702
- "type": "object"
8703
9994
  },
8704
- "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction": {
8705
- "description": "Search action.",
8706
- "id": "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction",
8707
- "properties": {
8708
- "query": {
8709
- "description": "The query to search.",
9995
+ "text": {
9996
+ "description": "The text segment itself.",
8710
9997
  "type": "string"
8711
9998
  }
8712
9999
  },
@@ -9438,11 +10725,12 @@
9438
10725
  "type": "boolean"
9439
10726
  },
9440
10727
  "kmsKey": {
9441
- "description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
10728
+ "description": "Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
9442
10729
  "type": "string"
9443
10730
  },
9444
10731
  "kmsKeyVersion": {
9445
- "description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
10732
+ "description": "Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
10733
+ "readOnly": true,
9446
10734
  "type": "string"
9447
10735
  },
9448
10736
  "lastRotationTimestampMicros": {
@@ -10817,6 +12105,10 @@
10817
12105
  "description": "The layout parsing configurations for documents.",
10818
12106
  "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig",
10819
12107
  "properties": {
12108
+ "enableGetProcessedDocument": {
12109
+ "description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.",
12110
+ "type": "boolean"
12111
+ },
10820
12112
  "enableImageAnnotation": {
10821
12113
  "description": "Optional. If true, the LLM based annotation is added to the image during parsing.",
10822
12114
  "type": "boolean"
@@ -10971,7 +12263,7 @@
10971
12263
  ],
10972
12264
  "type": "string"
10973
12265
  },
10974
- "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`",
12266
+ "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.",
10975
12267
  "type": "object"
10976
12268
  },
10977
12269
  "industryVertical": {
@@ -11627,7 +12919,7 @@
11627
12919
  "description": "Cloud Storage location for the input content."
11628
12920
  },
11629
12921
  "idField": {
11630
- "description": "The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{\"my_id\": \"some_uuid\"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.",
12922
+ "description": "The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{\"my_id\": \"some_uuid\"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * BigtableSource.",
11631
12923
  "type": "string"
11632
12924
  },
11633
12925
  "inlineSource": {
@@ -12343,6 +13635,21 @@
12343
13635
  "dataUseTermsVersion": {
12344
13636
  "description": "Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time.",
12345
13637
  "type": "string"
13638
+ },
13639
+ "saasParams": {
13640
+ "$ref": "GoogleCloudDiscoveryengineV1ProvisionProjectRequestSaasParams",
13641
+ "description": "Optional. Parameters for Agentspace."
13642
+ }
13643
+ },
13644
+ "type": "object"
13645
+ },
13646
+ "GoogleCloudDiscoveryengineV1ProvisionProjectRequestSaasParams": {
13647
+ "description": "Parameters for Agentspace.",
13648
+ "id": "GoogleCloudDiscoveryengineV1ProvisionProjectRequestSaasParams",
13649
+ "properties": {
13650
+ "acceptBizQos": {
13651
+ "description": "Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service].",
13652
+ "type": "boolean"
12346
13653
  }
12347
13654
  },
12348
13655
  "type": "object"
@@ -12614,7 +13921,7 @@
12614
13921
  "type": "string"
12615
13922
  },
12616
13923
  "records": {
12617
- "description": "Required. A list of records to rank. At most 200 records to rank.",
13924
+ "description": "Required. A list of records to rank.",
12618
13925
  "items": {
12619
13926
  "$ref": "GoogleCloudDiscoveryengineV1RankingRecord"
12620
13927
  },
@@ -13067,7 +14374,7 @@
13067
14374
  "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical."
13068
14375
  },
13069
14376
  "session": {
13070
- "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
14377
+ "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
13071
14378
  "type": "string"
13072
14379
  },
13073
14380
  "sessionSpec": {
@@ -14294,6 +15601,133 @@
14294
15601
  },
14295
15602
  "type": "object"
14296
15603
  },
15604
+ "GoogleCloudDiscoveryengineV1StreamAssistRequest": {
15605
+ "description": "Request for the AssistantService.StreamAssist method.",
15606
+ "id": "GoogleCloudDiscoveryengineV1StreamAssistRequest",
15607
+ "properties": {
15608
+ "generationSpec": {
15609
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestGenerationSpec",
15610
+ "description": "Optional. Specification of the generation configuration for the request."
15611
+ },
15612
+ "query": {
15613
+ "$ref": "GoogleCloudDiscoveryengineV1Query",
15614
+ "description": "Optional. Current user query. Empty query is only supported if `file_ids` are provided. In this case, the answer will be generated based on those context files."
15615
+ },
15616
+ "session": {
15617
+ "description": "Optional. The session to use for the request. If specified, the assistant has access to the session history, and the query and the answer are stored there. If `-` is specified as the session ID, or it is left empty, then a new session is created with an automatically generated ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`",
15618
+ "type": "string"
15619
+ },
15620
+ "toolsSpec": {
15621
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpec",
15622
+ "description": "Optional. Specification of tools that are used to serve the request."
15623
+ },
15624
+ "userMetadata": {
15625
+ "$ref": "GoogleCloudDiscoveryengineV1AssistUserMetadata",
15626
+ "description": "Optional. Information about the user initiating the query."
15627
+ }
15628
+ },
15629
+ "type": "object"
15630
+ },
15631
+ "GoogleCloudDiscoveryengineV1StreamAssistRequestGenerationSpec": {
15632
+ "description": "Assistant generation specification for the request. This allows to override the default generation configuration at the engine level.",
15633
+ "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestGenerationSpec",
15634
+ "properties": {
15635
+ "modelId": {
15636
+ "description": "Optional. The Vertex AI model_id used for the generative model. If not set, the default Assistant model will be used.",
15637
+ "type": "string"
15638
+ }
15639
+ },
15640
+ "type": "object"
15641
+ },
15642
+ "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpec": {
15643
+ "description": "Specification of tools that are used to serve the request.",
15644
+ "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpec",
15645
+ "properties": {
15646
+ "imageGenerationSpec": {
15647
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecImageGenerationSpec",
15648
+ "description": "Optional. Specification of the image generation tool."
15649
+ },
15650
+ "vertexAiSearchSpec": {
15651
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVertexAiSearchSpec",
15652
+ "description": "Optional. Specification of the Vertex AI Search tool."
15653
+ },
15654
+ "videoGenerationSpec": {
15655
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVideoGenerationSpec",
15656
+ "description": "Optional. Specification of the video generation tool."
15657
+ },
15658
+ "webGroundingSpec": {
15659
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecWebGroundingSpec",
15660
+ "description": "Optional. Specification of the web grounding tool. If field is present, enables grounding with web search. Works only if Assistant.web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH."
15661
+ }
15662
+ },
15663
+ "type": "object"
15664
+ },
15665
+ "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecImageGenerationSpec": {
15666
+ "description": "Specification of the image generation tool.",
15667
+ "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecImageGenerationSpec",
15668
+ "properties": {},
15669
+ "type": "object"
15670
+ },
15671
+ "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVertexAiSearchSpec": {
15672
+ "description": "Specification of the Vertex AI Search tool.",
15673
+ "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVertexAiSearchSpec",
15674
+ "properties": {
15675
+ "dataStoreSpecs": {
15676
+ "description": "Optional. 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.",
15677
+ "items": {
15678
+ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec"
15679
+ },
15680
+ "type": "array"
15681
+ },
15682
+ "filter": {
15683
+ "description": "Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)",
15684
+ "type": "string"
15685
+ }
15686
+ },
15687
+ "type": "object"
15688
+ },
15689
+ "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVideoGenerationSpec": {
15690
+ "description": "Specification of the video generation tool.",
15691
+ "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVideoGenerationSpec",
15692
+ "properties": {},
15693
+ "type": "object"
15694
+ },
15695
+ "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecWebGroundingSpec": {
15696
+ "description": "Specification of the web grounding tool.",
15697
+ "id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecWebGroundingSpec",
15698
+ "properties": {},
15699
+ "type": "object"
15700
+ },
15701
+ "GoogleCloudDiscoveryengineV1StreamAssistResponse": {
15702
+ "description": "Response for the AssistantService.StreamAssist method.",
15703
+ "id": "GoogleCloudDiscoveryengineV1StreamAssistResponse",
15704
+ "properties": {
15705
+ "answer": {
15706
+ "$ref": "GoogleCloudDiscoveryengineV1AssistAnswer",
15707
+ "description": "Assist answer resource object containing parts of the assistant's final answer for the user's query. Not present if the current response doesn't add anything to previously sent AssistAnswer.replies. Observe AssistAnswer.state to see if more parts are to be expected. While the state is `IN_PROGRESS`, the AssistAnswer.replies field in each response will contain replies (reply fragments) to be appended to the ones received in previous responses. AssistAnswer.name won't be filled. If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response is the last response and AssistAnswer.name will have a value."
15708
+ },
15709
+ "assistToken": {
15710
+ "description": "A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.",
15711
+ "type": "string"
15712
+ },
15713
+ "sessionInfo": {
15714
+ "$ref": "GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo",
15715
+ "description": "Session information."
15716
+ }
15717
+ },
15718
+ "type": "object"
15719
+ },
15720
+ "GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo": {
15721
+ "description": "Information about the session.",
15722
+ "id": "GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo",
15723
+ "properties": {
15724
+ "session": {
15725
+ "description": "Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`.",
15726
+ "type": "string"
15727
+ }
15728
+ },
15729
+ "type": "object"
15730
+ },
14297
15731
  "GoogleCloudDiscoveryengineV1SuggestionDenyListEntry": {
14298
15732
  "description": "Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.",
14299
15733
  "id": "GoogleCloudDiscoveryengineV1SuggestionDenyListEntry",
@@ -14776,14 +16210,16 @@
14776
16210
  "ASSIGNED",
14777
16211
  "UNASSIGNED",
14778
16212
  "NO_LICENSE",
14779
- "NO_LICENSE_ATTEMPTED_LOGIN"
16213
+ "NO_LICENSE_ATTEMPTED_LOGIN",
16214
+ "BLOCKED"
14780
16215
  ],
14781
16216
  "enumDescriptions": [
14782
16217
  "Default value.",
14783
16218
  "License assigned to the user.",
14784
16219
  "No license assigned to the user. Deprecated, translated to NO_LICENSE.",
14785
16220
  "No license assigned to the user.",
14786
- "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)."
16221
+ "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).",
16222
+ "User is blocked from assigning a license."
14787
16223
  ],
14788
16224
  "readOnly": true,
14789
16225
  "type": "string"
@@ -15690,11 +17126,12 @@
15690
17126
  "type": "boolean"
15691
17127
  },
15692
17128
  "kmsKey": {
15693
- "description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
17129
+ "description": "Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
15694
17130
  "type": "string"
15695
17131
  },
15696
17132
  "kmsKeyVersion": {
15697
- "description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
17133
+ "description": "Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
17134
+ "readOnly": true,
15698
17135
  "type": "string"
15699
17136
  },
15700
17137
  "lastRotationTimestampMicros": {
@@ -16710,14 +18147,12 @@
16710
18147
  "enum": [
16711
18148
  "PERIODIC",
16712
18149
  "STREAMING",
16713
- "UNSPECIFIED",
16714
- "SCALA_SYNC"
18150
+ "UNSPECIFIED"
16715
18151
  ],
16716
18152
  "enumDescriptions": [
16717
18153
  "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.",
16718
18154
  "The data will be synced in real time.",
16719
- "Connector that doesn't ingest data will have this value",
16720
- "The data will be synced with Scala Sync, a data ingestion solution."
18155
+ "Connector that doesn't ingest data will have this value"
16721
18156
  ],
16722
18157
  "type": "string"
16723
18158
  },
@@ -16765,6 +18200,10 @@
16765
18200
  "description": "Optional. The ID of the Secret Manager secret used for webhook secret.",
16766
18201
  "type": "string"
16767
18202
  },
18203
+ "streamingError": {
18204
+ "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError",
18205
+ "description": "Optional. Streaming error details."
18206
+ },
16768
18207
  "webhookUri": {
16769
18208
  "description": "Optional. Webhook url for the connector to specify additional params for realtime sync.",
16770
18209
  "type": "string"
@@ -16772,6 +18211,33 @@
16772
18211
  },
16773
18212
  "type": "object"
16774
18213
  },
18214
+ "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError": {
18215
+ "description": "Streaming error details.",
18216
+ "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError",
18217
+ "properties": {
18218
+ "error": {
18219
+ "$ref": "GoogleRpcStatus",
18220
+ "description": "Optional. Error details."
18221
+ },
18222
+ "streamingErrorReason": {
18223
+ "description": "Optional. Streaming error.",
18224
+ "enum": [
18225
+ "STREAMING_ERROR_REASON_UNSPECIFIED",
18226
+ "STREAMING_SETUP_ERROR",
18227
+ "STREAMING_SYNC_ERROR",
18228
+ "INGRESS_ENDPOINT_REQUIRED"
18229
+ ],
18230
+ "enumDescriptions": [
18231
+ "Streaming error reason unspecified.",
18232
+ "Some error occurred while setting up resources for realtime sync.",
18233
+ "Some error was encountered while running realtime sync for the connector.",
18234
+ "Ingress endpoint is required when setting up realtime sync in private connectivity."
18235
+ ],
18236
+ "type": "string"
18237
+ }
18238
+ },
18239
+ "type": "object"
18240
+ },
16775
18241
  "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity": {
16776
18242
  "description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.",
16777
18243
  "id": "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity",
@@ -17320,6 +18786,10 @@
17320
18786
  "description": "The layout parsing configurations for documents.",
17321
18787
  "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig",
17322
18788
  "properties": {
18789
+ "enableGetProcessedDocument": {
18790
+ "description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.",
18791
+ "type": "boolean"
18792
+ },
17323
18793
  "enableImageAnnotation": {
17324
18794
  "description": "Optional. If true, the LLM based annotation is added to the image during parsing.",
17325
18795
  "type": "boolean"
@@ -17453,7 +18923,7 @@
17453
18923
  ],
17454
18924
  "type": "string"
17455
18925
  },
17456
- "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`",
18926
+ "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.",
17457
18927
  "type": "object"
17458
18928
  },
17459
18929
  "industryVertical": {
@@ -17892,6 +19362,29 @@
17892
19362
  },
17893
19363
  "type": "object"
17894
19364
  },
19365
+ "GoogleCloudDiscoveryengineV1alphaExportMetricsMetadata": {
19366
+ "description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.",
19367
+ "id": "GoogleCloudDiscoveryengineV1alphaExportMetricsMetadata",
19368
+ "properties": {
19369
+ "createTime": {
19370
+ "description": "Operation create time.",
19371
+ "format": "google-datetime",
19372
+ "type": "string"
19373
+ },
19374
+ "updateTime": {
19375
+ "description": "Operation last update time. If the operation is done, this is also the finish time.",
19376
+ "format": "google-datetime",
19377
+ "type": "string"
19378
+ }
19379
+ },
19380
+ "type": "object"
19381
+ },
19382
+ "GoogleCloudDiscoveryengineV1alphaExportMetricsResponse": {
19383
+ "description": "Response of the ExportMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.",
19384
+ "id": "GoogleCloudDiscoveryengineV1alphaExportMetricsResponse",
19385
+ "properties": {},
19386
+ "type": "object"
19387
+ },
17895
19388
  "GoogleCloudDiscoveryengineV1alphaFieldConfig": {
17896
19389
  "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.",
17897
19390
  "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig",
@@ -18495,7 +19988,7 @@
18495
19988
  "id": "GoogleCloudDiscoveryengineV1alphaListSessionsRequest",
18496
19989
  "properties": {
18497
19990
  "filter": {
18498
- "description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
19991
+ "description": "A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = \"some_name\"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > \"1970-01-01T12:00:00Z\"`",
18499
19992
  "type": "string"
18500
19993
  },
18501
19994
  "orderBy": {
@@ -19301,7 +20794,7 @@
19301
20794
  },
19302
20795
  "naturalLanguageQueryUnderstandingSpec": {
19303
20796
  "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec",
19304
- "description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
20797
+ "description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
19305
20798
  },
19306
20799
  "offset": {
19307
20800
  "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.",
@@ -19346,7 +20839,7 @@
19346
20839
  "description": "The query expansion specification that specifies the conditions under which query expansion occurs."
19347
20840
  },
19348
20841
  "rankingExpression": {
19349
- "description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result",
20842
+ "description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result",
19350
20843
  "type": "string"
19351
20844
  },
19352
20845
  "rankingExpressionBackend": {
@@ -19413,7 +20906,7 @@ false
19413
20906
  "type": "string"
19414
20907
  },
19415
20908
  "session": {
19416
- "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
20909
+ "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
19417
20910
  "type": "string"
19418
20911
  },
19419
20912
  "sessionSpec": {
@@ -19910,6 +21403,20 @@ false
19910
21403
  "description": "Specification to enable natural language understanding capabilities for search requests.",
19911
21404
  "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec",
19912
21405
  "properties": {
21406
+ "extractedFilterBehavior": {
21407
+ "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.",
21408
+ "enum": [
21409
+ "EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED",
21410
+ "HARD_FILTER",
21411
+ "SOFT_BOOST"
21412
+ ],
21413
+ "enumDescriptions": [
21414
+ "`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior for extracted filters. For single datastore search, the default is to apply as hard filters. For multi-datastore search, the default is to apply as soft boosts.",
21415
+ "Applies all extracted filters as hard filters on the results. Results that do not pass the extracted filters will not be returned in the result set.",
21416
+ "Applies all extracted filters as soft boosts. Results that pass the filters will be boosted up to higher ranks in the result set."
21417
+ ],
21418
+ "type": "string"
21419
+ },
19913
21420
  "filterExtractionCondition": {
19914
21421
  "description": "The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.",
19915
21422
  "enum": [
@@ -20584,14 +22091,16 @@ false
20584
22091
  "ASSIGNED",
20585
22092
  "UNASSIGNED",
20586
22093
  "NO_LICENSE",
20587
- "NO_LICENSE_ATTEMPTED_LOGIN"
22094
+ "NO_LICENSE_ATTEMPTED_LOGIN",
22095
+ "BLOCKED"
20588
22096
  ],
20589
22097
  "enumDescriptions": [
20590
22098
  "Default value.",
20591
22099
  "License assigned to the user.",
20592
22100
  "No license assigned to the user. Deprecated, translated to NO_LICENSE.",
20593
22101
  "No license assigned to the user.",
20594
- "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)."
22102
+ "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).",
22103
+ "User is blocked from assigning a license."
20595
22104
  ],
20596
22105
  "readOnly": true,
20597
22106
  "type": "string"
@@ -20766,11 +22275,12 @@ false
20766
22275
  "type": "boolean"
20767
22276
  },
20768
22277
  "kmsKey": {
20769
- "description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
22278
+ "description": "Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
20770
22279
  "type": "string"
20771
22280
  },
20772
22281
  "kmsKeyVersion": {
20773
- "description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
22282
+ "description": "Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
22283
+ "readOnly": true,
20774
22284
  "type": "string"
20775
22285
  },
20776
22286
  "lastRotationTimestampMicros": {
@@ -21643,6 +23153,10 @@ false
21643
23153
  "description": "The layout parsing configurations for documents.",
21644
23154
  "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig",
21645
23155
  "properties": {
23156
+ "enableGetProcessedDocument": {
23157
+ "description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.",
23158
+ "type": "boolean"
23159
+ },
21646
23160
  "enableImageAnnotation": {
21647
23161
  "description": "Optional. If true, the LLM based annotation is added to the image during parsing.",
21648
23162
  "type": "boolean"
@@ -21776,7 +23290,7 @@ false
21776
23290
  ],
21777
23291
  "type": "string"
21778
23292
  },
21779
- "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`",
23293
+ "description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.",
21780
23294
  "type": "object"
21781
23295
  },
21782
23296
  "industryVertical": {
@@ -22914,7 +24428,7 @@ false
22914
24428
  },
22915
24429
  "naturalLanguageQueryUnderstandingSpec": {
22916
24430
  "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec",
22917
- "description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
24431
+ "description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
22918
24432
  },
22919
24433
  "offset": {
22920
24434
  "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.",
@@ -22959,7 +24473,7 @@ false
22959
24473
  "description": "The query expansion specification that specifies the conditions under which query expansion occurs."
22960
24474
  },
22961
24475
  "rankingExpression": {
22962
- "description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result",
24476
+ "description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result",
22963
24477
  "type": "string"
22964
24478
  },
22965
24479
  "rankingExpressionBackend": {
@@ -23026,7 +24540,7 @@ false
23026
24540
  "type": "string"
23027
24541
  },
23028
24542
  "session": {
23029
- "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
24543
+ "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
23030
24544
  "type": "string"
23031
24545
  },
23032
24546
  "sessionSpec": {
@@ -23519,6 +25033,20 @@ false
23519
25033
  "description": "Specification to enable natural language understanding capabilities for search requests.",
23520
25034
  "id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec",
23521
25035
  "properties": {
25036
+ "extractedFilterBehavior": {
25037
+ "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.",
25038
+ "enum": [
25039
+ "EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED",
25040
+ "HARD_FILTER",
25041
+ "SOFT_BOOST"
25042
+ ],
25043
+ "enumDescriptions": [
25044
+ "`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior for extracted filters. For single datastore search, the default is to apply as hard filters. For multi-datastore search, the default is to apply as soft boosts.",
25045
+ "Applies all extracted filters as hard filters on the results. Results that do not pass the extracted filters will not be returned in the result set.",
25046
+ "Applies all extracted filters as soft boosts. Results that pass the filters will be boosted up to higher ranks in the result set."
25047
+ ],
25048
+ "type": "string"
25049
+ },
23522
25050
  "filterExtractionCondition": {
23523
25051
  "description": "The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.",
23524
25052
  "enum": [
@@ -24014,14 +25542,16 @@ false
24014
25542
  "ASSIGNED",
24015
25543
  "UNASSIGNED",
24016
25544
  "NO_LICENSE",
24017
- "NO_LICENSE_ATTEMPTED_LOGIN"
25545
+ "NO_LICENSE_ATTEMPTED_LOGIN",
25546
+ "BLOCKED"
24018
25547
  ],
24019
25548
  "enumDescriptions": [
24020
25549
  "Default value.",
24021
25550
  "License assigned to the user.",
24022
25551
  "No license assigned to the user. Deprecated, translated to NO_LICENSE.",
24023
25552
  "No license assigned to the user.",
24024
- "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)."
25553
+ "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).",
25554
+ "User is blocked from assigning a license."
24025
25555
  ],
24026
25556
  "readOnly": true,
24027
25557
  "type": "string"