google-api-python-client 2.165.0__py2.py3-none-any.whl → 2.166.0__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (93) hide show
  1. {google_api_python_client-2.165.0.dist-info → google_api_python_client-2.166.0.dist-info}/METADATA +1 -1
  2. {google_api_python_client-2.165.0.dist-info → google_api_python_client-2.166.0.dist-info}/RECORD +93 -92
  3. googleapiclient/discovery_cache/documents/addressvalidation.v1.json +8 -8
  4. googleapiclient/discovery_cache/documents/adsense.v2.json +7 -7
  5. googleapiclient/discovery_cache/documents/aiplatform.v1.json +22 -3
  6. googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +217 -3
  7. googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +79 -1
  8. googleapiclient/discovery_cache/documents/alloydb.v1beta.json +79 -1
  9. googleapiclient/discovery_cache/documents/analyticshub.v1.json +7 -2
  10. googleapiclient/discovery_cache/documents/androidpublisher.v3.json +2 -2
  11. googleapiclient/discovery_cache/documents/apigee.v1.json +442 -1
  12. googleapiclient/discovery_cache/documents/backupdr.v1.json +2 -2
  13. googleapiclient/discovery_cache/documents/bigquery.v2.json +9 -1
  14. googleapiclient/discovery_cache/documents/bigquerydatapolicy.v1.json +2 -2
  15. googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +5 -1
  16. googleapiclient/discovery_cache/documents/chat.v1.json +7 -3
  17. googleapiclient/discovery_cache/documents/civicinfo.v2.json +267 -267
  18. googleapiclient/discovery_cache/documents/cloudchannel.v1.json +8 -8
  19. googleapiclient/discovery_cache/documents/compute.alpha.json +1454 -456
  20. googleapiclient/discovery_cache/documents/compute.beta.json +44 -16
  21. googleapiclient/discovery_cache/documents/compute.v1.json +43 -15
  22. googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +69 -1
  23. googleapiclient/discovery_cache/documents/container.v1.json +369 -10
  24. googleapiclient/discovery_cache/documents/container.v1beta1.json +31 -10
  25. googleapiclient/discovery_cache/documents/datacatalog.v1.json +2 -2
  26. googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json +2 -2
  27. googleapiclient/discovery_cache/documents/dataform.v1beta1.json +5 -5
  28. googleapiclient/discovery_cache/documents/dataplex.v1.json +57 -15
  29. googleapiclient/discovery_cache/documents/dataproc.v1.json +347 -5
  30. googleapiclient/discovery_cache/documents/datastream.v1.json +21 -1
  31. googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +70 -1
  32. googleapiclient/discovery_cache/documents/discoveryengine.v1.json +417 -11
  33. googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +319 -10
  34. googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +573 -10
  35. googleapiclient/discovery_cache/documents/displayvideo.v2.json +1 -3
  36. googleapiclient/discovery_cache/documents/displayvideo.v3.json +254 -55
  37. googleapiclient/discovery_cache/documents/displayvideo.v4.json +197 -45
  38. googleapiclient/discovery_cache/documents/documentai.v1.json +14 -8
  39. googleapiclient/discovery_cache/documents/documentai.v1beta3.json +18 -8
  40. googleapiclient/discovery_cache/documents/firebase.v1beta1.json +2 -2
  41. googleapiclient/discovery_cache/documents/gkebackup.v1.json +7 -1
  42. googleapiclient/discovery_cache/documents/gkehub.v1.json +11 -1
  43. googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +11 -1
  44. googleapiclient/discovery_cache/documents/gkehub.v1beta.json +11 -1
  45. googleapiclient/discovery_cache/documents/gkehub.v2.json +11 -1
  46. googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +11 -1
  47. googleapiclient/discovery_cache/documents/gkehub.v2beta.json +11 -1
  48. googleapiclient/discovery_cache/documents/iam.v1.json +3 -3
  49. googleapiclient/discovery_cache/documents/integrations.v1.json +14 -1
  50. googleapiclient/discovery_cache/documents/managedkafka.v1.json +730 -1
  51. googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +10 -10
  52. googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +40 -1
  53. googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +3 -3
  54. googleapiclient/discovery_cache/documents/monitoring.v3.json +5 -1
  55. googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json +8 -8
  56. googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +8 -8
  57. googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json +8 -8
  58. googleapiclient/discovery_cache/documents/netapp.v1.json +2 -2
  59. googleapiclient/discovery_cache/documents/netapp.v1beta1.json +16 -2
  60. googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +17 -1
  61. googleapiclient/discovery_cache/documents/networkservices.v1.json +80 -6
  62. googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +84 -6
  63. googleapiclient/discovery_cache/documents/notebooks.v2.json +6 -1
  64. googleapiclient/discovery_cache/documents/observability.v1.json +588 -0
  65. googleapiclient/discovery_cache/documents/oracledatabase.v1.json +103 -1
  66. googleapiclient/discovery_cache/documents/oslogin.v1.json +2 -2
  67. googleapiclient/discovery_cache/documents/oslogin.v1alpha.json +2 -2
  68. googleapiclient/discovery_cache/documents/oslogin.v1beta.json +2 -2
  69. googleapiclient/discovery_cache/documents/places.v1.json +13 -13
  70. googleapiclient/discovery_cache/documents/pubsub.v1.json +7 -2
  71. googleapiclient/discovery_cache/documents/retail.v2.json +2 -2
  72. googleapiclient/discovery_cache/documents/retail.v2alpha.json +2 -2
  73. googleapiclient/discovery_cache/documents/retail.v2beta.json +2 -2
  74. googleapiclient/discovery_cache/documents/run.v2.json +10 -2
  75. googleapiclient/discovery_cache/documents/securitycenter.v1.json +53 -9
  76. googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +53 -9
  77. googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +53 -9
  78. googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +2 -2
  79. googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +2 -2
  80. googleapiclient/discovery_cache/documents/servicenetworking.v1.json +3 -3
  81. googleapiclient/discovery_cache/documents/serviceusage.v1.json +2 -2
  82. googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +2 -2
  83. googleapiclient/discovery_cache/documents/storage.v1.json +117 -2
  84. googleapiclient/discovery_cache/documents/sts.v1.json +166 -1
  85. googleapiclient/discovery_cache/documents/sts.v1beta.json +166 -1
  86. googleapiclient/discovery_cache/documents/tasks.v1.json +4 -4
  87. googleapiclient/discovery_cache/documents/verifiedaccess.v2.json +3 -2
  88. googleapiclient/discovery_cache/documents/workstations.v1.json +6 -6
  89. googleapiclient/discovery_cache/documents/workstations.v1beta.json +7 -7
  90. googleapiclient/version.py +1 -1
  91. {google_api_python_client-2.165.0.dist-info → google_api_python_client-2.166.0.dist-info}/LICENSE +0 -0
  92. {google_api_python_client-2.165.0.dist-info → google_api_python_client-2.166.0.dist-info}/WHEEL +0 -0
  93. {google_api_python_client-2.165.0.dist-info → google_api_python_client-2.166.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": "20250312",
7928
+ "revision": "20250320",
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."
@@ -10442,6 +10666,10 @@
10442
10666
  "description": "Output only. The connector contains the necessary parameters and is configured to support actions.",
10443
10667
  "readOnly": true,
10444
10668
  "type": "boolean"
10669
+ },
10670
+ "serviceName": {
10671
+ "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.",
10672
+ "type": "string"
10445
10673
  }
