google-api-python-client 2.165.0__py2.py3-none-any.whl → 2.167.0__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {google_api_python_client-2.165.0.dist-info → google_api_python_client-2.167.0.dist-info}/METADATA +3 -2
- {google_api_python_client-2.165.0.dist-info → google_api_python_client-2.167.0.dist-info}/RECORD +202 -199
- googleapiclient/discovery_cache/documents/addressvalidation.v1.json +10 -10
- googleapiclient/discovery_cache/documents/admin.directory_v1.json +5 -5
- googleapiclient/discovery_cache/documents/admin.directoryv1.json +5 -5
- googleapiclient/discovery_cache/documents/admin.reports_v1.json +263 -4
- googleapiclient/discovery_cache/documents/admin.reportsv1.json +263 -4
- googleapiclient/discovery_cache/documents/adsense.v2.json +7 -7
- googleapiclient/discovery_cache/documents/aiplatform.v1.json +402 -11
- googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +2069 -11
- googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +7 -7
- googleapiclient/discovery_cache/documents/alloydb.v1.json +8 -2
- googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +86 -2
- googleapiclient/discovery_cache/documents/alloydb.v1beta.json +86 -2
- googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +279 -3
- googleapiclient/discovery_cache/documents/analyticshub.v1.json +14 -2
- googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json +2 -2
- googleapiclient/discovery_cache/documents/androidenterprise.v1.json +5 -5
- googleapiclient/discovery_cache/documents/androidmanagement.v1.json +26 -2
- googleapiclient/discovery_cache/documents/androidpublisher.v3.json +2 -2
- googleapiclient/discovery_cache/documents/apigee.v1.json +454 -13
- googleapiclient/discovery_cache/documents/areainsights.v1.json +4 -4
- googleapiclient/discovery_cache/documents/backupdr.v1.json +12 -4
- googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +4 -108
- googleapiclient/discovery_cache/documents/bigquery.v2.json +9 -1
- googleapiclient/discovery_cache/documents/bigquerydatapolicy.v1.json +2 -2
- googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +7 -1
- googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +5 -1
- googleapiclient/discovery_cache/documents/blockchainnodeengine.v1.json +7 -1
- googleapiclient/discovery_cache/documents/chat.v1.json +172 -5
- googleapiclient/discovery_cache/documents/chromepolicy.v1.json +36 -1
- googleapiclient/discovery_cache/documents/civicinfo.v2.json +267 -267
- googleapiclient/discovery_cache/documents/classroom.v1.json +106 -2
- googleapiclient/discovery_cache/documents/cloudbuild.v2.json +7 -1
- googleapiclient/discovery_cache/documents/cloudchannel.v1.json +11 -11
- googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +7 -1
- googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +7 -1
- googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +7 -1
- googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +7 -1
- googleapiclient/discovery_cache/documents/compute.alpha.json +1454 -456
- googleapiclient/discovery_cache/documents/compute.beta.json +44 -16
- googleapiclient/discovery_cache/documents/compute.v1.json +43 -15
- googleapiclient/discovery_cache/documents/connectors.v1.json +23 -1
- googleapiclient/discovery_cache/documents/connectors.v2.json +16 -1
- googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +7 -1
- googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +69 -1
- googleapiclient/discovery_cache/documents/container.v1.json +383 -11
- googleapiclient/discovery_cache/documents/container.v1beta1.json +65 -11
- googleapiclient/discovery_cache/documents/datacatalog.v1.json +2 -2
- googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/dataform.v1beta1.json +11 -5
- googleapiclient/discovery_cache/documents/datalineage.v1.json +6 -1
- googleapiclient/discovery_cache/documents/datamigration.v1.json +53 -1
- googleapiclient/discovery_cache/documents/dataplex.v1.json +214 -21
- googleapiclient/discovery_cache/documents/dataproc.v1.json +347 -5
- googleapiclient/discovery_cache/documents/datastream.v1.json +216 -1
- googleapiclient/discovery_cache/documents/datastream.v1alpha1.json +7 -1
- googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +5 -1
- googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +23 -1
- googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +5 -1
- googleapiclient/discovery_cache/documents/developerconnect.v1.json +603 -1
- googleapiclient/discovery_cache/documents/dialogflow.v2.json +258 -1
- googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +258 -1
- googleapiclient/discovery_cache/documents/dialogflow.v3.json +251 -1
- googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +332 -1
- googleapiclient/discovery_cache/documents/discoveryengine.v1.json +529 -14
- googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +387 -14
- googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +681 -13
- googleapiclient/discovery_cache/documents/displayvideo.v2.json +1 -3
- googleapiclient/discovery_cache/documents/displayvideo.v3.json +254 -55
- googleapiclient/discovery_cache/documents/displayvideo.v4.json +197 -45
- googleapiclient/discovery_cache/documents/dlp.v2.json +2 -2
- googleapiclient/discovery_cache/documents/docs.v1.json +6 -2
- googleapiclient/discovery_cache/documents/documentai.v1.json +14 -8
- googleapiclient/discovery_cache/documents/documentai.v1beta3.json +18 -8
- googleapiclient/discovery_cache/documents/drive.v2.json +8 -8
- googleapiclient/discovery_cache/documents/drive.v3.json +21 -21
- googleapiclient/discovery_cache/documents/driveactivity.v2.json +7 -7
- googleapiclient/discovery_cache/documents/drivelabels.v2.json +2 -2
- googleapiclient/discovery_cache/documents/drivelabels.v2beta.json +2 -2
- googleapiclient/discovery_cache/documents/file.v1.json +7 -1
- googleapiclient/discovery_cache/documents/file.v1beta1.json +39 -3
- googleapiclient/discovery_cache/documents/firebase.v1beta1.json +3 -2
- googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json +1849 -0
- googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json +7 -1
- googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +99 -1
- googleapiclient/discovery_cache/documents/forms.v1.json +4 -4
- googleapiclient/discovery_cache/documents/games.v1.json +2 -2
- googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json +2 -2
- googleapiclient/discovery_cache/documents/gamesManagement.v1management.json +2 -2
- googleapiclient/discovery_cache/documents/gkebackup.v1.json +7 -1
- googleapiclient/discovery_cache/documents/gkehub.v1.json +17 -1
- googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +17 -1
- googleapiclient/discovery_cache/documents/gkehub.v1beta.json +17 -1
- googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +7 -1
- googleapiclient/discovery_cache/documents/gkehub.v2.json +17 -1
- googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +17 -1
- googleapiclient/discovery_cache/documents/gkehub.v2beta.json +17 -1
- googleapiclient/discovery_cache/documents/gkeonprem.v1.json +15 -1
- googleapiclient/discovery_cache/documents/gmail.v1.json +8 -8
- googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json +2 -2
- googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/healthcare.v1.json +7 -1
- googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +7 -1
- googleapiclient/discovery_cache/documents/iam.v1.json +939 -20
- googleapiclient/discovery_cache/documents/ids.v1.json +7 -1
- googleapiclient/discovery_cache/documents/integrations.v1.json +53 -1
- googleapiclient/discovery_cache/documents/jobs.v3.json +8 -8
- googleapiclient/discovery_cache/documents/jobs.v3p1beta1.json +8 -8
- googleapiclient/discovery_cache/documents/jobs.v4.json +9 -9
- googleapiclient/discovery_cache/documents/keep.v1.json +2 -2
- googleapiclient/discovery_cache/documents/managedkafka.v1.json +798 -63
- googleapiclient/discovery_cache/documents/meet.v2.json +3 -3
- googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +32 -16
- googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json +209 -1
- googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +74 -11
- googleapiclient/discovery_cache/documents/metastore.v1.json +7 -1
- googleapiclient/discovery_cache/documents/metastore.v1alpha.json +7 -1
- googleapiclient/discovery_cache/documents/metastore.v1beta.json +7 -1
- googleapiclient/discovery_cache/documents/migrationcenter.v1.json +7 -1
- googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +9 -3
- googleapiclient/discovery_cache/documents/monitoring.v1.json +7 -3
- googleapiclient/discovery_cache/documents/monitoring.v3.json +12 -1
- googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json +8 -8
- googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +8 -8
- googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json +8 -8
- googleapiclient/discovery_cache/documents/netapp.v1.json +2 -2
- googleapiclient/discovery_cache/documents/netapp.v1beta1.json +16 -2
- googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +28 -1
- googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +8 -1
- googleapiclient/discovery_cache/documents/networkmanagement.v1.json +13 -13
- googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +13 -13
- googleapiclient/discovery_cache/documents/networkservices.v1.json +84 -8
- googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +116 -8
- googleapiclient/discovery_cache/documents/notebooks.v2.json +37 -1
- googleapiclient/discovery_cache/documents/observability.v1.json +594 -0
- googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +4 -4
- googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +4 -4
- googleapiclient/discovery_cache/documents/oracledatabase.v1.json +195 -1
- googleapiclient/discovery_cache/documents/osconfig.v1.json +45 -1
- googleapiclient/discovery_cache/documents/osconfig.v1alpha.json +45 -1
- googleapiclient/discovery_cache/documents/osconfig.v1beta.json +45 -1
- googleapiclient/discovery_cache/documents/osconfig.v2.json +2318 -0
- googleapiclient/discovery_cache/documents/osconfig.v2beta.json +53 -9
- googleapiclient/discovery_cache/documents/oslogin.v1.json +2 -2
- googleapiclient/discovery_cache/documents/oslogin.v1alpha.json +2 -2
- googleapiclient/discovery_cache/documents/oslogin.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/parallelstore.v1.json +8 -2
- googleapiclient/discovery_cache/documents/parallelstore.v1beta.json +8 -2
- googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +91 -1
- googleapiclient/discovery_cache/documents/places.v1.json +13 -13
- googleapiclient/discovery_cache/documents/policysimulator.v1.json +1 -703
- googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +108 -1899
- googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +104 -1895
- googleapiclient/discovery_cache/documents/pubsub.v1.json +7 -2
- googleapiclient/discovery_cache/documents/rapidmigrationassessment.v1.json +7 -1
- googleapiclient/discovery_cache/documents/recommender.v1beta1.json +25 -1
- googleapiclient/discovery_cache/documents/redis.v1.json +16 -10
- googleapiclient/discovery_cache/documents/redis.v1beta1.json +16 -10
- googleapiclient/discovery_cache/documents/retail.v2.json +8 -8
- googleapiclient/discovery_cache/documents/retail.v2alpha.json +8 -8
- googleapiclient/discovery_cache/documents/retail.v2beta.json +8 -8
- googleapiclient/discovery_cache/documents/run.v1.json +9 -3
- googleapiclient/discovery_cache/documents/run.v2.json +20 -12
- googleapiclient/discovery_cache/documents/secretmanager.v1.json +17 -1
- googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +17 -1
- googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +17 -1
- googleapiclient/discovery_cache/documents/securitycenter.v1.json +237 -9
- googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +237 -9
- googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +238 -10
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +2 -2
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/servicedirectory.v1.json +7 -1
- googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json +7 -1
- googleapiclient/discovery_cache/documents/servicenetworking.v1.json +3 -3
- googleapiclient/discovery_cache/documents/serviceusage.v1.json +2 -2
- googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/sheets.v4.json +22 -22
- googleapiclient/discovery_cache/documents/slides.v1.json +7 -3
- googleapiclient/discovery_cache/documents/storage.v1.json +117 -2
- googleapiclient/discovery_cache/documents/sts.v1.json +166 -1
- googleapiclient/discovery_cache/documents/sts.v1beta.json +166 -1
- googleapiclient/discovery_cache/documents/tasks.v1.json +4 -4
- googleapiclient/discovery_cache/documents/testing.v1.json +21 -1
- googleapiclient/discovery_cache/documents/texttospeech.v1.json +2 -2
- googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/tpu.v1.json +7 -1
- googleapiclient/discovery_cache/documents/tpu.v1alpha1.json +7 -1
- googleapiclient/discovery_cache/documents/tpu.v2.json +7 -1
- googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +46 -1
- googleapiclient/discovery_cache/documents/vault.v1.json +15 -16
- googleapiclient/discovery_cache/documents/verifiedaccess.v2.json +4 -3
- googleapiclient/discovery_cache/documents/vmmigration.v1.json +21 -1
- googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +21 -1
- googleapiclient/discovery_cache/documents/workloadmanager.v1.json +8 -1
- googleapiclient/discovery_cache/documents/workstations.v1.json +6 -6
- googleapiclient/discovery_cache/documents/workstations.v1beta.json +23 -8
- googleapiclient/discovery_cache/documents/youtube.v3.json +20 -6
- googleapiclient/version.py +1 -1
- {google_api_python_client-2.165.0.dist-info → google_api_python_client-2.167.0.dist-info}/LICENSE +0 -0
- {google_api_python_client-2.165.0.dist-info → google_api_python_client-2.167.0.dist-info}/WHEEL +0 -0
- {google_api_python_client-2.165.0.dist-info → google_api_python_client-2.167.0.dist-info}/top_level.txt +0 -0
|
@@ -161,6 +161,31 @@
|
|
|
161
161
|
"resources": {
|
|
162
162
|
"locations": {
|
|
163
163
|
"methods": {
|
|
164
|
+
"getCmekConfig": {
|
|
165
|
+
"description": "Gets the CmekConfig.",
|
|
166
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/cmekConfig",
|
|
167
|
+
"httpMethod": "GET",
|
|
168
|
+
"id": "discoveryengine.projects.locations.getCmekConfig",
|
|
169
|
+
"parameterOrder": [
|
|
170
|
+
"name"
|
|
171
|
+
],
|
|
172
|
+
"parameters": {
|
|
173
|
+
"name": {
|
|
174
|
+
"description": "Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.",
|
|
175
|
+
"location": "path",
|
|
176
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$",
|
|
177
|
+
"required": true,
|
|
178
|
+
"type": "string"
|
|
179
|
+
}
|
|
180
|
+
},
|
|
181
|
+
"path": "v1beta/{+name}",
|
|
182
|
+
"response": {
|
|
183
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig"
|
|
184
|
+
},
|
|
185
|
+
"scopes": [
|
|
186
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
187
|
+
]
|
|
188
|
+
},
|
|
164
189
|
"obtainCrawlRate": {
|
|
165
190
|
"description": "Obtains the time series data of organic or dedicated crawl rate for monitoring. When dedicated crawl rate is not set, it will return vertex AI's organic crawl rate time series. Organic crawl means Google automatically crawl the internet at its own convenience. When dedicated crawl rate is set, it will return vertex AI's dedicated crawl rate time series.",
|
|
166
191
|
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:obtainCrawlRate",
|
|
@@ -244,9 +269,154 @@
|
|
|
244
269
|
"scopes": [
|
|
245
270
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
246
271
|
]
|
|
272
|
+
},
|
|
273
|
+
"updateCmekConfig": {
|
|
274
|
+
"description": "Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.",
|
|
275
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/cmekConfig",
|
|
276
|
+
"httpMethod": "PATCH",
|
|
277
|
+
"id": "discoveryengine.projects.locations.updateCmekConfig",
|
|
278
|
+
"parameterOrder": [
|
|
279
|
+
"name"
|
|
280
|
+
],
|
|
281
|
+
"parameters": {
|
|
282
|
+
"name": {
|
|
283
|
+
"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
|
|
284
|
+
"location": "path",
|
|
285
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$",
|
|
286
|
+
"required": true,
|
|
287
|
+
"type": "string"
|
|
288
|
+
},
|
|
289
|
+
"setDefault": {
|
|
290
|
+
"description": "Set the following CmekConfig as the default to be used for child resources if one is not specified.",
|
|
291
|
+
"location": "query",
|
|
292
|
+
"type": "boolean"
|
|
293
|
+
}
|
|
294
|
+
},
|
|
295
|
+
"path": "v1beta/{+name}",
|
|
296
|
+
"request": {
|
|
297
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig"
|
|
298
|
+
},
|
|
299
|
+
"response": {
|
|
300
|
+
"$ref": "GoogleLongrunningOperation"
|
|
301
|
+
},
|
|
302
|
+
"scopes": [
|
|
303
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
304
|
+
]
|
|
247
305
|
}
|
|
248
306
|
},
|
|
249
307
|
"resources": {
|
|
308
|
+
"cmekConfigs": {
|
|
309
|
+
"methods": {
|
|
310
|
+
"delete": {
|
|
311
|
+
"description": "De-provisions a CmekConfig.",
|
|
312
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}",
|
|
313
|
+
"httpMethod": "DELETE",
|
|
314
|
+
"id": "discoveryengine.projects.locations.cmekConfigs.delete",
|
|
315
|
+
"parameterOrder": [
|
|
316
|
+
"name"
|
|
317
|
+
],
|
|
318
|
+
"parameters": {
|
|
319
|
+
"name": {
|
|
320
|
+
"description": "Required. The resource name of the CmekConfig to delete, such as `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.",
|
|
321
|
+
"location": "path",
|
|
322
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$",
|
|
323
|
+
"required": true,
|
|
324
|
+
"type": "string"
|
|
325
|
+
}
|
|
326
|
+
},
|
|
327
|
+
"path": "v1beta/{+name}",
|
|
328
|
+
"response": {
|
|
329
|
+
"$ref": "GoogleLongrunningOperation"
|
|
330
|
+
},
|
|
331
|
+
"scopes": [
|
|
332
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
333
|
+
]
|
|
334
|
+
},
|
|
335
|
+
"get": {
|
|
336
|
+
"description": "Gets the CmekConfig.",
|
|
337
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}",
|
|
338
|
+
"httpMethod": "GET",
|
|
339
|
+
"id": "discoveryengine.projects.locations.cmekConfigs.get",
|
|
340
|
+
"parameterOrder": [
|
|
341
|
+
"name"
|
|
342
|
+
],
|
|
343
|
+
"parameters": {
|
|
344
|
+
"name": {
|
|
345
|
+
"description": "Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.",
|
|
346
|
+
"location": "path",
|
|
347
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$",
|
|
348
|
+
"required": true,
|
|
349
|
+
"type": "string"
|
|
350
|
+
}
|
|
351
|
+
},
|
|
352
|
+
"path": "v1beta/{+name}",
|
|
353
|
+
"response": {
|
|
354
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig"
|
|
355
|
+
},
|
|
356
|
+
"scopes": [
|
|
357
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
358
|
+
]
|
|
359
|
+
},
|
|
360
|
+
"list": {
|
|
361
|
+
"description": "Lists all the CmekConfigs with the project.",
|
|
362
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/cmekConfigs",
|
|
363
|
+
"httpMethod": "GET",
|
|
364
|
+
"id": "discoveryengine.projects.locations.cmekConfigs.list",
|
|
365
|
+
"parameterOrder": [
|
|
366
|
+
"parent"
|
|
367
|
+
],
|
|
368
|
+
"parameters": {
|
|
369
|
+
"parent": {
|
|
370
|
+
"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned.",
|
|
371
|
+
"location": "path",
|
|
372
|
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
373
|
+
"required": true,
|
|
374
|
+
"type": "string"
|
|
375
|
+
}
|
|
376
|
+
},
|
|
377
|
+
"path": "v1beta/{+parent}/cmekConfigs",
|
|
378
|
+
"response": {
|
|
379
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse"
|
|
380
|
+
},
|
|
381
|
+
"scopes": [
|
|
382
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
383
|
+
]
|
|
384
|
+
},
|
|
385
|
+
"patch": {
|
|
386
|
+
"description": "Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.",
|
|
387
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}",
|
|
388
|
+
"httpMethod": "PATCH",
|
|
389
|
+
"id": "discoveryengine.projects.locations.cmekConfigs.patch",
|
|
390
|
+
"parameterOrder": [
|
|
391
|
+
"name"
|
|
392
|
+
],
|
|
393
|
+
"parameters": {
|
|
394
|
+
"name": {
|
|
395
|
+
"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
|
|
396
|
+
"location": "path",
|
|
397
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$",
|
|
398
|
+
"required": true,
|
|
399
|
+
"type": "string"
|
|
400
|
+
},
|
|
401
|
+
"setDefault": {
|
|
402
|
+
"description": "Set the following CmekConfig as the default to be used for child resources if one is not specified.",
|
|
403
|
+
"location": "query",
|
|
404
|
+
"type": "boolean"
|
|
405
|
+
}
|
|
406
|
+
},
|
|
407
|
+
"path": "v1beta/{+name}",
|
|
408
|
+
"request": {
|
|
409
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig"
|
|
410
|
+
},
|
|
411
|
+
"response": {
|
|
412
|
+
"$ref": "GoogleLongrunningOperation"
|
|
413
|
+
},
|
|
414
|
+
"scopes": [
|
|
415
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
416
|
+
]
|
|
417
|
+
}
|
|
418
|
+
}
|
|
419
|
+
},
|
|
250
420
|
"collections": {
|
|
251
421
|
"resources": {
|
|
252
422
|
"dataConnector": {
|
|
@@ -7136,6 +7306,39 @@
|
|
|
7136
7306
|
}
|
|
7137
7307
|
}
|
|
7138
7308
|
},
|
|
7309
|
+
"podcasts": {
|
|
7310
|
+
"resources": {
|
|
7311
|
+
"operations": {
|
|
7312
|
+
"methods": {
|
|
7313
|
+
"get": {
|
|
7314
|
+
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
|
|
7315
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/podcasts/{podcastsId}/operations/{operationsId}",
|
|
7316
|
+
"httpMethod": "GET",
|
|
7317
|
+
"id": "discoveryengine.projects.locations.podcasts.operations.get",
|
|
7318
|
+
"parameterOrder": [
|
|
7319
|
+
"name"
|
|
7320
|
+
],
|
|
7321
|
+
"parameters": {
|
|
7322
|
+
"name": {
|
|
7323
|
+
"description": "The name of the operation resource.",
|
|
7324
|
+
"location": "path",
|
|
7325
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/podcasts/[^/]+/operations/[^/]+$",
|
|
7326
|
+
"required": true,
|
|
7327
|
+
"type": "string"
|
|
7328
|
+
}
|
|
7329
|
+
},
|
|
7330
|
+
"path": "v1beta/{+name}",
|
|
7331
|
+
"response": {
|
|
7332
|
+
"$ref": "GoogleLongrunningOperation"
|
|
7333
|
+
},
|
|
7334
|
+
"scopes": [
|
|
7335
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
7336
|
+
]
|
|
7337
|
+
}
|
|
7338
|
+
}
|
|
7339
|
+
}
|
|
7340
|
+
}
|
|
7341
|
+
},
|
|
7139
7342
|
"rankingConfigs": {
|
|
7140
7343
|
"methods": {
|
|
7141
7344
|
"rank": {
|
|
@@ -7722,7 +7925,7 @@
|
|
|
7722
7925
|
}
|
|
7723
7926
|
}
|
|
7724
7927
|
},
|
|
7725
|
-
"revision": "
|
|
7928
|
+
"revision": "20250331",
|
|
7726
7929
|
"rootUrl": "https://discoveryengine.googleapis.com/",
|
|
7727
7930
|
"schemas": {
|
|
7728
7931
|
"GoogleApiDistribution": {
|
|
@@ -8211,6 +8414,23 @@
|
|
|
8211
8414
|
"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
|
|
8212
8415
|
"type": "string"
|
|
8213
8416
|
},
|
|
8417
|
+
"notebooklmState": {
|
|
8418
|
+
"description": "Output only. Whether the NotebookLM Corpus is ready to be used.",
|
|
8419
|
+
"enum": [
|
|
8420
|
+
"NOTEBOOK_LM_STATE_UNSPECIFIED",
|
|
8421
|
+
"NOTEBOOK_LM_NOT_READY",
|
|
8422
|
+
"NOTEBOOK_LM_READY",
|
|
8423
|
+
"NOTEBOOK_LM_NOT_ENABLED"
|
|
8424
|
+
],
|
|
8425
|
+
"enumDescriptions": [
|
|
8426
|
+
"The NotebookLM state is unknown.",
|
|
8427
|
+
"The NotebookLM is not ready.",
|
|
8428
|
+
"The NotebookLM is ready to be used.",
|
|
8429
|
+
"The NotebookLM is not enabled."
|
|
8430
|
+
],
|
|
8431
|
+
"readOnly": true,
|
|
8432
|
+
"type": "string"
|
|
8433
|
+
},
|
|
8214
8434
|
"singleRegionKeys": {
|
|
8215
8435
|
"description": "Optional. Single-regional CMEKs that are required for some VAIS features.",
|
|
8216
8436
|
"items": {
|
|
@@ -8622,6 +8842,10 @@
|
|
|
8622
8842
|
"description": "DataStore captures global settings and configs at the DataStore level.",
|
|
8623
8843
|
"id": "GoogleCloudDiscoveryengineV1DataStore",
|
|
8624
8844
|
"properties": {
|
|
8845
|
+
"aclEnabled": {
|
|
8846
|
+
"description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.",
|
|
8847
|
+
"type": "boolean"
|
|
8848
|
+
},
|
|
8625
8849
|
"advancedSiteSearchConfig": {
|
|
8626
8850
|
"$ref": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig",
|
|
8627
8851
|
"description": "Optional. Configuration for advanced site search."
|
|
@@ -9016,7 +9240,16 @@
|
|
|
9016
9240
|
"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": {
|
|
9017
9241
|
"description": "The layout parsing configurations for documents.",
|
|
9018
9242
|
"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig",
|
|
9019
|
-
"properties": {
|
|
9243
|
+
"properties": {
|
|
9244
|
+
"enableImageAnnotation": {
|
|
9245
|
+
"description": "Optional. If true, the LLM based annotation is added to the image during parsing.",
|
|
9246
|
+
"type": "boolean"
|
|
9247
|
+
},
|
|
9248
|
+
"enableTableAnnotation": {
|
|
9249
|
+
"description": "Optional. If true, the LLM based annotation is added to the table during parsing.",
|
|
9250
|
+
"type": "boolean"
|
|
9251
|
+
}
|
|
9252
|
+
},
|
|
9020
9253
|
"type": "object"
|
|
9021
9254
|
},
|
|
9022
9255
|
"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": {
|
|
@@ -10442,6 +10675,10 @@
|
|
|
10442
10675
|
"description": "Output only. The connector contains the necessary parameters and is configured to support actions.",
|
|
10443
10676
|
"readOnly": true,
|
|
10444
10677
|
"type": "boolean"
|
|
10678
|
+
},
|
|
10679
|
+
"serviceName": {
|
|
10680
|
+
"description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.",
|
|
10681
|
+
"type": "string"
|
|
10445
10682
|
}
|
|
10446
10683
|
},
|
|
10447
10684
|
"type": "object"
|
|
@@ -10543,6 +10780,13 @@
|
|
|
10543
10780
|
"description": "The textual answer.",
|
|
10544
10781
|
"type": "string"
|
|
10545
10782
|
},
|
|
10783
|
+
"blobAttachments": {
|
|
10784
|
+
"description": "List of blob attachments in the answer.",
|
|
10785
|
+
"items": {
|
|
10786
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment"
|
|
10787
|
+
},
|
|
10788
|
+
"type": "array"
|
|
10789
|
+
},
|
|
10546
10790
|
"citations": {
|
|
10547
10791
|
"description": "Citations.",
|
|
10548
10792
|
"items": {
|
|
@@ -10631,6 +10875,51 @@
|
|
|
10631
10875
|
},
|
|
10632
10876
|
"type": "object"
|
|
10633
10877
|
},
|
|
10878
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment": {
|
|
10879
|
+
"description": "Stores binarydata attached to text answer, e.g. image, video, audio, etc.",
|
|
10880
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment",
|
|
10881
|
+
"properties": {
|
|
10882
|
+
"attributionType": {
|
|
10883
|
+
"description": "Output only. The attribution type of the blob.",
|
|
10884
|
+
"enum": [
|
|
10885
|
+
"ATTRIBUTION_TYPE_UNSPECIFIED",
|
|
10886
|
+
"CORPUS",
|
|
10887
|
+
"GENERATED"
|
|
10888
|
+
],
|
|
10889
|
+
"enumDescriptions": [
|
|
10890
|
+
"Unspecified attribution type.",
|
|
10891
|
+
"The attachment data is from the corpus.",
|
|
10892
|
+
"The attachment data is generated by the model through code generation."
|
|
10893
|
+
],
|
|
10894
|
+
"readOnly": true,
|
|
10895
|
+
"type": "string"
|
|
10896
|
+
},
|
|
10897
|
+
"data": {
|
|
10898
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob",
|
|
10899
|
+
"description": "Output only. The mime type and data of the blob.",
|
|
10900
|
+
"readOnly": true
|
|
10901
|
+
}
|
|
10902
|
+
},
|
|
10903
|
+
"type": "object"
|
|
10904
|
+
},
|
|
10905
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob": {
|
|
10906
|
+
"description": "The media type and data of the blob.",
|
|
10907
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob",
|
|
10908
|
+
"properties": {
|
|
10909
|
+
"data": {
|
|
10910
|
+
"description": "Output only. Raw bytes.",
|
|
10911
|
+
"format": "byte",
|
|
10912
|
+
"readOnly": true,
|
|
10913
|
+
"type": "string"
|
|
10914
|
+
},
|
|
10915
|
+
"mimeType": {
|
|
10916
|
+
"description": "Output only. The media type (MIME type) of the generated or retrieved data.",
|
|
10917
|
+
"readOnly": true,
|
|
10918
|
+
"type": "string"
|
|
10919
|
+
}
|
|
10920
|
+
},
|
|
10921
|
+
"type": "object"
|
|
10922
|
+
},
|
|
10634
10923
|
"GoogleCloudDiscoveryengineV1alphaAnswerCitation": {
|
|
10635
10924
|
"description": "Citation info for a segment.",
|
|
10636
10925
|
"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation",
|
|
@@ -10765,6 +11054,15 @@
|
|
|
10765
11054
|
"description": "Chunk information.",
|
|
10766
11055
|
"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo",
|
|
10767
11056
|
"properties": {
|
|
11057
|
+
"blobAttachmentIndexes": {
|
|
11058
|
+
"description": "Output only. Stores indexes of blobattachments linked to this chunk.",
|
|
11059
|
+
"items": {
|
|
11060
|
+
"format": "int64",
|
|
11061
|
+
"type": "string"
|
|
11062
|
+
},
|
|
11063
|
+
"readOnly": true,
|
|
11064
|
+
"type": "array"
|
|
11065
|
+
},
|
|
10768
11066
|
"chunk": {
|
|
10769
11067
|
"description": "Chunk resource name.",
|
|
10770
11068
|
"type": "string"
|
|
@@ -10883,6 +11181,15 @@
|
|
|
10883
11181
|
"description": "Chunk content.",
|
|
10884
11182
|
"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent",
|
|
10885
11183
|
"properties": {
|
|
11184
|
+
"blobAttachmentIndexes": {
|
|
11185
|
+
"description": "Output only. Stores indexes of blobattachments linked to this chunk.",
|
|
11186
|
+
"items": {
|
|
11187
|
+
"format": "int64",
|
|
11188
|
+
"type": "string"
|
|
11189
|
+
},
|
|
11190
|
+
"readOnly": true,
|
|
11191
|
+
"type": "array"
|
|
11192
|
+
},
|
|
10886
11193
|
"content": {
|
|
10887
11194
|
"description": "Chunk textual content.",
|
|
10888
11195
|
"type": "string"
|
|
@@ -11134,6 +11441,23 @@
|
|
|
11134
11441
|
"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
|
|
11135
11442
|
"type": "string"
|
|
11136
11443
|
},
|
|
11444
|
+
"notebooklmState": {
|
|
11445
|
+
"description": "Output only. Whether the NotebookLM Corpus is ready to be used.",
|
|
11446
|
+
"enum": [
|
|
11447
|
+
"NOTEBOOK_LM_STATE_UNSPECIFIED",
|
|
11448
|
+
"NOTEBOOK_LM_NOT_READY",
|
|
11449
|
+
"NOTEBOOK_LM_READY",
|
|
11450
|
+
"NOTEBOOK_LM_NOT_ENABLED"
|
|
11451
|
+
],
|
|
11452
|
+
"enumDescriptions": [
|
|
11453
|
+
"The NotebookLM state is unknown.",
|
|
11454
|
+
"The NotebookLM is not ready.",
|
|
11455
|
+
"The NotebookLM is ready to be used.",
|
|
11456
|
+
"The NotebookLM is not enabled."
|
|
11457
|
+
],
|
|
11458
|
+
"readOnly": true,
|
|
11459
|
+
"type": "string"
|
|
11460
|
+
},
|
|
11137
11461
|
"singleRegionKeys": {
|
|
11138
11462
|
"description": "Optional. Single-regional CMEKs that are required for some VAIS features.",
|
|
11139
11463
|
"items": {
|
|
@@ -11985,6 +12309,10 @@
|
|
|
11985
12309
|
"readOnly": true,
|
|
11986
12310
|
"type": "string"
|
|
11987
12311
|
},
|
|
12312
|
+
"realtimeSyncConfig": {
|
|
12313
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig",
|
|
12314
|
+
"description": "Optional. The configuration for realtime sync."
|
|
12315
|
+
},
|
|
11988
12316
|
"refreshInterval": {
|
|
11989
12317
|
"description": "Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days.",
|
|
11990
12318
|
"format": "google-duration",
|
|
@@ -12048,6 +12376,21 @@
|
|
|
12048
12376
|
},
|
|
12049
12377
|
"type": "object"
|
|
12050
12378
|
},
|
|
12379
|
+
"GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig": {
|
|
12380
|
+
"description": "The configuration for realtime sync to store additional params for realtime sync.",
|
|
12381
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig",
|
|
12382
|
+
"properties": {
|
|
12383
|
+
"realtimeSyncSecret": {
|
|
12384
|
+
"description": "Optional. The ID of the Secret Manager secret used for webhook secret.",
|
|
12385
|
+
"type": "string"
|
|
12386
|
+
},
|
|
12387
|
+
"webhookUri": {
|
|
12388
|
+
"description": "Optional. Webhook url for the connector to specify additional params for realtime sync.",
|
|
12389
|
+
"type": "string"
|
|
12390
|
+
}
|
|
12391
|
+
},
|
|
12392
|
+
"type": "object"
|
|
12393
|
+
},
|
|
12051
12394
|
"GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity": {
|
|
12052
12395
|
"description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.",
|
|
12053
12396
|
"id": "GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity",
|
|
@@ -12595,7 +12938,16 @@
|
|
|
12595
12938
|
"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": {
|
|
12596
12939
|
"description": "The layout parsing configurations for documents.",
|
|
12597
12940
|
"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig",
|
|
12598
|
-
"properties": {
|
|
12941
|
+
"properties": {
|
|
12942
|
+
"enableImageAnnotation": {
|
|
12943
|
+
"description": "Optional. If true, the LLM based annotation is added to the image during parsing.",
|
|
12944
|
+
"type": "boolean"
|
|
12945
|
+
},
|
|
12946
|
+
"enableTableAnnotation": {
|
|
12947
|
+
"description": "Optional. If true, the LLM based annotation is added to the table during parsing.",
|
|
12948
|
+
"type": "boolean"
|
|
12949
|
+
}
|
|
12950
|
+
},
|
|
12599
12951
|
"type": "object"
|
|
12600
12952
|
},
|
|
12601
12953
|
"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": {
|
|
@@ -14435,7 +14787,7 @@
|
|
|
14435
14787
|
"description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec."
|
|
14436
14788
|
},
|
|
14437
14789
|
"dataStoreSpecs": {
|
|
14438
|
-
"description": "Specifications that define the specific
|
|
14790
|
+
"description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.",
|
|
14439
14791
|
"items": {
|
|
14440
14792
|
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec"
|
|
14441
14793
|
},
|
|
@@ -14515,13 +14867,13 @@
|
|
|
14515
14867
|
"description": "The query expansion specification that specifies the conditions under which query expansion occurs."
|
|
14516
14868
|
},
|
|
14517
14869
|
"rankingExpression": {
|
|
14518
|
-
"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If
|
|
14870
|
+
"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result",
|
|
14519
14871
|
"type": "string"
|
|
14520
14872
|
},
|
|
14521
14873
|
"rankingExpressionBackend": {
|
|
14522
14874
|
"description": "Optional. The backend to use for the ranking expression evaluation.",
|
|
14523
14875
|
"enum": [
|
|
14524
|
-
"
|
|
14876
|
+
"RANKING_EXPRESSION_BACKEND_UNSPECIFIED",
|
|
14525
14877
|
"BYOE",
|
|
14526
14878
|
"CLEARBOX"
|
|
14527
14879
|
],
|
|
@@ -14605,7 +14957,7 @@
|
|
|
14605
14957
|
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec",
|
|
14606
14958
|
"properties": {
|
|
14607
14959
|
"conditionBoostSpecs": {
|
|
14608
|
-
"description": "Condition boost specifications. If a document matches multiple conditions in the
|
|
14960
|
+
"description": "Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.",
|
|
14609
14961
|
"items": {
|
|
14610
14962
|
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec"
|
|
14611
14963
|
},
|
|
@@ -14837,6 +15189,10 @@
|
|
|
14837
15189
|
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec",
|
|
14838
15190
|
"description": "If specified, the spec will be used to modify the model specification provided to the LLM."
|
|
14839
15191
|
},
|
|
15192
|
+
"multimodalSpec": {
|
|
15193
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec",
|
|
15194
|
+
"description": "Optional. Multimodal specification."
|
|
15195
|
+
},
|
|
14840
15196
|
"summaryResultCount": {
|
|
14841
15197
|
"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.",
|
|
14842
15198
|
"format": "int32",
|
|
@@ -14871,6 +15227,29 @@
|
|
|
14871
15227
|
},
|
|
14872
15228
|
"type": "object"
|
|
14873
15229
|
},
|
|
15230
|
+
"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec": {
|
|
15231
|
+
"description": "Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.",
|
|
15232
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec",
|
|
15233
|
+
"properties": {
|
|
15234
|
+
"imageSource": {
|
|
15235
|
+
"description": "Optional. Source of image returned in the answer.",
|
|
15236
|
+
"enum": [
|
|
15237
|
+
"IMAGE_SOURCE_UNSPECIFIED",
|
|
15238
|
+
"ALL_AVAILABLE_SOURCES",
|
|
15239
|
+
"CORPUS_IMAGE_ONLY",
|
|
15240
|
+
"FIGURE_GENERATION_ONLY"
|
|
15241
|
+
],
|
|
15242
|
+
"enumDescriptions": [
|
|
15243
|
+
"Unspecified image source (multimodal feature is disabled by default).",
|
|
15244
|
+
"Behavior when service determines the pick from all available sources.",
|
|
15245
|
+
"Includes image from corpus in the answer.",
|
|
15246
|
+
"Triggers figure generation in the answer."
|
|
15247
|
+
],
|
|
15248
|
+
"type": "string"
|
|
15249
|
+
}
|
|
15250
|
+
},
|
|
15251
|
+
"type": "object"
|
|
15252
|
+
},
|
|
14874
15253
|
"GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": {
|
|
14875
15254
|
"description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.",
|
|
14876
15255
|
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec",
|
|
@@ -15639,6 +16018,10 @@
|
|
|
15639
16018
|
"description": "Information of an end user.",
|
|
15640
16019
|
"id": "GoogleCloudDiscoveryengineV1alphaUserInfo",
|
|
15641
16020
|
"properties": {
|
|
16021
|
+
"timeZone": {
|
|
16022
|
+
"description": "Optional. IANA time zone, e.g. Europe/Budapest.",
|
|
16023
|
+
"type": "string"
|
|
16024
|
+
},
|
|
15642
16025
|
"userAgent": {
|
|
15643
16026
|
"description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.",
|
|
15644
16027
|
"type": "string"
|
|
@@ -15761,7 +16144,7 @@
|
|
|
15761
16144
|
"id": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpec",
|
|
15762
16145
|
"properties": {
|
|
15763
16146
|
"conditionBoostSpecs": {
|
|
15764
|
-
"description": "Condition boost specifications. If a suggestion matches multiple conditions in the
|
|
16147
|
+
"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.",
|
|
15765
16148
|
"items": {
|
|
15766
16149
|
"$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec"
|
|
15767
16150
|
},
|
|
@@ -16085,6 +16468,13 @@
|
|
|
16085
16468
|
"description": "The textual answer.",
|
|
16086
16469
|
"type": "string"
|
|
16087
16470
|
},
|
|
16471
|
+
"blobAttachments": {
|
|
16472
|
+
"description": "List of blob attachments in the answer.",
|
|
16473
|
+
"items": {
|
|
16474
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerBlobAttachment"
|
|
16475
|
+
},
|
|
16476
|
+
"type": "array"
|
|
16477
|
+
},
|
|
16088
16478
|
"citations": {
|
|
16089
16479
|
"description": "Citations.",
|
|
16090
16480
|
"items": {
|
|
@@ -16173,6 +16563,51 @@
|
|
|
16173
16563
|
},
|
|
16174
16564
|
"type": "object"
|
|
16175
16565
|
},
|
|
16566
|
+
"GoogleCloudDiscoveryengineV1betaAnswerBlobAttachment": {
|
|
16567
|
+
"description": "Stores binarydata attached to text answer, e.g. image, video, audio, etc.",
|
|
16568
|
+
"id": "GoogleCloudDiscoveryengineV1betaAnswerBlobAttachment",
|
|
16569
|
+
"properties": {
|
|
16570
|
+
"attributionType": {
|
|
16571
|
+
"description": "Output only. The attribution type of the blob.",
|
|
16572
|
+
"enum": [
|
|
16573
|
+
"ATTRIBUTION_TYPE_UNSPECIFIED",
|
|
16574
|
+
"CORPUS",
|
|
16575
|
+
"GENERATED"
|
|
16576
|
+
],
|
|
16577
|
+
"enumDescriptions": [
|
|
16578
|
+
"Unspecified attribution type.",
|
|
16579
|
+
"The attachment data is from the corpus.",
|
|
16580
|
+
"The attachment data is generated by the model through code generation."
|
|
16581
|
+
],
|
|
16582
|
+
"readOnly": true,
|
|
16583
|
+
"type": "string"
|
|
16584
|
+
},
|
|
16585
|
+
"data": {
|
|
16586
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerBlobAttachmentBlob",
|
|
16587
|
+
"description": "Output only. The mime type and data of the blob.",
|
|
16588
|
+
"readOnly": true
|
|
16589
|
+
}
|
|
16590
|
+
},
|
|
16591
|
+
"type": "object"
|
|
16592
|
+
},
|
|
16593
|
+
"GoogleCloudDiscoveryengineV1betaAnswerBlobAttachmentBlob": {
|
|
16594
|
+
"description": "The media type and data of the blob.",
|
|
16595
|
+
"id": "GoogleCloudDiscoveryengineV1betaAnswerBlobAttachmentBlob",
|
|
16596
|
+
"properties": {
|
|
16597
|
+
"data": {
|
|
16598
|
+
"description": "Output only. Raw bytes.",
|
|
16599
|
+
"format": "byte",
|
|
16600
|
+
"readOnly": true,
|
|
16601
|
+
"type": "string"
|
|
16602
|
+
},
|
|
16603
|
+
"mimeType": {
|
|
16604
|
+
"description": "Output only. The media type (MIME type) of the generated or retrieved data.",
|
|
16605
|
+
"readOnly": true,
|
|
16606
|
+
"type": "string"
|
|
16607
|
+
}
|
|
16608
|
+
},
|
|
16609
|
+
"type": "object"
|
|
16610
|
+
},
|
|
16176
16611
|
"GoogleCloudDiscoveryengineV1betaAnswerCitation": {
|
|
16177
16612
|
"description": "Citation info for a segment.",
|
|
16178
16613
|
"id": "GoogleCloudDiscoveryengineV1betaAnswerCitation",
|
|
@@ -16332,6 +16767,10 @@
|
|
|
16332
16767
|
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec",
|
|
16333
16768
|
"description": "Answer generation model specification."
|
|
16334
16769
|
},
|
|
16770
|
+
"multimodalSpec": {
|
|
16771
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecMultimodalSpec",
|
|
16772
|
+
"description": "Optional. Multimodal specification."
|
|
16773
|
+
},
|
|
16335
16774
|
"promptSpec": {
|
|
16336
16775
|
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec",
|
|
16337
16776
|
"description": "Answer generation prompt specification."
|
|
@@ -16350,6 +16789,29 @@
|
|
|
16350
16789
|
},
|
|
16351
16790
|
"type": "object"
|
|
16352
16791
|
},
|
|
16792
|
+
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecMultimodalSpec": {
|
|
16793
|
+
"description": "Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.",
|
|
16794
|
+
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecMultimodalSpec",
|
|
16795
|
+
"properties": {
|
|
16796
|
+
"imageSource": {
|
|
16797
|
+
"description": "Optional. Source of image returned in the answer.",
|
|
16798
|
+
"enum": [
|
|
16799
|
+
"IMAGE_SOURCE_UNSPECIFIED",
|
|
16800
|
+
"ALL_AVAILABLE_SOURCES",
|
|
16801
|
+
"CORPUS_IMAGE_ONLY",
|
|
16802
|
+
"FIGURE_GENERATION_ONLY"
|
|
16803
|
+
],
|
|
16804
|
+
"enumDescriptions": [
|
|
16805
|
+
"Unspecified image source (multimodal feature is disabled by default).",
|
|
16806
|
+
"Behavior when service determines the pick from all available sources.",
|
|
16807
|
+
"Includes image from corpus in the answer.",
|
|
16808
|
+
"Triggers figure generation in the answer."
|
|
16809
|
+
],
|
|
16810
|
+
"type": "string"
|
|
16811
|
+
}
|
|
16812
|
+
},
|
|
16813
|
+
"type": "object"
|
|
16814
|
+
},
|
|
16353
16815
|
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec": {
|
|
16354
16816
|
"description": "Answer generation prompt specification.",
|
|
16355
16817
|
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec",
|
|
@@ -16899,6 +17361,15 @@
|
|
|
16899
17361
|
"description": "Chunk information.",
|
|
16900
17362
|
"id": "GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo",
|
|
16901
17363
|
"properties": {
|
|
17364
|
+
"blobAttachmentIndexes": {
|
|
17365
|
+
"description": "Output only. Stores indexes of blobattachments linked to this chunk.",
|
|
17366
|
+
"items": {
|
|
17367
|
+
"format": "int64",
|
|
17368
|
+
"type": "string"
|
|
17369
|
+
},
|
|
17370
|
+
"readOnly": true,
|
|
17371
|
+
"type": "array"
|
|
17372
|
+
},
|
|
16902
17373
|
"chunk": {
|
|
16903
17374
|
"description": "Chunk resource name.",
|
|
16904
17375
|
"type": "string"
|
|
@@ -17017,6 +17488,15 @@
|
|
|
17017
17488
|
"description": "Chunk content.",
|
|
17018
17489
|
"id": "GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent",
|
|
17019
17490
|
"properties": {
|
|
17491
|
+
"blobAttachmentIndexes": {
|
|
17492
|
+
"description": "Output only. Stores indexes of blobattachments linked to this chunk.",
|
|
17493
|
+
"items": {
|
|
17494
|
+
"format": "int64",
|
|
17495
|
+
"type": "string"
|
|
17496
|
+
},
|
|
17497
|
+
"readOnly": true,
|
|
17498
|
+
"type": "array"
|
|
17499
|
+
},
|
|
17020
17500
|
"content": {
|
|
17021
17501
|
"description": "Chunk textual content.",
|
|
17022
17502
|
"type": "string"
|
|
@@ -17768,6 +18248,23 @@
|
|
|
17768
18248
|
"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
|
|
17769
18249
|
"type": "string"
|
|
17770
18250
|
},
|
|
18251
|
+
"notebooklmState": {
|
|
18252
|
+
"description": "Output only. Whether the NotebookLM Corpus is ready to be used.",
|
|
18253
|
+
"enum": [
|
|
18254
|
+
"NOTEBOOK_LM_STATE_UNSPECIFIED",
|
|
18255
|
+
"NOTEBOOK_LM_NOT_READY",
|
|
18256
|
+
"NOTEBOOK_LM_READY",
|
|
18257
|
+
"NOTEBOOK_LM_NOT_ENABLED"
|
|
18258
|
+
],
|
|
18259
|
+
"enumDescriptions": [
|
|
18260
|
+
"The NotebookLM state is unknown.",
|
|
18261
|
+
"The NotebookLM is not ready.",
|
|
18262
|
+
"The NotebookLM is ready to be used.",
|
|
18263
|
+
"The NotebookLM is not enabled."
|
|
18264
|
+
],
|
|
18265
|
+
"readOnly": true,
|
|
18266
|
+
"type": "string"
|
|
18267
|
+
},
|
|
17771
18268
|
"singleRegionKeys": {
|
|
17772
18269
|
"description": "Optional. Single-regional CMEKs that are required for some VAIS features.",
|
|
17773
18270
|
"items": {
|
|
@@ -18551,6 +19048,10 @@
|
|
|
18551
19048
|
"description": "DataStore captures global settings and configs at the DataStore level.",
|
|
18552
19049
|
"id": "GoogleCloudDiscoveryengineV1betaDataStore",
|
|
18553
19050
|
"properties": {
|
|
19051
|
+
"aclEnabled": {
|
|
19052
|
+
"description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.",
|
|
19053
|
+
"type": "boolean"
|
|
19054
|
+
},
|
|
18554
19055
|
"advancedSiteSearchConfig": {
|
|
18555
19056
|
"$ref": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig",
|
|
18556
19057
|
"description": "Optional. Configuration for advanced site search."
|
|
@@ -18888,6 +19389,10 @@
|
|
|
18888
19389
|
"description": "Document captures all raw metadata information of items to be recommended or searched.",
|
|
18889
19390
|
"id": "GoogleCloudDiscoveryengineV1betaDocument",
|
|
18890
19391
|
"properties": {
|
|
19392
|
+
"aclInfo": {
|
|
19393
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentAclInfo",
|
|
19394
|
+
"description": "Access control information for the document."
|
|
19395
|
+
},
|
|
18891
19396
|
"content": {
|
|
18892
19397
|
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentContent",
|
|
18893
19398
|
"description": "The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store."
|
|
@@ -18943,6 +19448,38 @@
|
|
|
18943
19448
|
},
|
|
18944
19449
|
"type": "object"
|
|
18945
19450
|
},
|
|
19451
|
+
"GoogleCloudDiscoveryengineV1betaDocumentAclInfo": {
|
|
19452
|
+
"description": "ACL Information of the Document.",
|
|
19453
|
+
"id": "GoogleCloudDiscoveryengineV1betaDocumentAclInfo",
|
|
19454
|
+
"properties": {
|
|
19455
|
+
"readers": {
|
|
19456
|
+
"description": "Readers of the document.",
|
|
19457
|
+
"items": {
|
|
19458
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentAclInfoAccessRestriction"
|
|
19459
|
+
},
|
|
19460
|
+
"type": "array"
|
|
19461
|
+
}
|
|
19462
|
+
},
|
|
19463
|
+
"type": "object"
|
|
19464
|
+
},
|
|
19465
|
+
"GoogleCloudDiscoveryengineV1betaDocumentAclInfoAccessRestriction": {
|
|
19466
|
+
"description": "AclRestriction to model complex inheritance restrictions. Example: Modeling a \"Both Permit\" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { \"acl_info\": { \"readers\": [ { \"principals\": [ { \"group_id\": \"group_1\" }, { \"user_id\": \"user_1\" } ] } ] } } Page_P ACL Restriction. { \"acl_info\": { \"readers\": [ { \"principals\": [ { \"group_id\": \"group_2\" }, { \"group_id\": \"group_3\" }, { \"user_id\": \"user_2\" } ], }, { \"principals\": [ { \"group_id\": \"group_1\" }, { \"user_id\": \"user_1\" } ], } ] } }",
|
|
19467
|
+
"id": "GoogleCloudDiscoveryengineV1betaDocumentAclInfoAccessRestriction",
|
|
19468
|
+
"properties": {
|
|
19469
|
+
"idpWide": {
|
|
19470
|
+
"description": "All users within the Identity Provider.",
|
|
19471
|
+
"type": "boolean"
|
|
19472
|
+
},
|
|
19473
|
+
"principals": {
|
|
19474
|
+
"description": "List of principals.",
|
|
19475
|
+
"items": {
|
|
19476
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaPrincipal"
|
|
19477
|
+
},
|
|
19478
|
+
"type": "array"
|
|
19479
|
+
}
|
|
19480
|
+
},
|
|
19481
|
+
"type": "object"
|
|
19482
|
+
},
|
|
18946
19483
|
"GoogleCloudDiscoveryengineV1betaDocumentContent": {
|
|
18947
19484
|
"description": "Unstructured data linked to this document.",
|
|
18948
19485
|
"id": "GoogleCloudDiscoveryengineV1betaDocumentContent",
|
|
@@ -19108,7 +19645,16 @@
|
|
|
19108
19645
|
"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": {
|
|
19109
19646
|
"description": "The layout parsing configurations for documents.",
|
|
19110
19647
|
"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig",
|
|
19111
|
-
"properties": {
|
|
19648
|
+
"properties": {
|
|
19649
|
+
"enableImageAnnotation": {
|
|
19650
|
+
"description": "Optional. If true, the LLM based annotation is added to the image during parsing.",
|
|
19651
|
+
"type": "boolean"
|
|
19652
|
+
},
|
|
19653
|
+
"enableTableAnnotation": {
|
|
19654
|
+
"description": "Optional. If true, the LLM based annotation is added to the table during parsing.",
|
|
19655
|
+
"type": "boolean"
|
|
19656
|
+
}
|
|
19657
|
+
},
|
|
19112
19658
|
"type": "object"
|
|
19113
19659
|
},
|
|
19114
19660
|
"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": {
|
|
@@ -20276,6 +20822,20 @@
|
|
|
20276
20822
|
},
|
|
20277
20823
|
"type": "object"
|
|
20278
20824
|
},
|
|
20825
|
+
"GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse": {
|
|
20826
|
+
"description": "Response message for CmekConfigService.ListCmekConfigs method.",
|
|
20827
|
+
"id": "GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse",
|
|
20828
|
+
"properties": {
|
|
20829
|
+
"cmekConfigs": {
|
|
20830
|
+
"description": "All the customer's CmekConfigs.",
|
|
20831
|
+
"items": {
|
|
20832
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig"
|
|
20833
|
+
},
|
|
20834
|
+
"type": "array"
|
|
20835
|
+
}
|
|
20836
|
+
},
|
|
20837
|
+
"type": "object"
|
|
20838
|
+
},
|
|
20279
20839
|
"GoogleCloudDiscoveryengineV1betaListControlsResponse": {
|
|
20280
20840
|
"description": "Response for ListControls method.",
|
|
20281
20841
|
"id": "GoogleCloudDiscoveryengineV1betaListControlsResponse",
|
|
@@ -20741,6 +21301,21 @@
|
|
|
20741
21301
|
"properties": {},
|
|
20742
21302
|
"type": "object"
|
|
20743
21303
|
},
|
|
21304
|
+
"GoogleCloudDiscoveryengineV1betaPrincipal": {
|
|
21305
|
+
"description": "Principal identifier of a user or a group.",
|
|
21306
|
+
"id": "GoogleCloudDiscoveryengineV1betaPrincipal",
|
|
21307
|
+
"properties": {
|
|
21308
|
+
"groupId": {
|
|
21309
|
+
"description": "Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.",
|
|
21310
|
+
"type": "string"
|
|
21311
|
+
},
|
|
21312
|
+
"userId": {
|
|
21313
|
+
"description": "User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.",
|
|
21314
|
+
"type": "string"
|
|
21315
|
+
}
|
|
21316
|
+
},
|
|
21317
|
+
"type": "object"
|
|
21318
|
+
},
|
|
20744
21319
|
"GoogleCloudDiscoveryengineV1betaProject": {
|
|
20745
21320
|
"description": "Metadata and configurations for a Google Cloud project in the service.",
|
|
20746
21321
|
"id": "GoogleCloudDiscoveryengineV1betaProject",
|
|
@@ -21692,7 +22267,7 @@
|
|
|
21692
22267
|
"description": "A specification for configuring the behavior of content search."
|
|
21693
22268
|
},
|
|
21694
22269
|
"dataStoreSpecs": {
|
|
21695
|
-
"description": "Specifications that define the specific
|
|
22270
|
+
"description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.",
|
|
21696
22271
|
"items": {
|
|
21697
22272
|
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec"
|
|
21698
22273
|
},
|
|
@@ -21772,13 +22347,13 @@
|
|
|
21772
22347
|
"description": "The query expansion specification that specifies the conditions under which query expansion occurs."
|
|
21773
22348
|
},
|
|
21774
22349
|
"rankingExpression": {
|
|
21775
|
-
"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If
|
|
22350
|
+
"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result",
|
|
21776
22351
|
"type": "string"
|
|
21777
22352
|
},
|
|
21778
22353
|
"rankingExpressionBackend": {
|
|
21779
22354
|
"description": "Optional. The backend to use for the ranking expression evaluation.",
|
|
21780
22355
|
"enum": [
|
|
21781
|
-
"
|
|
22356
|
+
"RANKING_EXPRESSION_BACKEND_UNSPECIFIED",
|
|
21782
22357
|
"BYOE",
|
|
21783
22358
|
"CLEARBOX"
|
|
21784
22359
|
],
|
|
@@ -21862,7 +22437,7 @@
|
|
|
21862
22437
|
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
|
|
21863
22438
|
"properties": {
|
|
21864
22439
|
"conditionBoostSpecs": {
|
|
21865
|
-
"description": "Condition boost specifications. If a document matches multiple conditions in the
|
|
22440
|
+
"description": "Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.",
|
|
21866
22441
|
"items": {
|
|
21867
22442
|
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec"
|
|
21868
22443
|
},
|
|
@@ -22094,6 +22669,10 @@
|
|
|
22094
22669
|
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec",
|
|
22095
22670
|
"description": "If specified, the spec will be used to modify the model specification provided to the LLM."
|
|
22096
22671
|
},
|
|
22672
|
+
"multimodalSpec": {
|
|
22673
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec",
|
|
22674
|
+
"description": "Optional. Multimodal specification."
|
|
22675
|
+
},
|
|
22097
22676
|
"summaryResultCount": {
|
|
22098
22677
|
"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.",
|
|
22099
22678
|
"format": "int32",
|
|
@@ -22128,6 +22707,29 @@
|
|
|
22128
22707
|
},
|
|
22129
22708
|
"type": "object"
|
|
22130
22709
|
},
|
|
22710
|
+
"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec": {
|
|
22711
|
+
"description": "Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.",
|
|
22712
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec",
|
|
22713
|
+
"properties": {
|
|
22714
|
+
"imageSource": {
|
|
22715
|
+
"description": "Optional. Source of image returned in the answer.",
|
|
22716
|
+
"enum": [
|
|
22717
|
+
"IMAGE_SOURCE_UNSPECIFIED",
|
|
22718
|
+
"ALL_AVAILABLE_SOURCES",
|
|
22719
|
+
"CORPUS_IMAGE_ONLY",
|
|
22720
|
+
"FIGURE_GENERATION_ONLY"
|
|
22721
|
+
],
|
|
22722
|
+
"enumDescriptions": [
|
|
22723
|
+
"Unspecified image source (multimodal feature is disabled by default).",
|
|
22724
|
+
"Behavior when service determines the pick from all available sources.",
|
|
22725
|
+
"Includes image from corpus in the answer.",
|
|
22726
|
+
"Triggers figure generation in the answer."
|
|
22727
|
+
],
|
|
22728
|
+
"type": "string"
|
|
22729
|
+
}
|
|
22730
|
+
},
|
|
22731
|
+
"type": "object"
|
|
22732
|
+
},
|
|
22131
22733
|
"GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": {
|
|
22132
22734
|
"description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.",
|
|
22133
22735
|
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec",
|
|
@@ -22958,6 +23560,51 @@
|
|
|
22958
23560
|
},
|
|
22959
23561
|
"type": "object"
|
|
22960
23562
|
},
|
|
23563
|
+
"GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachment": {
|
|
23564
|
+
"description": "Stores binarydata attached to text answer, e.g. image, video, audio, etc.",
|
|
23565
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachment",
|
|
23566
|
+
"properties": {
|
|
23567
|
+
"attributionType": {
|
|
23568
|
+
"description": "Output only. The attribution type of the blob.",
|
|
23569
|
+
"enum": [
|
|
23570
|
+
"ATTRIBUTION_TYPE_UNSPECIFIED",
|
|
23571
|
+
"CORPUS",
|
|
23572
|
+
"GENERATED"
|
|
23573
|
+
],
|
|
23574
|
+
"enumDescriptions": [
|
|
23575
|
+
"Unspecified attribution type.",
|
|
23576
|
+
"The attachment data is from the corpus.",
|
|
23577
|
+
"The attachment data is generated by the model through code generation."
|
|
23578
|
+
],
|
|
23579
|
+
"readOnly": true,
|
|
23580
|
+
"type": "string"
|
|
23581
|
+
},
|
|
23582
|
+
"data": {
|
|
23583
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachmentBlob",
|
|
23584
|
+
"description": "Output only. The blob data.",
|
|
23585
|
+
"readOnly": true
|
|
23586
|
+
}
|
|
23587
|
+
},
|
|
23588
|
+
"type": "object"
|
|
23589
|
+
},
|
|
23590
|
+
"GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachmentBlob": {
|
|
23591
|
+
"description": "Stores type and data of the blob.",
|
|
23592
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachmentBlob",
|
|
23593
|
+
"properties": {
|
|
23594
|
+
"data": {
|
|
23595
|
+
"description": "Output only. Raw bytes.",
|
|
23596
|
+
"format": "byte",
|
|
23597
|
+
"readOnly": true,
|
|
23598
|
+
"type": "string"
|
|
23599
|
+
},
|
|
23600
|
+
"mimeType": {
|
|
23601
|
+
"description": "Output only. The media type (MIME type) of the generated data.",
|
|
23602
|
+
"readOnly": true,
|
|
23603
|
+
"type": "string"
|
|
23604
|
+
}
|
|
23605
|
+
},
|
|
23606
|
+
"type": "object"
|
|
23607
|
+
},
|
|
22961
23608
|
"GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation": {
|
|
22962
23609
|
"description": "Citation info for a segment.",
|
|
22963
23610
|
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation",
|
|
@@ -23038,6 +23685,15 @@
|
|
|
23038
23685
|
"description": "Chunk content.",
|
|
23039
23686
|
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent",
|
|
23040
23687
|
"properties": {
|
|
23688
|
+
"blobAttachmentIndexes": {
|
|
23689
|
+
"description": "Output only. Stores indexes of blobattachments linked to this chunk.",
|
|
23690
|
+
"items": {
|
|
23691
|
+
"format": "int64",
|
|
23692
|
+
"type": "string"
|
|
23693
|
+
},
|
|
23694
|
+
"readOnly": true,
|
|
23695
|
+
"type": "array"
|
|
23696
|
+
},
|
|
23041
23697
|
"content": {
|
|
23042
23698
|
"description": "Chunk textual content.",
|
|
23043
23699
|
"type": "string"
|
|
@@ -23075,6 +23731,14 @@
|
|
|
23075
23731
|
"description": "Summary with metadata information.",
|
|
23076
23732
|
"id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata",
|
|
23077
23733
|
"properties": {
|
|
23734
|
+
"blobAttachments": {
|
|
23735
|
+
"description": "Output only. Store multimodal data for answer enhancement.",
|
|
23736
|
+
"items": {
|
|
23737
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachment"
|
|
23738
|
+
},
|
|
23739
|
+
"readOnly": true,
|
|
23740
|
+
"type": "array"
|
|
23741
|
+
},
|
|
23078
23742
|
"citationMetadata": {
|
|
23079
23743
|
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata",
|
|
23080
23744
|
"description": "Citation metadata for given summary."
|
|
@@ -23977,6 +24641,10 @@
|
|
|
23977
24641
|
"description": "Information of an end user.",
|
|
23978
24642
|
"id": "GoogleCloudDiscoveryengineV1betaUserInfo",
|
|
23979
24643
|
"properties": {
|
|
24644
|
+
"timeZone": {
|
|
24645
|
+
"description": "Optional. IANA time zone, e.g. Europe/Budapest.",
|
|
24646
|
+
"type": "string"
|
|
24647
|
+
},
|
|
23980
24648
|
"userAgent": {
|
|
23981
24649
|
"description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.",
|
|
23982
24650
|
"type": "string"
|