google-api-python-client 2.161.0__py2.py3-none-any.whl → 2.163.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.161.0.dist-info → google_api_python_client-2.163.0.dist-info}/METADATA +1 -1
- {google_api_python_client-2.161.0.dist-info → google_api_python_client-2.163.0.dist-info}/RECORD +205 -205
- googleapiclient/discovery_cache/documents/accessapproval.v1.json +7 -3
- googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +2 -2
- googleapiclient/discovery_cache/documents/admin.directory_v1.json +3 -3
- googleapiclient/discovery_cache/documents/admin.directoryv1.json +3 -3
- googleapiclient/discovery_cache/documents/adsense.v2.json +123 -4
- googleapiclient/discovery_cache/documents/aiplatform.v1.json +217 -13
- googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +288 -29
- googleapiclient/discovery_cache/documents/alloydb.v1.json +576 -12
- googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +468 -12
- googleapiclient/discovery_cache/documents/alloydb.v1beta.json +492 -12
- googleapiclient/discovery_cache/documents/analyticshub.v1.json +19 -6
- googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +6 -1
- googleapiclient/discovery_cache/documents/androidenterprise.v1.json +29 -1
- googleapiclient/discovery_cache/documents/androidmanagement.v1.json +46 -1
- googleapiclient/discovery_cache/documents/androidpublisher.v3.json +5 -1
- googleapiclient/discovery_cache/documents/apigee.v1.json +28 -4
- googleapiclient/discovery_cache/documents/appengine.v1.json +3 -3
- googleapiclient/discovery_cache/documents/appengine.v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/areainsights.v1.json +8 -8
- googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +2 -2
- googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/backupdr.v1.json +3 -3
- googleapiclient/discovery_cache/documents/beyondcorp.v1.json +5 -3
- googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +11 -7
- googleapiclient/discovery_cache/documents/bigquery.v2.json +62 -13
- googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +57 -1
- googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +104 -1
- googleapiclient/discovery_cache/documents/certificatemanager.v1.json +5 -3
- googleapiclient/discovery_cache/documents/chat.v1.json +51 -13
- googleapiclient/discovery_cache/documents/chromemanagement.v1.json +69 -1
- googleapiclient/discovery_cache/documents/cloudasset.v1.json +7 -7
- googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +4 -4
- googleapiclient/discovery_cache/documents/cloudbuild.v1.json +70 -1
- googleapiclient/discovery_cache/documents/cloudbuild.v2.json +25 -1
- googleapiclient/discovery_cache/documents/clouddeploy.v1.json +8 -8
- googleapiclient/discovery_cache/documents/cloudkms.v1.json +76 -10
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +2 -2
- googleapiclient/discovery_cache/documents/composer.v1.json +2 -2
- googleapiclient/discovery_cache/documents/composer.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/compute.alpha.json +3412 -296
- googleapiclient/discovery_cache/documents/compute.beta.json +1452 -40
- googleapiclient/discovery_cache/documents/compute.v1.json +1098 -12
- googleapiclient/discovery_cache/documents/config.v1.json +2 -2
- googleapiclient/discovery_cache/documents/connectors.v1.json +11 -3
- googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +1 -5
- googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +97 -17
- googleapiclient/discovery_cache/documents/container.v1.json +34 -11
- googleapiclient/discovery_cache/documents/container.v1beta1.json +41 -13
- googleapiclient/discovery_cache/documents/containeranalysis.v1.json +71 -2
- googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +70 -1
- googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +70 -1
- googleapiclient/discovery_cache/documents/css.v1.json +5 -5
- googleapiclient/discovery_cache/documents/datacatalog.v1.json +58 -4
- googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json +46 -4
- googleapiclient/discovery_cache/documents/dataform.v1beta1.json +115 -8
- googleapiclient/discovery_cache/documents/datafusion.v1.json +22 -2
- googleapiclient/discovery_cache/documents/datafusion.v1beta1.json +22 -2
- googleapiclient/discovery_cache/documents/datalineage.v1.json +3 -3
- googleapiclient/discovery_cache/documents/datamigration.v1.json +58 -10
- googleapiclient/discovery_cache/documents/dataplex.v1.json +73 -10
- googleapiclient/discovery_cache/documents/dataportability.v1.json +140 -1
- googleapiclient/discovery_cache/documents/dataportability.v1beta.json +140 -1
- googleapiclient/discovery_cache/documents/dataproc.v1.json +95 -1
- googleapiclient/discovery_cache/documents/datastore.v1.json +2 -2
- googleapiclient/discovery_cache/documents/datastore.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/datastore.v1beta3.json +2 -2
- googleapiclient/discovery_cache/documents/datastream.v1.json +212 -2
- googleapiclient/discovery_cache/documents/dfareporting.v4.json +9 -5
- googleapiclient/discovery_cache/documents/dialogflow.v2.json +21 -23
- googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +350 -21
- googleapiclient/discovery_cache/documents/dialogflow.v3.json +14 -14
- googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +14 -14
- googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +105 -1
- googleapiclient/discovery_cache/documents/discoveryengine.v1.json +732 -91
- googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +9493 -7537
- googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +755 -68
- googleapiclient/discovery_cache/documents/displayvideo.v2.json +93 -93
- googleapiclient/discovery_cache/documents/displayvideo.v3.json +120 -188
- googleapiclient/discovery_cache/documents/displayvideo.v4.json +21293 -106
- googleapiclient/discovery_cache/documents/dlp.v2.json +212 -6
- googleapiclient/discovery_cache/documents/docs.v1.json +5 -5
- googleapiclient/discovery_cache/documents/documentai.v1beta3.json +3 -3
- googleapiclient/discovery_cache/documents/drive.v2.json +41 -5
- googleapiclient/discovery_cache/documents/drive.v3.json +63 -16
- googleapiclient/discovery_cache/documents/eventarc.v1.json +3 -3
- googleapiclient/discovery_cache/documents/fcm.v1.json +5 -1
- googleapiclient/discovery_cache/documents/file.v1.json +11 -4
- googleapiclient/discovery_cache/documents/file.v1beta1.json +11 -4
- googleapiclient/discovery_cache/documents/firebase.v1beta1.json +1 -1
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +51 -1
- googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +29 -5
- googleapiclient/discovery_cache/documents/firestore.v1.json +3 -25
- googleapiclient/discovery_cache/documents/forms.v1.json +7 -7
- googleapiclient/discovery_cache/documents/gkebackup.v1.json +2 -2
- googleapiclient/discovery_cache/documents/gkehub.v1.json +7 -5
- googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +128 -5
- googleapiclient/discovery_cache/documents/gkehub.v1beta.json +7 -5
- googleapiclient/discovery_cache/documents/gkehub.v2.json +5 -3
- googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +5 -3
- googleapiclient/discovery_cache/documents/gkehub.v2beta.json +5 -3
- googleapiclient/discovery_cache/documents/gkeonprem.v1.json +2 -2
- googleapiclient/discovery_cache/documents/healthcare.v1.json +171 -3
- googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +171 -3
- googleapiclient/discovery_cache/documents/iam.v1.json +5 -3
- googleapiclient/discovery_cache/documents/iam.v2.json +2 -2
- googleapiclient/discovery_cache/documents/iam.v2beta.json +2 -2
- googleapiclient/discovery_cache/documents/ids.v1.json +3 -3
- googleapiclient/discovery_cache/documents/integrations.v1.json +29 -6
- googleapiclient/discovery_cache/documents/kmsinventory.v1.json +13 -5
- googleapiclient/discovery_cache/documents/logging.v2.json +6 -61
- googleapiclient/discovery_cache/documents/looker.v1.json +165 -267
- googleapiclient/discovery_cache/documents/memcache.v1.json +2 -2
- googleapiclient/discovery_cache/documents/memcache.v1beta2.json +2 -390
- googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +22 -8
- googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json +6 -1
- googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +6 -1
- googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +6 -1
- googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json +6 -1
- googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json +6 -1
- googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +6 -1
- googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json +6 -1
- googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json +6 -1
- googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json +6 -1
- googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json +6 -1
- googleapiclient/discovery_cache/documents/migrationcenter.v1.json +43 -6
- googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +47 -6
- googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +3 -2
- googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +27 -15
- googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +9 -5
- googleapiclient/discovery_cache/documents/networkmanagement.v1.json +58 -3
- googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +268 -10
- googleapiclient/discovery_cache/documents/networksecurity.v1.json +1828 -534
- googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +735 -322
- googleapiclient/discovery_cache/documents/networkservices.v1.json +39 -63
- googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +39 -63
- googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +105 -1
- googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +105 -1
- googleapiclient/discovery_cache/documents/oracledatabase.v1.json +7 -5
- googleapiclient/discovery_cache/documents/oslogin.v1alpha.json +44 -1
- googleapiclient/discovery_cache/documents/oslogin.v1beta.json +44 -1
- googleapiclient/discovery_cache/documents/parallelstore.v1.json +10 -4
- googleapiclient/discovery_cache/documents/parallelstore.v1beta.json +10 -4
- googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +16 -1
- googleapiclient/discovery_cache/documents/places.v1.json +9 -5
- googleapiclient/discovery_cache/documents/playintegrity.v1.json +1 -43
- googleapiclient/discovery_cache/documents/privateca.v1.json +9 -4
- googleapiclient/discovery_cache/documents/pubsub.v1.json +7 -7
- googleapiclient/discovery_cache/documents/rapidmigrationassessment.v1.json +2 -2
- googleapiclient/discovery_cache/documents/realtimebidding.v1.json +3 -2
- googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +3 -3
- googleapiclient/discovery_cache/documents/redis.v1.json +138 -18
- googleapiclient/discovery_cache/documents/redis.v1beta1.json +137 -17
- googleapiclient/discovery_cache/documents/retail.v2.json +10 -2
- googleapiclient/discovery_cache/documents/retail.v2alpha.json +10 -2
- googleapiclient/discovery_cache/documents/retail.v2beta.json +10 -2
- googleapiclient/discovery_cache/documents/run.v1.json +74 -2
- googleapiclient/discovery_cache/documents/run.v2.json +755 -9
- googleapiclient/discovery_cache/documents/secretmanager.v1.json +31 -1
- googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +31 -1
- googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +31 -1
- googleapiclient/discovery_cache/documents/securitycenter.v1.json +366 -2
- googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +366 -2
- googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +366 -2
- googleapiclient/discovery_cache/documents/securityposture.v1.json +5 -5
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +37 -3
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +37 -3
- googleapiclient/discovery_cache/documents/servicemanagement.v1.json +33 -3
- googleapiclient/discovery_cache/documents/servicenetworking.v1.json +7 -3
- googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +7 -3
- googleapiclient/discovery_cache/documents/serviceusage.v1.json +38 -4
- googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +38 -4
- googleapiclient/discovery_cache/documents/sheets.v4.json +2 -2
- googleapiclient/discovery_cache/documents/slides.v1.json +12 -12
- googleapiclient/discovery_cache/documents/spanner.v1.json +116 -5
- googleapiclient/discovery_cache/documents/sqladmin.v1.json +446 -4
- googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +446 -4
- googleapiclient/discovery_cache/documents/storage.v1.json +6 -6
- googleapiclient/discovery_cache/documents/storagetransfer.v1.json +3 -3
- googleapiclient/discovery_cache/documents/sts.v1.json +41 -1
- googleapiclient/discovery_cache/documents/sts.v1beta.json +41 -1
- googleapiclient/discovery_cache/documents/tagmanager.v2.json +5 -1
- googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +9 -2
- googleapiclient/discovery_cache/documents/trafficdirector.v3.json +41 -15
- googleapiclient/discovery_cache/documents/transcoder.v1.json +2 -2
- googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +2 -2
- googleapiclient/discovery_cache/documents/vault.v1.json +40 -5
- googleapiclient/discovery_cache/documents/vmmigration.v1.json +3 -3
- googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +3 -3
- googleapiclient/discovery_cache/documents/vmwareengine.v1.json +665 -1
- googleapiclient/discovery_cache/documents/workflowexecutions.v1.json +5 -5
- googleapiclient/discovery_cache/documents/workflows.v1.json +2 -2
- googleapiclient/discovery_cache/documents/workloadmanager.v1.json +1102 -24
- googleapiclient/discovery_cache/documents/workspaceevents.v1.json +2 -2
- googleapiclient/discovery_cache/documents/workstations.v1.json +4 -4
- googleapiclient/discovery_cache/documents/workstations.v1beta.json +4 -4
- googleapiclient/discovery_cache/documents/youtube.v3.json +11 -3
- googleapiclient/version.py +1 -1
- {google_api_python_client-2.161.0.dist-info → google_api_python_client-2.163.0.dist-info}/LICENSE +0 -0
- {google_api_python_client-2.161.0.dist-info → google_api_python_client-2.163.0.dist-info}/WHEEL +0 -0
- {google_api_python_client-2.161.0.dist-info → google_api_python_client-2.163.0.dist-info}/top_level.txt +0 -0
|
@@ -188,6 +188,90 @@
|
|
|
188
188
|
"scopes": [
|
|
189
189
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
190
190
|
]
|
|
191
|
+
},
|
|
192
|
+
"obtainCrawlRate": {
|
|
193
|
+
"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.",
|
|
194
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:obtainCrawlRate",
|
|
195
|
+
"httpMethod": "POST",
|
|
196
|
+
"id": "discoveryengine.projects.locations.obtainCrawlRate",
|
|
197
|
+
"parameterOrder": [
|
|
198
|
+
"location"
|
|
199
|
+
],
|
|
200
|
+
"parameters": {
|
|
201
|
+
"location": {
|
|
202
|
+
"description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`",
|
|
203
|
+
"location": "path",
|
|
204
|
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
205
|
+
"required": true,
|
|
206
|
+
"type": "string"
|
|
207
|
+
}
|
|
208
|
+
},
|
|
209
|
+
"path": "v1beta/{+location}:obtainCrawlRate",
|
|
210
|
+
"request": {
|
|
211
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest"
|
|
212
|
+
},
|
|
213
|
+
"response": {
|
|
214
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse"
|
|
215
|
+
},
|
|
216
|
+
"scopes": [
|
|
217
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
218
|
+
]
|
|
219
|
+
},
|
|
220
|
+
"removeDedicatedCrawlRate": {
|
|
221
|
+
"description": "Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl rate was set, this will disable vertex AI's crawl bot from using the dedicated crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-op.",
|
|
222
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:removeDedicatedCrawlRate",
|
|
223
|
+
"httpMethod": "POST",
|
|
224
|
+
"id": "discoveryengine.projects.locations.removeDedicatedCrawlRate",
|
|
225
|
+
"parameterOrder": [
|
|
226
|
+
"location"
|
|
227
|
+
],
|
|
228
|
+
"parameters": {
|
|
229
|
+
"location": {
|
|
230
|
+
"description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`",
|
|
231
|
+
"location": "path",
|
|
232
|
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
233
|
+
"required": true,
|
|
234
|
+
"type": "string"
|
|
235
|
+
}
|
|
236
|
+
},
|
|
237
|
+
"path": "v1beta/{+location}:removeDedicatedCrawlRate",
|
|
238
|
+
"request": {
|
|
239
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest"
|
|
240
|
+
},
|
|
241
|
+
"response": {
|
|
242
|
+
"$ref": "GoogleLongrunningOperation"
|
|
243
|
+
},
|
|
244
|
+
"scopes": [
|
|
245
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
246
|
+
]
|
|
247
|
+
},
|
|
248
|
+
"setDedicatedCrawlRate": {
|
|
249
|
+
"description": "Sets the dedicated crawl rate for a crawl_rate_scope. If the dedicated crawl rate was not set, this will enable vertex AI's crawl bot to use the new dedicated crawl rate for crawling. If the dedicated crawl rate was set, vertex AI's crawl bot will try to update the rate to the new value. If the new value is too high, the crawl bot may crawl at a lower rate to avoid overloading the user's website.",
|
|
250
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:setDedicatedCrawlRate",
|
|
251
|
+
"httpMethod": "POST",
|
|
252
|
+
"id": "discoveryengine.projects.locations.setDedicatedCrawlRate",
|
|
253
|
+
"parameterOrder": [
|
|
254
|
+
"location"
|
|
255
|
+
],
|
|
256
|
+
"parameters": {
|
|
257
|
+
"location": {
|
|
258
|
+
"description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`",
|
|
259
|
+
"location": "path",
|
|
260
|
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
261
|
+
"required": true,
|
|
262
|
+
"type": "string"
|
|
263
|
+
}
|
|
264
|
+
},
|
|
265
|
+
"path": "v1beta/{+location}:setDedicatedCrawlRate",
|
|
266
|
+
"request": {
|
|
267
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest"
|
|
268
|
+
},
|
|
269
|
+
"response": {
|
|
270
|
+
"$ref": "GoogleLongrunningOperation"
|
|
271
|
+
},
|
|
272
|
+
"scopes": [
|
|
273
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
274
|
+
]
|
|
191
275
|
}
|
|
192
276
|
},
|
|
193
277
|
"resources": {
|
|
@@ -2464,6 +2548,37 @@
|
|
|
2464
2548
|
"scopes": [
|
|
2465
2549
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
2466
2550
|
]
|
|
2551
|
+
},
|
|
2552
|
+
"fetch": {
|
|
2553
|
+
"description": "Fetch Sitemaps in a DataStore.",
|
|
2554
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch",
|
|
2555
|
+
"httpMethod": "GET",
|
|
2556
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.fetch",
|
|
2557
|
+
"parameterOrder": [
|
|
2558
|
+
"parent"
|
|
2559
|
+
],
|
|
2560
|
+
"parameters": {
|
|
2561
|
+
"matcher.urisMatcher.uris": {
|
|
2562
|
+
"description": "The Sitemap uris.",
|
|
2563
|
+
"location": "query",
|
|
2564
|
+
"repeated": true,
|
|
2565
|
+
"type": "string"
|
|
2566
|
+
},
|
|
2567
|
+
"parent": {
|
|
2568
|
+
"description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
|
|
2569
|
+
"location": "path",
|
|
2570
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
|
|
2571
|
+
"required": true,
|
|
2572
|
+
"type": "string"
|
|
2573
|
+
}
|
|
2574
|
+
},
|
|
2575
|
+
"path": "v1beta/{+parent}/sitemaps:fetch",
|
|
2576
|
+
"response": {
|
|
2577
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse"
|
|
2578
|
+
},
|
|
2579
|
+
"scopes": [
|
|
2580
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
2581
|
+
]
|
|
2467
2582
|
}
|
|
2468
2583
|
}
|
|
2469
2584
|
},
|
|
@@ -3186,6 +3301,34 @@
|
|
|
3186
3301
|
"scopes": [
|
|
3187
3302
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
3188
3303
|
]
|
|
3304
|
+
},
|
|
3305
|
+
"removeSuggestion": {
|
|
3306
|
+
"description": "Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the AdvancedCompleteQueryResponse.recent_search_suggestions for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again.",
|
|
3307
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/completionConfig:removeSuggestion",
|
|
3308
|
+
"httpMethod": "POST",
|
|
3309
|
+
"id": "discoveryengine.projects.locations.collections.engines.completionConfig.removeSuggestion",
|
|
3310
|
+
"parameterOrder": [
|
|
3311
|
+
"completionConfig"
|
|
3312
|
+
],
|
|
3313
|
+
"parameters": {
|
|
3314
|
+
"completionConfig": {
|
|
3315
|
+
"description": "Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.",
|
|
3316
|
+
"location": "path",
|
|
3317
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig$",
|
|
3318
|
+
"required": true,
|
|
3319
|
+
"type": "string"
|
|
3320
|
+
}
|
|
3321
|
+
},
|
|
3322
|
+
"path": "v1beta/{+completionConfig}:removeSuggestion",
|
|
3323
|
+
"request": {
|
|
3324
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest"
|
|
3325
|
+
},
|
|
3326
|
+
"response": {
|
|
3327
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse"
|
|
3328
|
+
},
|
|
3329
|
+
"scopes": [
|
|
3330
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
3331
|
+
]
|
|
3189
3332
|
}
|
|
3190
3333
|
}
|
|
3191
3334
|
},
|
|
@@ -7607,7 +7750,7 @@
|
|
|
7607
7750
|
}
|
|
7608
7751
|
}
|
|
7609
7752
|
},
|
|
7610
|
-
"revision": "
|
|
7753
|
+
"revision": "20250226",
|
|
7611
7754
|
"rootUrl": "https://discoveryengine.googleapis.com/",
|
|
7612
7755
|
"schemas": {
|
|
7613
7756
|
"GoogleApiDistribution": {
|
|
@@ -7863,6 +8006,43 @@
|
|
|
7863
8006
|
},
|
|
7864
8007
|
"type": "object"
|
|
7865
8008
|
},
|
|
8009
|
+
"GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext": {
|
|
8010
|
+
"description": "The error payload that is populated on LRO sync APIs, including the following: * `google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector` * `google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun`",
|
|
8011
|
+
"id": "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext",
|
|
8012
|
+
"properties": {
|
|
8013
|
+
"connectorRun": {
|
|
8014
|
+
"description": "The full resource name of the Connector Run. Format: `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. The `connector_run_id` is system-generated.",
|
|
8015
|
+
"type": "string"
|
|
8016
|
+
},
|
|
8017
|
+
"dataConnector": {
|
|
8018
|
+
"description": "The full resource name of the DataConnector. Format: `projects/*/locations/*/collections/*/dataConnector`.",
|
|
8019
|
+
"type": "string"
|
|
8020
|
+
},
|
|
8021
|
+
"endTime": {
|
|
8022
|
+
"description": "The time when the connector run ended.",
|
|
8023
|
+
"format": "google-datetime",
|
|
8024
|
+
"type": "string"
|
|
8025
|
+
},
|
|
8026
|
+
"entity": {
|
|
8027
|
+
"description": "The entity to sync for the connector run.",
|
|
8028
|
+
"type": "string"
|
|
8029
|
+
},
|
|
8030
|
+
"operation": {
|
|
8031
|
+
"description": "The operation resource name of the LRO to sync the connector.",
|
|
8032
|
+
"type": "string"
|
|
8033
|
+
},
|
|
8034
|
+
"startTime": {
|
|
8035
|
+
"description": "The time when the connector run started.",
|
|
8036
|
+
"format": "google-datetime",
|
|
8037
|
+
"type": "string"
|
|
8038
|
+
},
|
|
8039
|
+
"syncType": {
|
|
8040
|
+
"description": "The type of sync run. Can be one of the following: * `FULL` * `INCREMENTAL`",
|
|
8041
|
+
"type": "string"
|
|
8042
|
+
}
|
|
8043
|
+
},
|
|
8044
|
+
"type": "object"
|
|
8045
|
+
},
|
|
7866
8046
|
"GoogleCloudDiscoveryengineLoggingErrorContext": {
|
|
7867
8047
|
"description": "A description of the context in which an error occurred.",
|
|
7868
8048
|
"id": "GoogleCloudDiscoveryengineLoggingErrorContext",
|
|
@@ -7882,6 +8062,10 @@
|
|
|
7882
8062
|
"description": "An error log which is reported to the Error Reporting system.",
|
|
7883
8063
|
"id": "GoogleCloudDiscoveryengineLoggingErrorLog",
|
|
7884
8064
|
"properties": {
|
|
8065
|
+
"connectorRunPayload": {
|
|
8066
|
+
"$ref": "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext",
|
|
8067
|
+
"description": "The error payload that is populated on LRO connector sync APIs."
|
|
8068
|
+
},
|
|
7885
8069
|
"context": {
|
|
7886
8070
|
"$ref": "GoogleCloudDiscoveryengineLoggingErrorContext",
|
|
7887
8071
|
"description": "A description of the context in which the error occurred."
|
|
@@ -8038,11 +8222,11 @@
|
|
|
8038
8222
|
"type": "boolean"
|
|
8039
8223
|
},
|
|
8040
8224
|
"kmsKey": {
|
|
8041
|
-
"description": "
|
|
8225
|
+
"description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
|
|
8042
8226
|
"type": "string"
|
|
8043
8227
|
},
|
|
8044
8228
|
"kmsKeyVersion": {
|
|
8045
|
-
"description": "
|
|
8229
|
+
"description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
|
|
8046
8230
|
"type": "string"
|
|
8047
8231
|
},
|
|
8048
8232
|
"lastRotationTimestampMicros": {
|
|
@@ -8052,7 +8236,7 @@
|
|
|
8052
8236
|
"type": "string"
|
|
8053
8237
|
},
|
|
8054
8238
|
"name": {
|
|
8055
|
-
"description": "Required.
|
|
8239
|
+
"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
|
|
8056
8240
|
"type": "string"
|
|
8057
8241
|
},
|
|
8058
8242
|
"singleRegionKeys": {
|
|
@@ -8063,7 +8247,7 @@
|
|
|
8063
8247
|
"type": "array"
|
|
8064
8248
|
},
|
|
8065
8249
|
"state": {
|
|
8066
|
-
"description": "Output only.
|
|
8250
|
+
"description": "Output only. The states of the CmekConfig.",
|
|
8067
8251
|
"enum": [
|
|
8068
8252
|
"STATE_UNSPECIFIED",
|
|
8069
8253
|
"CREATING",
|
|
@@ -8428,6 +8612,23 @@
|
|
|
8428
8612
|
},
|
|
8429
8613
|
"type": "object"
|
|
8430
8614
|
},
|
|
8615
|
+
"GoogleCloudDiscoveryengineV1CreateSitemapMetadata": {
|
|
8616
|
+
"description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
8617
|
+
"id": "GoogleCloudDiscoveryengineV1CreateSitemapMetadata",
|
|
8618
|
+
"properties": {
|
|
8619
|
+
"createTime": {
|
|
8620
|
+
"description": "Operation create time.",
|
|
8621
|
+
"format": "google-datetime",
|
|
8622
|
+
"type": "string"
|
|
8623
|
+
},
|
|
8624
|
+
"updateTime": {
|
|
8625
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
8626
|
+
"format": "google-datetime",
|
|
8627
|
+
"type": "string"
|
|
8628
|
+
}
|
|
8629
|
+
},
|
|
8630
|
+
"type": "object"
|
|
8631
|
+
},
|
|
8431
8632
|
"GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": {
|
|
8432
8633
|
"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
8433
8634
|
"id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata",
|
|
@@ -8488,7 +8689,7 @@
|
|
|
8488
8689
|
"type": "string"
|
|
8489
8690
|
},
|
|
8490
8691
|
"defaultSchemaId": {
|
|
8491
|
-
"description": "Output only. The id of the default Schema
|
|
8692
|
+
"description": "Output only. The id of the default Schema associated to this data store.",
|
|
8492
8693
|
"readOnly": true,
|
|
8493
8694
|
"type": "string"
|
|
8494
8695
|
},
|
|
@@ -8504,6 +8705,10 @@
|
|
|
8504
8705
|
"$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig",
|
|
8505
8706
|
"description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
|
|
8506
8707
|
},
|
|
8708
|
+
"identityMappingStore": {
|
|
8709
|
+
"description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.",
|
|
8710
|
+
"type": "string"
|
|
8711
|
+
},
|
|
8507
8712
|
"industryVertical": {
|
|
8508
8713
|
"description": "Immutable. The industry vertical that the data store registers.",
|
|
8509
8714
|
"enum": [
|
|
@@ -8701,6 +8906,23 @@
|
|
|
8701
8906
|
},
|
|
8702
8907
|
"type": "object"
|
|
8703
8908
|
},
|
|
8909
|
+
"GoogleCloudDiscoveryengineV1DeleteSitemapMetadata": {
|
|
8910
|
+
"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
8911
|
+
"id": "GoogleCloudDiscoveryengineV1DeleteSitemapMetadata",
|
|
8912
|
+
"properties": {
|
|
8913
|
+
"createTime": {
|
|
8914
|
+
"description": "Operation create time.",
|
|
8915
|
+
"format": "google-datetime",
|
|
8916
|
+
"type": "string"
|
|
8917
|
+
},
|
|
8918
|
+
"updateTime": {
|
|
8919
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
8920
|
+
"format": "google-datetime",
|
|
8921
|
+
"type": "string"
|
|
8922
|
+
}
|
|
8923
|
+
},
|
|
8924
|
+
"type": "object"
|
|
8925
|
+
},
|
|
8704
8926
|
"GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": {
|
|
8705
8927
|
"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
8706
8928
|
"id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata",
|
|
@@ -8964,6 +9186,10 @@
|
|
|
8964
9186
|
"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig",
|
|
8965
9187
|
"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation."
|
|
8966
9188
|
},
|
|
9189
|
+
"allowCrossRegion": {
|
|
9190
|
+
"description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.",
|
|
9191
|
+
"type": "boolean"
|
|
9192
|
+
},
|
|
8967
9193
|
"dialogflowAgentToLink": {
|
|
8968
9194
|
"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.",
|
|
8969
9195
|
"type": "string"
|
|
@@ -9068,7 +9294,7 @@
|
|
|
9068
9294
|
"type": "object"
|
|
9069
9295
|
},
|
|
9070
9296
|
"GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata": {
|
|
9071
|
-
"description": "IdentityMappingEntry LongRunningOperation metadata for
|
|
9297
|
+
"description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings",
|
|
9072
9298
|
"id": "GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata",
|
|
9073
9299
|
"properties": {
|
|
9074
9300
|
"failureCount": {
|
|
@@ -9942,6 +10168,28 @@
|
|
|
9942
10168
|
},
|
|
9943
10169
|
"type": "object"
|
|
9944
10170
|
},
|
|
10171
|
+
"GoogleCloudDiscoveryengineV1Sitemap": {
|
|
10172
|
+
"description": "A sitemap for the SiteSearchEngine.",
|
|
10173
|
+
"id": "GoogleCloudDiscoveryengineV1Sitemap",
|
|
10174
|
+
"properties": {
|
|
10175
|
+
"createTime": {
|
|
10176
|
+
"description": "Output only. The sitemap's creation time.",
|
|
10177
|
+
"format": "google-datetime",
|
|
10178
|
+
"readOnly": true,
|
|
10179
|
+
"type": "string"
|
|
10180
|
+
},
|
|
10181
|
+
"name": {
|
|
10182
|
+
"description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.",
|
|
10183
|
+
"readOnly": true,
|
|
10184
|
+
"type": "string"
|
|
10185
|
+
},
|
|
10186
|
+
"uri": {
|
|
10187
|
+
"description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.",
|
|
10188
|
+
"type": "string"
|
|
10189
|
+
}
|
|
10190
|
+
},
|
|
10191
|
+
"type": "object"
|
|
10192
|
+
},
|
|
9945
10193
|
"GoogleCloudDiscoveryengineV1TargetSite": {
|
|
9946
10194
|
"description": "A target site for the SiteSearchEngine.",
|
|
9947
10195
|
"id": "GoogleCloudDiscoveryengineV1TargetSite",
|
|
@@ -10373,7 +10621,7 @@
|
|
|
10373
10621
|
"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation",
|
|
10374
10622
|
"properties": {
|
|
10375
10623
|
"endIndex": {
|
|
10376
|
-
"description": "End of the attributed segment, exclusive.",
|
|
10624
|
+
"description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.",
|
|
10377
10625
|
"format": "int64",
|
|
10378
10626
|
"type": "string"
|
|
10379
10627
|
},
|
|
@@ -10385,7 +10633,7 @@
|
|
|
10385
10633
|
"type": "array"
|
|
10386
10634
|
},
|
|
10387
10635
|
"startIndex": {
|
|
10388
|
-
"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).",
|
|
10636
|
+
"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.",
|
|
10389
10637
|
"format": "int64",
|
|
10390
10638
|
"type": "string"
|
|
10391
10639
|
}
|
|
@@ -10568,6 +10816,16 @@
|
|
|
10568
10816
|
},
|
|
10569
10817
|
"description": "Structured search data.",
|
|
10570
10818
|
"type": "object"
|
|
10819
|
+
},
|
|
10820
|
+
"title": {
|
|
10821
|
+
"description": "Output only. The title of the document.",
|
|
10822
|
+
"readOnly": true,
|
|
10823
|
+
"type": "string"
|
|
10824
|
+
},
|
|
10825
|
+
"uri": {
|
|
10826
|
+
"description": "Output only. The URI of the document.",
|
|
10827
|
+
"readOnly": true,
|
|
10828
|
+
"type": "string"
|
|
10571
10829
|
}
|
|
10572
10830
|
},
|
|
10573
10831
|
"type": "object"
|
|
@@ -10779,6 +11037,30 @@
|
|
|
10779
11037
|
},
|
|
10780
11038
|
"type": "object"
|
|
10781
11039
|
},
|
|
11040
|
+
"GoogleCloudDiscoveryengineV1alphaBAPConfig": {
|
|
11041
|
+
"description": "The configuration for the BAP connector.",
|
|
11042
|
+
"id": "GoogleCloudDiscoveryengineV1alphaBAPConfig",
|
|
11043
|
+
"properties": {
|
|
11044
|
+
"supportedConnectorModes": {
|
|
11045
|
+
"description": "Required. The supported connector modes for the associated BAP connection.",
|
|
11046
|
+
"items": {
|
|
11047
|
+
"enum": [
|
|
11048
|
+
"CONNECTOR_MODE_UNSPECIFIED",
|
|
11049
|
+
"DATA_INGESTION",
|
|
11050
|
+
"ACTIONS"
|
|
11051
|
+
],
|
|
11052
|
+
"enumDescriptions": [
|
|
11053
|
+
"Connector mode unspecified.",
|
|
11054
|
+
"Connector utilized for data ingestion.",
|
|
11055
|
+
"Connector utilized for Actions"
|
|
11056
|
+
],
|
|
11057
|
+
"type": "string"
|
|
11058
|
+
},
|
|
11059
|
+
"type": "array"
|
|
11060
|
+
}
|
|
11061
|
+
},
|
|
11062
|
+
"type": "object"
|
|
11063
|
+
},
|
|
10782
11064
|
"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": {
|
|
10783
11065
|
"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
10784
11066
|
"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata",
|
|
@@ -10820,11 +11102,11 @@
|
|
|
10820
11102
|
"type": "boolean"
|
|
10821
11103
|
},
|
|
10822
11104
|
"kmsKey": {
|
|
10823
|
-
"description": "
|
|
11105
|
+
"description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
|
|
10824
11106
|
"type": "string"
|
|
10825
11107
|
},
|
|
10826
11108
|
"kmsKeyVersion": {
|
|
10827
|
-
"description": "
|
|
11109
|
+
"description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
|
|
10828
11110
|
"type": "string"
|
|
10829
11111
|
},
|
|
10830
11112
|
"lastRotationTimestampMicros": {
|
|
@@ -10834,7 +11116,7 @@
|
|
|
10834
11116
|
"type": "string"
|
|
10835
11117
|
},
|
|
10836
11118
|
"name": {
|
|
10837
|
-
"description": "Required.
|
|
11119
|
+
"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
|
|
10838
11120
|
"type": "string"
|
|
10839
11121
|
},
|
|
10840
11122
|
"singleRegionKeys": {
|
|
@@ -10845,7 +11127,7 @@
|
|
|
10845
11127
|
"type": "array"
|
|
10846
11128
|
},
|
|
10847
11129
|
"state": {
|
|
10848
|
-
"description": "Output only.
|
|
11130
|
+
"description": "Output only. The states of the CmekConfig.",
|
|
10849
11131
|
"enum": [
|
|
10850
11132
|
"STATE_UNSPECIFIED",
|
|
10851
11133
|
"CREATING",
|
|
@@ -11053,6 +11335,11 @@
|
|
|
11053
11335
|
"description": "Represents an entity that was synced in this ConnectorRun.",
|
|
11054
11336
|
"id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun",
|
|
11055
11337
|
"properties": {
|
|
11338
|
+
"deletedRecordCount": {
|
|
11339
|
+
"description": "The number of documents deleted.",
|
|
11340
|
+
"format": "int64",
|
|
11341
|
+
"type": "string"
|
|
11342
|
+
},
|
|
11056
11343
|
"entityName": {
|
|
11057
11344
|
"description": "The name of the source entity.",
|
|
11058
11345
|
"type": "string"
|
|
@@ -11490,6 +11777,10 @@
|
|
|
11490
11777
|
"description": "Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync.",
|
|
11491
11778
|
"type": "boolean"
|
|
11492
11779
|
},
|
|
11780
|
+
"bapConfig": {
|
|
11781
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaBAPConfig",
|
|
11782
|
+
"description": "Optional. The configuration for establishing a BAP connection."
|
|
11783
|
+
},
|
|
11493
11784
|
"blockingReasons": {
|
|
11494
11785
|
"description": "Output only. User actions that must be completed before the connector can start syncing data.",
|
|
11495
11786
|
"items": {
|
|
@@ -11631,10 +11922,12 @@
|
|
|
11631
11922
|
"syncMode": {
|
|
11632
11923
|
"description": "The data synchronization mode supported by the data connector.",
|
|
11633
11924
|
"enum": [
|
|
11634
|
-
"PERIODIC"
|
|
11925
|
+
"PERIODIC",
|
|
11926
|
+
"STREAMING"
|
|
11635
11927
|
],
|
|
11636
11928
|
"enumDescriptions": [
|
|
11637
|
-
"The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync."
|
|
11929
|
+
"The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.",
|
|
11930
|
+
"The data will be synced in real time."
|
|
11638
11931
|
],
|
|
11639
11932
|
"type": "string"
|
|
11640
11933
|
},
|
|
@@ -11660,6 +11953,10 @@
|
|
|
11660
11953
|
"description": "The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`",
|
|
11661
11954
|
"type": "string"
|
|
11662
11955
|
},
|
|
11956
|
+
"healthcareFhirConfig": {
|
|
11957
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig",
|
|
11958
|
+
"description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
|
|
11959
|
+
},
|
|
11663
11960
|
"keyPropertyMappings": {
|
|
11664
11961
|
"additionalProperties": {
|
|
11665
11962
|
"type": "string"
|
|
@@ -11674,6 +11971,10 @@
|
|
|
11674
11971
|
},
|
|
11675
11972
|
"description": "The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.",
|
|
11676
11973
|
"type": "object"
|
|
11974
|
+
},
|
|
11975
|
+
"startingSchema": {
|
|
11976
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSchema",
|
|
11977
|
+
"description": "Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)."
|
|
11677
11978
|
}
|
|
11678
11979
|
},
|
|
11679
11980
|
"type": "object"
|
|
@@ -11725,7 +12026,7 @@
|
|
|
11725
12026
|
"type": "string"
|
|
11726
12027
|
},
|
|
11727
12028
|
"defaultSchemaId": {
|
|
11728
|
-
"description": "Output only. The id of the default Schema
|
|
12029
|
+
"description": "Output only. The id of the default Schema associated to this data store.",
|
|
11729
12030
|
"readOnly": true,
|
|
11730
12031
|
"type": "string"
|
|
11731
12032
|
},
|
|
@@ -11741,6 +12042,10 @@
|
|
|
11741
12042
|
"$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig",
|
|
11742
12043
|
"description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
|
|
11743
12044
|
},
|
|
12045
|
+
"identityMappingStore": {
|
|
12046
|
+
"description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.",
|
|
12047
|
+
"type": "string"
|
|
12048
|
+
},
|
|
11744
12049
|
"idpConfig": {
|
|
11745
12050
|
"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig",
|
|
11746
12051
|
"description": "Output only. Data store level identity provider config.",
|
|
@@ -12329,6 +12634,10 @@
|
|
|
12329
12634
|
"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig",
|
|
12330
12635
|
"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation."
|
|
12331
12636
|
},
|
|
12637
|
+
"allowCrossRegion": {
|
|
12638
|
+
"description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.",
|
|
12639
|
+
"type": "boolean"
|
|
12640
|
+
},
|
|
12332
12641
|
"dialogflowAgentToLink": {
|
|
12333
12642
|
"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.",
|
|
12334
12643
|
"type": "string"
|
|
@@ -12641,31 +12950,6 @@
|
|
|
12641
12950
|
},
|
|
12642
12951
|
"type": "object"
|
|
12643
12952
|
},
|
|
12644
|
-
"GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse": {
|
|
12645
|
-
"description": "Response message for SiteSearchEngineService.FetchSitemaps method.",
|
|
12646
|
-
"id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse",
|
|
12647
|
-
"properties": {
|
|
12648
|
-
"sitemapsMetadata": {
|
|
12649
|
-
"description": "List of Sitemaps fetched.",
|
|
12650
|
-
"items": {
|
|
12651
|
-
"$ref": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata"
|
|
12652
|
-
},
|
|
12653
|
-
"type": "array"
|
|
12654
|
-
}
|
|
12655
|
-
},
|
|
12656
|
-
"type": "object"
|
|
12657
|
-
},
|
|
12658
|
-
"GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata": {
|
|
12659
|
-
"description": "Contains a Sitemap and its metadata.",
|
|
12660
|
-
"id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata",
|
|
12661
|
-
"properties": {
|
|
12662
|
-
"sitemap": {
|
|
12663
|
-
"$ref": "GoogleCloudDiscoveryengineV1alphaSitemap",
|
|
12664
|
-
"description": "The Sitemap."
|
|
12665
|
-
}
|
|
12666
|
-
},
|
|
12667
|
-
"type": "object"
|
|
12668
|
-
},
|
|
12669
12953
|
"GoogleCloudDiscoveryengineV1alphaFieldConfig": {
|
|
12670
12954
|
"description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.",
|
|
12671
12955
|
"id": "GoogleCloudDiscoveryengineV1alphaFieldConfig",
|
|
@@ -12872,7 +13156,7 @@
|
|
|
12872
13156
|
"type": "object"
|
|
12873
13157
|
},
|
|
12874
13158
|
"GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata": {
|
|
12875
|
-
"description": "IdentityMappingEntry LongRunningOperation metadata for
|
|
13159
|
+
"description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings",
|
|
12876
13160
|
"id": "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata",
|
|
12877
13161
|
"properties": {
|
|
12878
13162
|
"failureCount": {
|
|
@@ -14041,6 +14325,10 @@
|
|
|
14041
14325
|
},
|
|
14042
14326
|
"type": "array"
|
|
14043
14327
|
},
|
|
14328
|
+
"displaySpec": {
|
|
14329
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec",
|
|
14330
|
+
"description": "Optional. Config for display feature, like match highlighting on search results."
|
|
14331
|
+
},
|
|
14044
14332
|
"embeddingSpec": {
|
|
14045
14333
|
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec",
|
|
14046
14334
|
"description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path."
|
|
@@ -14111,15 +14399,33 @@
|
|
|
14111
14399
|
"description": "The query expansion specification that specifies the conditions under which query expansion occurs."
|
|
14112
14400
|
},
|
|
14113
14401
|
"rankingExpression": {
|
|
14114
|
-
"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.",
|
|
14115
|
-
"type": "string"
|
|
14116
|
-
},
|
|
14117
|
-
"regionCode": {
|
|
14118
|
-
"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.",
|
|
14402
|
+
"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",
|
|
14119
14403
|
"type": "string"
|
|
14120
14404
|
},
|
|
14121
|
-
"
|
|
14122
|
-
"description": "
|
|
14405
|
+
"rankingExpressionBackend": {
|
|
14406
|
+
"description": "Optional. The backend to use for the ranking expression evaluation.",
|
|
14407
|
+
"enum": [
|
|
14408
|
+
"UNKNOWN",
|
|
14409
|
+
"BYOE",
|
|
14410
|
+
"CLEARBOX"
|
|
14411
|
+
],
|
|
14412
|
+
"enumDescriptions": [
|
|
14413
|
+
"Default option for unspecified/unknown values.",
|
|
14414
|
+
"Bring your own embedding (BYOE), the default way to evaluate the ranking expression.",
|
|
14415
|
+
"The expression is compiled into a Clearbox formula."
|
|
14416
|
+
],
|
|
14417
|
+
"type": "string"
|
|
14418
|
+
},
|
|
14419
|
+
"regionCode": {
|
|
14420
|
+
"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.",
|
|
14421
|
+
"type": "string"
|
|
14422
|
+
},
|
|
14423
|
+
"relevanceScoreSpec": {
|
|
14424
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec",
|
|
14425
|
+
"description": "Optional. The specification for returning the relevance score."
|
|
14426
|
+
},
|
|
14427
|
+
"relevanceThreshold": {
|
|
14428
|
+
"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.",
|
|
14123
14429
|
"enum": [
|
|
14124
14430
|
"RELEVANCE_THRESHOLD_UNSPECIFIED",
|
|
14125
14431
|
"LOWEST",
|
|
@@ -14468,6 +14774,27 @@
|
|
|
14468
14774
|
},
|
|
14469
14775
|
"type": "object"
|
|
14470
14776
|
},
|
|
14777
|
+
"GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec": {
|
|
14778
|
+
"description": "Specifies features for display, like match highlighting.",
|
|
14779
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec",
|
|
14780
|
+
"properties": {
|
|
14781
|
+
"matchHighlightingCondition": {
|
|
14782
|
+
"description": "The condition under which match highlighting should occur.",
|
|
14783
|
+
"enum": [
|
|
14784
|
+
"MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED",
|
|
14785
|
+
"MATCH_HIGHLIGHTING_DISABLED",
|
|
14786
|
+
"MATCH_HIGHLIGHTING_ENABLED"
|
|
14787
|
+
],
|
|
14788
|
+
"enumDescriptions": [
|
|
14789
|
+
"Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.",
|
|
14790
|
+
"Disables match highlighting on all documents.",
|
|
14791
|
+
"Enables match highlighting on all documents."
|
|
14792
|
+
],
|
|
14793
|
+
"type": "string"
|
|
14794
|
+
}
|
|
14795
|
+
},
|
|
14796
|
+
"type": "object"
|
|
14797
|
+
},
|
|
14471
14798
|
"GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": {
|
|
14472
14799
|
"description": "The specification that uses customized query embedding vector to do semantic document retrieval.",
|
|
14473
14800
|
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec",
|
|
@@ -14660,6 +14987,17 @@
|
|
|
14660
14987
|
},
|
|
14661
14988
|
"type": "object"
|
|
14662
14989
|
},
|
|
14990
|
+
"GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec": {
|
|
14991
|
+
"description": "The specification for returning the document relevance score.",
|
|
14992
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec",
|
|
14993
|
+
"properties": {
|
|
14994
|
+
"returnRelevanceScore": {
|
|
14995
|
+
"description": "Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.",
|
|
14996
|
+
"type": "boolean"
|
|
14997
|
+
}
|
|
14998
|
+
},
|
|
14999
|
+
"type": "object"
|
|
15000
|
+
},
|
|
14663
15001
|
"GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": {
|
|
14664
15002
|
"description": "Specification for search as you type in search requests.",
|
|
14665
15003
|
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec",
|
|
@@ -14669,12 +15007,14 @@
|
|
|
14669
15007
|
"enum": [
|
|
14670
15008
|
"CONDITION_UNSPECIFIED",
|
|
14671
15009
|
"DISABLED",
|
|
14672
|
-
"ENABLED"
|
|
15010
|
+
"ENABLED",
|
|
15011
|
+
"AUTO"
|
|
14673
15012
|
],
|
|
14674
15013
|
"enumDescriptions": [
|
|
14675
15014
|
"Server behavior defaults to Condition.DISABLED.",
|
|
14676
15015
|
"Disables Search As You Type.",
|
|
14677
|
-
"Enables Search As You Type."
|
|
15016
|
+
"Enables Search As You Type.",
|
|
15017
|
+
"Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)."
|
|
14678
15018
|
],
|
|
14679
15019
|
"type": "string"
|
|
14680
15020
|
}
|
|
@@ -14690,7 +15030,7 @@
|
|
|
14690
15030
|
"type": "string"
|
|
14691
15031
|
},
|
|
14692
15032
|
"searchResultPersistenceCount": {
|
|
14693
|
-
"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is
|
|
15033
|
+
"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.",
|
|
14694
15034
|
"format": "int32",
|
|
14695
15035
|
"type": "integer"
|
|
14696
15036
|
}
|
|
@@ -15256,7 +15596,7 @@
|
|
|
15256
15596
|
"type": "string"
|
|
15257
15597
|
},
|
|
15258
15598
|
"queryModel": {
|
|
15259
|
-
"description": "Specifies the autocomplete
|
|
15599
|
+
"description": "Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.",
|
|
15260
15600
|
"type": "string"
|
|
15261
15601
|
},
|
|
15262
15602
|
"suggestionTypeSpecs": {
|
|
@@ -15423,10 +15763,23 @@
|
|
|
15423
15763
|
"description": "The name of the dataStore that this suggestion belongs to.",
|
|
15424
15764
|
"type": "string"
|
|
15425
15765
|
},
|
|
15766
|
+
"destinationUri": {
|
|
15767
|
+
"description": "The destination uri of the content suggestion.",
|
|
15768
|
+
"type": "string"
|
|
15769
|
+
},
|
|
15426
15770
|
"document": {
|
|
15427
15771
|
"$ref": "GoogleCloudDiscoveryengineV1betaDocument",
|
|
15428
15772
|
"description": "The document data snippet in the suggestion. Only a subset of fields will be populated."
|
|
15429
15773
|
},
|
|
15774
|
+
"iconUri": {
|
|
15775
|
+
"description": "The icon uri of the content suggestion.",
|
|
15776
|
+
"type": "string"
|
|
15777
|
+
},
|
|
15778
|
+
"score": {
|
|
15779
|
+
"description": "The score of each suggestion. The score is in the range of [0, 1].",
|
|
15780
|
+
"format": "double",
|
|
15781
|
+
"type": "number"
|
|
15782
|
+
},
|
|
15430
15783
|
"suggestion": {
|
|
15431
15784
|
"description": "The suggestion for the query.",
|
|
15432
15785
|
"type": "string"
|
|
@@ -15442,6 +15795,14 @@
|
|
|
15442
15795
|
"description": "The name of the dataStore that this suggestion belongs to.",
|
|
15443
15796
|
"type": "string"
|
|
15444
15797
|
},
|
|
15798
|
+
"destinationUri": {
|
|
15799
|
+
"description": "The destination uri of the person suggestion.",
|
|
15800
|
+
"type": "string"
|
|
15801
|
+
},
|
|
15802
|
+
"displayPhotoUri": {
|
|
15803
|
+
"description": "The photo uri of the person suggestion.",
|
|
15804
|
+
"type": "string"
|
|
15805
|
+
},
|
|
15445
15806
|
"document": {
|
|
15446
15807
|
"$ref": "GoogleCloudDiscoveryengineV1betaDocument",
|
|
15447
15808
|
"description": "The document data snippet in the suggestion. Only a subset of fields is populated."
|
|
@@ -15460,6 +15821,11 @@
|
|
|
15460
15821
|
],
|
|
15461
15822
|
"type": "string"
|
|
15462
15823
|
},
|
|
15824
|
+
"score": {
|
|
15825
|
+
"description": "The score of each suggestion. The score is in the range of [0, 1].",
|
|
15826
|
+
"format": "double",
|
|
15827
|
+
"type": "number"
|
|
15828
|
+
},
|
|
15463
15829
|
"suggestion": {
|
|
15464
15830
|
"description": "The suggestion for the query.",
|
|
15465
15831
|
"type": "string"
|
|
@@ -15485,6 +15851,11 @@
|
|
|
15485
15851
|
},
|
|
15486
15852
|
"type": "array"
|
|
15487
15853
|
},
|
|
15854
|
+
"score": {
|
|
15855
|
+
"description": "The score of each suggestion. The score is in the range of [0, 1].",
|
|
15856
|
+
"format": "double",
|
|
15857
|
+
"type": "number"
|
|
15858
|
+
},
|
|
15488
15859
|
"suggestion": {
|
|
15489
15860
|
"description": "The suggestion for the query.",
|
|
15490
15861
|
"type": "string"
|
|
@@ -15501,6 +15872,11 @@
|
|
|
15501
15872
|
"format": "google-datetime",
|
|
15502
15873
|
"type": "string"
|
|
15503
15874
|
},
|
|
15875
|
+
"score": {
|
|
15876
|
+
"description": "The score of each suggestion. The score is in the range of [0, 1].",
|
|
15877
|
+
"format": "double",
|
|
15878
|
+
"type": "number"
|
|
15879
|
+
},
|
|
15504
15880
|
"suggestion": {
|
|
15505
15881
|
"description": "The suggestion for the query.",
|
|
15506
15882
|
"type": "string"
|
|
@@ -15686,7 +16062,7 @@
|
|
|
15686
16062
|
"id": "GoogleCloudDiscoveryengineV1betaAnswerCitation",
|
|
15687
16063
|
"properties": {
|
|
15688
16064
|
"endIndex": {
|
|
15689
|
-
"description": "End of the attributed segment, exclusive.",
|
|
16065
|
+
"description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.",
|
|
15690
16066
|
"format": "int64",
|
|
15691
16067
|
"type": "string"
|
|
15692
16068
|
},
|
|
@@ -15698,7 +16074,7 @@
|
|
|
15698
16074
|
"type": "array"
|
|
15699
16075
|
},
|
|
15700
16076
|
"startIndex": {
|
|
15701
|
-
"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).",
|
|
16077
|
+
"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.",
|
|
15702
16078
|
"format": "int64",
|
|
15703
16079
|
"type": "string"
|
|
15704
16080
|
}
|
|
@@ -16469,6 +16845,16 @@
|
|
|
16469
16845
|
},
|
|
16470
16846
|
"description": "Structured search data.",
|
|
16471
16847
|
"type": "object"
|
|
16848
|
+
},
|
|
16849
|
+
"title": {
|
|
16850
|
+
"description": "Output only. The title of the document.",
|
|
16851
|
+
"readOnly": true,
|
|
16852
|
+
"type": "string"
|
|
16853
|
+
},
|
|
16854
|
+
"uri": {
|
|
16855
|
+
"description": "Output only. The URI of the document.",
|
|
16856
|
+
"readOnly": true,
|
|
16857
|
+
"type": "string"
|
|
16472
16858
|
}
|
|
16473
16859
|
},
|
|
16474
16860
|
"type": "object"
|
|
@@ -17245,11 +17631,11 @@
|
|
|
17245
17631
|
"type": "boolean"
|
|
17246
17632
|
},
|
|
17247
17633
|
"kmsKey": {
|
|
17248
|
-
"description": "
|
|
17634
|
+
"description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
|
|
17249
17635
|
"type": "string"
|
|
17250
17636
|
},
|
|
17251
17637
|
"kmsKeyVersion": {
|
|
17252
|
-
"description": "
|
|
17638
|
+
"description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
|
|
17253
17639
|
"type": "string"
|
|
17254
17640
|
},
|
|
17255
17641
|
"lastRotationTimestampMicros": {
|
|
@@ -17259,7 +17645,7 @@
|
|
|
17259
17645
|
"type": "string"
|
|
17260
17646
|
},
|
|
17261
17647
|
"name": {
|
|
17262
|
-
"description": "Required.
|
|
17648
|
+
"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
|
|
17263
17649
|
"type": "string"
|
|
17264
17650
|
},
|
|
17265
17651
|
"singleRegionKeys": {
|
|
@@ -17270,7 +17656,7 @@
|
|
|
17270
17656
|
"type": "array"
|
|
17271
17657
|
},
|
|
17272
17658
|
"state": {
|
|
17273
|
-
"description": "Output only.
|
|
17659
|
+
"description": "Output only. The states of the CmekConfig.",
|
|
17274
17660
|
"enum": [
|
|
17275
17661
|
"STATE_UNSPECIFIED",
|
|
17276
17662
|
"CREATING",
|
|
@@ -17835,6 +18221,17 @@
|
|
|
17835
18221
|
},
|
|
17836
18222
|
"type": "object"
|
|
17837
18223
|
},
|
|
18224
|
+
"GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries": {
|
|
18225
|
+
"description": "The historical crawl rate timeseries data, used for monitoring.",
|
|
18226
|
+
"id": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
|
|
18227
|
+
"properties": {
|
|
18228
|
+
"qpsTimeSeries": {
|
|
18229
|
+
"$ref": "GoogleMonitoringV3TimeSeries",
|
|
18230
|
+
"description": "The QPS of the crawl rate."
|
|
18231
|
+
}
|
|
18232
|
+
},
|
|
18233
|
+
"type": "object"
|
|
18234
|
+
},
|
|
17838
18235
|
"GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": {
|
|
17839
18236
|
"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
17840
18237
|
"id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata",
|
|
@@ -18073,7 +18470,7 @@
|
|
|
18073
18470
|
"type": "string"
|
|
18074
18471
|
},
|
|
18075
18472
|
"defaultSchemaId": {
|
|
18076
|
-
"description": "Output only. The id of the default Schema
|
|
18473
|
+
"description": "Output only. The id of the default Schema associated to this data store.",
|
|
18077
18474
|
"readOnly": true,
|
|
18078
18475
|
"type": "string"
|
|
18079
18476
|
},
|
|
@@ -18089,6 +18486,10 @@
|
|
|
18089
18486
|
"$ref": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig",
|
|
18090
18487
|
"description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
|
|
18091
18488
|
},
|
|
18489
|
+
"identityMappingStore": {
|
|
18490
|
+
"description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.",
|
|
18491
|
+
"type": "string"
|
|
18492
|
+
},
|
|
18092
18493
|
"industryVertical": {
|
|
18093
18494
|
"description": "Immutable. The industry vertical that the data store registers.",
|
|
18094
18495
|
"enum": [
|
|
@@ -18209,6 +18610,21 @@
|
|
|
18209
18610
|
},
|
|
18210
18611
|
"type": "object"
|
|
18211
18612
|
},
|
|
18613
|
+
"GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries": {
|
|
18614
|
+
"description": "The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.",
|
|
18615
|
+
"id": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries",
|
|
18616
|
+
"properties": {
|
|
18617
|
+
"autoRefreshCrawlRate": {
|
|
18618
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
|
|
18619
|
+
"description": "Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically."
|
|
18620
|
+
},
|
|
18621
|
+
"userTriggeredCrawlRate": {
|
|
18622
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
|
|
18623
|
+
"description": "Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users."
|
|
18624
|
+
}
|
|
18625
|
+
},
|
|
18626
|
+
"type": "object"
|
|
18627
|
+
},
|
|
18212
18628
|
"GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": {
|
|
18213
18629
|
"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
18214
18630
|
"id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata",
|
|
@@ -18738,6 +19154,10 @@
|
|
|
18738
19154
|
"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig",
|
|
18739
19155
|
"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation."
|
|
18740
19156
|
},
|
|
19157
|
+
"allowCrossRegion": {
|
|
19158
|
+
"description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.",
|
|
19159
|
+
"type": "boolean"
|
|
19160
|
+
},
|
|
18741
19161
|
"dialogflowAgentToLink": {
|
|
18742
19162
|
"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.",
|
|
18743
19163
|
"type": "string"
|
|
@@ -19529,7 +19949,7 @@
|
|
|
19529
19949
|
"type": "object"
|
|
19530
19950
|
},
|
|
19531
19951
|
"GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata": {
|
|
19532
|
-
"description": "IdentityMappingEntry LongRunningOperation metadata for
|
|
19952
|
+
"description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings",
|
|
19533
19953
|
"id": "GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata",
|
|
19534
19954
|
"properties": {
|
|
19535
19955
|
"failureCount": {
|
|
@@ -20490,6 +20910,66 @@
|
|
|
20490
20910
|
},
|
|
20491
20911
|
"type": "object"
|
|
20492
20912
|
},
|
|
20913
|
+
"GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest": {
|
|
20914
|
+
"description": "Request message for CrawlRateManagementService.ObtainCrawlRate method.",
|
|
20915
|
+
"id": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest",
|
|
20916
|
+
"properties": {
|
|
20917
|
+
"crawlRateScope": {
|
|
20918
|
+
"description": "Required. The scope of the crawl rate that the user wants to monitor. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.",
|
|
20919
|
+
"type": "string"
|
|
20920
|
+
}
|
|
20921
|
+
},
|
|
20922
|
+
"type": "object"
|
|
20923
|
+
},
|
|
20924
|
+
"GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse": {
|
|
20925
|
+
"description": "Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.",
|
|
20926
|
+
"id": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse",
|
|
20927
|
+
"properties": {
|
|
20928
|
+
"dedicatedCrawlRateTimeSeries": {
|
|
20929
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries",
|
|
20930
|
+
"description": "The historical dedicated crawl rate timeseries data, used for monitoring."
|
|
20931
|
+
},
|
|
20932
|
+
"error": {
|
|
20933
|
+
"$ref": "GoogleRpcStatus",
|
|
20934
|
+
"description": "Errors from service when handling the request."
|
|
20935
|
+
},
|
|
20936
|
+
"organicCrawlRateTimeSeries": {
|
|
20937
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries",
|
|
20938
|
+
"description": "The historical organic crawl rate timeseries data, used for monitoring."
|
|
20939
|
+
},
|
|
20940
|
+
"state": {
|
|
20941
|
+
"description": "Output only. The state of the response.",
|
|
20942
|
+
"enum": [
|
|
20943
|
+
"STATE_UNSPECIFIED",
|
|
20944
|
+
"SUCCEEDED",
|
|
20945
|
+
"FAILED"
|
|
20946
|
+
],
|
|
20947
|
+
"enumDescriptions": [
|
|
20948
|
+
"The state is unspecified.",
|
|
20949
|
+
"The state is successful.",
|
|
20950
|
+
"The state is failed."
|
|
20951
|
+
],
|
|
20952
|
+
"readOnly": true,
|
|
20953
|
+
"type": "string"
|
|
20954
|
+
}
|
|
20955
|
+
},
|
|
20956
|
+
"type": "object"
|
|
20957
|
+
},
|
|
20958
|
+
"GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries": {
|
|
20959
|
+
"description": "The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website.",
|
|
20960
|
+
"id": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries",
|
|
20961
|
+
"properties": {
|
|
20962
|
+
"googleOrganicCrawlRate": {
|
|
20963
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
|
|
20964
|
+
"description": "Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots."
|
|
20965
|
+
},
|
|
20966
|
+
"vertexAiOrganicCrawlRate": {
|
|
20967
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
|
|
20968
|
+
"description": "Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot."
|
|
20969
|
+
}
|
|
20970
|
+
},
|
|
20971
|
+
"type": "object"
|
|
20972
|
+
},
|
|
20493
20973
|
"GoogleCloudDiscoveryengineV1betaPageInfo": {
|
|
20494
20974
|
"description": "Detailed page information.",
|
|
20495
20975
|
"id": "GoogleCloudDiscoveryengineV1betaPageInfo",
|
|
@@ -21083,7 +21563,7 @@
|
|
|
21083
21563
|
"id": "GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest",
|
|
21084
21564
|
"properties": {
|
|
21085
21565
|
"siteCredential": {
|
|
21086
|
-
"description": "Optional.
|
|
21566
|
+
"description": "Optional. Credential id to use for crawling.",
|
|
21087
21567
|
"type": "string"
|
|
21088
21568
|
},
|
|
21089
21569
|
"uris": {
|
|
@@ -21096,6 +21576,94 @@
|
|
|
21096
21576
|
},
|
|
21097
21577
|
"type": "object"
|
|
21098
21578
|
},
|
|
21579
|
+
"GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata": {
|
|
21580
|
+
"description": "Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
21581
|
+
"id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata",
|
|
21582
|
+
"properties": {
|
|
21583
|
+
"createTime": {
|
|
21584
|
+
"description": "Operation create time.",
|
|
21585
|
+
"format": "google-datetime",
|
|
21586
|
+
"type": "string"
|
|
21587
|
+
},
|
|
21588
|
+
"updateTime": {
|
|
21589
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
21590
|
+
"format": "google-datetime",
|
|
21591
|
+
"type": "string"
|
|
21592
|
+
}
|
|
21593
|
+
},
|
|
21594
|
+
"type": "object"
|
|
21595
|
+
},
|
|
21596
|
+
"GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest": {
|
|
21597
|
+
"description": "Request message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. The user can remove the dedicated crawl rate for a crawl_rate_scope they own, and Google will fall back to organic crawl, and the crawl rate will be determined by Google.",
|
|
21598
|
+
"id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest",
|
|
21599
|
+
"properties": {
|
|
21600
|
+
"crawlRateScope": {
|
|
21601
|
+
"description": "Required. The scope of the crawl rate change. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.",
|
|
21602
|
+
"type": "string"
|
|
21603
|
+
}
|
|
21604
|
+
},
|
|
21605
|
+
"type": "object"
|
|
21606
|
+
},
|
|
21607
|
+
"GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse": {
|
|
21608
|
+
"description": "Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.",
|
|
21609
|
+
"id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse",
|
|
21610
|
+
"properties": {
|
|
21611
|
+
"error": {
|
|
21612
|
+
"$ref": "GoogleRpcStatus",
|
|
21613
|
+
"description": "Errors from service when handling the request."
|
|
21614
|
+
},
|
|
21615
|
+
"state": {
|
|
21616
|
+
"description": "Output only. The state of the response.",
|
|
21617
|
+
"enum": [
|
|
21618
|
+
"STATE_UNSPECIFIED",
|
|
21619
|
+
"SUCCEEDED",
|
|
21620
|
+
"FAILED"
|
|
21621
|
+
],
|
|
21622
|
+
"enumDescriptions": [
|
|
21623
|
+
"The state is unspecified.",
|
|
21624
|
+
"The state is successful.",
|
|
21625
|
+
"The state is failed."
|
|
21626
|
+
],
|
|
21627
|
+
"readOnly": true,
|
|
21628
|
+
"type": "string"
|
|
21629
|
+
}
|
|
21630
|
+
},
|
|
21631
|
+
"type": "object"
|
|
21632
|
+
},
|
|
21633
|
+
"GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest": {
|
|
21634
|
+
"description": "Request message for CompletionService.RemoveSuggestion method.",
|
|
21635
|
+
"id": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest",
|
|
21636
|
+
"properties": {
|
|
21637
|
+
"removeAllSearchHistorySuggestions": {
|
|
21638
|
+
"description": "Remove all search history suggestions for the user.",
|
|
21639
|
+
"type": "boolean"
|
|
21640
|
+
},
|
|
21641
|
+
"removeTime": {
|
|
21642
|
+
"description": "Required. Time at which the suggestion was removed. If not set, the current time will be used.",
|
|
21643
|
+
"format": "google-datetime",
|
|
21644
|
+
"type": "string"
|
|
21645
|
+
},
|
|
21646
|
+
"searchHistorySuggestion": {
|
|
21647
|
+
"description": "The search history suggestion to be removed.",
|
|
21648
|
+
"type": "string"
|
|
21649
|
+
},
|
|
21650
|
+
"userInfo": {
|
|
21651
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaUserInfo",
|
|
21652
|
+
"description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info."
|
|
21653
|
+
},
|
|
21654
|
+
"userPseudoId": {
|
|
21655
|
+
"description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128.",
|
|
21656
|
+
"type": "string"
|
|
21657
|
+
}
|
|
21658
|
+
},
|
|
21659
|
+
"type": "object"
|
|
21660
|
+
},
|
|
21661
|
+
"GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse": {
|
|
21662
|
+
"description": "Response message for CompletionService.RemoveSuggestion method.",
|
|
21663
|
+
"id": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse",
|
|
21664
|
+
"properties": {},
|
|
21665
|
+
"type": "object"
|
|
21666
|
+
},
|
|
21099
21667
|
"GoogleCloudDiscoveryengineV1betaReply": {
|
|
21100
21668
|
"description": "Defines a reply message to user.",
|
|
21101
21669
|
"id": "GoogleCloudDiscoveryengineV1betaReply",
|
|
@@ -21490,15 +22058,33 @@
|
|
|
21490
22058
|
"description": "The query expansion specification that specifies the conditions under which query expansion occurs."
|
|
21491
22059
|
},
|
|
21492
22060
|
"rankingExpression": {
|
|
21493
|
-
"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.",
|
|
22061
|
+
"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",
|
|
22062
|
+
"type": "string"
|
|
22063
|
+
},
|
|
22064
|
+
"rankingExpressionBackend": {
|
|
22065
|
+
"description": "Optional. The backend to use for the ranking expression evaluation.",
|
|
22066
|
+
"enum": [
|
|
22067
|
+
"UNKNOWN",
|
|
22068
|
+
"BYOE",
|
|
22069
|
+
"CLEARBOX"
|
|
22070
|
+
],
|
|
22071
|
+
"enumDescriptions": [
|
|
22072
|
+
"Default option for unspecified/unknown values.",
|
|
22073
|
+
"Bring your own embedding (BYOE), the default way to evaluate the ranking expression.",
|
|
22074
|
+
"The expression is compiled into a Clearbox formula."
|
|
22075
|
+
],
|
|
21494
22076
|
"type": "string"
|
|
21495
22077
|
},
|
|
21496
22078
|
"regionCode": {
|
|
21497
22079
|
"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.",
|
|
21498
22080
|
"type": "string"
|
|
21499
22081
|
},
|
|
22082
|
+
"relevanceScoreSpec": {
|
|
22083
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec",
|
|
22084
|
+
"description": "Optional. The specification for returning the relevance score."
|
|
22085
|
+
},
|
|
21500
22086
|
"relevanceThreshold": {
|
|
21501
|
-
"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.",
|
|
22087
|
+
"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.",
|
|
21502
22088
|
"enum": [
|
|
21503
22089
|
"RELEVANCE_THRESHOLD_UNSPECIFIED",
|
|
21504
22090
|
"LOWEST",
|
|
@@ -22039,6 +22625,17 @@
|
|
|
22039
22625
|
},
|
|
22040
22626
|
"type": "object"
|
|
22041
22627
|
},
|
|
22628
|
+
"GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec": {
|
|
22629
|
+
"description": "The specification for returning the document relevance score.",
|
|
22630
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec",
|
|
22631
|
+
"properties": {
|
|
22632
|
+
"returnRelevanceScore": {
|
|
22633
|
+
"description": "Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.",
|
|
22634
|
+
"type": "boolean"
|
|
22635
|
+
}
|
|
22636
|
+
},
|
|
22637
|
+
"type": "object"
|
|
22638
|
+
},
|
|
22042
22639
|
"GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": {
|
|
22043
22640
|
"description": "Specification for search as you type in search requests.",
|
|
22044
22641
|
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec",
|
|
@@ -22048,12 +22645,14 @@
|
|
|
22048
22645
|
"enum": [
|
|
22049
22646
|
"CONDITION_UNSPECIFIED",
|
|
22050
22647
|
"DISABLED",
|
|
22051
|
-
"ENABLED"
|
|
22648
|
+
"ENABLED",
|
|
22649
|
+
"AUTO"
|
|
22052
22650
|
],
|
|
22053
22651
|
"enumDescriptions": [
|
|
22054
22652
|
"Server behavior defaults to Condition.DISABLED.",
|
|
22055
22653
|
"Disables Search As You Type.",
|
|
22056
|
-
"Enables Search As You Type."
|
|
22654
|
+
"Enables Search As You Type.",
|
|
22655
|
+
"Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)."
|
|
22057
22656
|
],
|
|
22058
22657
|
"type": "string"
|
|
22059
22658
|
}
|
|
@@ -22069,7 +22668,7 @@
|
|
|
22069
22668
|
"type": "string"
|
|
22070
22669
|
},
|
|
22071
22670
|
"searchResultPersistenceCount": {
|
|
22072
|
-
"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is
|
|
22671
|
+
"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.",
|
|
22073
22672
|
"format": "int32",
|
|
22074
22673
|
"type": "integer"
|
|
22075
22674
|
}
|
|
@@ -22543,7 +23142,8 @@
|
|
|
22543
23142
|
"additionalProperties": {
|
|
22544
23143
|
"$ref": "GoogleCloudDiscoveryengineV1betaDoubleList"
|
|
22545
23144
|
},
|
|
22546
|
-
"description": "Google provided available scores.",
|
|
23145
|
+
"description": "Output only. Google provided available scores.",
|
|
23146
|
+
"readOnly": true,
|
|
22547
23147
|
"type": "object"
|
|
22548
23148
|
}
|
|
22549
23149
|
},
|
|
@@ -23001,6 +23601,93 @@
|
|
|
23001
23601
|
},
|
|
23002
23602
|
"type": "object"
|
|
23003
23603
|
},
|
|
23604
|
+
"GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata": {
|
|
23605
|
+
"description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
23606
|
+
"id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata",
|
|
23607
|
+
"properties": {
|
|
23608
|
+
"createTime": {
|
|
23609
|
+
"description": "Operation create time.",
|
|
23610
|
+
"format": "google-datetime",
|
|
23611
|
+
"type": "string"
|
|
23612
|
+
},
|
|
23613
|
+
"updateTime": {
|
|
23614
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
23615
|
+
"format": "google-datetime",
|
|
23616
|
+
"type": "string"
|
|
23617
|
+
}
|
|
23618
|
+
},
|
|
23619
|
+
"type": "object"
|
|
23620
|
+
},
|
|
23621
|
+
"GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest": {
|
|
23622
|
+
"description": "Request message for CrawlRateManagementService.SetDedicatedCrawlRate method. The user can set the crawl rate for a crawl_rate_scope they own. They can set up an overall crawl rate, or set up a user-triggered crawl rate and a auto-refresh crawl rate separately. If an overall crawl rate is set, Vertex AI will automatically splits crawl_rate into user-triggered and auto-refresh.",
|
|
23623
|
+
"id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest",
|
|
23624
|
+
"properties": {
|
|
23625
|
+
"crawlRate": {
|
|
23626
|
+
"description": "Optional. The crawl QPS set by the user. It is not guaranteed that Vertex crawl bot will crawl at this QPS. If the crawl rate is too high, the real QPS may be lower than the value set by the user to avoid overloading the user's website.",
|
|
23627
|
+
"format": "int32",
|
|
23628
|
+
"type": "integer"
|
|
23629
|
+
},
|
|
23630
|
+
"crawlRateScope": {
|
|
23631
|
+
"description": "Required. The scope of the crawl rate that the user wants to config. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.",
|
|
23632
|
+
"type": "string"
|
|
23633
|
+
},
|
|
23634
|
+
"crawlType": {
|
|
23635
|
+
"description": "Optional. Whether it's the crawl rate of user-triggered or auto-refresh.",
|
|
23636
|
+
"enum": [
|
|
23637
|
+
"CRAWL_TYPE_UNSPECIFIED",
|
|
23638
|
+
"USER_TRIGGERED",
|
|
23639
|
+
"AUTO_REFRESH"
|
|
23640
|
+
],
|
|
23641
|
+
"enumDescriptions": [
|
|
23642
|
+
"The crawl type is unspecified.",
|
|
23643
|
+
"The crawl type is user-triggered.",
|
|
23644
|
+
"The crawl type is auto-refresh."
|
|
23645
|
+
],
|
|
23646
|
+
"type": "string"
|
|
23647
|
+
},
|
|
23648
|
+
"mode": {
|
|
23649
|
+
"description": "Optional. Whether the rate is explicitly set by users, or set by vertex AI.",
|
|
23650
|
+
"enum": [
|
|
23651
|
+
"MODE_UNSPECIFIED",
|
|
23652
|
+
"AUTOMATIC",
|
|
23653
|
+
"EXPLICIT"
|
|
23654
|
+
],
|
|
23655
|
+
"enumDescriptions": [
|
|
23656
|
+
"The mode is unspecified. If the user does not specify the mode, default to AUTOMATIC.",
|
|
23657
|
+
"Vertex AI automatically splits crawl_rate into user-triggered and auto-refresh. Users don't need to specify SetDedicatedCrawlRateRequest.CrawlType if the mode is AUTOMATIC.",
|
|
23658
|
+
"Users explicitly set user-triggered or auto-refresh crawl rate."
|
|
23659
|
+
],
|
|
23660
|
+
"type": "string"
|
|
23661
|
+
}
|
|
23662
|
+
},
|
|
23663
|
+
"type": "object"
|
|
23664
|
+
},
|
|
23665
|
+
"GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse": {
|
|
23666
|
+
"description": "Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.",
|
|
23667
|
+
"id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse",
|
|
23668
|
+
"properties": {
|
|
23669
|
+
"error": {
|
|
23670
|
+
"$ref": "GoogleRpcStatus",
|
|
23671
|
+
"description": "Errors from service when handling the request."
|
|
23672
|
+
},
|
|
23673
|
+
"state": {
|
|
23674
|
+
"description": "Output only. The state of the response.",
|
|
23675
|
+
"enum": [
|
|
23676
|
+
"STATE_UNSPECIFIED",
|
|
23677
|
+
"SUCCEEDED",
|
|
23678
|
+
"FAILED"
|
|
23679
|
+
],
|
|
23680
|
+
"enumDescriptions": [
|
|
23681
|
+
"The state is unspecified.",
|
|
23682
|
+
"The state is successful.",
|
|
23683
|
+
"The state is failed."
|
|
23684
|
+
],
|
|
23685
|
+
"readOnly": true,
|
|
23686
|
+
"type": "string"
|
|
23687
|
+
}
|
|
23688
|
+
},
|
|
23689
|
+
"type": "object"
|
|
23690
|
+
},
|
|
23004
23691
|
"GoogleCloudDiscoveryengineV1betaSingleRegionKey": {
|
|
23005
23692
|
"description": "Metadata for single-regional CMEKs.",
|
|
23006
23693
|
"id": "GoogleCloudDiscoveryengineV1betaSingleRegionKey",
|