10446
10674
  },
10447
10675
  "type": "object"
@@ -10543,6 +10771,13 @@
10543
10771
  "description": "The textual answer.",
10544
10772
  "type": "string"
10545
10773
  },
10774
+ "blobAttachments": {
10775
+ "description": "List of blob attachments in the answer.",
10776
+ "items": {
10777
+ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment"
10778
+ },
10779
+ "type": "array"
10780
+ },
10546
10781
  "citations": {
10547
10782
  "description": "Citations.",
10548
10783
  "items": {
@@ -10631,6 +10866,51 @@
10631
10866
  },
10632
10867
  "type": "object"
10633
10868
  },
10869
+ "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment": {
10870
+ "description": "Stores binarydata attached to text answer, e.g. image, video, audio, etc.",
10871
+ "id": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment",
10872
+ "properties": {
10873
+ "attributionType": {
10874
+ "description": "Output only. The attribution type of the blob.",
10875
+ "enum": [
10876
+ "ATTRIBUTION_TYPE_UNSPECIFIED",
10877
+ "CORPUS",
10878
+ "GENERATED"
10879
+ ],
10880
+ "enumDescriptions": [
10881
+ "Unspecified attribution type.",
10882
+ "The attachment data is from the corpus.",
10883
+ "The attachment data is generated by the model through code generation."
10884
+ ],
10885
+ "readOnly": true,
10886
+ "type": "string"
10887
+ },
10888
+ "data": {
10889
+ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob",
10890
+ "description": "Output only. The mime type and data of the blob.",
10891
+ "readOnly": true
10892
+ }
10893
+ },
10894
+ "type": "object"
10895
+ },
10896
+ "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob": {
10897
+ "description": "The media type and data of the blob.",
10898
+ "id": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob",
10899
+ "properties": {
10900
+ "data": {
10901
+ "description": "Output only. Raw bytes.",
10902
+ "format": "byte",
10903
+ "readOnly": true,
10904
+ "type": "string"
10905
+ },
10906
+ "mimeType": {
10907
+ "description": "Output only. The media type (MIME type) of the generated or retrieved data.",
10908
+ "readOnly": true,
10909
+ "type": "string"
10910
+ }
10911
+ },
10912
+ "type": "object"
10913
+ },
10634
10914
  "GoogleCloudDiscoveryengineV1alphaAnswerCitation": {
10635
10915
  "description": "Citation info for a segment.",
10636
10916
  "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation",
@@ -10765,6 +11045,15 @@
10765
11045
  "description": "Chunk information.",
10766
11046
  "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo",
10767
11047
  "properties": {
11048
+ "blobAttachmentIndexes": {
11049
+ "description": "Output only. Stores indexes of blobattachments linked to this chunk.",
11050
+ "items": {
11051
+ "format": "int64",
11052
+ "type": "string"
11053
+ },
11054
+ "readOnly": true,
11055
+ "type": "array"
11056
+ },
10768
11057
  "chunk": {
10769
11058
  "description": "Chunk resource name.",
10770
11059
  "type": "string"
@@ -10883,6 +11172,15 @@
10883
11172
  "description": "Chunk content.",
10884
11173
  "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent",
10885
11174
  "properties": {
11175
+ "blobAttachmentIndexes": {
11176
+ "description": "Output only. Stores indexes of blobattachments linked to this chunk.",
11177
+ "items": {
11178
+ "format": "int64",
11179
+ "type": "string"
11180
+ },
11181
+ "readOnly": true,
11182
+ "type": "array"
11183
+ },
10886
11184
  "content": {
10887
11185
  "description": "Chunk textual content.",
10888
11186
  "type": "string"
@@ -11134,6 +11432,23 @@
11134
11432
  "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
11135
11433
  "type": "string"
11136
11434
  },
11435
+ "notebooklmState": {
11436
+ "description": "Output only. Whether the NotebookLM Corpus is ready to be used.",
11437
+ "enum": [
11438
+ "NOTEBOOK_LM_STATE_UNSPECIFIED",
11439
+ "NOTEBOOK_LM_NOT_READY",
11440
+ "NOTEBOOK_LM_READY",
11441
+ "NOTEBOOK_LM_NOT_ENABLED"
11442
+ ],
11443
+ "enumDescriptions": [
11444
+ "The NotebookLM state is unknown.",
11445
+ "The NotebookLM is not ready.",
11446
+ "The NotebookLM is ready to be used.",
11447
+ "The NotebookLM is not enabled."
11448
+ ],
11449
+ "readOnly": true,
11450
+ "type": "string"
11451
+ },
11137
11452
  "singleRegionKeys": {
11138
11453
  "description": "Optional. Single-regional CMEKs that are required for some VAIS features.",
11139
11454
  "items": {
@@ -14435,7 +14750,7 @@
14435
14750
  "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec."
14436
14751
  },
14437
14752
  "dataStoreSpecs": {
14438
- "description": "Specifications that define the specific [DataStore]s 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.",
14753
+ "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
14754
  "items": {
14440
14755
  "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec"
14441
14756
  },
@@ -14515,13 +14830,13 @@
14515
14830
  "description": "The query expansion specification that specifies the conditions under which query expansion occurs."
14516
14831
  },
14517
14832
  "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 ranking expression is not provided or set to BYOE, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result",
14833
+ "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
14834
  "type": "string"
14520
14835
  },
14521
14836
  "rankingExpressionBackend": {
14522
14837
  "description": "Optional. The backend to use for the ranking expression evaluation.",
14523
14838
  "enum": [
14524
- "UNKNOWN",
14839
+ "RANKING_EXPRESSION_BACKEND_UNSPECIFIED",
14525
14840
  "BYOE",
14526
14841
  "CLEARBOX"
14527
14842
  ],
@@ -14605,7 +14920,7 @@
14605
14920
  "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec",
14606
14921
  "properties": {
14607
14922
  "conditionBoostSpecs": {
14608
- "description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.",
14923
+ "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
14924
  "items": {
14610
14925
  "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec"
14611
14926
  },
@@ -14837,6 +15152,10 @@
14837
15152
  "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec",
14838
15153
  "description": "If specified, the spec will be used to modify the model specification provided to the LLM."
14839
15154
  },
15155
+ "multimodalSpec": {
15156
+ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec",
15157
+ "description": "Optional. Multimodal specification."
15158
+ },
14840
15159
  "summaryResultCount": {
14841
15160
  "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
15161
  "format": "int32",
@@ -14871,6 +15190,29 @@
14871
15190
  },
14872
15191
  "type": "object"
14873
15192
  },
15193
+ "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec": {
15194
+ "description": "Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.",
15195
+ "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec",
15196
+ "properties": {
15197
+ "imageSource": {
15198
+ "description": "Optional. Source of image returned in the answer.",
15199
+ "enum": [
15200
+ "IMAGE_SOURCE_UNSPECIFIED",
15201
+ "ALL_AVAILABLE_SOURCES",
15202
+ "CORPUS_IMAGE_ONLY",
15203
+ "FIGURE_GENERATION_ONLY"
15204
+ ],
15205
+ "enumDescriptions": [
15206
+ "Unspecified image source (multimodal feature is disabled by default).",
15207
+ "Behavior when service determines the pick from all available sources.",
15208
+ "Includes image from corpus in the answer.",
15209
+ "Triggers figure generation in the answer."
15210
+ ],
15211
+ "type": "string"
15212
+ }
15213
+ },
15214
+ "type": "object"
15215
+ },
14874
15216
  "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": {
14875
15217
  "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
15218
  "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec",
@@ -15761,7 +16103,7 @@
15761
16103
  "id": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpec",
15762
16104
  "properties": {
15763
16105
  "conditionBoostSpecs": {
15764
- "description": "Condition boost specifications. If a suggestion matches multiple conditions in the specifictions, 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.",
16106
+ "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
16107
  "items": {
15766
16108
  "$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpecConditionBoostSpec"
15767
16109
  },
@@ -16085,6 +16427,13 @@
16085
16427
  "description": "The textual answer.",
16086
16428
  "type": "string"
16087
16429
  },
16430
+ "blobAttachments": {
16431
+ "description": "List of blob attachments in the answer.",
16432
+ "items": {
16433
+ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerBlobAttachment"
16434
+ },
16435
+ "type": "array"
16436
+ },
16088
16437
  "citations": {
16089
16438
  "description": "Citations.",
16090
16439
  "items": {
@@ -16173,6 +16522,51 @@
16173
16522
  },
16174
16523
  "type": "object"
16175
16524
  },
16525
+ "GoogleCloudDiscoveryengineV1betaAnswerBlobAttachment": {
16526
+ "description": "Stores binarydata attached to text answer, e.g. image, video, audio, etc.",
16527
+ "id": "GoogleCloudDiscoveryengineV1betaAnswerBlobAttachment",
16528
+ "properties": {
16529
+ "attributionType": {
16530
+ "description": "Output only. The attribution type of the blob.",
16531
+ "enum": [
16532
+ "ATTRIBUTION_TYPE_UNSPECIFIED",
16533
+ "CORPUS",
16534
+ "GENERATED"
16535
+ ],
16536
+ "enumDescriptions": [
16537
+ "Unspecified attribution type.",
16538
+ "The attachment data is from the corpus.",
16539
+ "The attachment data is generated by the model through code generation."
16540
+ ],
16541
+ "readOnly": true,
16542
+ "type": "string"
16543
+ },
16544
+ "data": {
16545
+ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerBlobAttachmentBlob",
16546
+ "description": "Output only. The mime type and data of the blob.",
16547
+ "readOnly": true
16548
+ }
16549
+ },
16550
+ "type": "object"
16551
+ },
16552
+ "GoogleCloudDiscoveryengineV1betaAnswerBlobAttachmentBlob": {
16553
+ "description": "The media type and data of the blob.",
16554
+ "id": "GoogleCloudDiscoveryengineV1betaAnswerBlobAttachmentBlob",
16555
+ "properties": {
16556
+ "data": {
16557
+ "description": "Output only. Raw bytes.",
16558
+ "format": "byte",
16559
+ "readOnly": true,
16560
+ "type": "string"
16561
+ },
16562
+ "mimeType": {
16563
+ "description": "Output only. The media type (MIME type) of the generated or retrieved data.",
16564
+ "readOnly": true,
16565
+ "type": "string"
16566
+ }
16567
+ },
16568
+ "type": "object"
16569
+ },
16176
16570
  "GoogleCloudDiscoveryengineV1betaAnswerCitation": {
16177
16571
  "description": "Citation info for a segment.",
16178
16572
  "id": "GoogleCloudDiscoveryengineV1betaAnswerCitation",
@@ -16332,6 +16726,10 @@
16332
16726
  "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec",
16333
16727
  "description": "Answer generation model specification."
16334
16728
  },
16729
+ "multimodalSpec": {
16730
+ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecMultimodalSpec",
16731
+ "description": "Optional. Multimodal specification."
16732
+ },
16335
16733
  "promptSpec": {
16336
16734
  "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec",
16337
16735
  "description": "Answer generation prompt specification."
@@ -16350,6 +16748,29 @@
16350
16748
  },
16351
16749
  "type": "object"
16352
16750
  },
16751
+ "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecMultimodalSpec": {
16752
+ "description": "Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.",
16753
+ "id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecMultimodalSpec",
16754
+ "properties": {
16755
+ "imageSource": {
16756
+ "description": "Optional. Source of image returned in the answer.",
16757
+ "enum": [
16758
+ "IMAGE_SOURCE_UNSPECIFIED",
16759
+ "ALL_AVAILABLE_SOURCES",
16760
+ "CORPUS_IMAGE_ONLY",
16761
+ "FIGURE_GENERATION_ONLY"
16762
+ ],
16763
+ "enumDescriptions": [
16764
+ "Unspecified image source (multimodal feature is disabled by default).",
16765
+ "Behavior when service determines the pick from all available sources.",
16766
+ "Includes image from corpus in the answer.",
16767
+ "Triggers figure generation in the answer."
16768
+ ],
16769
+ "type": "string"
16770
+ }
16771
+ },
16772
+ "type": "object"
16773
+ },
16353
16774
  "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec": {
16354
16775
  "description": "Answer generation prompt specification.",
16355
16776
  "id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec",
@@ -16899,6 +17320,15 @@
16899
17320
  "description": "Chunk information.",
16900
17321
  "id": "GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo",
16901
17322
  "properties": {
17323
+ "blobAttachmentIndexes": {
17324
+ "description": "Output only. Stores indexes of blobattachments linked to this chunk.",
17325
+ "items": {
17326
+ "format": "int64",
17327
+ "type": "string"
17328
+ },
17329
+ "readOnly": true,
17330
+ "type": "array"
17331
+ },
16902
17332
  "chunk": {
16903
17333
  "description": "Chunk resource name.",
16904
17334
  "type": "string"
@@ -17017,6 +17447,15 @@
17017
17447
  "description": "Chunk content.",
17018
17448
  "id": "GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent",
17019
17449
  "properties": {
17450
+ "blobAttachmentIndexes": {
17451
+ "description": "Output only. Stores indexes of blobattachments linked to this chunk.",
17452
+ "items": {
17453
+ "format": "int64",
17454
+ "type": "string"
17455
+ },
17456
+ "readOnly": true,
17457
+ "type": "array"
17458
+ },
17020
17459
  "content": {
17021
17460
  "description": "Chunk textual content.",
17022
17461
  "type": "string"
@@ -17768,6 +18207,23 @@
17768
18207
  "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
17769
18208
  "type": "string"
17770
18209
  },
18210
+ "notebooklmState": {
18211
+ "description": "Output only. Whether the NotebookLM Corpus is ready to be used.",
18212
+ "enum": [
18213
+ "NOTEBOOK_LM_STATE_UNSPECIFIED",
18214
+ "NOTEBOOK_LM_NOT_READY",
18215
+ "NOTEBOOK_LM_READY",
18216
+ "NOTEBOOK_LM_NOT_ENABLED"
18217
+ ],
18218
+ "enumDescriptions": [
18219
+ "The NotebookLM state is unknown.",
18220
+ "The NotebookLM is not ready.",
18221
+ "The NotebookLM is ready to be used.",
18222
+ "The NotebookLM is not enabled."
18223
+ ],
18224
+ "readOnly": true,
18225
+ "type": "string"
18226
+ },
17771
18227
  "singleRegionKeys": {
17772
18228
  "description": "Optional. Single-regional CMEKs that are required for some VAIS features.",
17773
18229
  "items": {
@@ -18551,6 +19007,10 @@
18551
19007
  "description": "DataStore captures global settings and configs at the DataStore level.",
18552
19008
  "id": "GoogleCloudDiscoveryengineV1betaDataStore",
18553
19009
  "properties": {
19010
+ "aclEnabled": {
19011
+ "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.",
19012
+ "type": "boolean"
19013
+ },
18554
19014
  "advancedSiteSearchConfig": {
18555
19015
  "$ref": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig",
18556
19016
  "description": "Optional. Configuration for advanced site search."
@@ -20276,6 +20736,20 @@
20276
20736
  },
20277
20737
  "type": "object"
20278
20738
  },
20739
+ "GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse": {
20740
+ "description": "Response message for CmekConfigService.ListCmekConfigs method.",
20741
+ "id": "GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse",
20742
+ "properties": {
20743
+ "cmekConfigs": {
20744
+ "description": "All the customer's CmekConfigs.",
20745
+ "items": {
20746
+ "$ref": "GoogleCloudDiscoveryengineV1betaCmekConfig"
20747
+ },
20748
+ "type": "array"
20749
+ }
20750
+ },
20751
+ "type": "object"
20752
+ },
20279
20753
  "GoogleCloudDiscoveryengineV1betaListControlsResponse": {
20280
20754
  "description": "Response for ListControls method.",
20281
20755
  "id": "GoogleCloudDiscoveryengineV1betaListControlsResponse",
@@ -21692,7 +22166,7 @@
21692
22166
  "description": "A specification for configuring the behavior of content search."
21693
22167
  },
21694
22168
  "dataStoreSpecs": {
21695
- "description": "Specifications that define the specific [DataStore]s 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.",
22169
+ "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
22170
  "items": {
21697
22171
  "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec"
21698
22172
  },
@@ -21772,13 +22246,13 @@
21772
22246
  "description": "The query expansion specification that specifies the conditions under which query expansion occurs."
21773
22247
  },
21774
22248
  "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 ranking expression is not provided or set to BYOE, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result",
22249
+ "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
22250
  "type": "string"
21777
22251
  },
21778
22252
  "rankingExpressionBackend": {
21779
22253
  "description": "Optional. The backend to use for the ranking expression evaluation.",
21780
22254
  "enum": [
21781
- "UNKNOWN",
22255
+ "RANKING_EXPRESSION_BACKEND_UNSPECIFIED",
21782
22256
  "BYOE",
21783
22257
  "CLEARBOX"
21784
22258
  ],
@@ -21862,7 +22336,7 @@
21862
22336
  "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
21863
22337
  "properties": {
21864
22338
  "conditionBoostSpecs": {
21865
- "description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.",
22339
+ "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
22340
  "items": {
21867
22341
  "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec"
21868
22342
  },
@@ -22094,6 +22568,10 @@
22094
22568
  "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec",
22095
22569
  "description": "If specified, the spec will be used to modify the model specification provided to the LLM."
22096
22570
  },
22571
+ "multimodalSpec": {
22572
+ "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec",
22573
+ "description": "Optional. Multimodal specification."
22574
+ },
22097
22575
  "summaryResultCount": {
22098
22576
  "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
22577
  "format": "int32",
@@ -22128,6 +22606,29 @@
22128
22606
  },
22129
22607
  "type": "object"
22130
22608
  },
22609
+ "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec": {
22610
+ "description": "Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.",
22611
+ "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec",
22612
+ "properties": {
22613
+ "imageSource": {
22614
+ "description": "Optional. Source of image returned in the answer.",
22615
+ "enum": [
22616
+ "IMAGE_SOURCE_UNSPECIFIED",
22617
+ "ALL_AVAILABLE_SOURCES",
22618
+ "CORPUS_IMAGE_ONLY",
22619
+ "FIGURE_GENERATION_ONLY"
22620
+ ],
22621
+ "enumDescriptions": [
22622
+ "Unspecified image source (multimodal feature is disabled by default).",
22623
+ "Behavior when service determines the pick from all available sources.",
22624
+ "Includes image from corpus in the answer.",
22625
+ "Triggers figure generation in the answer."
22626
+ ],
22627
+ "type": "string"
22628
+ }
22629
+ },
22630
+ "type": "object"
22631
+ },
22131
22632
  "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": {
22132
22633
  "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
22634
  "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec",
@@ -22958,6 +23459,51 @@
22958
23459
  },
22959
23460
  "type": "object"
22960
23461
  },
23462
+ "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachment": {
23463
+ "description": "Stores binarydata attached to text answer, e.g. image, video, audio, etc.",
23464
+ "id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachment",
23465
+ "properties": {
23466
+ "attributionType": {
23467
+ "description": "Output only. The attribution type of the blob.",
23468
+ "enum": [
23469
+ "ATTRIBUTION_TYPE_UNSPECIFIED",
23470
+ "CORPUS",
23471
+ "GENERATED"
23472
+ ],
23473
+ "enumDescriptions": [
23474
+ "Unspecified attribution type.",
23475
+ "The attachment data is from the corpus.",
23476
+ "The attachment data is generated by the model through code generation."
23477
+ ],
23478
+ "readOnly": true,
23479
+ "type": "string"
23480
+ },
23481
+ "data": {
23482
+ "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachmentBlob",
23483
+ "description": "Output only. The blob data.",
23484
+ "readOnly": true
23485
+ }
23486
+ },
23487
+ "type": "object"
23488
+ },
23489
+ "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachmentBlob": {
23490
+ "description": "Stores type and data of the blob.",
23491
+ "id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachmentBlob",
23492
+ "properties": {
23493
+ "data": {
23494
+ "description": "Output only. Raw bytes.",
23495
+ "format": "byte",
23496
+ "readOnly": true,
23497
+ "type": "string"
23498
+ },
23499
+ "mimeType": {
23500
+ "description": "Output only. The media type (MIME type) of the generated data.",
23501
+ "readOnly": true,
23502
+ "type": "string"
23503
+ }
23504
+ },
23505
+ "type": "object"
23506
+ },
22961
23507
  "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation": {
22962
23508
  "description": "Citation info for a segment.",
22963
23509
  "id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation",
@@ -23038,6 +23584,15 @@
23038
23584
  "description": "Chunk content.",
23039
23585
  "id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent",
23040
23586
  "properties": {
23587
+ "blobAttachmentIndexes": {
23588
+ "description": "Output only. Stores indexes of blobattachments linked to this chunk.",
23589
+ "items": {
23590
+ "format": "int64",
23591
+ "type": "string"
23592
+ },
23593
+ "readOnly": true,
23594
+ "type": "array"
23595
+ },
23041
23596
  "content": {
23042
23597
  "description": "Chunk textual content.",
23043
23598
  "type": "string"
@@ -23075,6 +23630,14 @@
23075
23630
  "description": "Summary with metadata information.",
23076
23631
  "id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata",
23077
23632
  "properties": {
23633
+ "blobAttachments": {
23634
+ "description": "Output only. Store multimodal data for answer enhancement.",
23635
+ "items": {
23636
+ "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryBlobAttachment"
23637
+ },
23638
+ "readOnly": true,
23639
+ "type": "array"
23640
+ },
23078
23641
  "citationMetadata": {
23079
23642
  "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata",
23080
23643
  "description": "Citation metadata for given summary."