google-api-python-client 2.160.0__py2.py3-none-any.whl → 2.162.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.160.0.dist-info → google_api_python_client-2.162.0.dist-info}/METADATA +1 -1
- {google_api_python_client-2.160.0.dist-info → google_api_python_client-2.162.0.dist-info}/RECORD +242 -242
- 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/admin.reports_v1.json +4 -4
- googleapiclient/discovery_cache/documents/admin.reportsv1.json +4 -4
- googleapiclient/discovery_cache/documents/adsense.v2.json +105 -3
- googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json +4 -4
- googleapiclient/discovery_cache/documents/aiplatform.v1.json +666 -16
- googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +657 -18
- googleapiclient/discovery_cache/documents/alloydb.v1.json +245 -12
- googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +184 -12
- googleapiclient/discovery_cache/documents/alloydb.v1beta.json +208 -12
- googleapiclient/discovery_cache/documents/analyticshub.v1.json +57 -8
- googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +6 -2
- googleapiclient/discovery_cache/documents/androidenterprise.v1.json +34 -1
- googleapiclient/discovery_cache/documents/androidmanagement.v1.json +48 -3
- googleapiclient/discovery_cache/documents/apigee.v1.json +86 -5
- googleapiclient/discovery_cache/documents/appengine.v1.json +27 -3
- googleapiclient/discovery_cache/documents/appengine.v1beta.json +27 -3
- googleapiclient/discovery_cache/documents/apphub.v1.json +3 -391
- googleapiclient/discovery_cache/documents/apphub.v1alpha.json +3 -391
- googleapiclient/discovery_cache/documents/areainsights.v1.json +3 -3
- googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +2 -2
- googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json +2 -2
- googleapiclient/discovery_cache/documents/backupdr.v1.json +317 -4
- googleapiclient/discovery_cache/documents/batch.v1.json +52 -5
- googleapiclient/discovery_cache/documents/bigquery.v2.json +457 -14
- googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +36 -1
- googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +2 -2
- googleapiclient/discovery_cache/documents/binaryauthorization.v1.json +3 -2
- googleapiclient/discovery_cache/documents/calendar.v3.json +147 -24
- googleapiclient/discovery_cache/documents/certificatemanager.v1.json +25 -3
- googleapiclient/discovery_cache/documents/chat.v1.json +133 -79
- googleapiclient/discovery_cache/documents/chromemanagement.v1.json +97 -12
- 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 +26 -2
- googleapiclient/discovery_cache/documents/clouddeploy.v1.json +10 -9
- googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +53 -11
- googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +53 -11
- googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +53 -11
- googleapiclient/discovery_cache/documents/cloudidentity.v1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +17 -4
- googleapiclient/discovery_cache/documents/cloudkms.v1.json +76 -10
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +2 -2
- googleapiclient/discovery_cache/documents/cloudtasks.v2.json +2 -2
- googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.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 +2138 -95
- googleapiclient/discovery_cache/documents/compute.beta.json +573 -35
- googleapiclient/discovery_cache/documents/compute.v1.json +1277 -169
- googleapiclient/discovery_cache/documents/connectors.v1.json +73 -5
- googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +2 -6
- googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +93 -17
- googleapiclient/discovery_cache/documents/container.v1.json +65 -10
- googleapiclient/discovery_cache/documents/container.v1beta1.json +66 -11
- googleapiclient/discovery_cache/documents/containeranalysis.v1.json +144 -2
- googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +143 -1
- googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +143 -1
- googleapiclient/discovery_cache/documents/content.v2.1.json +13 -3
- 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/dataflow.v1b3.json +9 -3
- googleapiclient/discovery_cache/documents/dataform.v1beta1.json +63 -17
- googleapiclient/discovery_cache/documents/datafusion.v1.json +47 -3
- googleapiclient/discovery_cache/documents/datafusion.v1beta1.json +45 -1
- googleapiclient/discovery_cache/documents/datalabeling.v1beta1.json +9 -9
- googleapiclient/discovery_cache/documents/datalineage.v1.json +8 -3
- googleapiclient/discovery_cache/documents/datamigration.v1.json +42 -2
- googleapiclient/discovery_cache/documents/dataplex.v1.json +19 -15
- googleapiclient/discovery_cache/documents/dataportability.v1.json +147 -1
- googleapiclient/discovery_cache/documents/dataportability.v1beta.json +147 -1
- googleapiclient/discovery_cache/documents/dataproc.v1.json +103 -2
- googleapiclient/discovery_cache/documents/datastore.v1.json +3 -3
- googleapiclient/discovery_cache/documents/datastore.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/datastore.v1beta3.json +3 -3
- googleapiclient/discovery_cache/documents/datastream.v1.json +262 -7
- googleapiclient/discovery_cache/documents/developerconnect.v1.json +160 -1
- googleapiclient/discovery_cache/documents/dfareporting.v4.json +9 -5
- googleapiclient/discovery_cache/documents/dialogflow.v2.json +67 -13
- googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +372 -11
- googleapiclient/discovery_cache/documents/dialogflow.v3.json +38 -5
- googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +41 -224
- googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +105 -1
- googleapiclient/discovery_cache/documents/discoveryengine.v1.json +1396 -94
- googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +6948 -4267
- googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +1558 -152
- googleapiclient/discovery_cache/documents/displayvideo.v2.json +154 -225
- googleapiclient/discovery_cache/documents/displayvideo.v3.json +213 -110
- googleapiclient/discovery_cache/documents/displayvideo.v4.json +21293 -106
- googleapiclient/discovery_cache/documents/dlp.v2.json +214 -8
- googleapiclient/discovery_cache/documents/documentai.v1.json +9 -1
- googleapiclient/discovery_cache/documents/documentai.v1beta3.json +11 -3
- googleapiclient/discovery_cache/documents/drive.v2.json +42 -6
- googleapiclient/discovery_cache/documents/drive.v3.json +59 -17
- googleapiclient/discovery_cache/documents/eventarc.v1.json +4 -3
- googleapiclient/discovery_cache/documents/file.v1.json +12 -5
- googleapiclient/discovery_cache/documents/file.v1beta1.json +12 -5
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +83 -8
- googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +102 -5
- googleapiclient/discovery_cache/documents/firestore.v1.json +25 -3
- googleapiclient/discovery_cache/documents/forms.v1.json +17 -1
- googleapiclient/discovery_cache/documents/gkebackup.v1.json +6 -4
- googleapiclient/discovery_cache/documents/gkehub.v1.json +9 -5
- googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +130 -43
- googleapiclient/discovery_cache/documents/gkehub.v1beta.json +9 -43
- googleapiclient/discovery_cache/documents/gkehub.v2.json +7 -3
- googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +7 -3
- googleapiclient/discovery_cache/documents/gkehub.v2beta.json +7 -3
- googleapiclient/discovery_cache/documents/healthcare.v1.json +169 -1
- googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +171 -2
- googleapiclient/discovery_cache/documents/iam.v1.json +6 -4
- googleapiclient/discovery_cache/documents/iam.v2.json +2 -2
- googleapiclient/discovery_cache/documents/iam.v2beta.json +2 -2
- googleapiclient/discovery_cache/documents/identitytoolkit.v1.json +5 -8
- googleapiclient/discovery_cache/documents/identitytoolkit.v2.json +36 -1
- googleapiclient/discovery_cache/documents/ids.v1.json +3 -3
- googleapiclient/discovery_cache/documents/integrations.v1.json +47 -1
- googleapiclient/discovery_cache/documents/kmsinventory.v1.json +13 -5
- googleapiclient/discovery_cache/documents/language.v1.json +7 -1
- googleapiclient/discovery_cache/documents/language.v1beta2.json +7 -1
- googleapiclient/discovery_cache/documents/language.v2.json +7 -1
- googleapiclient/discovery_cache/documents/logging.v2.json +6 -61
- googleapiclient/discovery_cache/documents/looker.v1.json +165 -267
- googleapiclient/discovery_cache/documents/managedidentities.v1.json +7 -7
- googleapiclient/discovery_cache/documents/managedidentities.v1alpha1.json +7 -7
- googleapiclient/discovery_cache/documents/managedidentities.v1beta1.json +7 -7
- googleapiclient/discovery_cache/documents/meet.v2.json +8 -3
- googleapiclient/discovery_cache/documents/memcache.v1.json +2 -390
- googleapiclient/discovery_cache/documents/memcache.v1beta2.json +2 -390
- googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +41 -7
- googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json +9 -2
- googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +9 -1
- googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +9 -1
- googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json +9 -1
- googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json +9 -1
- googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +16 -2
- googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json +23 -9
- googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json +9 -1
- googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json +12 -1
- googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json +21 -1
- googleapiclient/discovery_cache/documents/metastore.v1.json +30 -30
- googleapiclient/discovery_cache/documents/metastore.v1alpha.json +33 -33
- googleapiclient/discovery_cache/documents/metastore.v1beta.json +33 -33
- googleapiclient/discovery_cache/documents/migrationcenter.v1.json +41 -4
- googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +236 -6
- googleapiclient/discovery_cache/documents/monitoring.v1.json +50 -1
- googleapiclient/discovery_cache/documents/monitoring.v3.json +7 -3
- googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +3 -2
- googleapiclient/discovery_cache/documents/netapp.v1.json +304 -1
- googleapiclient/discovery_cache/documents/netapp.v1beta1.json +304 -1
- googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +2 -2
- googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +2 -2
- googleapiclient/discovery_cache/documents/networkmanagement.v1.json +6 -3
- googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +217 -11
- googleapiclient/discovery_cache/documents/networksecurity.v1.json +1720 -478
- googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +477 -97
- googleapiclient/discovery_cache/documents/networkservices.v1.json +5 -5
- googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +5 -5
- 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 +5 -3
- googleapiclient/discovery_cache/documents/orgpolicy.v2.json +29 -29
- 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/playdeveloperreporting.v1alpha1.json +5 -5
- googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json +5 -5
- googleapiclient/discovery_cache/documents/playintegrity.v1.json +1 -43
- googleapiclient/discovery_cache/documents/policysimulator.v1.json +9 -9
- googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +9 -9
- googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +9 -9
- googleapiclient/discovery_cache/documents/privateca.v1.json +26 -1
- googleapiclient/discovery_cache/documents/pubsub.v1.json +45 -1
- googleapiclient/discovery_cache/documents/rapidmigrationassessment.v1.json +2 -2
- googleapiclient/discovery_cache/documents/realtimebidding.v1.json +5 -4
- googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +9 -5
- googleapiclient/discovery_cache/documents/redis.v1.json +150 -20
- googleapiclient/discovery_cache/documents/redis.v1beta1.json +149 -19
- googleapiclient/discovery_cache/documents/retail.v2.json +4 -3
- googleapiclient/discovery_cache/documents/retail.v2alpha.json +4 -3
- googleapiclient/discovery_cache/documents/retail.v2beta.json +4 -3
- googleapiclient/discovery_cache/documents/run.v1.json +151 -2
- googleapiclient/discovery_cache/documents/run.v2.json +2524 -1519
- googleapiclient/discovery_cache/documents/script.v1.json +2 -2
- googleapiclient/discovery_cache/documents/searchconsole.v1.json +2 -1
- googleapiclient/discovery_cache/documents/secretmanager.v1.json +41 -1
- googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +41 -1
- googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +41 -1
- googleapiclient/discovery_cache/documents/securitycenter.v1.json +359 -2
- googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +360 -3
- googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +359 -2
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +42 -4
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +42 -4
- googleapiclient/discovery_cache/documents/servicecontrol.v1.json +6 -2
- googleapiclient/discovery_cache/documents/servicecontrol.v2.json +5 -1
- googleapiclient/discovery_cache/documents/servicemanagement.v1.json +40 -2
- googleapiclient/discovery_cache/documents/servicenetworking.v1.json +42 -4
- googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +42 -4
- googleapiclient/discovery_cache/documents/serviceusage.v1.json +43 -5
- googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +43 -5
- googleapiclient/discovery_cache/documents/sheets.v4.json +2 -2
- googleapiclient/discovery_cache/documents/spanner.v1.json +29 -10
- googleapiclient/discovery_cache/documents/sqladmin.v1.json +458 -9
- googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +462 -11
- googleapiclient/discovery_cache/documents/storagetransfer.v1.json +3 -3
- googleapiclient/discovery_cache/documents/sts.v1.json +46 -1
- googleapiclient/discovery_cache/documents/sts.v1beta.json +46 -1
- googleapiclient/discovery_cache/documents/tagmanager.v2.json +9 -1
- googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +2 -1
- googleapiclient/discovery_cache/documents/tpu.v2.json +2 -2
- googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +9 -4
- googleapiclient/discovery_cache/documents/trafficdirector.v3.json +41 -15
- googleapiclient/discovery_cache/documents/vault.v1.json +109 -20
- googleapiclient/discovery_cache/documents/videointelligence.v1.json +3 -3
- googleapiclient/discovery_cache/documents/vmmigration.v1.json +7 -5
- googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +7 -5
- googleapiclient/discovery_cache/documents/vmwareengine.v1.json +665 -1
- googleapiclient/discovery_cache/documents/walletobjects.v1.json +56 -1
- googleapiclient/discovery_cache/documents/webfonts.v1.json +6 -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 +1110 -18
- googleapiclient/discovery_cache/documents/workstations.v1beta.json +14 -1
- googleapiclient/discovery_cache/documents/youtube.v3.json +60 -1
- googleapiclient/version.py +1 -1
- {google_api_python_client-2.160.0.dist-info → google_api_python_client-2.162.0.dist-info}/LICENSE +0 -0
- {google_api_python_client-2.160.0.dist-info → google_api_python_client-2.162.0.dist-info}/WHEEL +0 -0
- {google_api_python_client-2.160.0.dist-info → google_api_python_client-2.162.0.dist-info}/top_level.txt +0 -0
|
@@ -2317,6 +2317,94 @@
|
|
|
2317
2317
|
}
|
|
2318
2318
|
}
|
|
2319
2319
|
},
|
|
2320
|
+
"sitemaps": {
|
|
2321
|
+
"methods": {
|
|
2322
|
+
"create": {
|
|
2323
|
+
"description": "Creates a Sitemap.",
|
|
2324
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps",
|
|
2325
|
+
"httpMethod": "POST",
|
|
2326
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.create",
|
|
2327
|
+
"parameterOrder": [
|
|
2328
|
+
"parent"
|
|
2329
|
+
],
|
|
2330
|
+
"parameters": {
|
|
2331
|
+
"parent": {
|
|
2332
|
+
"description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
|
|
2333
|
+
"location": "path",
|
|
2334
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
|
|
2335
|
+
"required": true,
|
|
2336
|
+
"type": "string"
|
|
2337
|
+
}
|
|
2338
|
+
},
|
|
2339
|
+
"path": "v1/{+parent}/sitemaps",
|
|
2340
|
+
"request": {
|
|
2341
|
+
"$ref": "GoogleCloudDiscoveryengineV1Sitemap"
|
|
2342
|
+
},
|
|
2343
|
+
"response": {
|
|
2344
|
+
"$ref": "GoogleLongrunningOperation"
|
|
2345
|
+
},
|
|
2346
|
+
"scopes": [
|
|
2347
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
2348
|
+
]
|
|
2349
|
+
},
|
|
2350
|
+
"delete": {
|
|
2351
|
+
"description": "Deletes a Sitemap.",
|
|
2352
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}",
|
|
2353
|
+
"httpMethod": "DELETE",
|
|
2354
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.delete",
|
|
2355
|
+
"parameterOrder": [
|
|
2356
|
+
"name"
|
|
2357
|
+
],
|
|
2358
|
+
"parameters": {
|
|
2359
|
+
"name": {
|
|
2360
|
+
"description": "Required. Full resource name of Sitemap, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned.",
|
|
2361
|
+
"location": "path",
|
|
2362
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/sitemaps/[^/]+$",
|
|
2363
|
+
"required": true,
|
|
2364
|
+
"type": "string"
|
|
2365
|
+
}
|
|
2366
|
+
},
|
|
2367
|
+
"path": "v1/{+name}",
|
|
2368
|
+
"response": {
|
|
2369
|
+
"$ref": "GoogleLongrunningOperation"
|
|
2370
|
+
},
|
|
2371
|
+
"scopes": [
|
|
2372
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
2373
|
+
]
|
|
2374
|
+
},
|
|
2375
|
+
"fetch": {
|
|
2376
|
+
"description": "Fetch Sitemaps in a DataStore.",
|
|
2377
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch",
|
|
2378
|
+
"httpMethod": "GET",
|
|
2379
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.fetch",
|
|
2380
|
+
"parameterOrder": [
|
|
2381
|
+
"parent"
|
|
2382
|
+
],
|
|
2383
|
+
"parameters": {
|
|
2384
|
+
"matcher.urisMatcher.uris": {
|
|
2385
|
+
"description": "The Sitemap uris.",
|
|
2386
|
+
"location": "query",
|
|
2387
|
+
"repeated": true,
|
|
2388
|
+
"type": "string"
|
|
2389
|
+
},
|
|
2390
|
+
"parent": {
|
|
2391
|
+
"description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
|
|
2392
|
+
"location": "path",
|
|
2393
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
|
|
2394
|
+
"required": true,
|
|
2395
|
+
"type": "string"
|
|
2396
|
+
}
|
|
2397
|
+
},
|
|
2398
|
+
"path": "v1/{+parent}/sitemaps:fetch",
|
|
2399
|
+
"response": {
|
|
2400
|
+
"$ref": "GoogleCloudDiscoveryengineV1FetchSitemapsResponse"
|
|
2401
|
+
},
|
|
2402
|
+
"scopes": [
|
|
2403
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
2404
|
+
]
|
|
2405
|
+
}
|
|
2406
|
+
}
|
|
2407
|
+
},
|
|
2320
2408
|
"targetSites": {
|
|
2321
2409
|
"methods": {
|
|
2322
2410
|
"batchCreate": {
|
|
@@ -5582,6 +5670,94 @@
|
|
|
5582
5670
|
}
|
|
5583
5671
|
},
|
|
5584
5672
|
"resources": {
|
|
5673
|
+
"sitemaps": {
|
|
5674
|
+
"methods": {
|
|
5675
|
+
"create": {
|
|
5676
|
+
"description": "Creates a Sitemap.",
|
|
5677
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps",
|
|
5678
|
+
"httpMethod": "POST",
|
|
5679
|
+
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.create",
|
|
5680
|
+
"parameterOrder": [
|
|
5681
|
+
"parent"
|
|
5682
|
+
],
|
|
5683
|
+
"parameters": {
|
|
5684
|
+
"parent": {
|
|
5685
|
+
"description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
|
|
5686
|
+
"location": "path",
|
|
5687
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
|
|
5688
|
+
"required": true,
|
|
5689
|
+
"type": "string"
|
|
5690
|
+
}
|
|
5691
|
+
},
|
|
5692
|
+
"path": "v1/{+parent}/sitemaps",
|
|
5693
|
+
"request": {
|
|
5694
|
+
"$ref": "GoogleCloudDiscoveryengineV1Sitemap"
|
|
5695
|
+
},
|
|
5696
|
+
"response": {
|
|
5697
|
+
"$ref": "GoogleLongrunningOperation"
|
|
5698
|
+
},
|
|
5699
|
+
"scopes": [
|
|
5700
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
5701
|
+
]
|
|
5702
|
+
},
|
|
5703
|
+
"delete": {
|
|
5704
|
+
"description": "Deletes a Sitemap.",
|
|
5705
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}",
|
|
5706
|
+
"httpMethod": "DELETE",
|
|
5707
|
+
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.delete",
|
|
5708
|
+
"parameterOrder": [
|
|
5709
|
+
"name"
|
|
5710
|
+
],
|
|
5711
|
+
"parameters": {
|
|
5712
|
+
"name": {
|
|
5713
|
+
"description": "Required. Full resource name of Sitemap, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned.",
|
|
5714
|
+
"location": "path",
|
|
5715
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/sitemaps/[^/]+$",
|
|
5716
|
+
"required": true,
|
|
5717
|
+
"type": "string"
|
|
5718
|
+
}
|
|
5719
|
+
},
|
|
5720
|
+
"path": "v1/{+name}",
|
|
5721
|
+
"response": {
|
|
5722
|
+
"$ref": "GoogleLongrunningOperation"
|
|
5723
|
+
},
|
|
5724
|
+
"scopes": [
|
|
5725
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
5726
|
+
]
|
|
5727
|
+
},
|
|
5728
|
+
"fetch": {
|
|
5729
|
+
"description": "Fetch Sitemaps in a DataStore.",
|
|
5730
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch",
|
|
5731
|
+
"httpMethod": "GET",
|
|
5732
|
+
"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.fetch",
|
|
5733
|
+
"parameterOrder": [
|
|
5734
|
+
"parent"
|
|
5735
|
+
],
|
|
5736
|
+
"parameters": {
|
|
5737
|
+
"matcher.urisMatcher.uris": {
|
|
5738
|
+
"description": "The Sitemap uris.",
|
|
5739
|
+
"location": "query",
|
|
5740
|
+
"repeated": true,
|
|
5741
|
+
"type": "string"
|
|
5742
|
+
},
|
|
5743
|
+
"parent": {
|
|
5744
|
+
"description": "Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
|
|
5745
|
+
"location": "path",
|
|
5746
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$",
|
|
5747
|
+
"required": true,
|
|
5748
|
+
"type": "string"
|
|
5749
|
+
}
|
|
5750
|
+
},
|
|
5751
|
+
"path": "v1/{+parent}/sitemaps:fetch",
|
|
5752
|
+
"response": {
|
|
5753
|
+
"$ref": "GoogleCloudDiscoveryengineV1FetchSitemapsResponse"
|
|
5754
|
+
},
|
|
5755
|
+
"scopes": [
|
|
5756
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
5757
|
+
]
|
|
5758
|
+
}
|
|
5759
|
+
}
|
|
5760
|
+
},
|
|
5585
5761
|
"targetSites": {
|
|
5586
5762
|
"methods": {
|
|
5587
5763
|
"batchCreate": {
|
|
@@ -5987,6 +6163,229 @@
|
|
|
5987
6163
|
}
|
|
5988
6164
|
},
|
|
5989
6165
|
"identityMappingStores": {
|
|
6166
|
+
"methods": {
|
|
6167
|
+
"create": {
|
|
6168
|
+
"description": "Creates a new Identity Mapping Store.",
|
|
6169
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores",
|
|
6170
|
+
"httpMethod": "POST",
|
|
6171
|
+
"id": "discoveryengine.projects.locations.identityMappingStores.create",
|
|
6172
|
+
"parameterOrder": [
|
|
6173
|
+
"parent"
|
|
6174
|
+
],
|
|
6175
|
+
"parameters": {
|
|
6176
|
+
"cmekConfigName": {
|
|
6177
|
+
"description": "Resource name of the CmekConfig to use for protecting this Identity Mapping Store.",
|
|
6178
|
+
"location": "query",
|
|
6179
|
+
"type": "string"
|
|
6180
|
+
},
|
|
6181
|
+
"disableCmek": {
|
|
6182
|
+
"description": "Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.",
|
|
6183
|
+
"location": "query",
|
|
6184
|
+
"type": "boolean"
|
|
6185
|
+
},
|
|
6186
|
+
"identityMappingStoreId": {
|
|
6187
|
+
"description": "Required. The ID of the Identity Mapping Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.",
|
|
6188
|
+
"location": "query",
|
|
6189
|
+
"type": "string"
|
|
6190
|
+
},
|
|
6191
|
+
"parent": {
|
|
6192
|
+
"description": "Required. The parent collection resource name, such as `projects/{project}/locations/{location}`.",
|
|
6193
|
+
"location": "path",
|
|
6194
|
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
6195
|
+
"required": true,
|
|
6196
|
+
"type": "string"
|
|
6197
|
+
}
|
|
6198
|
+
},
|
|
6199
|
+
"path": "v1/{+parent}/identityMappingStores",
|
|
6200
|
+
"request": {
|
|
6201
|
+
"$ref": "GoogleCloudDiscoveryengineV1IdentityMappingStore"
|
|
6202
|
+
},
|
|
6203
|
+
"response": {
|
|
6204
|
+
"$ref": "GoogleCloudDiscoveryengineV1IdentityMappingStore"
|
|
6205
|
+
},
|
|
6206
|
+
"scopes": [
|
|
6207
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
6208
|
+
]
|
|
6209
|
+
},
|
|
6210
|
+
"delete": {
|
|
6211
|
+
"description": "Deletes the Identity Mapping Store.",
|
|
6212
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}",
|
|
6213
|
+
"httpMethod": "DELETE",
|
|
6214
|
+
"id": "discoveryengine.projects.locations.identityMappingStores.delete",
|
|
6215
|
+
"parameterOrder": [
|
|
6216
|
+
"name"
|
|
6217
|
+
],
|
|
6218
|
+
"parameters": {
|
|
6219
|
+
"name": {
|
|
6220
|
+
"description": "Required. The name of the Identity Mapping Store to delete. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`",
|
|
6221
|
+
"location": "path",
|
|
6222
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$",
|
|
6223
|
+
"required": true,
|
|
6224
|
+
"type": "string"
|
|
6225
|
+
}
|
|
6226
|
+
},
|
|
6227
|
+
"path": "v1/{+name}",
|
|
6228
|
+
"response": {
|
|
6229
|
+
"$ref": "GoogleLongrunningOperation"
|
|
6230
|
+
},
|
|
6231
|
+
"scopes": [
|
|
6232
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
6233
|
+
]
|
|
6234
|
+
},
|
|
6235
|
+
"get": {
|
|
6236
|
+
"description": "Gets the Identity Mapping Store.",
|
|
6237
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}",
|
|
6238
|
+
"httpMethod": "GET",
|
|
6239
|
+
"id": "discoveryengine.projects.locations.identityMappingStores.get",
|
|
6240
|
+
"parameterOrder": [
|
|
6241
|
+
"name"
|
|
6242
|
+
],
|
|
6243
|
+
"parameters": {
|
|
6244
|
+
"name": {
|
|
6245
|
+
"description": "Required. The name of the Identity Mapping Store to get. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`",
|
|
6246
|
+
"location": "path",
|
|
6247
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$",
|
|
6248
|
+
"required": true,
|
|
6249
|
+
"type": "string"
|
|
6250
|
+
}
|
|
6251
|
+
},
|
|
6252
|
+
"path": "v1/{+name}",
|
|
6253
|
+
"response": {
|
|
6254
|
+
"$ref": "GoogleCloudDiscoveryengineV1IdentityMappingStore"
|
|
6255
|
+
},
|
|
6256
|
+
"scopes": [
|
|
6257
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
6258
|
+
]
|
|
6259
|
+
},
|
|
6260
|
+
"importIdentityMappings": {
|
|
6261
|
+
"description": "Imports a list of Identity Mapping Entries to an Identity Mapping Store.",
|
|
6262
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:importIdentityMappings",
|
|
6263
|
+
"httpMethod": "POST",
|
|
6264
|
+
"id": "discoveryengine.projects.locations.identityMappingStores.importIdentityMappings",
|
|
6265
|
+
"parameterOrder": [
|
|
6266
|
+
"identityMappingStore"
|
|
6267
|
+
],
|
|
6268
|
+
"parameters": {
|
|
6269
|
+
"identityMappingStore": {
|
|
6270
|
+
"description": "Required. The name of the Identity Mapping Store to import Identity Mapping Entries to. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`",
|
|
6271
|
+
"location": "path",
|
|
6272
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$",
|
|
6273
|
+
"required": true,
|
|
6274
|
+
"type": "string"
|
|
6275
|
+
}
|
|
6276
|
+
},
|
|
6277
|
+
"path": "v1/{+identityMappingStore}:importIdentityMappings",
|
|
6278
|
+
"request": {
|
|
6279
|
+
"$ref": "GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest"
|
|
6280
|
+
},
|
|
6281
|
+
"response": {
|
|
6282
|
+
"$ref": "GoogleLongrunningOperation"
|
|
6283
|
+
},
|
|
6284
|
+
"scopes": [
|
|
6285
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
6286
|
+
]
|
|
6287
|
+
},
|
|
6288
|
+
"list": {
|
|
6289
|
+
"description": "Lists all Identity Mapping Stores.",
|
|
6290
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores",
|
|
6291
|
+
"httpMethod": "GET",
|
|
6292
|
+
"id": "discoveryengine.projects.locations.identityMappingStores.list",
|
|
6293
|
+
"parameterOrder": [
|
|
6294
|
+
"parent"
|
|
6295
|
+
],
|
|
6296
|
+
"parameters": {
|
|
6297
|
+
"pageSize": {
|
|
6298
|
+
"description": "Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.",
|
|
6299
|
+
"format": "int32",
|
|
6300
|
+
"location": "query",
|
|
6301
|
+
"type": "integer"
|
|
6302
|
+
},
|
|
6303
|
+
"pageToken": {
|
|
6304
|
+
"description": "A page token, received from a previous `ListIdentityMappingStores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappingStores` must match the call that provided the page token.",
|
|
6305
|
+
"location": "query",
|
|
6306
|
+
"type": "string"
|
|
6307
|
+
},
|
|
6308
|
+
"parent": {
|
|
6309
|
+
"description": "Required. The parent of the Identity Mapping Stores to list. Format: `projects/{project}/locations/{location}`.",
|
|
6310
|
+
"location": "path",
|
|
6311
|
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
6312
|
+
"required": true,
|
|
6313
|
+
"type": "string"
|
|
6314
|
+
}
|
|
6315
|
+
},
|
|
6316
|
+
"path": "v1/{+parent}/identityMappingStores",
|
|
6317
|
+
"response": {
|
|
6318
|
+
"$ref": "GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse"
|
|
6319
|
+
},
|
|
6320
|
+
"scopes": [
|
|
6321
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
6322
|
+
]
|
|
6323
|
+
},
|
|
6324
|
+
"listIdentityMappings": {
|
|
6325
|
+
"description": "Lists Identity Mappings in an Identity Mapping Store.",
|
|
6326
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:listIdentityMappings",
|
|
6327
|
+
"httpMethod": "GET",
|
|
6328
|
+
"id": "discoveryengine.projects.locations.identityMappingStores.listIdentityMappings",
|
|
6329
|
+
"parameterOrder": [
|
|
6330
|
+
"identityMappingStore"
|
|
6331
|
+
],
|
|
6332
|
+
"parameters": {
|
|
6333
|
+
"identityMappingStore": {
|
|
6334
|
+
"description": "Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`",
|
|
6335
|
+
"location": "path",
|
|
6336
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$",
|
|
6337
|
+
"required": true,
|
|
6338
|
+
"type": "string"
|
|
6339
|
+
},
|
|
6340
|
+
"pageSize": {
|
|
6341
|
+
"description": "Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000.",
|
|
6342
|
+
"format": "int32",
|
|
6343
|
+
"location": "query",
|
|
6344
|
+
"type": "integer"
|
|
6345
|
+
},
|
|
6346
|
+
"pageToken": {
|
|
6347
|
+
"description": "A page token, received from a previous `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token.",
|
|
6348
|
+
"location": "query",
|
|
6349
|
+
"type": "string"
|
|
6350
|
+
}
|
|
6351
|
+
},
|
|
6352
|
+
"path": "v1/{+identityMappingStore}:listIdentityMappings",
|
|
6353
|
+
"response": {
|
|
6354
|
+
"$ref": "GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse"
|
|
6355
|
+
},
|
|
6356
|
+
"scopes": [
|
|
6357
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
6358
|
+
]
|
|
6359
|
+
},
|
|
6360
|
+
"purgeIdentityMappings": {
|
|
6361
|
+
"description": "Purges specified or all Identity Mapping Entries from an Identity Mapping Store.",
|
|
6362
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}:purgeIdentityMappings",
|
|
6363
|
+
"httpMethod": "POST",
|
|
6364
|
+
"id": "discoveryengine.projects.locations.identityMappingStores.purgeIdentityMappings",
|
|
6365
|
+
"parameterOrder": [
|
|
6366
|
+
"identityMappingStore"
|
|
6367
|
+
],
|
|
6368
|
+
"parameters": {
|
|
6369
|
+
"identityMappingStore": {
|
|
6370
|
+
"description": "Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`",
|
|
6371
|
+
"location": "path",
|
|
6372
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$",
|
|
6373
|
+
"required": true,
|
|
6374
|
+
"type": "string"
|
|
6375
|
+
}
|
|
6376
|
+
},
|
|
6377
|
+
"path": "v1/{+identityMappingStore}:purgeIdentityMappings",
|
|
6378
|
+
"request": {
|
|
6379
|
+
"$ref": "GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest"
|
|
6380
|
+
},
|
|
6381
|
+
"response": {
|
|
6382
|
+
"$ref": "GoogleLongrunningOperation"
|
|
6383
|
+
},
|
|
6384
|
+
"scopes": [
|
|
6385
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
6386
|
+
]
|
|
6387
|
+
}
|
|
6388
|
+
},
|
|
5990
6389
|
"resources": {
|
|
5991
6390
|
"operations": {
|
|
5992
6391
|
"methods": {
|
|
@@ -6371,7 +6770,7 @@
|
|
|
6371
6770
|
}
|
|
6372
6771
|
}
|
|
6373
6772
|
},
|
|
6374
|
-
"revision": "
|
|
6773
|
+
"revision": "20250214",
|
|
6375
6774
|
"rootUrl": "https://discoveryengine.googleapis.com/",
|
|
6376
6775
|
"schemas": {
|
|
6377
6776
|
"GoogleApiDistribution": {
|
|
@@ -6924,7 +7323,7 @@
|
|
|
6924
7323
|
"id": "GoogleCloudDiscoveryengineV1AnswerCitation",
|
|
6925
7324
|
"properties": {
|
|
6926
7325
|
"endIndex": {
|
|
6927
|
-
"description": "End of the attributed segment, exclusive.",
|
|
7326
|
+
"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.",
|
|
6928
7327
|
"format": "int64",
|
|
6929
7328
|
"type": "string"
|
|
6930
7329
|
},
|
|
@@ -6936,7 +7335,7 @@
|
|
|
6936
7335
|
"type": "array"
|
|
6937
7336
|
},
|
|
6938
7337
|
"startIndex": {
|
|
6939
|
-
"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).",
|
|
7338
|
+
"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.",
|
|
6940
7339
|
"format": "int64",
|
|
6941
7340
|
"type": "string"
|
|
6942
7341
|
}
|
|
@@ -7000,6 +7399,10 @@
|
|
|
7000
7399
|
"description": "Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.",
|
|
7001
7400
|
"type": "boolean"
|
|
7002
7401
|
},
|
|
7402
|
+
"endUserSpec": {
|
|
7403
|
+
"$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec",
|
|
7404
|
+
"description": "Optional. End user specification."
|
|
7405
|
+
},
|
|
7003
7406
|
"groundingSpec": {
|
|
7004
7407
|
"$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec",
|
|
7005
7408
|
"description": "Optional. Grounding specification."
|
|
@@ -7103,6 +7506,57 @@
|
|
|
7103
7506
|
},
|
|
7104
7507
|
"type": "object"
|
|
7105
7508
|
},
|
|
7509
|
+
"GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec": {
|
|
7510
|
+
"description": "End user specification.",
|
|
7511
|
+
"id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpec",
|
|
7512
|
+
"properties": {
|
|
7513
|
+
"endUserMetadata": {
|
|
7514
|
+
"description": "Optional. End user metadata.",
|
|
7515
|
+
"items": {
|
|
7516
|
+
"$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData"
|
|
7517
|
+
},
|
|
7518
|
+
"type": "array"
|
|
7519
|
+
}
|
|
7520
|
+
},
|
|
7521
|
+
"type": "object"
|
|
7522
|
+
},
|
|
7523
|
+
"GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData": {
|
|
7524
|
+
"description": "End user metadata.",
|
|
7525
|
+
"id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaData",
|
|
7526
|
+
"properties": {
|
|
7527
|
+
"chunkInfo": {
|
|
7528
|
+
"$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo",
|
|
7529
|
+
"description": "Chunk information."
|
|
7530
|
+
}
|
|
7531
|
+
},
|
|
7532
|
+
"type": "object"
|
|
7533
|
+
},
|
|
7534
|
+
"GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo": {
|
|
7535
|
+
"description": "Chunk information.",
|
|
7536
|
+
"id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfo",
|
|
7537
|
+
"properties": {
|
|
7538
|
+
"content": {
|
|
7539
|
+
"description": "Chunk textual content. It is limited to 8000 characters.",
|
|
7540
|
+
"type": "string"
|
|
7541
|
+
},
|
|
7542
|
+
"documentMetadata": {
|
|
7543
|
+
"$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata",
|
|
7544
|
+
"description": "Metadata of the document from the current chunk."
|
|
7545
|
+
}
|
|
7546
|
+
},
|
|
7547
|
+
"type": "object"
|
|
7548
|
+
},
|
|
7549
|
+
"GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata": {
|
|
7550
|
+
"description": "Document metadata contains the information of the document of the current chunk.",
|
|
7551
|
+
"id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestEndUserSpecEndUserMetaDataChunkInfoDocumentMetadata",
|
|
7552
|
+
"properties": {
|
|
7553
|
+
"title": {
|
|
7554
|
+
"description": "Title of the document.",
|
|
7555
|
+
"type": "string"
|
|
7556
|
+
}
|
|
7557
|
+
},
|
|
7558
|
+
"type": "object"
|
|
7559
|
+
},
|
|
7106
7560
|
"GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec": {
|
|
7107
7561
|
"description": "Grounding specification.",
|
|
7108
7562
|
"id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec",
|
|
@@ -7648,6 +8102,16 @@
|
|
|
7648
8102
|
},
|
|
7649
8103
|
"description": "Structured search data.",
|
|
7650
8104
|
"type": "object"
|
|
8105
|
+
},
|
|
8106
|
+
"title": {
|
|
8107
|
+
"description": "Output only. The title of the document.",
|
|
8108
|
+
"readOnly": true,
|
|
8109
|
+
"type": "string"
|
|
8110
|
+
},
|
|
8111
|
+
"uri": {
|
|
8112
|
+
"description": "Output only. The URI of the document.",
|
|
8113
|
+
"readOnly": true,
|
|
8114
|
+
"type": "string"
|
|
7651
8115
|
}
|
|
7652
8116
|
},
|
|
7653
8117
|
"type": "object"
|
|
@@ -8247,7 +8711,7 @@
|
|
|
8247
8711
|
"type": "string"
|
|
8248
8712
|
},
|
|
8249
8713
|
"endPos": {
|
|
8250
|
-
"description": "Position indicating the end of the claim in the answer candidate, exclusive.",
|
|
8714
|
+
"description": "Position indicating the end of the claim in the answer candidate, exclusive, in bytes. Note that this is not measured in characters and, therefore, must be rendered as such. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent).",
|
|
8251
8715
|
"format": "int32",
|
|
8252
8716
|
"type": "integer"
|
|
8253
8717
|
},
|
|
@@ -8256,7 +8720,7 @@
|
|
|
8256
8720
|
"type": "boolean"
|
|
8257
8721
|
},
|
|
8258
8722
|
"startPos": {
|
|
8259
|
-
"description": "Position indicating the start of the claim in the answer candidate, measured in bytes.",
|
|
8723
|
+
"description": "Position indicating the start of the claim in the answer candidate, measured in bytes. Note that this is not measured in characters and, therefore, must be rendered in the user interface keeping in mind that some characters may take more than one byte. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent).",
|
|
8260
8724
|
"format": "int32",
|
|
8261
8725
|
"type": "integer"
|
|
8262
8726
|
}
|
|
@@ -8424,11 +8888,11 @@
|
|
|
8424
8888
|
"type": "boolean"
|
|
8425
8889
|
},
|
|
8426
8890
|
"kmsKey": {
|
|
8427
|
-
"description": "
|
|
8891
|
+
"description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
|
|
8428
8892
|
"type": "string"
|
|
8429
8893
|
},
|
|
8430
8894
|
"kmsKeyVersion": {
|
|
8431
|
-
"description": "
|
|
8895
|
+
"description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
|
|
8432
8896
|
"type": "string"
|
|
8433
8897
|
},
|
|
8434
8898
|
"lastRotationTimestampMicros": {
|
|
@@ -8438,7 +8902,7 @@
|
|
|
8438
8902
|
"type": "string"
|
|
8439
8903
|
},
|
|
8440
8904
|
"name": {
|
|
8441
|
-
"description": "Required.
|
|
8905
|
+
"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
|
|
8442
8906
|
"type": "string"
|
|
8443
8907
|
},
|
|
8444
8908
|
"singleRegionKeys": {
|
|
@@ -8449,13 +8913,14 @@
|
|
|
8449
8913
|
"type": "array"
|
|
8450
8914
|
},
|
|
8451
8915
|
"state": {
|
|
8452
|
-
"description": "Output only.
|
|
8916
|
+
"description": "Output only. The states of the CmekConfig.",
|
|
8453
8917
|
"enum": [
|
|
8454
8918
|
"STATE_UNSPECIFIED",
|
|
8455
8919
|
"CREATING",
|
|
8456
8920
|
"ACTIVE",
|
|
8457
8921
|
"KEY_ISSUE",
|
|
8458
8922
|
"DELETING",
|
|
8923
|
+
"DELETE_FAILED",
|
|
8459
8924
|
"UNUSABLE",
|
|
8460
8925
|
"ACTIVE_ROTATING"
|
|
8461
8926
|
],
|
|
@@ -8465,6 +8930,7 @@
|
|
|
8465
8930
|
"The CmekConfig can be used with DataStores.",
|
|
8466
8931
|
"The CmekConfig is unavailable, most likely due to the KMS Key being revoked.",
|
|
8467
8932
|
"The CmekConfig is deleting.",
|
|
8933
|
+
"The CmekConfig deletion process failed.",
|
|
8468
8934
|
"The CmekConfig is not usable, most likely due to some internal issue.",
|
|
8469
8935
|
"The KMS key version is being rotated."
|
|
8470
8936
|
],
|
|
@@ -8731,6 +9197,70 @@
|
|
|
8731
9197
|
"description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
|
|
8732
9198
|
"format": "float",
|
|
8733
9199
|
"type": "number"
|
|
9200
|
+
},
|
|
9201
|
+
"interpolationBoostSpec": {
|
|
9202
|
+
"$ref": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec",
|
|
9203
|
+
"description": "Optional. Complex specification for custom ranking based on customer defined attribute value."
|
|
9204
|
+
}
|
|
9205
|
+
},
|
|
9206
|
+
"type": "object"
|
|
9207
|
+
},
|
|
9208
|
+
"GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec": {
|
|
9209
|
+
"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.",
|
|
9210
|
+
"id": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec",
|
|
9211
|
+
"properties": {
|
|
9212
|
+
"attributeType": {
|
|
9213
|
+
"description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).",
|
|
9214
|
+
"enum": [
|
|
9215
|
+
"ATTRIBUTE_TYPE_UNSPECIFIED",
|
|
9216
|
+
"NUMERICAL",
|
|
9217
|
+
"FRESHNESS"
|
|
9218
|
+
],
|
|
9219
|
+
"enumDescriptions": [
|
|
9220
|
+
"Unspecified AttributeType.",
|
|
9221
|
+
"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.",
|
|
9222
|
+
"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`."
|
|
9223
|
+
],
|
|
9224
|
+
"type": "string"
|
|
9225
|
+
},
|
|
9226
|
+
"controlPoints": {
|
|
9227
|
+
"description": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.",
|
|
9228
|
+
"items": {
|
|
9229
|
+
"$ref": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint"
|
|
9230
|
+
},
|
|
9231
|
+
"type": "array"
|
|
9232
|
+
},
|
|
9233
|
+
"fieldName": {
|
|
9234
|
+
"description": "Optional. The name of the field whose value will be used to determine the boost amount.",
|
|
9235
|
+
"type": "string"
|
|
9236
|
+
},
|
|
9237
|
+
"interpolationType": {
|
|
9238
|
+
"description": "Optional. The interpolation type to be applied to connect the control points listed below.",
|
|
9239
|
+
"enum": [
|
|
9240
|
+
"INTERPOLATION_TYPE_UNSPECIFIED",
|
|
9241
|
+
"LINEAR"
|
|
9242
|
+
],
|
|
9243
|
+
"enumDescriptions": [
|
|
9244
|
+
"Interpolation type is unspecified. In this case, it defaults to Linear.",
|
|
9245
|
+
"Piecewise linear interpolation will be applied."
|
|
9246
|
+
],
|
|
9247
|
+
"type": "string"
|
|
9248
|
+
}
|
|
9249
|
+
},
|
|
9250
|
+
"type": "object"
|
|
9251
|
+
},
|
|
9252
|
+
"GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint": {
|
|
9253
|
+
"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).",
|
|
9254
|
+
"id": "GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint",
|
|
9255
|
+
"properties": {
|
|
9256
|
+
"attributeValue": {
|
|
9257
|
+
"description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.",
|
|
9258
|
+
"type": "string"
|
|
9259
|
+
},
|
|
9260
|
+
"boostAmount": {
|
|
9261
|
+
"description": "Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.",
|
|
9262
|
+
"format": "float",
|
|
9263
|
+
"type": "number"
|
|
8734
9264
|
}
|
|
8735
9265
|
},
|
|
8736
9266
|
"type": "object"
|
|
@@ -8992,6 +9522,23 @@
|
|
|
8992
9522
|
},
|
|
8993
9523
|
"type": "object"
|
|
8994
9524
|
},
|
|
9525
|
+
"GoogleCloudDiscoveryengineV1CreateSitemapMetadata": {
|
|
9526
|
+
"description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
9527
|
+
"id": "GoogleCloudDiscoveryengineV1CreateSitemapMetadata",
|
|
9528
|
+
"properties": {
|
|
9529
|
+
"createTime": {
|
|
9530
|
+
"description": "Operation create time.",
|
|
9531
|
+
"format": "google-datetime",
|
|
9532
|
+
"type": "string"
|
|
9533
|
+
},
|
|
9534
|
+
"updateTime": {
|
|
9535
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
9536
|
+
"format": "google-datetime",
|
|
9537
|
+
"type": "string"
|
|
9538
|
+
}
|
|
9539
|
+
},
|
|
9540
|
+
"type": "object"
|
|
9541
|
+
},
|
|
8995
9542
|
"GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": {
|
|
8996
9543
|
"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
8997
9544
|
"id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata",
|
|
@@ -9156,7 +9703,7 @@
|
|
|
9156
9703
|
"type": "string"
|
|
9157
9704
|
},
|
|
9158
9705
|
"defaultSchemaId": {
|
|
9159
|
-
"description": "Output only. The id of the default Schema
|
|
9706
|
+
"description": "Output only. The id of the default Schema associated to this data store.",
|
|
9160
9707
|
"readOnly": true,
|
|
9161
9708
|
"type": "string"
|
|
9162
9709
|
},
|
|
@@ -9168,6 +9715,14 @@
|
|
|
9168
9715
|
"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig",
|
|
9169
9716
|
"description": "Configuration for Document understanding and enrichment."
|
|
9170
9717
|
},
|
|
9718
|
+
"healthcareFhirConfig": {
|
|
9719
|
+
"$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig",
|
|
9720
|
+
"description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
|
|
9721
|
+
},
|
|
9722
|
+
"identityMappingStore": {
|
|
9723
|
+
"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}`.",
|
|
9724
|
+
"type": "string"
|
|
9725
|
+
},
|
|
9171
9726
|
"industryVertical": {
|
|
9172
9727
|
"description": "Immutable. The industry vertical that the data store registers.",
|
|
9173
9728
|
"enum": [
|
|
@@ -9280,6 +9835,23 @@
|
|
|
9280
9835
|
},
|
|
9281
9836
|
"type": "object"
|
|
9282
9837
|
},
|
|
9838
|
+
"GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata": {
|
|
9839
|
+
"description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
9840
|
+
"id": "GoogleCloudDiscoveryengineV1DeleteCmekConfigMetadata",
|
|
9841
|
+
"properties": {
|
|
9842
|
+
"createTime": {
|
|
9843
|
+
"description": "Operation create time.",
|
|
9844
|
+
"format": "google-datetime",
|
|
9845
|
+
"type": "string"
|
|
9846
|
+
},
|
|
9847
|
+
"updateTime": {
|
|
9848
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
9849
|
+
"format": "google-datetime",
|
|
9850
|
+
"type": "string"
|
|
9851
|
+
}
|
|
9852
|
+
},
|
|
9853
|
+
"type": "object"
|
|
9854
|
+
},
|
|
9283
9855
|
"GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": {
|
|
9284
9856
|
"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
9285
9857
|
"id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata",
|
|
@@ -9348,6 +9920,23 @@
|
|
|
9348
9920
|
},
|
|
9349
9921
|
"type": "object"
|
|
9350
9922
|
},
|
|
9923
|
+
"GoogleCloudDiscoveryengineV1DeleteSitemapMetadata": {
|
|
9924
|
+
"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
9925
|
+
"id": "GoogleCloudDiscoveryengineV1DeleteSitemapMetadata",
|
|
9926
|
+
"properties": {
|
|
9927
|
+
"createTime": {
|
|
9928
|
+
"description": "Operation create time.",
|
|
9929
|
+
"format": "google-datetime",
|
|
9930
|
+
"type": "string"
|
|
9931
|
+
},
|
|
9932
|
+
"updateTime": {
|
|
9933
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
9934
|
+
"format": "google-datetime",
|
|
9935
|
+
"type": "string"
|
|
9936
|
+
}
|
|
9937
|
+
},
|
|
9938
|
+
"type": "object"
|
|
9939
|
+
},
|
|
9351
9940
|
"GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": {
|
|
9352
9941
|
"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
9353
9942
|
"id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata",
|
|
@@ -9904,6 +10493,31 @@
|
|
|
9904
10493
|
},
|
|
9905
10494
|
"type": "object"
|
|
9906
10495
|
},
|
|
10496
|
+
"GoogleCloudDiscoveryengineV1FetchSitemapsResponse": {
|
|
10497
|
+
"description": "Response message for SiteSearchEngineService.FetchSitemaps method.",
|
|
10498
|
+
"id": "GoogleCloudDiscoveryengineV1FetchSitemapsResponse",
|
|
10499
|
+
"properties": {
|
|
10500
|
+
"sitemapsMetadata": {
|
|
10501
|
+
"description": "List of Sitemaps fetched.",
|
|
10502
|
+
"items": {
|
|
10503
|
+
"$ref": "GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata"
|
|
10504
|
+
},
|
|
10505
|
+
"type": "array"
|
|
10506
|
+
}
|
|
10507
|
+
},
|
|
10508
|
+
"type": "object"
|
|
10509
|
+
},
|
|
10510
|
+
"GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata": {
|
|
10511
|
+
"description": "Contains a Sitemap and its metadata.",
|
|
10512
|
+
"id": "GoogleCloudDiscoveryengineV1FetchSitemapsResponseSitemapMetadata",
|
|
10513
|
+
"properties": {
|
|
10514
|
+
"sitemap": {
|
|
10515
|
+
"$ref": "GoogleCloudDiscoveryengineV1Sitemap",
|
|
10516
|
+
"description": "The Sitemap."
|
|
10517
|
+
}
|
|
10518
|
+
},
|
|
10519
|
+
"type": "object"
|
|
10520
|
+
},
|
|
9907
10521
|
"GoogleCloudDiscoveryengineV1FhirStoreSource": {
|
|
9908
10522
|
"description": "Cloud FhirStore source import data from.",
|
|
9909
10523
|
"id": "GoogleCloudDiscoveryengineV1FhirStoreSource",
|
|
@@ -10397,11 +11011,87 @@
|
|
|
10397
11011
|
"additionalProperties": {
|
|
10398
11012
|
"type": "string"
|
|
10399
11013
|
},
|
|
10400
|
-
"description": "Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on.",
|
|
11014
|
+
"description": "Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on.",
|
|
11015
|
+
"type": "object"
|
|
11016
|
+
},
|
|
11017
|
+
"factText": {
|
|
11018
|
+
"description": "Text content of the fact. Can be at most 10K characters long.",
|
|
11019
|
+
"type": "string"
|
|
11020
|
+
}
|
|
11021
|
+
},
|
|
11022
|
+
"type": "object"
|
|
11023
|
+
},
|
|
11024
|
+
"GoogleCloudDiscoveryengineV1HealthcareFhirConfig": {
|
|
11025
|
+
"description": "Config to data store for `HEALTHCARE_FHIR` vertical.",
|
|
11026
|
+
"id": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig",
|
|
11027
|
+
"properties": {
|
|
11028
|
+
"enableConfigurableSchema": {
|
|
11029
|
+
"description": "Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.",
|
|
11030
|
+
"type": "boolean"
|
|
11031
|
+
},
|
|
11032
|
+
"enableStaticIndexingForBatchIngestion": {
|
|
11033
|
+
"description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.",
|
|
11034
|
+
"type": "boolean"
|
|
11035
|
+
}
|
|
11036
|
+
},
|
|
11037
|
+
"type": "object"
|
|
11038
|
+
},
|
|
11039
|
+
"GoogleCloudDiscoveryengineV1IdentityMappingEntry": {
|
|
11040
|
+
"description": "Identity Mapping Entry that maps an external identity to an internal identity.",
|
|
11041
|
+
"id": "GoogleCloudDiscoveryengineV1IdentityMappingEntry",
|
|
11042
|
+
"properties": {
|
|
11043
|
+
"externalIdentity": {
|
|
11044
|
+
"description": "Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters.",
|
|
11045
|
+
"type": "string"
|
|
11046
|
+
},
|
|
11047
|
+
"groupId": {
|
|
11048
|
+
"description": "Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider, group_id is the mapped group identifier configured during the workforcepool config.",
|
|
11049
|
+
"type": "string"
|
|
11050
|
+
},
|
|
11051
|
+
"userId": {
|
|
11052
|
+
"description": "User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider, user_id is the mapped user identifier configured during the workforcepool config.",
|
|
11053
|
+
"type": "string"
|
|
11054
|
+
}
|
|
11055
|
+
},
|
|
11056
|
+
"type": "object"
|
|
11057
|
+
},
|
|
11058
|
+
"GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata": {
|
|
11059
|
+
"description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings",
|
|
11060
|
+
"id": "GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata",
|
|
11061
|
+
"properties": {
|
|
11062
|
+
"failureCount": {
|
|
11063
|
+
"description": "The number of IdentityMappingEntries that failed to be processed.",
|
|
11064
|
+
"format": "int64",
|
|
11065
|
+
"type": "string"
|
|
11066
|
+
},
|
|
11067
|
+
"successCount": {
|
|
11068
|
+
"description": "The number of IdentityMappingEntries that were successfully processed.",
|
|
11069
|
+
"format": "int64",
|
|
11070
|
+
"type": "string"
|
|
11071
|
+
},
|
|
11072
|
+
"totalCount": {
|
|
11073
|
+
"description": "The total number of IdentityMappingEntries that were processed.",
|
|
11074
|
+
"format": "int64",
|
|
11075
|
+
"type": "string"
|
|
11076
|
+
}
|
|
11077
|
+
},
|
|
10401
11078
|
"type": "object"
|
|
10402
11079
|
},
|
|
10403
|
-
"
|
|
10404
|
-
"description": "
|
|
11080
|
+
"GoogleCloudDiscoveryengineV1IdentityMappingStore": {
|
|
11081
|
+
"description": "Identity Mapping Store which contains Identity Mapping Entries.",
|
|
11082
|
+
"id": "GoogleCloudDiscoveryengineV1IdentityMappingStore",
|
|
11083
|
+
"properties": {
|
|
11084
|
+
"cmekConfig": {
|
|
11085
|
+
"$ref": "GoogleCloudDiscoveryengineV1CmekConfig",
|
|
11086
|
+
"description": "Output only. CMEK-related information for the Identity Mapping Store.",
|
|
11087
|
+
"readOnly": true
|
|
11088
|
+
},
|
|
11089
|
+
"kmsKeyName": {
|
|
11090
|
+
"description": "Input only. The KMS key to be used to protect this Identity Mapping Store at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the Identity Mapping Store will be protected by the KMS key, as indicated in the cmek_config field.",
|
|
11091
|
+
"type": "string"
|
|
11092
|
+
},
|
|
11093
|
+
"name": {
|
|
11094
|
+
"description": "Immutable. The full resource name of the identity mapping store. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
|
|
10405
11095
|
"type": "string"
|
|
10406
11096
|
}
|
|
10407
11097
|
},
|
|
@@ -10642,6 +11332,45 @@
|
|
|
10642
11332
|
},
|
|
10643
11333
|
"type": "object"
|
|
10644
11334
|
},
|
|
11335
|
+
"GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest": {
|
|
11336
|
+
"description": "Request message for IdentityMappingStoreService.ImportIdentityMappings",
|
|
11337
|
+
"id": "GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequest",
|
|
11338
|
+
"properties": {
|
|
11339
|
+
"inlineSource": {
|
|
11340
|
+
"$ref": "GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource",
|
|
11341
|
+
"description": "The inline source to import identity mapping entries from."
|
|
11342
|
+
}
|
|
11343
|
+
},
|
|
11344
|
+
"type": "object"
|
|
11345
|
+
},
|
|
11346
|
+
"GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource": {
|
|
11347
|
+
"description": "The inline source to import identity mapping entries from.",
|
|
11348
|
+
"id": "GoogleCloudDiscoveryengineV1ImportIdentityMappingsRequestInlineSource",
|
|
11349
|
+
"properties": {
|
|
11350
|
+
"identityMappingEntries": {
|
|
11351
|
+
"description": "A maximum of 10000 entries can be imported at one time",
|
|
11352
|
+
"items": {
|
|
11353
|
+
"$ref": "GoogleCloudDiscoveryengineV1IdentityMappingEntry"
|
|
11354
|
+
},
|
|
11355
|
+
"type": "array"
|
|
11356
|
+
}
|
|
11357
|
+
},
|
|
11358
|
+
"type": "object"
|
|
11359
|
+
},
|
|
11360
|
+
"GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse": {
|
|
11361
|
+
"description": "Response message for IdentityMappingStoreService.ImportIdentityMappings",
|
|
11362
|
+
"id": "GoogleCloudDiscoveryengineV1ImportIdentityMappingsResponse",
|
|
11363
|
+
"properties": {
|
|
11364
|
+
"errorSamples": {
|
|
11365
|
+
"description": "A sample of errors encountered while processing the request.",
|
|
11366
|
+
"items": {
|
|
11367
|
+
"$ref": "GoogleRpcStatus"
|
|
11368
|
+
},
|
|
11369
|
+
"type": "array"
|
|
11370
|
+
}
|
|
11371
|
+
},
|
|
11372
|
+
"type": "object"
|
|
11373
|
+
},
|
|
10645
11374
|
"GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata": {
|
|
10646
11375
|
"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.",
|
|
10647
11376
|
"id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata",
|
|
@@ -10935,6 +11664,42 @@
|
|
|
10935
11664
|
},
|
|
10936
11665
|
"type": "object"
|
|
10937
11666
|
},
|
|
11667
|
+
"GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse": {
|
|
11668
|
+
"description": "Response message for IdentityMappingStoreService.ListIdentityMappingStores",
|
|
11669
|
+
"id": "GoogleCloudDiscoveryengineV1ListIdentityMappingStoresResponse",
|
|
11670
|
+
"properties": {
|
|
11671
|
+
"identityMappingStores": {
|
|
11672
|
+
"description": "The Identity Mapping Stores.",
|
|
11673
|
+
"items": {
|
|
11674
|
+
"$ref": "GoogleCloudDiscoveryengineV1IdentityMappingStore"
|
|
11675
|
+
},
|
|
11676
|
+
"type": "array"
|
|
11677
|
+
},
|
|
11678
|
+
"nextPageToken": {
|
|
11679
|
+
"description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
|
|
11680
|
+
"type": "string"
|
|
11681
|
+
}
|
|
11682
|
+
},
|
|
11683
|
+
"type": "object"
|
|
11684
|
+
},
|
|
11685
|
+
"GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse": {
|
|
11686
|
+
"description": "Response message for IdentityMappingStoreService.ListIdentityMappings",
|
|
11687
|
+
"id": "GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse",
|
|
11688
|
+
"properties": {
|
|
11689
|
+
"identityMappingEntries": {
|
|
11690
|
+
"description": "The Identity Mapping Entries.",
|
|
11691
|
+
"items": {
|
|
11692
|
+
"$ref": "GoogleCloudDiscoveryengineV1IdentityMappingEntry"
|
|
11693
|
+
},
|
|
11694
|
+
"type": "array"
|
|
11695
|
+
},
|
|
11696
|
+
"nextPageToken": {
|
|
11697
|
+
"description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
|
|
11698
|
+
"type": "string"
|
|
11699
|
+
}
|
|
11700
|
+
},
|
|
11701
|
+
"type": "object"
|
|
11702
|
+
},
|
|
10938
11703
|
"GoogleCloudDiscoveryengineV1ListSchemasResponse": {
|
|
10939
11704
|
"description": "Response message for SchemaService.ListSchemas method.",
|
|
10940
11705
|
"id": "GoogleCloudDiscoveryengineV1ListSchemasResponse",
|
|
@@ -11304,6 +12069,39 @@
|
|
|
11304
12069
|
},
|
|
11305
12070
|
"type": "object"
|
|
11306
12071
|
},
|
|
12072
|
+
"GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest": {
|
|
12073
|
+
"description": "Request message for IdentityMappingStoreService.PurgeIdentityMappings",
|
|
12074
|
+
"id": "GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest",
|
|
12075
|
+
"properties": {
|
|
12076
|
+
"filter": {
|
|
12077
|
+
"description": "Filter matching identity mappings to purge. The eligible field for filtering is: * `update_time`: in ISO 8601 \"zulu\" format. * `external_id` Examples: * Deleting all identity mappings updated in a time range: `update_time > \"2012-04-23T18:25:43.511Z\" AND update_time < \"2012-04-23T18:30:43.511Z\"` * Deleting all identity mappings for a given external_id: `external_id = \"id1\"` * Deleting all identity mappings inside an identity mapping store: `*` The filtering fields are assumed to have an implicit AND. Should not be used with source. An error will be thrown, if both are provided.",
|
|
12078
|
+
"type": "string"
|
|
12079
|
+
},
|
|
12080
|
+
"force": {
|
|
12081
|
+
"description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any identity mappings. This field is only supported for purge with filter. For input source this field is ignored and data will be purged regardless of the value of this field.",
|
|
12082
|
+
"type": "boolean"
|
|
12083
|
+
},
|
|
12084
|
+
"inlineSource": {
|
|
12085
|
+
"$ref": "GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource",
|
|
12086
|
+
"description": "The inline source to purge identity mapping entries from."
|
|
12087
|
+
}
|
|
12088
|
+
},
|
|
12089
|
+
"type": "object"
|
|
12090
|
+
},
|
|
12091
|
+
"GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource": {
|
|
12092
|
+
"description": "The inline source to purge identity mapping entries from.",
|
|
12093
|
+
"id": "GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource",
|
|
12094
|
+
"properties": {
|
|
12095
|
+
"identityMappingEntries": {
|
|
12096
|
+
"description": "A maximum of 10000 entries can be purged at one time",
|
|
12097
|
+
"items": {
|
|
12098
|
+
"$ref": "GoogleCloudDiscoveryengineV1IdentityMappingEntry"
|
|
12099
|
+
},
|
|
12100
|
+
"type": "array"
|
|
12101
|
+
}
|
|
12102
|
+
},
|
|
12103
|
+
"type": "object"
|
|
12104
|
+
},
|
|
11307
12105
|
"GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": {
|
|
11308
12106
|
"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.",
|
|
11309
12107
|
"id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata",
|
|
@@ -11546,7 +12344,7 @@
|
|
|
11546
12344
|
"id": "GoogleCloudDiscoveryengineV1RecrawlUrisRequest",
|
|
11547
12345
|
"properties": {
|
|
11548
12346
|
"siteCredential": {
|
|
11549
|
-
"description": "Optional.
|
|
12347
|
+
"description": "Optional. Credential id to use for crawling.",
|
|
11550
12348
|
"type": "string"
|
|
11551
12349
|
},
|
|
11552
12350
|
"uris": {
|
|
@@ -11829,7 +12627,7 @@
|
|
|
11829
12627
|
},
|
|
11830
12628
|
"userInfo": {
|
|
11831
12629
|
"$ref": "GoogleCloudDiscoveryengineV1UserInfo",
|
|
11832
|
-
"description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics."
|
|
12630
|
+
"description": "Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics."
|
|
11833
12631
|
},
|
|
11834
12632
|
"userLabels": {
|
|
11835
12633
|
"additionalProperties": {
|
|
@@ -12254,12 +13052,14 @@
|
|
|
12254
13052
|
"enum": [
|
|
12255
13053
|
"CONDITION_UNSPECIFIED",
|
|
12256
13054
|
"DISABLED",
|
|
12257
|
-
"ENABLED"
|
|
13055
|
+
"ENABLED",
|
|
13056
|
+
"AUTO"
|
|
12258
13057
|
],
|
|
12259
13058
|
"enumDescriptions": [
|
|
12260
13059
|
"Server behavior defaults to Condition.DISABLED.",
|
|
12261
13060
|
"Disables Search As You Type.",
|
|
12262
|
-
"Enables Search As You Type."
|
|
13061
|
+
"Enables Search As You Type.",
|
|
13062
|
+
"Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)."
|
|
12263
13063
|
],
|
|
12264
13064
|
"type": "string"
|
|
12265
13065
|
}
|
|
@@ -12275,7 +13075,7 @@
|
|
|
12275
13075
|
"type": "string"
|
|
12276
13076
|
},
|
|
12277
13077
|
"searchResultPersistenceCount": {
|
|
12278
|
-
"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
|
|
13078
|
+
"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.",
|
|
12279
13079
|
"format": "int32",
|
|
12280
13080
|
"type": "integer"
|
|
12281
13081
|
}
|
|
@@ -12935,6 +13735,28 @@
|
|
|
12935
13735
|
},
|
|
12936
13736
|
"type": "object"
|
|
12937
13737
|
},
|
|
13738
|
+
"GoogleCloudDiscoveryengineV1Sitemap": {
|
|
13739
|
+
"description": "A sitemap for the SiteSearchEngine.",
|
|
13740
|
+
"id": "GoogleCloudDiscoveryengineV1Sitemap",
|
|
13741
|
+
"properties": {
|
|
13742
|
+
"createTime": {
|
|
13743
|
+
"description": "Output only. The sitemap's creation time.",
|
|
13744
|
+
"format": "google-datetime",
|
|
13745
|
+
"readOnly": true,
|
|
13746
|
+
"type": "string"
|
|
13747
|
+
},
|
|
13748
|
+
"name": {
|
|
13749
|
+
"description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.",
|
|
13750
|
+
"readOnly": true,
|
|
13751
|
+
"type": "string"
|
|
13752
|
+
},
|
|
13753
|
+
"uri": {
|
|
13754
|
+
"description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.",
|
|
13755
|
+
"type": "string"
|
|
13756
|
+
}
|
|
13757
|
+
},
|
|
13758
|
+
"type": "object"
|
|
13759
|
+
},
|
|
12938
13760
|
"GoogleCloudDiscoveryengineV1SpannerSource": {
|
|
12939
13761
|
"description": "The Spanner source for importing data",
|
|
12940
13762
|
"id": "GoogleCloudDiscoveryengineV1SpannerSource",
|
|
@@ -13439,7 +14261,8 @@
|
|
|
13439
14261
|
"GOOGLE_CALENDAR",
|
|
13440
14262
|
"GOOGLE_CHAT",
|
|
13441
14263
|
"GOOGLE_GROUPS",
|
|
13442
|
-
"GOOGLE_KEEP"
|
|
14264
|
+
"GOOGLE_KEEP",
|
|
14265
|
+
"GOOGLE_PEOPLE"
|
|
13443
14266
|
],
|
|
13444
14267
|
"enumDescriptions": [
|
|
13445
14268
|
"Defaults to an unspecified Workspace type.",
|
|
@@ -13449,7 +14272,8 @@
|
|
|
13449
14272
|
"Workspace Data Store contains Calendar data",
|
|
13450
14273
|
"Workspace Data Store contains Chat data",
|
|
13451
14274
|
"Workspace Data Store contains Groups data",
|
|
13452
|
-
"Workspace Data Store contains Keep data"
|
|
14275
|
+
"Workspace Data Store contains Keep data",
|
|
14276
|
+
"Workspace Data Store contains People data"
|
|
13453
14277
|
],
|
|
13454
14278
|
"type": "string"
|
|
13455
14279
|
}
|
|
@@ -13638,7 +14462,7 @@
|
|
|
13638
14462
|
"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation",
|
|
13639
14463
|
"properties": {
|
|
13640
14464
|
"endIndex": {
|
|
13641
|
-
"description": "End of the attributed segment, exclusive.",
|
|
14465
|
+
"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.",
|
|
13642
14466
|
"format": "int64",
|
|
13643
14467
|
"type": "string"
|
|
13644
14468
|
},
|
|
@@ -13650,7 +14474,7 @@
|
|
|
13650
14474
|
"type": "array"
|
|
13651
14475
|
},
|
|
13652
14476
|
"startIndex": {
|
|
13653
|
-
"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).",
|
|
14477
|
+
"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.",
|
|
13654
14478
|
"format": "int64",
|
|
13655
14479
|
"type": "string"
|
|
13656
14480
|
}
|
|
@@ -13833,6 +14657,16 @@
|
|
|
13833
14657
|
},
|
|
13834
14658
|
"description": "Structured search data.",
|
|
13835
14659
|
"type": "object"
|
|
14660
|
+
},
|
|
14661
|
+
"title": {
|
|
14662
|
+
"description": "Output only. The title of the document.",
|
|
14663
|
+
"readOnly": true,
|
|
14664
|
+
"type": "string"
|
|
14665
|
+
},
|
|
14666
|
+
"uri": {
|
|
14667
|
+
"description": "Output only. The URI of the document.",
|
|
14668
|
+
"readOnly": true,
|
|
14669
|
+
"type": "string"
|
|
13836
14670
|
}
|
|
13837
14671
|
},
|
|
13838
14672
|
"type": "object"
|
|
@@ -14085,11 +14919,11 @@
|
|
|
14085
14919
|
"type": "boolean"
|
|
14086
14920
|
},
|
|
14087
14921
|
"kmsKey": {
|
|
14088
|
-
"description": "
|
|
14922
|
+
"description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
|
|
14089
14923
|
"type": "string"
|
|
14090
14924
|
},
|
|
14091
14925
|
"kmsKeyVersion": {
|
|
14092
|
-
"description": "
|
|
14926
|
+
"description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
|
|
14093
14927
|
"type": "string"
|
|
14094
14928
|
},
|
|
14095
14929
|
"lastRotationTimestampMicros": {
|
|
@@ -14099,7 +14933,7 @@
|
|
|
14099
14933
|
"type": "string"
|
|
14100
14934
|
},
|
|
14101
14935
|
"name": {
|
|
14102
|
-
"description": "Required.
|
|
14936
|
+
"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
|
|
14103
14937
|
"type": "string"
|
|
14104
14938
|
},
|
|
14105
14939
|
"singleRegionKeys": {
|
|
@@ -14110,13 +14944,14 @@
|
|
|
14110
14944
|
"type": "array"
|
|
14111
14945
|
},
|
|
14112
14946
|
"state": {
|
|
14113
|
-
"description": "Output only.
|
|
14947
|
+
"description": "Output only. The states of the CmekConfig.",
|
|
14114
14948
|
"enum": [
|
|
14115
14949
|
"STATE_UNSPECIFIED",
|
|
14116
14950
|
"CREATING",
|
|
14117
14951
|
"ACTIVE",
|
|
14118
14952
|
"KEY_ISSUE",
|
|
14119
14953
|
"DELETING",
|
|
14954
|
+
"DELETE_FAILED",
|
|
14120
14955
|
"UNUSABLE",
|
|
14121
14956
|
"ACTIVE_ROTATING"
|
|
14122
14957
|
],
|
|
@@ -14126,6 +14961,7 @@
|
|
|
14126
14961
|
"The CmekConfig can be used with DataStores.",
|
|
14127
14962
|
"The CmekConfig is unavailable, most likely due to the KMS Key being revoked.",
|
|
14128
14963
|
"The CmekConfig is deleting.",
|
|
14964
|
+
"The CmekConfig deletion process failed.",
|
|
14129
14965
|
"The CmekConfig is not usable, most likely due to some internal issue.",
|
|
14130
14966
|
"The KMS key version is being rotated."
|
|
14131
14967
|
],
|
|
@@ -14316,6 +15152,11 @@
|
|
|
14316
15152
|
"description": "Represents an entity that was synced in this ConnectorRun.",
|
|
14317
15153
|
"id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun",
|
|
14318
15154
|
"properties": {
|
|
15155
|
+
"deletedRecordCount": {
|
|
15156
|
+
"description": "The number of documents deleted.",
|
|
15157
|
+
"format": "int64",
|
|
15158
|
+
"type": "string"
|
|
15159
|
+
},
|
|
14319
15160
|
"entityName": {
|
|
14320
15161
|
"description": "The name of the source entity.",
|
|
14321
15162
|
"type": "string"
|
|
@@ -14505,6 +15346,70 @@
|
|
|
14505
15346
|
"description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
|
|
14506
15347
|
"format": "float",
|
|
14507
15348
|
"type": "number"
|
|
15349
|
+
},
|
|
15350
|
+
"interpolationBoostSpec": {
|
|
15351
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec",
|
|
15352
|
+
"description": "Optional. Complex specification for custom ranking based on customer defined attribute value."
|
|
15353
|
+
}
|
|
15354
|
+
},
|
|
15355
|
+
"type": "object"
|
|
15356
|
+
},
|
|
15357
|
+
"GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec": {
|
|
15358
|
+
"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.",
|
|
15359
|
+
"id": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec",
|
|
15360
|
+
"properties": {
|
|
15361
|
+
"attributeType": {
|
|
15362
|
+
"description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).",
|
|
15363
|
+
"enum": [
|
|
15364
|
+
"ATTRIBUTE_TYPE_UNSPECIFIED",
|
|
15365
|
+
"NUMERICAL",
|
|
15366
|
+
"FRESHNESS"
|
|
15367
|
+
],
|
|
15368
|
+
"enumDescriptions": [
|
|
15369
|
+
"Unspecified AttributeType.",
|
|
15370
|
+
"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.",
|
|
15371
|
+
"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`."
|
|
15372
|
+
],
|
|
15373
|
+
"type": "string"
|
|
15374
|
+
},
|
|
15375
|
+
"controlPoints": {
|
|
15376
|
+
"description": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.",
|
|
15377
|
+
"items": {
|
|
15378
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint"
|
|
15379
|
+
},
|
|
15380
|
+
"type": "array"
|
|
15381
|
+
},
|
|
15382
|
+
"fieldName": {
|
|
15383
|
+
"description": "Optional. The name of the field whose value will be used to determine the boost amount.",
|
|
15384
|
+
"type": "string"
|
|
15385
|
+
},
|
|
15386
|
+
"interpolationType": {
|
|
15387
|
+
"description": "Optional. The interpolation type to be applied to connect the control points listed below.",
|
|
15388
|
+
"enum": [
|
|
15389
|
+
"INTERPOLATION_TYPE_UNSPECIFIED",
|
|
15390
|
+
"LINEAR"
|
|
15391
|
+
],
|
|
15392
|
+
"enumDescriptions": [
|
|
15393
|
+
"Interpolation type is unspecified. In this case, it defaults to Linear.",
|
|
15394
|
+
"Piecewise linear interpolation will be applied."
|
|
15395
|
+
],
|
|
15396
|
+
"type": "string"
|
|
15397
|
+
}
|
|
15398
|
+
},
|
|
15399
|
+
"type": "object"
|
|
15400
|
+
},
|
|
15401
|
+
"GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint": {
|
|
15402
|
+
"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).",
|
|
15403
|
+
"id": "GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpecControlPoint",
|
|
15404
|
+
"properties": {
|
|
15405
|
+
"attributeValue": {
|
|
15406
|
+
"description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.",
|
|
15407
|
+
"type": "string"
|
|
15408
|
+
},
|
|
15409
|
+
"boostAmount": {
|
|
15410
|
+
"description": "Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.",
|
|
15411
|
+
"format": "float",
|
|
15412
|
+
"type": "number"
|
|
14508
15413
|
}
|
|
14509
15414
|
},
|
|
14510
15415
|
"type": "object"
|
|
@@ -14772,7 +15677,7 @@
|
|
|
14772
15677
|
},
|
|
14773
15678
|
"nextSyncTime": {
|
|
14774
15679
|
"$ref": "GoogleTypeDateTime",
|
|
14775
|
-
"description": "
|
|
15680
|
+
"description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity."
|
|
14776
15681
|
},
|
|
14777
15682
|
"params": {
|
|
14778
15683
|
"additionalProperties": {
|
|
@@ -14800,7 +15705,8 @@
|
|
|
14800
15705
|
"ACTIVE",
|
|
14801
15706
|
"FAILED",
|
|
14802
15707
|
"RUNNING",
|
|
14803
|
-
"WARNING"
|
|
15708
|
+
"WARNING",
|
|
15709
|
+
"INITIALIZATION_FAILED"
|
|
14804
15710
|
],
|
|
14805
15711
|
"enumDescriptions": [
|
|
14806
15712
|
"Default value.",
|
|
@@ -14808,7 +15714,8 @@
|
|
|
14808
15714
|
"The connector is successfully set up and awaiting next sync run.",
|
|
14809
15715
|
"The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.",
|
|
14810
15716
|
"The connector is actively syncing records from the data source.",
|
|
14811
|
-
"The connector has completed a sync run, but encountered non-fatal errors."
|
|
15717
|
+
"The connector has completed a sync run, but encountered non-fatal errors.",
|
|
15718
|
+
"Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types)."
|
|
14812
15719
|
],
|
|
14813
15720
|
"readOnly": true,
|
|
14814
15721
|
"type": "string"
|
|
@@ -14828,10 +15735,12 @@
|
|
|
14828
15735
|
"syncMode": {
|
|
14829
15736
|
"description": "The data synchronization mode supported by the data connector.",
|
|
14830
15737
|
"enum": [
|
|
14831
|
-
"PERIODIC"
|
|
15738
|
+
"PERIODIC",
|
|
15739
|
+
"STREAMING"
|
|
14832
15740
|
],
|
|
14833
15741
|
"enumDescriptions": [
|
|
14834
|
-
"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."
|
|
15742
|
+
"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.",
|
|
15743
|
+
"The data will be synced in real time."
|
|
14835
15744
|
],
|
|
14836
15745
|
"type": "string"
|
|
14837
15746
|
},
|
|
@@ -14857,6 +15766,10 @@
|
|
|
14857
15766
|
"description": "The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`",
|
|
14858
15767
|
"type": "string"
|
|
14859
15768
|
},
|
|
15769
|
+
"healthcareFhirConfig": {
|
|
15770
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig",
|
|
15771
|
+
"description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
|
|
15772
|
+
},
|
|
14860
15773
|
"keyPropertyMappings": {
|
|
14861
15774
|
"additionalProperties": {
|
|
14862
15775
|
"type": "string"
|
|
@@ -14871,6 +15784,10 @@
|
|
|
14871
15784
|
},
|
|
14872
15785
|
"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.",
|
|
14873
15786
|
"type": "object"
|
|
15787
|
+
},
|
|
15788
|
+
"startingSchema": {
|
|
15789
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSchema",
|
|
15790
|
+
"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)."
|
|
14874
15791
|
}
|
|
14875
15792
|
},
|
|
14876
15793
|
"type": "object"
|
|
@@ -14922,7 +15839,7 @@
|
|
|
14922
15839
|
"type": "string"
|
|
14923
15840
|
},
|
|
14924
15841
|
"defaultSchemaId": {
|
|
14925
|
-
"description": "Output only. The id of the default Schema
|
|
15842
|
+
"description": "Output only. The id of the default Schema associated to this data store.",
|
|
14926
15843
|
"readOnly": true,
|
|
14927
15844
|
"type": "string"
|
|
14928
15845
|
},
|
|
@@ -14934,6 +15851,14 @@
|
|
|
14934
15851
|
"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig",
|
|
14935
15852
|
"description": "Configuration for Document understanding and enrichment."
|
|
14936
15853
|
},
|
|
15854
|
+
"healthcareFhirConfig": {
|
|
15855
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig",
|
|
15856
|
+
"description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
|
|
15857
|
+
},
|
|
15858
|
+
"identityMappingStore": {
|
|
15859
|
+
"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}`.",
|
|
15860
|
+
"type": "string"
|
|
15861
|
+
},
|
|
14937
15862
|
"idpConfig": {
|
|
14938
15863
|
"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig",
|
|
14939
15864
|
"description": "Output only. Data store level identity provider config.",
|
|
@@ -15074,6 +15999,23 @@
|
|
|
15074
15999
|
},
|
|
15075
16000
|
"type": "object"
|
|
15076
16001
|
},
|
|
16002
|
+
"GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata": {
|
|
16003
|
+
"description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
16004
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata",
|
|
16005
|
+
"properties": {
|
|
16006
|
+
"createTime": {
|
|
16007
|
+
"description": "Operation create time.",
|
|
16008
|
+
"format": "google-datetime",
|
|
16009
|
+
"type": "string"
|
|
16010
|
+
},
|
|
16011
|
+
"updateTime": {
|
|
16012
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
16013
|
+
"format": "google-datetime",
|
|
16014
|
+
"type": "string"
|
|
16015
|
+
}
|
|
16016
|
+
},
|
|
16017
|
+
"type": "object"
|
|
16018
|
+
},
|
|
15077
16019
|
"GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata": {
|
|
15078
16020
|
"description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
15079
16021
|
"id": "GoogleCloudDiscoveryengineV1alphaDeleteCollectionMetadata",
|
|
@@ -15817,31 +16759,6 @@
|
|
|
15817
16759
|
},
|
|
15818
16760
|
"type": "object"
|
|
15819
16761
|
},
|
|
15820
|
-
"GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse": {
|
|
15821
|
-
"description": "Response message for SiteSearchEngineService.FetchSitemaps method.",
|
|
15822
|
-
"id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse",
|
|
15823
|
-
"properties": {
|
|
15824
|
-
"sitemapsMetadata": {
|
|
15825
|
-
"description": "List of Sitemaps fetched.",
|
|
15826
|
-
"items": {
|
|
15827
|
-
"$ref": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata"
|
|
15828
|
-
},
|
|
15829
|
-
"type": "array"
|
|
15830
|
-
}
|
|
15831
|
-
},
|
|
15832
|
-
"type": "object"
|
|
15833
|
-
},
|
|
15834
|
-
"GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata": {
|
|
15835
|
-
"description": "Contains a Sitemap and its metadata.",
|
|
15836
|
-
"id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata",
|
|
15837
|
-
"properties": {
|
|
15838
|
-
"sitemap": {
|
|
15839
|
-
"$ref": "GoogleCloudDiscoveryengineV1alphaSitemap",
|
|
15840
|
-
"description": "The Sitemap."
|
|
15841
|
-
}
|
|
15842
|
-
},
|
|
15843
|
-
"type": "object"
|
|
15844
|
-
},
|
|
15845
16762
|
"GoogleCloudDiscoveryengineV1alphaFieldConfig": {
|
|
15846
16763
|
"description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.",
|
|
15847
16764
|
"id": "GoogleCloudDiscoveryengineV1alphaFieldConfig",
|
|
@@ -16032,6 +16949,43 @@
|
|
|
16032
16949
|
},
|
|
16033
16950
|
"type": "object"
|
|
16034
16951
|
},
|
|
16952
|
+
"GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig": {
|
|
16953
|
+
"description": "Config to data store for `HEALTHCARE_FHIR` vertical.",
|
|
16954
|
+
"id": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig",
|
|
16955
|
+
"properties": {
|
|
16956
|
+
"enableConfigurableSchema": {
|
|
16957
|
+
"description": "Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.",
|
|
16958
|
+
"type": "boolean"
|
|
16959
|
+
},
|
|
16960
|
+
"enableStaticIndexingForBatchIngestion": {
|
|
16961
|
+
"description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.",
|
|
16962
|
+
"type": "boolean"
|
|
16963
|
+
}
|
|
16964
|
+
},
|
|
16965
|
+
"type": "object"
|
|
16966
|
+
},
|
|
16967
|
+
"GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata": {
|
|
16968
|
+
"description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings",
|
|
16969
|
+
"id": "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata",
|
|
16970
|
+
"properties": {
|
|
16971
|
+
"failureCount": {
|
|
16972
|
+
"description": "The number of IdentityMappingEntries that failed to be processed.",
|
|
16973
|
+
"format": "int64",
|
|
16974
|
+
"type": "string"
|
|
16975
|
+
},
|
|
16976
|
+
"successCount": {
|
|
16977
|
+
"description": "The number of IdentityMappingEntries that were successfully processed.",
|
|
16978
|
+
"format": "int64",
|
|
16979
|
+
"type": "string"
|
|
16980
|
+
},
|
|
16981
|
+
"totalCount": {
|
|
16982
|
+
"description": "The total number of IdentityMappingEntries that were processed.",
|
|
16983
|
+
"format": "int64",
|
|
16984
|
+
"type": "string"
|
|
16985
|
+
}
|
|
16986
|
+
},
|
|
16987
|
+
"type": "object"
|
|
16988
|
+
},
|
|
16035
16989
|
"GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig": {
|
|
16036
16990
|
"description": "The configuration for the identity data synchronization runs.",
|
|
16037
16991
|
"id": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig",
|
|
@@ -16190,6 +17144,20 @@
|
|
|
16190
17144
|
},
|
|
16191
17145
|
"type": "object"
|
|
16192
17146
|
},
|
|
17147
|
+
"GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse": {
|
|
17148
|
+
"description": "Response message for IdentityMappingStoreService.ImportIdentityMappings",
|
|
17149
|
+
"id": "GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsResponse",
|
|
17150
|
+
"properties": {
|
|
17151
|
+
"errorSamples": {
|
|
17152
|
+
"description": "A sample of errors encountered while processing the request.",
|
|
17153
|
+
"items": {
|
|
17154
|
+
"$ref": "GoogleRpcStatus"
|
|
17155
|
+
},
|
|
17156
|
+
"type": "array"
|
|
17157
|
+
}
|
|
17158
|
+
},
|
|
17159
|
+
"type": "object"
|
|
17160
|
+
},
|
|
16193
17161
|
"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": {
|
|
16194
17162
|
"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
16195
17163
|
"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata",
|
|
@@ -16823,15 +17791,27 @@
|
|
|
16823
17791
|
"format": "google-datetime",
|
|
16824
17792
|
"type": "string"
|
|
16825
17793
|
},
|
|
16826
|
-
"invalidUris": {
|
|
16827
|
-
"description": "Unique URIs in the request that have invalid format. Sample limited to 1000.",
|
|
17794
|
+
"invalidUris": {
|
|
17795
|
+
"description": "Unique URIs in the request that have invalid format. Sample limited to 1000.",
|
|
17796
|
+
"items": {
|
|
17797
|
+
"type": "string"
|
|
17798
|
+
},
|
|
17799
|
+
"type": "array"
|
|
17800
|
+
},
|
|
17801
|
+
"invalidUrisCount": {
|
|
17802
|
+
"description": "Total number of unique URIs in the request that have invalid format.",
|
|
17803
|
+
"format": "int32",
|
|
17804
|
+
"type": "integer"
|
|
17805
|
+
},
|
|
17806
|
+
"noindexUris": {
|
|
17807
|
+
"description": "URIs that have no index meta tag. Sample limited to 1000.",
|
|
16828
17808
|
"items": {
|
|
16829
17809
|
"type": "string"
|
|
16830
17810
|
},
|
|
16831
17811
|
"type": "array"
|
|
16832
17812
|
},
|
|
16833
|
-
"
|
|
16834
|
-
"description": "Total number of
|
|
17813
|
+
"noindexUrisCount": {
|
|
17814
|
+
"description": "Total number of URIs that have no index meta tag.",
|
|
16835
17815
|
"format": "int32",
|
|
16836
17816
|
"type": "integer"
|
|
16837
17817
|
},
|
|
@@ -17154,6 +18134,10 @@
|
|
|
17154
18134
|
},
|
|
17155
18135
|
"type": "array"
|
|
17156
18136
|
},
|
|
18137
|
+
"displaySpec": {
|
|
18138
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec",
|
|
18139
|
+
"description": "Optional. Config for display feature, like match highlighting on search results."
|
|
18140
|
+
},
|
|
17157
18141
|
"embeddingSpec": {
|
|
17158
18142
|
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec",
|
|
17159
18143
|
"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."
|
|
@@ -17224,7 +18208,21 @@
|
|
|
17224
18208
|
"description": "The query expansion specification that specifies the conditions under which query expansion occurs."
|
|
17225
18209
|
},
|
|
17226
18210
|
"rankingExpression": {
|
|
17227
|
-
"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)`.",
|
|
18211
|
+
"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",
|
|
18212
|
+
"type": "string"
|
|
18213
|
+
},
|
|
18214
|
+
"rankingExpressionBackend": {
|
|
18215
|
+
"description": "Optional. The backend to use for the ranking expression evaluation.",
|
|
18216
|
+
"enum": [
|
|
18217
|
+
"UNKNOWN",
|
|
18218
|
+
"BYOE",
|
|
18219
|
+
"CLEARBOX"
|
|
18220
|
+
],
|
|
18221
|
+
"enumDescriptions": [
|
|
18222
|
+
"Default option for unspecified/unknown values.",
|
|
18223
|
+
"Bring your own embedding (BYOE), the default way to evaluate the ranking expression.",
|
|
18224
|
+
"The expression is compiled into a Clearbox formula."
|
|
18225
|
+
],
|
|
17228
18226
|
"type": "string"
|
|
17229
18227
|
},
|
|
17230
18228
|
"regionCode": {
|
|
@@ -17275,7 +18273,7 @@
|
|
|
17275
18273
|
},
|
|
17276
18274
|
"userInfo": {
|
|
17277
18275
|
"$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo",
|
|
17278
|
-
"description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics."
|
|
18276
|
+
"description": "Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics."
|
|
17279
18277
|
},
|
|
17280
18278
|
"userLabels": {
|
|
17281
18279
|
"additionalProperties": {
|
|
@@ -17581,6 +18579,27 @@
|
|
|
17581
18579
|
},
|
|
17582
18580
|
"type": "object"
|
|
17583
18581
|
},
|
|
18582
|
+
"GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec": {
|
|
18583
|
+
"description": "Specifies features for display, like match highlighting.",
|
|
18584
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec",
|
|
18585
|
+
"properties": {
|
|
18586
|
+
"matchHighlightingCondition": {
|
|
18587
|
+
"description": "The condition under which match highlighting should occur.",
|
|
18588
|
+
"enum": [
|
|
18589
|
+
"MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED",
|
|
18590
|
+
"MATCH_HIGHLIGHTING_DISABLED",
|
|
18591
|
+
"MATCH_HIGHLIGHTING_ENABLED"
|
|
18592
|
+
],
|
|
18593
|
+
"enumDescriptions": [
|
|
18594
|
+
"Server behavior is the same as DISABLED.",
|
|
18595
|
+
"Disables match highlighting on all documents.",
|
|
18596
|
+
"Enables match highlighting on all documents."
|
|
18597
|
+
],
|
|
18598
|
+
"type": "string"
|
|
18599
|
+
}
|
|
18600
|
+
},
|
|
18601
|
+
"type": "object"
|
|
18602
|
+
},
|
|
17584
18603
|
"GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": {
|
|
17585
18604
|
"description": "The specification that uses customized query embedding vector to do semantic document retrieval.",
|
|
17586
18605
|
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec",
|
|
@@ -17782,12 +18801,14 @@
|
|
|
17782
18801
|
"enum": [
|
|
17783
18802
|
"CONDITION_UNSPECIFIED",
|
|
17784
18803
|
"DISABLED",
|
|
17785
|
-
"ENABLED"
|
|
18804
|
+
"ENABLED",
|
|
18805
|
+
"AUTO"
|
|
17786
18806
|
],
|
|
17787
18807
|
"enumDescriptions": [
|
|
17788
18808
|
"Server behavior defaults to Condition.DISABLED.",
|
|
17789
18809
|
"Disables Search As You Type.",
|
|
17790
|
-
"Enables Search As You Type."
|
|
18810
|
+
"Enables Search As You Type.",
|
|
18811
|
+
"Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)."
|
|
17791
18812
|
],
|
|
17792
18813
|
"type": "string"
|
|
17793
18814
|
}
|
|
@@ -17803,7 +18824,7 @@
|
|
|
17803
18824
|
"type": "string"
|
|
17804
18825
|
},
|
|
17805
18826
|
"searchResultPersistenceCount": {
|
|
17806
|
-
"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
|
|
18827
|
+
"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.",
|
|
17807
18828
|
"format": "int32",
|
|
17808
18829
|
"type": "integer"
|
|
17809
18830
|
}
|
|
@@ -18333,7 +19354,8 @@
|
|
|
18333
19354
|
"GOOGLE_CALENDAR",
|
|
18334
19355
|
"GOOGLE_CHAT",
|
|
18335
19356
|
"GOOGLE_GROUPS",
|
|
18336
|
-
"GOOGLE_KEEP"
|
|
19357
|
+
"GOOGLE_KEEP",
|
|
19358
|
+
"GOOGLE_PEOPLE"
|
|
18337
19359
|
],
|
|
18338
19360
|
"enumDescriptions": [
|
|
18339
19361
|
"Defaults to an unspecified Workspace type.",
|
|
@@ -18343,7 +19365,8 @@
|
|
|
18343
19365
|
"Workspace Data Store contains Calendar data",
|
|
18344
19366
|
"Workspace Data Store contains Chat data",
|
|
18345
19367
|
"Workspace Data Store contains Groups data",
|
|
18346
|
-
"Workspace Data Store contains Keep data"
|
|
19368
|
+
"Workspace Data Store contains Keep data",
|
|
19369
|
+
"Workspace Data Store contains People data"
|
|
18347
19370
|
],
|
|
18348
19371
|
"type": "string"
|
|
18349
19372
|
}
|
|
@@ -18406,11 +19429,11 @@
|
|
|
18406
19429
|
"type": "boolean"
|
|
18407
19430
|
},
|
|
18408
19431
|
"kmsKey": {
|
|
18409
|
-
"description": "
|
|
19432
|
+
"description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
|
|
18410
19433
|
"type": "string"
|
|
18411
19434
|
},
|
|
18412
19435
|
"kmsKeyVersion": {
|
|
18413
|
-
"description": "
|
|
19436
|
+
"description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
|
|
18414
19437
|
"type": "string"
|
|
18415
19438
|
},
|
|
18416
19439
|
"lastRotationTimestampMicros": {
|
|
@@ -18420,7 +19443,7 @@
|
|
|
18420
19443
|
"type": "string"
|
|
18421
19444
|
},
|
|
18422
19445
|
"name": {
|
|
18423
|
-
"description": "Required.
|
|
19446
|
+
"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
|
|
18424
19447
|
"type": "string"
|
|
18425
19448
|
},
|
|
18426
19449
|
"singleRegionKeys": {
|
|
@@ -18431,13 +19454,14 @@
|
|
|
18431
19454
|
"type": "array"
|
|
18432
19455
|
},
|
|
18433
19456
|
"state": {
|
|
18434
|
-
"description": "Output only.
|
|
19457
|
+
"description": "Output only. The states of the CmekConfig.",
|
|
18435
19458
|
"enum": [
|
|
18436
19459
|
"STATE_UNSPECIFIED",
|
|
18437
19460
|
"CREATING",
|
|
18438
19461
|
"ACTIVE",
|
|
18439
19462
|
"KEY_ISSUE",
|
|
18440
19463
|
"DELETING",
|
|
19464
|
+
"DELETE_FAILED",
|
|
18441
19465
|
"UNUSABLE",
|
|
18442
19466
|
"ACTIVE_ROTATING"
|
|
18443
19467
|
],
|
|
@@ -18447,6 +19471,7 @@
|
|
|
18447
19471
|
"The CmekConfig can be used with DataStores.",
|
|
18448
19472
|
"The CmekConfig is unavailable, most likely due to the KMS Key being revoked.",
|
|
18449
19473
|
"The CmekConfig is deleting.",
|
|
19474
|
+
"The CmekConfig deletion process failed.",
|
|
18450
19475
|
"The CmekConfig is not usable, most likely due to some internal issue.",
|
|
18451
19476
|
"The KMS key version is being rotated."
|
|
18452
19477
|
],
|
|
@@ -18620,6 +19645,70 @@
|
|
|
18620
19645
|
"description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
|
|
18621
19646
|
"format": "float",
|
|
18622
19647
|
"type": "number"
|
|
19648
|
+
},
|
|
19649
|
+
"interpolationBoostSpec": {
|
|
19650
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec",
|
|
19651
|
+
"description": "Optional. Complex specification for custom ranking based on customer defined attribute value."
|
|
19652
|
+
}
|
|
19653
|
+
},
|
|
19654
|
+
"type": "object"
|
|
19655
|
+
},
|
|
19656
|
+
"GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec": {
|
|
19657
|
+
"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.",
|
|
19658
|
+
"id": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpec",
|
|
19659
|
+
"properties": {
|
|
19660
|
+
"attributeType": {
|
|
19661
|
+
"description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).",
|
|
19662
|
+
"enum": [
|
|
19663
|
+
"ATTRIBUTE_TYPE_UNSPECIFIED",
|
|
19664
|
+
"NUMERICAL",
|
|
19665
|
+
"FRESHNESS"
|
|
19666
|
+
],
|
|
19667
|
+
"enumDescriptions": [
|
|
19668
|
+
"Unspecified AttributeType.",
|
|
19669
|
+
"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.",
|
|
19670
|
+
"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`."
|
|
19671
|
+
],
|
|
19672
|
+
"type": "string"
|
|
19673
|
+
},
|
|
19674
|
+
"controlPoints": {
|
|
19675
|
+
"description": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.",
|
|
19676
|
+
"items": {
|
|
19677
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint"
|
|
19678
|
+
},
|
|
19679
|
+
"type": "array"
|
|
19680
|
+
},
|
|
19681
|
+
"fieldName": {
|
|
19682
|
+
"description": "Optional. The name of the field whose value will be used to determine the boost amount.",
|
|
19683
|
+
"type": "string"
|
|
19684
|
+
},
|
|
19685
|
+
"interpolationType": {
|
|
19686
|
+
"description": "Optional. The interpolation type to be applied to connect the control points listed below.",
|
|
19687
|
+
"enum": [
|
|
19688
|
+
"INTERPOLATION_TYPE_UNSPECIFIED",
|
|
19689
|
+
"LINEAR"
|
|
19690
|
+
],
|
|
19691
|
+
"enumDescriptions": [
|
|
19692
|
+
"Interpolation type is unspecified. In this case, it defaults to Linear.",
|
|
19693
|
+
"Piecewise linear interpolation will be applied."
|
|
19694
|
+
],
|
|
19695
|
+
"type": "string"
|
|
19696
|
+
}
|
|
19697
|
+
},
|
|
19698
|
+
"type": "object"
|
|
19699
|
+
},
|
|
19700
|
+
"GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint": {
|
|
19701
|
+
"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).",
|
|
19702
|
+
"id": "GoogleCloudDiscoveryengineV1betaControlBoostActionInterpolationBoostSpecControlPoint",
|
|
19703
|
+
"properties": {
|
|
19704
|
+
"attributeValue": {
|
|
19705
|
+
"description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.",
|
|
19706
|
+
"type": "string"
|
|
19707
|
+
},
|
|
19708
|
+
"boostAmount": {
|
|
19709
|
+
"description": "Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.",
|
|
19710
|
+
"format": "float",
|
|
19711
|
+
"type": "number"
|
|
18623
19712
|
}
|
|
18624
19713
|
},
|
|
18625
19714
|
"type": "object"
|
|
@@ -18679,6 +19768,17 @@
|
|
|
18679
19768
|
},
|
|
18680
19769
|
"type": "object"
|
|
18681
19770
|
},
|
|
19771
|
+
"GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries": {
|
|
19772
|
+
"description": "The historical crawl rate timeseries data, used for monitoring.",
|
|
19773
|
+
"id": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
|
|
19774
|
+
"properties": {
|
|
19775
|
+
"qpsTimeSeries": {
|
|
19776
|
+
"$ref": "GoogleMonitoringV3TimeSeries",
|
|
19777
|
+
"description": "The QPS of the crawl rate."
|
|
19778
|
+
}
|
|
19779
|
+
},
|
|
19780
|
+
"type": "object"
|
|
19781
|
+
},
|
|
18682
19782
|
"GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": {
|
|
18683
19783
|
"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
18684
19784
|
"id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata",
|
|
@@ -18813,7 +19913,7 @@
|
|
|
18813
19913
|
"type": "string"
|
|
18814
19914
|
},
|
|
18815
19915
|
"defaultSchemaId": {
|
|
18816
|
-
"description": "Output only. The id of the default Schema
|
|
19916
|
+
"description": "Output only. The id of the default Schema associated to this data store.",
|
|
18817
19917
|
"readOnly": true,
|
|
18818
19918
|
"type": "string"
|
|
18819
19919
|
},
|
|
@@ -18825,6 +19925,14 @@
|
|
|
18825
19925
|
"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig",
|
|
18826
19926
|
"description": "Configuration for Document understanding and enrichment."
|
|
18827
19927
|
},
|
|
19928
|
+
"healthcareFhirConfig": {
|
|
19929
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig",
|
|
19930
|
+
"description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
|
|
19931
|
+
},
|
|
19932
|
+
"identityMappingStore": {
|
|
19933
|
+
"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}`.",
|
|
19934
|
+
"type": "string"
|
|
19935
|
+
},
|
|
18828
19936
|
"industryVertical": {
|
|
18829
19937
|
"description": "Immutable. The industry vertical that the data store registers.",
|
|
18830
19938
|
"enum": [
|
|
@@ -18945,6 +20053,21 @@
|
|
|
18945
20053
|
},
|
|
18946
20054
|
"type": "object"
|
|
18947
20055
|
},
|
|
20056
|
+
"GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries": {
|
|
20057
|
+
"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.",
|
|
20058
|
+
"id": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries",
|
|
20059
|
+
"properties": {
|
|
20060
|
+
"autoRefreshCrawlRate": {
|
|
20061
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
|
|
20062
|
+
"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."
|
|
20063
|
+
},
|
|
20064
|
+
"userTriggeredCrawlRate": {
|
|
20065
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
|
|
20066
|
+
"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."
|
|
20067
|
+
}
|
|
20068
|
+
},
|
|
20069
|
+
"type": "object"
|
|
20070
|
+
},
|
|
18948
20071
|
"GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": {
|
|
18949
20072
|
"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
18950
20073
|
"id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata",
|
|
@@ -19471,27 +20594,39 @@
|
|
|
19471
20594
|
},
|
|
19472
20595
|
"type": "object"
|
|
19473
20596
|
},
|
|
19474
|
-
"
|
|
19475
|
-
"description": "
|
|
19476
|
-
"id": "
|
|
20597
|
+
"GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig": {
|
|
20598
|
+
"description": "Config to data store for `HEALTHCARE_FHIR` vertical.",
|
|
20599
|
+
"id": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig",
|
|
19477
20600
|
"properties": {
|
|
19478
|
-
"
|
|
19479
|
-
"description": "
|
|
19480
|
-
"
|
|
19481
|
-
"$ref": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponseSitemapMetadata"
|
|
20601
|
+
"enableConfigurableSchema": {
|
|
20602
|
+
"description": "Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.",
|
|
20603
|
+
"type": "boolean"
|
|
19482
20604
|
},
|
|
19483
|
-
"
|
|
20605
|
+
"enableStaticIndexingForBatchIngestion": {
|
|
20606
|
+
"description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.",
|
|
20607
|
+
"type": "boolean"
|
|
19484
20608
|
}
|
|
19485
20609
|
},
|
|
19486
20610
|
"type": "object"
|
|
19487
20611
|
},
|
|
19488
|
-
"
|
|
19489
|
-
"description": "
|
|
19490
|
-
"id": "
|
|
20612
|
+
"GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata": {
|
|
20613
|
+
"description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings",
|
|
20614
|
+
"id": "GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata",
|
|
19491
20615
|
"properties": {
|
|
19492
|
-
"
|
|
19493
|
-
"
|
|
19494
|
-
"
|
|
20616
|
+
"failureCount": {
|
|
20617
|
+
"description": "The number of IdentityMappingEntries that failed to be processed.",
|
|
20618
|
+
"format": "int64",
|
|
20619
|
+
"type": "string"
|
|
20620
|
+
},
|
|
20621
|
+
"successCount": {
|
|
20622
|
+
"description": "The number of IdentityMappingEntries that were successfully processed.",
|
|
20623
|
+
"format": "int64",
|
|
20624
|
+
"type": "string"
|
|
20625
|
+
},
|
|
20626
|
+
"totalCount": {
|
|
20627
|
+
"description": "The total number of IdentityMappingEntries that were processed.",
|
|
20628
|
+
"format": "int64",
|
|
20629
|
+
"type": "string"
|
|
19495
20630
|
}
|
|
19496
20631
|
},
|
|
19497
20632
|
"type": "object"
|
|
@@ -19602,6 +20737,20 @@
|
|
|
19602
20737
|
},
|
|
19603
20738
|
"type": "object"
|
|
19604
20739
|
},
|
|
20740
|
+
"GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse": {
|
|
20741
|
+
"description": "Response message for IdentityMappingStoreService.ImportIdentityMappings",
|
|
20742
|
+
"id": "GoogleCloudDiscoveryengineV1betaImportIdentityMappingsResponse",
|
|
20743
|
+
"properties": {
|
|
20744
|
+
"errorSamples": {
|
|
20745
|
+
"description": "A sample of errors encountered while processing the request.",
|
|
20746
|
+
"items": {
|
|
20747
|
+
"$ref": "GoogleRpcStatus"
|
|
20748
|
+
},
|
|
20749
|
+
"type": "array"
|
|
20750
|
+
}
|
|
20751
|
+
},
|
|
20752
|
+
"type": "object"
|
|
20753
|
+
},
|
|
19605
20754
|
"GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": {
|
|
19606
20755
|
"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
19607
20756
|
"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata",
|
|
@@ -19822,6 +20971,55 @@
|
|
|
19822
20971
|
},
|
|
19823
20972
|
"type": "object"
|
|
19824
20973
|
},
|
|
20974
|
+
"GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse": {
|
|
20975
|
+
"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.",
|
|
20976
|
+
"id": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse",
|
|
20977
|
+
"properties": {
|
|
20978
|
+
"dedicatedCrawlRateTimeSeries": {
|
|
20979
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries",
|
|
20980
|
+
"description": "The historical dedicated crawl rate timeseries data, used for monitoring."
|
|
20981
|
+
},
|
|
20982
|
+
"error": {
|
|
20983
|
+
"$ref": "GoogleRpcStatus",
|
|
20984
|
+
"description": "Errors from service when handling the request."
|
|
20985
|
+
},
|
|
20986
|
+
"organicCrawlRateTimeSeries": {
|
|
20987
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries",
|
|
20988
|
+
"description": "The historical organic crawl rate timeseries data, used for monitoring."
|
|
20989
|
+
},
|
|
20990
|
+
"state": {
|
|
20991
|
+
"description": "Output only. The state of the response.",
|
|
20992
|
+
"enum": [
|
|
20993
|
+
"STATE_UNSPECIFIED",
|
|
20994
|
+
"SUCCEEDED",
|
|
20995
|
+
"FAILED"
|
|
20996
|
+
],
|
|
20997
|
+
"enumDescriptions": [
|
|
20998
|
+
"The state is unspecified.",
|
|
20999
|
+
"The state is successful.",
|
|
21000
|
+
"The state is failed."
|
|
21001
|
+
],
|
|
21002
|
+
"readOnly": true,
|
|
21003
|
+
"type": "string"
|
|
21004
|
+
}
|
|
21005
|
+
},
|
|
21006
|
+
"type": "object"
|
|
21007
|
+
},
|
|
21008
|
+
"GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries": {
|
|
21009
|
+
"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.",
|
|
21010
|
+
"id": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries",
|
|
21011
|
+
"properties": {
|
|
21012
|
+
"googleOrganicCrawlRate": {
|
|
21013
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
|
|
21014
|
+
"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."
|
|
21015
|
+
},
|
|
21016
|
+
"vertexAiOrganicCrawlRate": {
|
|
21017
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
|
|
21018
|
+
"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."
|
|
21019
|
+
}
|
|
21020
|
+
},
|
|
21021
|
+
"type": "object"
|
|
21022
|
+
},
|
|
19825
21023
|
"GoogleCloudDiscoveryengineV1betaProject": {
|
|
19826
21024
|
"description": "Metadata and configurations for a Google Cloud project in the service.",
|
|
19827
21025
|
"id": "GoogleCloudDiscoveryengineV1betaProject",
|
|
@@ -20042,6 +21240,49 @@
|
|
|
20042
21240
|
},
|
|
20043
21241
|
"type": "object"
|
|
20044
21242
|
},
|
|
21243
|
+
"GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata": {
|
|
21244
|
+
"description": "Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
21245
|
+
"id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata",
|
|
21246
|
+
"properties": {
|
|
21247
|
+
"createTime": {
|
|
21248
|
+
"description": "Operation create time.",
|
|
21249
|
+
"format": "google-datetime",
|
|
21250
|
+
"type": "string"
|
|
21251
|
+
},
|
|
21252
|
+
"updateTime": {
|
|
21253
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
21254
|
+
"format": "google-datetime",
|
|
21255
|
+
"type": "string"
|
|
21256
|
+
}
|
|
21257
|
+
},
|
|
21258
|
+
"type": "object"
|
|
21259
|
+
},
|
|
21260
|
+
"GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse": {
|
|
21261
|
+
"description": "Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.",
|
|
21262
|
+
"id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse",
|
|
21263
|
+
"properties": {
|
|
21264
|
+
"error": {
|
|
21265
|
+
"$ref": "GoogleRpcStatus",
|
|
21266
|
+
"description": "Errors from service when handling the request."
|
|
21267
|
+
},
|
|
21268
|
+
"state": {
|
|
21269
|
+
"description": "Output only. The state of the response.",
|
|
21270
|
+
"enum": [
|
|
21271
|
+
"STATE_UNSPECIFIED",
|
|
21272
|
+
"SUCCEEDED",
|
|
21273
|
+
"FAILED"
|
|
21274
|
+
],
|
|
21275
|
+
"enumDescriptions": [
|
|
21276
|
+
"The state is unspecified.",
|
|
21277
|
+
"The state is successful.",
|
|
21278
|
+
"The state is failed."
|
|
21279
|
+
],
|
|
21280
|
+
"readOnly": true,
|
|
21281
|
+
"type": "string"
|
|
21282
|
+
}
|
|
21283
|
+
},
|
|
21284
|
+
"type": "object"
|
|
21285
|
+
},
|
|
20045
21286
|
"GoogleCloudDiscoveryengineV1betaSchema": {
|
|
20046
21287
|
"description": "Defines the structure and layout of a type of document data.",
|
|
20047
21288
|
"id": "GoogleCloudDiscoveryengineV1betaSchema",
|
|
@@ -20189,7 +21430,21 @@
|
|
|
20189
21430
|
"description": "The query expansion specification that specifies the conditions under which query expansion occurs."
|
|
20190
21431
|
},
|
|
20191
21432
|
"rankingExpression": {
|
|
20192
|
-
"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)`.",
|
|
21433
|
+
"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",
|
|
21434
|
+
"type": "string"
|
|
21435
|
+
},
|
|
21436
|
+
"rankingExpressionBackend": {
|
|
21437
|
+
"description": "Optional. The backend to use for the ranking expression evaluation.",
|
|
21438
|
+
"enum": [
|
|
21439
|
+
"UNKNOWN",
|
|
21440
|
+
"BYOE",
|
|
21441
|
+
"CLEARBOX"
|
|
21442
|
+
],
|
|
21443
|
+
"enumDescriptions": [
|
|
21444
|
+
"Default option for unspecified/unknown values.",
|
|
21445
|
+
"Bring your own embedding (BYOE), the default way to evaluate the ranking expression.",
|
|
21446
|
+
"The expression is compiled into a Clearbox formula."
|
|
21447
|
+
],
|
|
20193
21448
|
"type": "string"
|
|
20194
21449
|
},
|
|
20195
21450
|
"regionCode": {
|
|
@@ -20240,7 +21495,7 @@
|
|
|
20240
21495
|
},
|
|
20241
21496
|
"userInfo": {
|
|
20242
21497
|
"$ref": "GoogleCloudDiscoveryengineV1betaUserInfo",
|
|
20243
|
-
"description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics."
|
|
21498
|
+
"description": "Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics."
|
|
20244
21499
|
},
|
|
20245
21500
|
"userLabels": {
|
|
20246
21501
|
"additionalProperties": {
|
|
@@ -20747,12 +22002,14 @@
|
|
|
20747
22002
|
"enum": [
|
|
20748
22003
|
"CONDITION_UNSPECIFIED",
|
|
20749
22004
|
"DISABLED",
|
|
20750
|
-
"ENABLED"
|
|
22005
|
+
"ENABLED",
|
|
22006
|
+
"AUTO"
|
|
20751
22007
|
],
|
|
20752
22008
|
"enumDescriptions": [
|
|
20753
22009
|
"Server behavior defaults to Condition.DISABLED.",
|
|
20754
22010
|
"Disables Search As You Type.",
|
|
20755
|
-
"Enables Search As You Type."
|
|
22011
|
+
"Enables Search As You Type.",
|
|
22012
|
+
"Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)."
|
|
20756
22013
|
],
|
|
20757
22014
|
"type": "string"
|
|
20758
22015
|
}
|
|
@@ -20768,7 +22025,7 @@
|
|
|
20768
22025
|
"type": "string"
|
|
20769
22026
|
},
|
|
20770
22027
|
"searchResultPersistenceCount": {
|
|
20771
|
-
"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
|
|
22028
|
+
"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.",
|
|
20772
22029
|
"format": "int32",
|
|
20773
22030
|
"type": "integer"
|
|
20774
22031
|
}
|
|
@@ -20796,6 +22053,49 @@
|
|
|
20796
22053
|
},
|
|
20797
22054
|
"type": "object"
|
|
20798
22055
|
},
|
|
22056
|
+
"GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata": {
|
|
22057
|
+
"description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
22058
|
+
"id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata",
|
|
22059
|
+
"properties": {
|
|
22060
|
+
"createTime": {
|
|
22061
|
+
"description": "Operation create time.",
|
|
22062
|
+
"format": "google-datetime",
|
|
22063
|
+
"type": "string"
|
|
22064
|
+
},
|
|
22065
|
+
"updateTime": {
|
|
22066
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
22067
|
+
"format": "google-datetime",
|
|
22068
|
+
"type": "string"
|
|
22069
|
+
}
|
|
22070
|
+
},
|
|
22071
|
+
"type": "object"
|
|
22072
|
+
},
|
|
22073
|
+
"GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse": {
|
|
22074
|
+
"description": "Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.",
|
|
22075
|
+
"id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse",
|
|
22076
|
+
"properties": {
|
|
22077
|
+
"error": {
|
|
22078
|
+
"$ref": "GoogleRpcStatus",
|
|
22079
|
+
"description": "Errors from service when handling the request."
|
|
22080
|
+
},
|
|
22081
|
+
"state": {
|
|
22082
|
+
"description": "Output only. The state of the response.",
|
|
22083
|
+
"enum": [
|
|
22084
|
+
"STATE_UNSPECIFIED",
|
|
22085
|
+
"SUCCEEDED",
|
|
22086
|
+
"FAILED"
|
|
22087
|
+
],
|
|
22088
|
+
"enumDescriptions": [
|
|
22089
|
+
"The state is unspecified.",
|
|
22090
|
+
"The state is successful.",
|
|
22091
|
+
"The state is failed."
|
|
22092
|
+
],
|
|
22093
|
+
"readOnly": true,
|
|
22094
|
+
"type": "string"
|
|
22095
|
+
}
|
|
22096
|
+
},
|
|
22097
|
+
"type": "object"
|
|
22098
|
+
},
|
|
20799
22099
|
"GoogleCloudDiscoveryengineV1betaSingleRegionKey": {
|
|
20800
22100
|
"description": "Metadata for single-regional CMEKs.",
|
|
20801
22101
|
"id": "GoogleCloudDiscoveryengineV1betaSingleRegionKey",
|
|
@@ -21102,7 +22402,8 @@
|
|
|
21102
22402
|
"GOOGLE_CALENDAR",
|
|
21103
22403
|
"GOOGLE_CHAT",
|
|
21104
22404
|
"GOOGLE_GROUPS",
|
|
21105
|
-
"GOOGLE_KEEP"
|
|
22405
|
+
"GOOGLE_KEEP",
|
|
22406
|
+
"GOOGLE_PEOPLE"
|
|
21106
22407
|
],
|
|
21107
22408
|
"enumDescriptions": [
|
|
21108
22409
|
"Defaults to an unspecified Workspace type.",
|
|
@@ -21112,7 +22413,8 @@
|
|
|
21112
22413
|
"Workspace Data Store contains Calendar data",
|
|
21113
22414
|
"Workspace Data Store contains Chat data",
|
|
21114
22415
|
"Workspace Data Store contains Groups data",
|
|
21115
|
-
"Workspace Data Store contains Keep data"
|
|
22416
|
+
"Workspace Data Store contains Keep data",
|
|
22417
|
+
"Workspace Data Store contains People data"
|
|
21116
22418
|
],
|
|
21117
22419
|
"type": "string"
|
|
21118
22420
|
}
|