google-api-python-client 2.154.0__py2.py3-none-any.whl → 2.156.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.154.0.dist-info → google_api_python_client-2.156.0.dist-info}/METADATA +1 -1
- {google_api_python_client-2.154.0.dist-info → google_api_python_client-2.156.0.dist-info}/RECORD +256 -250
- googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +19 -11
- googleapiclient/discovery_cache/documents/addressvalidation.v1.json +6 -6
- googleapiclient/discovery_cache/documents/admin.directory_v1.json +5 -1
- googleapiclient/discovery_cache/documents/admin.directoryv1.json +5 -1
- googleapiclient/discovery_cache/documents/adsense.v2.json +7 -3
- googleapiclient/discovery_cache/documents/adsenseplatform.v1.json +3 -3
- googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json +3 -3
- googleapiclient/discovery_cache/documents/aiplatform.v1.json +2903 -112
- googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +1243 -64
- googleapiclient/discovery_cache/documents/alloydb.v1.json +130 -3
- googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +166 -3
- googleapiclient/discovery_cache/documents/alloydb.v1beta.json +166 -3
- googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json +11 -1
- googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json +3 -3
- googleapiclient/discovery_cache/documents/androidmanagement.v1.json +25 -9
- googleapiclient/discovery_cache/documents/androidpublisher.v3.json +37 -1
- googleapiclient/discovery_cache/documents/apigateway.v1.json +3 -3
- googleapiclient/discovery_cache/documents/apigateway.v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/apigee.v1.json +33 -2
- googleapiclient/discovery_cache/documents/appengine.v1.json +67 -1
- googleapiclient/discovery_cache/documents/appengine.v1alpha.json +20 -1
- googleapiclient/discovery_cache/documents/appengine.v1beta.json +67 -1
- googleapiclient/discovery_cache/documents/artifactregistry.v1.json +6 -1
- googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +18 -9
- googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +18 -9
- googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json +3 -3
- googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json +3 -3
- googleapiclient/discovery_cache/documents/backupdr.v1.json +68 -11
- googleapiclient/discovery_cache/documents/batch.v1.json +3 -3
- googleapiclient/discovery_cache/documents/beyondcorp.v1.json +9 -9
- googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +9 -9
- googleapiclient/discovery_cache/documents/bigquery.v2.json +20 -6
- googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +10 -8
- googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +3 -3
- googleapiclient/discovery_cache/documents/binaryauthorization.v1.json +1 -2
- googleapiclient/discovery_cache/documents/blockchainnodeengine.v1.json +2 -2
- googleapiclient/discovery_cache/documents/certificatemanager.v1.json +6 -6
- googleapiclient/discovery_cache/documents/chat.v1.json +68 -4
- googleapiclient/discovery_cache/documents/checks.v1alpha.json +495 -5
- googleapiclient/discovery_cache/documents/chromemanagement.v1.json +847 -13
- googleapiclient/discovery_cache/documents/chromepolicy.v1.json +2 -2
- googleapiclient/discovery_cache/documents/classroom.v1.json +399 -1
- googleapiclient/discovery_cache/documents/cloudasset.v1.json +10 -2
- googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +10 -2
- googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +10 -2
- googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +10 -2
- googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +13 -1
- googleapiclient/discovery_cache/documents/cloudbuild.v1.json +231 -4
- googleapiclient/discovery_cache/documents/cloudbuild.v2.json +230 -3
- googleapiclient/discovery_cache/documents/cloudchannel.v1.json +12 -12
- googleapiclient/discovery_cache/documents/clouddeploy.v1.json +4 -4
- googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +6 -4
- googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +6 -4
- googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +6 -4
- googleapiclient/discovery_cache/documents/cloudidentity.v1.json +203 -7
- googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +53 -13
- googleapiclient/discovery_cache/documents/cloudkms.v1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudshell.v1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudsupport.v2.json +2 -2
- googleapiclient/discovery_cache/documents/cloudsupport.v2beta.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 +1162 -164
- googleapiclient/discovery_cache/documents/compute.beta.json +927 -72
- googleapiclient/discovery_cache/documents/compute.v1.json +2980 -1157
- googleapiclient/discovery_cache/documents/config.v1.json +9 -8
- googleapiclient/discovery_cache/documents/connectors.v1.json +180 -48
- googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +3 -3
- googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +112 -6
- googleapiclient/discovery_cache/documents/container.v1.json +14 -4
- googleapiclient/discovery_cache/documents/container.v1beta1.json +18 -6
- googleapiclient/discovery_cache/documents/content.v2.1.json +7 -3
- googleapiclient/discovery_cache/documents/contentwarehouse.v1.json +8 -8
- googleapiclient/discovery_cache/documents/css.v1.json +16 -14
- googleapiclient/discovery_cache/documents/datacatalog.v1.json +2 -2
- googleapiclient/discovery_cache/documents/dataflow.v1b3.json +22 -1
- googleapiclient/discovery_cache/documents/dataform.v1beta1.json +1 -220
- googleapiclient/discovery_cache/documents/datafusion.v1.json +31 -362
- googleapiclient/discovery_cache/documents/datafusion.v1beta1.json +15 -347
- googleapiclient/discovery_cache/documents/datalabeling.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/datalineage.v1.json +3 -3
- googleapiclient/discovery_cache/documents/datamigration.v1.json +330 -7
- googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/dataplex.v1.json +16 -11
- googleapiclient/discovery_cache/documents/dataportability.v1.json +1 -1
- googleapiclient/discovery_cache/documents/dataportability.v1beta.json +1 -1
- googleapiclient/discovery_cache/documents/datastore.v1.json +2 -2
- googleapiclient/discovery_cache/documents/datastream.v1.json +27 -12
- googleapiclient/discovery_cache/documents/datastream.v1alpha1.json +3 -3
- googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +2 -2
- googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +2 -2
- googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +2 -2
- googleapiclient/discovery_cache/documents/developerconnect.v1.json +4 -4
- googleapiclient/discovery_cache/documents/dialogflow.v2.json +26 -22
- googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +16 -12
- googleapiclient/discovery_cache/documents/dialogflow.v3.json +14 -10
- googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +250 -11
- googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +2 -1
- googleapiclient/discovery_cache/documents/discoveryengine.v1.json +782 -189
- googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +781 -102
- googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +846 -94
- googleapiclient/discovery_cache/documents/displayvideo.v2.json +34 -8
- googleapiclient/discovery_cache/documents/displayvideo.v3.json +40 -12
- googleapiclient/discovery_cache/documents/dlp.v2.json +5 -1
- googleapiclient/discovery_cache/documents/documentai.v1.json +9 -9
- googleapiclient/discovery_cache/documents/documentai.v1beta3.json +9 -9
- googleapiclient/discovery_cache/documents/domains.v1.json +6 -6
- googleapiclient/discovery_cache/documents/domains.v1alpha2.json +6 -6
- googleapiclient/discovery_cache/documents/domains.v1beta1.json +6 -6
- googleapiclient/discovery_cache/documents/drive.v3.json +15 -15
- googleapiclient/discovery_cache/documents/eventarc.v1.json +23 -9
- googleapiclient/discovery_cache/documents/file.v1.json +20 -20
- googleapiclient/discovery_cache/documents/file.v1beta1.json +21 -21
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +23 -7
- googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json +2 -1
- googleapiclient/discovery_cache/documents/firebasehosting.v1.json +2 -2
- googleapiclient/discovery_cache/documents/firebaseml.v1.json +2 -2
- googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +182 -2
- googleapiclient/discovery_cache/documents/firebaserules.v1.json +11 -11
- googleapiclient/discovery_cache/documents/firestore.v1.json +2 -2
- googleapiclient/discovery_cache/documents/forms.v1.json +33 -1
- googleapiclient/discovery_cache/documents/games.v1.json +2 -2
- googleapiclient/discovery_cache/documents/gamesManagement.v1management.json +2 -2
- googleapiclient/discovery_cache/documents/gkebackup.v1.json +3 -3
- googleapiclient/discovery_cache/documents/gkehub.v1.json +3 -3
- googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +3 -3
- googleapiclient/discovery_cache/documents/gkehub.v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/gkehub.v2.json +3 -29
- googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +3 -29
- googleapiclient/discovery_cache/documents/gkehub.v2beta.json +3 -29
- googleapiclient/discovery_cache/documents/gkeonprem.v1.json +2 -2
- googleapiclient/discovery_cache/documents/healthcare.v1.json +542 -2
- googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +27 -2
- googleapiclient/discovery_cache/documents/iam.v1.json +15 -15
- googleapiclient/discovery_cache/documents/iam.v2.json +2 -2
- googleapiclient/discovery_cache/documents/iam.v2beta.json +2 -2
- googleapiclient/discovery_cache/documents/iap.v1.json +2 -2
- googleapiclient/discovery_cache/documents/identitytoolkit.v1.json +3 -3
- googleapiclient/discovery_cache/documents/integrations.v1.json +134 -20
- googleapiclient/discovery_cache/documents/localservices.v1.json +3 -3
- googleapiclient/discovery_cache/documents/looker.v1.json +10 -4
- googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +17 -17
- googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +8 -4
- googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/metastore.v1.json +3 -3
- googleapiclient/discovery_cache/documents/metastore.v1alpha.json +3 -3
- googleapiclient/discovery_cache/documents/metastore.v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/metastore.v2.json +1813 -0
- googleapiclient/discovery_cache/documents/metastore.v2alpha.json +2313 -0
- googleapiclient/discovery_cache/documents/metastore.v2beta.json +2313 -0
- googleapiclient/discovery_cache/documents/migrationcenter.v1.json +725 -8
- googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +4 -4
- googleapiclient/discovery_cache/documents/ml.v1.json +3 -3
- googleapiclient/discovery_cache/documents/monitoring.v3.json +8 -4
- googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json +6 -6
- googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +6 -6
- googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json +6 -6
- googleapiclient/discovery_cache/documents/netapp.v1.json +73 -275
- googleapiclient/discovery_cache/documents/netapp.v1beta1.json +73 -275
- googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +4 -4
- googleapiclient/discovery_cache/documents/networkmanagement.v1.json +369 -20
- googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +52 -20
- googleapiclient/discovery_cache/documents/networksecurity.v1.json +32 -11
- googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +2232 -1049
- googleapiclient/discovery_cache/documents/networkservices.v1.json +3 -3
- googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/notebooks.v1.json +2 -2
- googleapiclient/discovery_cache/documents/notebooks.v2.json +6 -2
- googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +2 -2
- googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/oracledatabase.v1.json +9 -8
- googleapiclient/discovery_cache/documents/orgpolicy.v2.json +13 -1
- googleapiclient/discovery_cache/documents/osconfig.v1.json +4 -4
- googleapiclient/discovery_cache/documents/osconfig.v1alpha.json +2 -2
- googleapiclient/discovery_cache/documents/osconfig.v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/osconfig.v2beta.json +4 -4
- googleapiclient/discovery_cache/documents/oslogin.v1alpha.json +2 -2
- googleapiclient/discovery_cache/documents/parallelstore.v1.json +975 -0
- googleapiclient/discovery_cache/documents/parallelstore.v1beta.json +980 -0
- googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +18 -1
- googleapiclient/discovery_cache/documents/places.v1.json +4 -4
- googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json +13 -13
- googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json +13 -13
- googleapiclient/discovery_cache/documents/playintegrity.v1.json +38 -1
- googleapiclient/discovery_cache/documents/policysimulator.v1.json +9 -1
- googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +9 -1
- googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +9 -1
- googleapiclient/discovery_cache/documents/privateca.v1.json +12 -17
- googleapiclient/discovery_cache/documents/privateca.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/pubsublite.v1.json +2 -2
- googleapiclient/discovery_cache/documents/rapidmigrationassessment.v1.json +2 -2
- googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +3 -3
- googleapiclient/discovery_cache/documents/redis.v1.json +644 -6
- googleapiclient/discovery_cache/documents/redis.v1beta1.json +645 -7
- googleapiclient/discovery_cache/documents/retail.v2.json +31 -13
- googleapiclient/discovery_cache/documents/retail.v2alpha.json +31 -13
- googleapiclient/discovery_cache/documents/retail.v2beta.json +31 -13
- googleapiclient/discovery_cache/documents/run.v2.json +13 -4
- googleapiclient/discovery_cache/documents/secretmanager.v1.json +2 -2
- googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +2 -2
- googleapiclient/discovery_cache/documents/securitycenter.v1.json +526 -2
- googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +481 -2
- googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +480 -1
- googleapiclient/discovery_cache/documents/securityposture.v1.json +2136 -0
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +14 -3
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +23 -4
- googleapiclient/discovery_cache/documents/servicecontrol.v2.json +9 -1
- googleapiclient/discovery_cache/documents/servicemanagement.v1.json +12 -1
- googleapiclient/discovery_cache/documents/servicenetworking.v1.json +6 -2
- googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +5 -1
- googleapiclient/discovery_cache/documents/serviceusage.v1.json +18 -3
- googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +17 -2
- googleapiclient/discovery_cache/documents/sheets.v4.json +5 -1
- googleapiclient/discovery_cache/documents/solar.v1.json +2 -2
- googleapiclient/discovery_cache/documents/spanner.v1.json +6 -6
- googleapiclient/discovery_cache/documents/sqladmin.v1.json +66 -10
- googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +66 -10
- googleapiclient/discovery_cache/documents/storage.v1.json +94 -2
- googleapiclient/discovery_cache/documents/tagmanager.v2.json +5 -1
- googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +2 -1
- googleapiclient/discovery_cache/documents/tpu.v1.json +2 -2
- googleapiclient/discovery_cache/documents/tpu.v1alpha1.json +2 -2
- googleapiclient/discovery_cache/documents/tpu.v2.json +6 -4
- googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +2 -2
- googleapiclient/discovery_cache/documents/vault.v1.json +2 -2
- googleapiclient/discovery_cache/documents/verifiedaccess.v2.json +2 -2
- googleapiclient/discovery_cache/documents/vision.v1.json +2 -2
- googleapiclient/discovery_cache/documents/vmmigration.v1.json +2 -2
- googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +2 -2
- googleapiclient/discovery_cache/documents/walletobjects.v1.json +117 -2
- googleapiclient/discovery_cache/documents/webrisk.v1.json +2 -2
- googleapiclient/discovery_cache/documents/workflows.v1.json +8 -1
- googleapiclient/discovery_cache/documents/workloadmanager.v1.json +96 -2
- googleapiclient/discovery_cache/documents/workspaceevents.v1.json +1 -1
- googleapiclient/discovery_cache/documents/workstations.v1.json +6 -6
- googleapiclient/discovery_cache/documents/workstations.v1beta.json +6 -6
- googleapiclient/discovery_cache/documents/youtube.v3.json +28 -62
- googleapiclient/version.py +1 -1
- {google_api_python_client-2.154.0.dist-info → google_api_python_client-2.156.0.dist-info}/LICENSE +0 -0
- {google_api_python_client-2.154.0.dist-info → google_api_python_client-2.156.0.dist-info}/WHEEL +0 -0
- {google_api_python_client-2.154.0.dist-info → google_api_python_client-2.156.0.dist-info}/top_level.txt +0 -0
|
@@ -1241,7 +1241,7 @@
|
|
|
1241
1241
|
"operations": {
|
|
1242
1242
|
"methods": {
|
|
1243
1243
|
"cancel": {
|
|
1244
|
-
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
|
|
1244
|
+
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
|
|
1245
1245
|
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel",
|
|
1246
1246
|
"httpMethod": "POST",
|
|
1247
1247
|
"id": "discoveryengine.projects.locations.collections.dataStores.branches.operations.cancel",
|
|
@@ -2391,6 +2391,34 @@
|
|
|
2391
2391
|
"scopes": [
|
|
2392
2392
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
2393
2393
|
]
|
|
2394
|
+
},
|
|
2395
|
+
"streamAnswer": {
|
|
2396
|
+
"description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.",
|
|
2397
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:streamAnswer",
|
|
2398
|
+
"httpMethod": "POST",
|
|
2399
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.streamAnswer",
|
|
2400
|
+
"parameterOrder": [
|
|
2401
|
+
"servingConfig"
|
|
2402
|
+
],
|
|
2403
|
+
"parameters": {
|
|
2404
|
+
"servingConfig": {
|
|
2405
|
+
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
|
|
2406
|
+
"location": "path",
|
|
2407
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
|
|
2408
|
+
"required": true,
|
|
2409
|
+
"type": "string"
|
|
2410
|
+
}
|
|
2411
|
+
},
|
|
2412
|
+
"path": "v1alpha/{+servingConfig}:streamAnswer",
|
|
2413
|
+
"request": {
|
|
2414
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest"
|
|
2415
|
+
},
|
|
2416
|
+
"response": {
|
|
2417
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse"
|
|
2418
|
+
},
|
|
2419
|
+
"scopes": [
|
|
2420
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
2421
|
+
]
|
|
2394
2422
|
}
|
|
2395
2423
|
}
|
|
2396
2424
|
},
|
|
@@ -2458,6 +2486,11 @@
|
|
|
2458
2486
|
"name"
|
|
2459
2487
|
],
|
|
2460
2488
|
"parameters": {
|
|
2489
|
+
"includeAnswerDetails": {
|
|
2490
|
+
"description": "Optional. If set to true, the full session including all answer details will be returned.",
|
|
2491
|
+
"location": "query",
|
|
2492
|
+
"type": "boolean"
|
|
2493
|
+
},
|
|
2461
2494
|
"name": {
|
|
2462
2495
|
"description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
2463
2496
|
"location": "path",
|
|
@@ -2489,7 +2522,7 @@
|
|
|
2489
2522
|
"type": "string"
|
|
2490
2523
|
},
|
|
2491
2524
|
"orderBy": {
|
|
2492
|
-
"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: \"update_time desc\" \"create_time\"",
|
|
2525
|
+
"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * \"update_time desc\" * \"create_time\" * \"is_pinned desc,update_time desc\": list sessions by is_pinned first, then by update_time.",
|
|
2493
2526
|
"location": "query",
|
|
2494
2527
|
"type": "string"
|
|
2495
2528
|
},
|
|
@@ -3245,7 +3278,7 @@
|
|
|
3245
3278
|
"type": "string"
|
|
3246
3279
|
},
|
|
3247
3280
|
"parent": {
|
|
3248
|
-
"description": "Required. The parent
|
|
3281
|
+
"description": "Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.",
|
|
3249
3282
|
"location": "path",
|
|
3250
3283
|
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
|
|
3251
3284
|
"required": true,
|
|
@@ -4271,6 +4304,34 @@
|
|
|
4271
4304
|
"scopes": [
|
|
4272
4305
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
4273
4306
|
]
|
|
4307
|
+
},
|
|
4308
|
+
"streamAnswer": {
|
|
4309
|
+
"description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.",
|
|
4310
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:streamAnswer",
|
|
4311
|
+
"httpMethod": "POST",
|
|
4312
|
+
"id": "discoveryengine.projects.locations.collections.engines.servingConfigs.streamAnswer",
|
|
4313
|
+
"parameterOrder": [
|
|
4314
|
+
"servingConfig"
|
|
4315
|
+
],
|
|
4316
|
+
"parameters": {
|
|
4317
|
+
"servingConfig": {
|
|
4318
|
+
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
|
|
4319
|
+
"location": "path",
|
|
4320
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
|
|
4321
|
+
"required": true,
|
|
4322
|
+
"type": "string"
|
|
4323
|
+
}
|
|
4324
|
+
},
|
|
4325
|
+
"path": "v1alpha/{+servingConfig}:streamAnswer",
|
|
4326
|
+
"request": {
|
|
4327
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest"
|
|
4328
|
+
},
|
|
4329
|
+
"response": {
|
|
4330
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse"
|
|
4331
|
+
},
|
|
4332
|
+
"scopes": [
|
|
4333
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
4334
|
+
]
|
|
4274
4335
|
}
|
|
4275
4336
|
}
|
|
4276
4337
|
},
|
|
@@ -4338,6 +4399,11 @@
|
|
|
4338
4399
|
"name"
|
|
4339
4400
|
],
|
|
4340
4401
|
"parameters": {
|
|
4402
|
+
"includeAnswerDetails": {
|
|
4403
|
+
"description": "Optional. If set to true, the full session including all answer details will be returned.",
|
|
4404
|
+
"location": "query",
|
|
4405
|
+
"type": "boolean"
|
|
4406
|
+
},
|
|
4341
4407
|
"name": {
|
|
4342
4408
|
"description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
4343
4409
|
"location": "path",
|
|
@@ -4369,7 +4435,7 @@
|
|
|
4369
4435
|
"type": "string"
|
|
4370
4436
|
},
|
|
4371
4437
|
"orderBy": {
|
|
4372
|
-
"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: \"update_time desc\" \"create_time\"",
|
|
4438
|
+
"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * \"update_time desc\" * \"create_time\" * \"is_pinned desc,update_time desc\": list sessions by is_pinned first, then by update_time.",
|
|
4373
4439
|
"location": "query",
|
|
4374
4440
|
"type": "string"
|
|
4375
4441
|
},
|
|
@@ -5236,7 +5302,7 @@
|
|
|
5236
5302
|
"operations": {
|
|
5237
5303
|
"methods": {
|
|
5238
5304
|
"cancel": {
|
|
5239
|
-
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
|
|
5305
|
+
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
|
|
5240
5306
|
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel",
|
|
5241
5307
|
"httpMethod": "POST",
|
|
5242
5308
|
"id": "discoveryengine.projects.locations.dataStores.branches.operations.cancel",
|
|
@@ -6285,6 +6351,34 @@
|
|
|
6285
6351
|
"scopes": [
|
|
6286
6352
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
6287
6353
|
]
|
|
6354
|
+
},
|
|
6355
|
+
"streamAnswer": {
|
|
6356
|
+
"description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.",
|
|
6357
|
+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:streamAnswer",
|
|
6358
|
+
"httpMethod": "POST",
|
|
6359
|
+
"id": "discoveryengine.projects.locations.dataStores.servingConfigs.streamAnswer",
|
|
6360
|
+
"parameterOrder": [
|
|
6361
|
+
"servingConfig"
|
|
6362
|
+
],
|
|
6363
|
+
"parameters": {
|
|
6364
|
+
"servingConfig": {
|
|
6365
|
+
"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
|
|
6366
|
+
"location": "path",
|
|
6367
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
|
|
6368
|
+
"required": true,
|
|
6369
|
+
"type": "string"
|
|
6370
|
+
}
|
|
6371
|
+
},
|
|
6372
|
+
"path": "v1alpha/{+servingConfig}:streamAnswer",
|
|
6373
|
+
"request": {
|
|
6374
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest"
|
|
6375
|
+
},
|
|
6376
|
+
"response": {
|
|
6377
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse"
|
|
6378
|
+
},
|
|
6379
|
+
"scopes": [
|
|
6380
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
6381
|
+
]
|
|
6288
6382
|
}
|
|
6289
6383
|
}
|
|
6290
6384
|
},
|
|
@@ -6352,6 +6446,11 @@
|
|
|
6352
6446
|
"name"
|
|
6353
6447
|
],
|
|
6354
6448
|
"parameters": {
|
|
6449
|
+
"includeAnswerDetails": {
|
|
6450
|
+
"description": "Optional. If set to true, the full session including all answer details will be returned.",
|
|
6451
|
+
"location": "query",
|
|
6452
|
+
"type": "boolean"
|
|
6453
|
+
},
|
|
6355
6454
|
"name": {
|
|
6356
6455
|
"description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
6357
6456
|
"location": "path",
|
|
@@ -6383,7 +6482,7 @@
|
|
|
6383
6482
|
"type": "string"
|
|
6384
6483
|
},
|
|
6385
6484
|
"orderBy": {
|
|
6386
|
-
"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: \"update_time desc\" \"create_time\"",
|
|
6485
|
+
"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * \"update_time desc\" * \"create_time\" * \"is_pinned desc,update_time desc\": list sessions by is_pinned first, then by update_time.",
|
|
6387
6486
|
"location": "query",
|
|
6388
6487
|
"type": "string"
|
|
6389
6488
|
},
|
|
@@ -6911,7 +7010,7 @@
|
|
|
6911
7010
|
"type": "string"
|
|
6912
7011
|
},
|
|
6913
7012
|
"parent": {
|
|
6914
|
-
"description": "Required. The parent
|
|
7013
|
+
"description": "Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.",
|
|
6915
7014
|
"location": "path",
|
|
6916
7015
|
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
6917
7016
|
"required": true,
|
|
@@ -7820,7 +7919,7 @@
|
|
|
7820
7919
|
"type": "string"
|
|
7821
7920
|
},
|
|
7822
7921
|
"parent": {
|
|
7823
|
-
"description": "Required. The parent
|
|
7922
|
+
"description": "Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.",
|
|
7824
7923
|
"location": "path",
|
|
7825
7924
|
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
7826
7925
|
"required": true,
|
|
@@ -8057,7 +8156,7 @@
|
|
|
8057
8156
|
}
|
|
8058
8157
|
}
|
|
8059
8158
|
},
|
|
8060
|
-
"revision": "
|
|
8159
|
+
"revision": "20241210",
|
|
8061
8160
|
"rootUrl": "https://discoveryengine.googleapis.com/",
|
|
8062
8161
|
"schemas": {
|
|
8063
8162
|
"GoogleApiDistribution": {
|
|
@@ -8614,6 +8713,10 @@
|
|
|
8614
8713
|
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
|
|
8615
8714
|
"type": "string"
|
|
8616
8715
|
},
|
|
8716
|
+
"promoteAction": {
|
|
8717
|
+
"$ref": "GoogleCloudDiscoveryengineV1ControlPromoteAction",
|
|
8718
|
+
"description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
|
|
8719
|
+
},
|
|
8617
8720
|
"redirectAction": {
|
|
8618
8721
|
"$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction",
|
|
8619
8722
|
"description": "Defines a redirect-type control."
|
|
@@ -8695,6 +8798,21 @@
|
|
|
8695
8798
|
},
|
|
8696
8799
|
"type": "object"
|
|
8697
8800
|
},
|
|
8801
|
+
"GoogleCloudDiscoveryengineV1ControlPromoteAction": {
|
|
8802
|
+
"description": "Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store.",
|
|
8803
|
+
"id": "GoogleCloudDiscoveryengineV1ControlPromoteAction",
|
|
8804
|
+
"properties": {
|
|
8805
|
+
"dataStore": {
|
|
8806
|
+
"description": "Required. Data store with which this promotion is attached to.",
|
|
8807
|
+
"type": "string"
|
|
8808
|
+
},
|
|
8809
|
+
"searchLinkPromotion": {
|
|
8810
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchLinkPromotion",
|
|
8811
|
+
"description": "Required. Promotion attached to this action."
|
|
8812
|
+
}
|
|
8813
|
+
},
|
|
8814
|
+
"type": "object"
|
|
8815
|
+
},
|
|
8698
8816
|
"GoogleCloudDiscoveryengineV1ControlRedirectAction": {
|
|
8699
8817
|
"description": "Redirects a shopper to the provided URI.",
|
|
8700
8818
|
"id": "GoogleCloudDiscoveryengineV1ControlRedirectAction",
|
|
@@ -9207,7 +9325,7 @@
|
|
|
9207
9325
|
"type": "string"
|
|
9208
9326
|
},
|
|
9209
9327
|
"industryVertical": {
|
|
9210
|
-
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore:
|
|
9328
|
+
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.",
|
|
9211
9329
|
"enum": [
|
|
9212
9330
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
9213
9331
|
"GENERIC",
|
|
@@ -9779,6 +9897,380 @@
|
|
|
9779
9897
|
},
|
|
9780
9898
|
"type": "object"
|
|
9781
9899
|
},
|
|
9900
|
+
"GoogleCloudDiscoveryengineV1SearchLinkPromotion": {
|
|
9901
|
+
"description": "Promotion proto includes uri and other helping information to display the promotion.",
|
|
9902
|
+
"id": "GoogleCloudDiscoveryengineV1SearchLinkPromotion",
|
|
9903
|
+
"properties": {
|
|
9904
|
+
"description": {
|
|
9905
|
+
"description": "Optional. The Promotion description. Maximum length: 200 characters.",
|
|
9906
|
+
"type": "string"
|
|
9907
|
+
},
|
|
9908
|
+
"enabled": {
|
|
9909
|
+
"description": "Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.",
|
|
9910
|
+
"type": "boolean"
|
|
9911
|
+
},
|
|
9912
|
+
"imageUri": {
|
|
9913
|
+
"description": "Optional. The promotion thumbnail image url.",
|
|
9914
|
+
"type": "string"
|
|
9915
|
+
},
|
|
9916
|
+
"title": {
|
|
9917
|
+
"description": "Required. The title of the promotion. Maximum length: 160 characters.",
|
|
9918
|
+
"type": "string"
|
|
9919
|
+
},
|
|
9920
|
+
"uri": {
|
|
9921
|
+
"description": "Required. The URL for the page the user wants to promote.",
|
|
9922
|
+
"type": "string"
|
|
9923
|
+
}
|
|
9924
|
+
},
|
|
9925
|
+
"type": "object"
|
|
9926
|
+
},
|
|
9927
|
+
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec": {
|
|
9928
|
+
"description": "A specification for configuring the behavior of content search.",
|
|
9929
|
+
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec",
|
|
9930
|
+
"properties": {
|
|
9931
|
+
"chunkSpec": {
|
|
9932
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec",
|
|
9933
|
+
"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS"
|
|
9934
|
+
},
|
|
9935
|
+
"extractiveContentSpec": {
|
|
9936
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec",
|
|
9937
|
+
"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response."
|
|
9938
|
+
},
|
|
9939
|
+
"searchResultMode": {
|
|
9940
|
+
"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.",
|
|
9941
|
+
"enum": [
|
|
9942
|
+
"SEARCH_RESULT_MODE_UNSPECIFIED",
|
|
9943
|
+
"DOCUMENTS",
|
|
9944
|
+
"CHUNKS"
|
|
9945
|
+
],
|
|
9946
|
+
"enumDescriptions": [
|
|
9947
|
+
"Default value.",
|
|
9948
|
+
"Returns documents in the search result.",
|
|
9949
|
+
"Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
|
|
9950
|
+
],
|
|
9951
|
+
"type": "string"
|
|
9952
|
+
},
|
|
9953
|
+
"snippetSpec": {
|
|
9954
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec",
|
|
9955
|
+
"description": "If `snippetSpec` is not specified, snippets are not included in the search response."
|
|
9956
|
+
},
|
|
9957
|
+
"summarySpec": {
|
|
9958
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec",
|
|
9959
|
+
"description": "If `summarySpec` is not specified, summaries are not included in the search response."
|
|
9960
|
+
}
|
|
9961
|
+
},
|
|
9962
|
+
"type": "object"
|
|
9963
|
+
},
|
|
9964
|
+
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec": {
|
|
9965
|
+
"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS",
|
|
9966
|
+
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec",
|
|
9967
|
+
"properties": {
|
|
9968
|
+
"numNextChunks": {
|
|
9969
|
+
"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.",
|
|
9970
|
+
"format": "int32",
|
|
9971
|
+
"type": "integer"
|
|
9972
|
+
},
|
|
9973
|
+
"numPreviousChunks": {
|
|
9974
|
+
"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.",
|
|
9975
|
+
"format": "int32",
|
|
9976
|
+
"type": "integer"
|
|
9977
|
+
}
|
|
9978
|
+
},
|
|
9979
|
+
"type": "object"
|
|
9980
|
+
},
|
|
9981
|
+
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec": {
|
|
9982
|
+
"description": "A specification for configuring the extractive content in a search response.",
|
|
9983
|
+
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec",
|
|
9984
|
+
"properties": {
|
|
9985
|
+
"maxExtractiveAnswerCount": {
|
|
9986
|
+
"description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.",
|
|
9987
|
+
"format": "int32",
|
|
9988
|
+
"type": "integer"
|
|
9989
|
+
},
|
|
9990
|
+
"maxExtractiveSegmentCount": {
|
|
9991
|
+
"description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.",
|
|
9992
|
+
"format": "int32",
|
|
9993
|
+
"type": "integer"
|
|
9994
|
+
},
|
|
9995
|
+
"numNextSegments": {
|
|
9996
|
+
"description": "Return at most `num_next_segments` segments after each selected segments.",
|
|
9997
|
+
"format": "int32",
|
|
9998
|
+
"type": "integer"
|
|
9999
|
+
},
|
|
10000
|
+
"numPreviousSegments": {
|
|
10001
|
+
"description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.",
|
|
10002
|
+
"format": "int32",
|
|
10003
|
+
"type": "integer"
|
|
10004
|
+
},
|
|
10005
|
+
"returnExtractiveSegmentScore": {
|
|
10006
|
+
"description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.",
|
|
10007
|
+
"type": "boolean"
|
|
10008
|
+
}
|
|
10009
|
+
},
|
|
10010
|
+
"type": "object"
|
|
10011
|
+
},
|
|
10012
|
+
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec": {
|
|
10013
|
+
"description": "A specification for configuring snippets in a search response.",
|
|
10014
|
+
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec",
|
|
10015
|
+
"properties": {
|
|
10016
|
+
"maxSnippetCount": {
|
|
10017
|
+
"deprecated": true,
|
|
10018
|
+
"description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.",
|
|
10019
|
+
"format": "int32",
|
|
10020
|
+
"type": "integer"
|
|
10021
|
+
},
|
|
10022
|
+
"referenceOnly": {
|
|
10023
|
+
"deprecated": true,
|
|
10024
|
+
"description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.",
|
|
10025
|
+
"type": "boolean"
|
|
10026
|
+
},
|
|
10027
|
+
"returnSnippet": {
|
|
10028
|
+
"description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.",
|
|
10029
|
+
"type": "boolean"
|
|
10030
|
+
}
|
|
10031
|
+
},
|
|
10032
|
+
"type": "object"
|
|
10033
|
+
},
|
|
10034
|
+
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec": {
|
|
10035
|
+
"description": "A specification for configuring a summary returned in a search response.",
|
|
10036
|
+
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec",
|
|
10037
|
+
"properties": {
|
|
10038
|
+
"ignoreAdversarialQuery": {
|
|
10039
|
+
"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.",
|
|
10040
|
+
"type": "boolean"
|
|
10041
|
+
},
|
|
10042
|
+
"ignoreJailBreakingQuery": {
|
|
10043
|
+
"description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.",
|
|
10044
|
+
"type": "boolean"
|
|
10045
|
+
},
|
|
10046
|
+
"ignoreLowRelevantContent": {
|
|
10047
|
+
"description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.",
|
|
10048
|
+
"type": "boolean"
|
|
10049
|
+
},
|
|
10050
|
+
"ignoreNonSummarySeekingQuery": {
|
|
10051
|
+
"description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.",
|
|
10052
|
+
"type": "boolean"
|
|
10053
|
+
},
|
|
10054
|
+
"includeCitations": {
|
|
10055
|
+
"description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.",
|
|
10056
|
+
"type": "boolean"
|
|
10057
|
+
},
|
|
10058
|
+
"languageCode": {
|
|
10059
|
+
"description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.",
|
|
10060
|
+
"type": "string"
|
|
10061
|
+
},
|
|
10062
|
+
"modelPromptSpec": {
|
|
10063
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec",
|
|
10064
|
+
"description": "If specified, the spec will be used to modify the prompt provided to the LLM."
|
|
10065
|
+
},
|
|
10066
|
+
"modelSpec": {
|
|
10067
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec",
|
|
10068
|
+
"description": "If specified, the spec will be used to modify the model specification provided to the LLM."
|
|
10069
|
+
},
|
|
10070
|
+
"summaryResultCount": {
|
|
10071
|
+
"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.",
|
|
10072
|
+
"format": "int32",
|
|
10073
|
+
"type": "integer"
|
|
10074
|
+
},
|
|
10075
|
+
"useSemanticChunks": {
|
|
10076
|
+
"description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.",
|
|
10077
|
+
"type": "boolean"
|
|
10078
|
+
}
|
|
10079
|
+
},
|
|
10080
|
+
"type": "object"
|
|
10081
|
+
},
|
|
10082
|
+
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec": {
|
|
10083
|
+
"description": "Specification of the prompt to use with the model.",
|
|
10084
|
+
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec",
|
|
10085
|
+
"properties": {
|
|
10086
|
+
"preamble": {
|
|
10087
|
+
"description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.",
|
|
10088
|
+
"type": "string"
|
|
10089
|
+
}
|
|
10090
|
+
},
|
|
10091
|
+
"type": "object"
|
|
10092
|
+
},
|
|
10093
|
+
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec": {
|
|
10094
|
+
"description": "Specification of the model.",
|
|
10095
|
+
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec",
|
|
10096
|
+
"properties": {
|
|
10097
|
+
"version": {
|
|
10098
|
+
"description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).",
|
|
10099
|
+
"type": "string"
|
|
10100
|
+
}
|
|
10101
|
+
},
|
|
10102
|
+
"type": "object"
|
|
10103
|
+
},
|
|
10104
|
+
"GoogleCloudDiscoveryengineV1ServingConfig": {
|
|
10105
|
+
"description": "Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.",
|
|
10106
|
+
"id": "GoogleCloudDiscoveryengineV1ServingConfig",
|
|
10107
|
+
"properties": {
|
|
10108
|
+
"boostControlIds": {
|
|
10109
|
+
"description": "Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.",
|
|
10110
|
+
"items": {
|
|
10111
|
+
"type": "string"
|
|
10112
|
+
},
|
|
10113
|
+
"type": "array"
|
|
10114
|
+
},
|
|
10115
|
+
"createTime": {
|
|
10116
|
+
"description": "Output only. ServingConfig created timestamp.",
|
|
10117
|
+
"format": "google-datetime",
|
|
10118
|
+
"readOnly": true,
|
|
10119
|
+
"type": "string"
|
|
10120
|
+
},
|
|
10121
|
+
"displayName": {
|
|
10122
|
+
"description": "Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
|
|
10123
|
+
"type": "string"
|
|
10124
|
+
},
|
|
10125
|
+
"dissociateControlIds": {
|
|
10126
|
+
"description": "Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
|
|
10127
|
+
"items": {
|
|
10128
|
+
"type": "string"
|
|
10129
|
+
},
|
|
10130
|
+
"type": "array"
|
|
10131
|
+
},
|
|
10132
|
+
"diversityLevel": {
|
|
10133
|
+
"description": "How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
|
|
10134
|
+
"type": "string"
|
|
10135
|
+
},
|
|
10136
|
+
"filterControlIds": {
|
|
10137
|
+
"description": "Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.",
|
|
10138
|
+
"items": {
|
|
10139
|
+
"type": "string"
|
|
10140
|
+
},
|
|
10141
|
+
"type": "array"
|
|
10142
|
+
},
|
|
10143
|
+
"genericConfig": {
|
|
10144
|
+
"$ref": "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig",
|
|
10145
|
+
"description": "The GenericConfig of the serving configuration."
|
|
10146
|
+
},
|
|
10147
|
+
"ignoreControlIds": {
|
|
10148
|
+
"description": "Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.",
|
|
10149
|
+
"items": {
|
|
10150
|
+
"type": "string"
|
|
10151
|
+
},
|
|
10152
|
+
"type": "array"
|
|
10153
|
+
},
|
|
10154
|
+
"mediaConfig": {
|
|
10155
|
+
"$ref": "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig",
|
|
10156
|
+
"description": "The MediaConfig of the serving configuration."
|
|
10157
|
+
},
|
|
10158
|
+
"modelId": {
|
|
10159
|
+
"description": "The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
|
|
10160
|
+
"type": "string"
|
|
10161
|
+
},
|
|
10162
|
+
"name": {
|
|
10163
|
+
"description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`",
|
|
10164
|
+
"type": "string"
|
|
10165
|
+
},
|
|
10166
|
+
"onewaySynonymsControlIds": {
|
|
10167
|
+
"description": "Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
|
|
10168
|
+
"items": {
|
|
10169
|
+
"type": "string"
|
|
10170
|
+
},
|
|
10171
|
+
"type": "array"
|
|
10172
|
+
},
|
|
10173
|
+
"promoteControlIds": {
|
|
10174
|
+
"description": "Condition promote specifications. Maximum number of specifications is 100.",
|
|
10175
|
+
"items": {
|
|
10176
|
+
"type": "string"
|
|
10177
|
+
},
|
|
10178
|
+
"type": "array"
|
|
10179
|
+
},
|
|
10180
|
+
"rankingExpression": {
|
|
10181
|
+
"description": "The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the 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)`.",
|
|
10182
|
+
"type": "string"
|
|
10183
|
+
},
|
|
10184
|
+
"redirectControlIds": {
|
|
10185
|
+
"description": "IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
|
|
10186
|
+
"items": {
|
|
10187
|
+
"type": "string"
|
|
10188
|
+
},
|
|
10189
|
+
"type": "array"
|
|
10190
|
+
},
|
|
10191
|
+
"replacementControlIds": {
|
|
10192
|
+
"description": "Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
|
|
10193
|
+
"items": {
|
|
10194
|
+
"type": "string"
|
|
10195
|
+
},
|
|
10196
|
+
"type": "array"
|
|
10197
|
+
},
|
|
10198
|
+
"solutionType": {
|
|
10199
|
+
"description": "Required. Immutable. Specifies the solution type that a serving config can be associated with.",
|
|
10200
|
+
"enum": [
|
|
10201
|
+
"SOLUTION_TYPE_UNSPECIFIED",
|
|
10202
|
+
"SOLUTION_TYPE_RECOMMENDATION",
|
|
10203
|
+
"SOLUTION_TYPE_SEARCH",
|
|
10204
|
+
"SOLUTION_TYPE_CHAT",
|
|
10205
|
+
"SOLUTION_TYPE_GENERATIVE_CHAT"
|
|
10206
|
+
],
|
|
10207
|
+
"enumDescriptions": [
|
|
10208
|
+
"Default value.",
|
|
10209
|
+
"Used for Recommendations AI.",
|
|
10210
|
+
"Used for Discovery Search.",
|
|
10211
|
+
"Used for use cases related to the Generative AI agent.",
|
|
10212
|
+
"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
|
|
10213
|
+
],
|
|
10214
|
+
"type": "string"
|
|
10215
|
+
},
|
|
10216
|
+
"synonymsControlIds": {
|
|
10217
|
+
"description": "Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.",
|
|
10218
|
+
"items": {
|
|
10219
|
+
"type": "string"
|
|
10220
|
+
},
|
|
10221
|
+
"type": "array"
|
|
10222
|
+
},
|
|
10223
|
+
"updateTime": {
|
|
10224
|
+
"description": "Output only. ServingConfig updated timestamp.",
|
|
10225
|
+
"format": "google-datetime",
|
|
10226
|
+
"readOnly": true,
|
|
10227
|
+
"type": "string"
|
|
10228
|
+
}
|
|
10229
|
+
},
|
|
10230
|
+
"type": "object"
|
|
10231
|
+
},
|
|
10232
|
+
"GoogleCloudDiscoveryengineV1ServingConfigGenericConfig": {
|
|
10233
|
+
"description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.",
|
|
10234
|
+
"id": "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig",
|
|
10235
|
+
"properties": {
|
|
10236
|
+
"contentSearchSpec": {
|
|
10237
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec",
|
|
10238
|
+
"description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store."
|
|
10239
|
+
}
|
|
10240
|
+
},
|
|
10241
|
+
"type": "object"
|
|
10242
|
+
},
|
|
10243
|
+
"GoogleCloudDiscoveryengineV1ServingConfigMediaConfig": {
|
|
10244
|
+
"description": "Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
|
|
10245
|
+
"id": "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig",
|
|
10246
|
+
"properties": {
|
|
10247
|
+
"contentFreshnessCutoffDays": {
|
|
10248
|
+
"description": "Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.",
|
|
10249
|
+
"format": "int32",
|
|
10250
|
+
"type": "integer"
|
|
10251
|
+
},
|
|
10252
|
+
"contentWatchedPercentageThreshold": {
|
|
10253
|
+
"description": "Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.",
|
|
10254
|
+
"format": "float",
|
|
10255
|
+
"type": "number"
|
|
10256
|
+
},
|
|
10257
|
+
"contentWatchedSecondsThreshold": {
|
|
10258
|
+
"description": "Specifies the content watched minutes threshold for demotion.",
|
|
10259
|
+
"format": "float",
|
|
10260
|
+
"type": "number"
|
|
10261
|
+
},
|
|
10262
|
+
"demoteContentWatchedPastDays": {
|
|
10263
|
+
"description": "Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days.",
|
|
10264
|
+
"format": "int32",
|
|
10265
|
+
"type": "integer"
|
|
10266
|
+
},
|
|
10267
|
+
"demotionEventType": {
|
|
10268
|
+
"description": "Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.",
|
|
10269
|
+
"type": "string"
|
|
10270
|
+
}
|
|
10271
|
+
},
|
|
10272
|
+
"type": "object"
|
|
10273
|
+
},
|
|
9782
10274
|
"GoogleCloudDiscoveryengineV1SiteVerificationInfo": {
|
|
9783
10275
|
"description": "Verification information for target sites in advanced site search.",
|
|
9784
10276
|
"id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo",
|
|
@@ -10403,6 +10895,18 @@
|
|
|
10403
10895
|
"readOnly": true,
|
|
10404
10896
|
"type": "string"
|
|
10405
10897
|
},
|
|
10898
|
+
"groundingScore": {
|
|
10899
|
+
"description": "A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.",
|
|
10900
|
+
"format": "double",
|
|
10901
|
+
"type": "number"
|
|
10902
|
+
},
|
|
10903
|
+
"groundingSupports": {
|
|
10904
|
+
"description": "Optional. Grounding supports.",
|
|
10905
|
+
"items": {
|
|
10906
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport"
|
|
10907
|
+
},
|
|
10908
|
+
"type": "array"
|
|
10909
|
+
},
|
|
10406
10910
|
"name": {
|
|
10407
10911
|
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`",
|
|
10408
10912
|
"type": "string"
|
|
@@ -10431,13 +10935,15 @@
|
|
|
10431
10935
|
"STATE_UNSPECIFIED",
|
|
10432
10936
|
"IN_PROGRESS",
|
|
10433
10937
|
"FAILED",
|
|
10434
|
-
"SUCCEEDED"
|
|
10938
|
+
"SUCCEEDED",
|
|
10939
|
+
"STREAMING"
|
|
10435
10940
|
],
|
|
10436
10941
|
"enumDescriptions": [
|
|
10437
10942
|
"Unknown.",
|
|
10438
10943
|
"Answer generation is currently in progress.",
|
|
10439
10944
|
"Answer generation currently failed.",
|
|
10440
|
-
"Answer generation has succeeded."
|
|
10945
|
+
"Answer generation has succeeded.",
|
|
10946
|
+
"Answer generation is currently in progress."
|
|
10441
10947
|
],
|
|
10442
10948
|
"type": "string"
|
|
10443
10949
|
},
|
|
@@ -10486,6 +10992,39 @@
|
|
|
10486
10992
|
},
|
|
10487
10993
|
"type": "object"
|
|
10488
10994
|
},
|
|
10995
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport": {
|
|
10996
|
+
"description": "Grounding support for a claim in `answer_text`.",
|
|
10997
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport",
|
|
10998
|
+
"properties": {
|
|
10999
|
+
"endIndex": {
|
|
11000
|
+
"description": "Required. End of the claim, exclusive.",
|
|
11001
|
+
"format": "int64",
|
|
11002
|
+
"type": "string"
|
|
11003
|
+
},
|
|
11004
|
+
"groundingCheckRequired": {
|
|
11005
|
+
"description": "Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore `grounding_score`, `sources` is not returned.",
|
|
11006
|
+
"type": "boolean"
|
|
11007
|
+
},
|
|
11008
|
+
"groundingScore": {
|
|
11009
|
+
"description": "A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks.",
|
|
11010
|
+
"format": "double",
|
|
11011
|
+
"type": "number"
|
|
11012
|
+
},
|
|
11013
|
+
"sources": {
|
|
11014
|
+
"description": "Optional. Citation sources for the claim.",
|
|
11015
|
+
"items": {
|
|
11016
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource"
|
|
11017
|
+
},
|
|
11018
|
+
"type": "array"
|
|
11019
|
+
},
|
|
11020
|
+
"startIndex": {
|
|
11021
|
+
"description": "Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).",
|
|
11022
|
+
"format": "int64",
|
|
11023
|
+
"type": "string"
|
|
11024
|
+
}
|
|
11025
|
+
},
|
|
11026
|
+
"type": "object"
|
|
11027
|
+
},
|
|
10489
11028
|
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest": {
|
|
10490
11029
|
"description": "Request message for ConversationalSearchService.AnswerQuery method.",
|
|
10491
11030
|
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest",
|
|
@@ -10682,6 +11221,31 @@
|
|
|
10682
11221
|
"description": "Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.",
|
|
10683
11222
|
"format": "int32",
|
|
10684
11223
|
"type": "integer"
|
|
11224
|
+
},
|
|
11225
|
+
"modelSpec": {
|
|
11226
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec",
|
|
11227
|
+
"description": "Optional. Query Rephraser Model specification."
|
|
11228
|
+
}
|
|
11229
|
+
},
|
|
11230
|
+
"type": "object"
|
|
11231
|
+
},
|
|
11232
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec": {
|
|
11233
|
+
"description": "Query Rephraser Model specification.",
|
|
11234
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec",
|
|
11235
|
+
"properties": {
|
|
11236
|
+
"modelType": {
|
|
11237
|
+
"description": "Optional. Enabled query rephraser model type. If not set, it will use LARGE by default.",
|
|
11238
|
+
"enum": [
|
|
11239
|
+
"MODEL_TYPE_UNSPECIFIED",
|
|
11240
|
+
"SMALL",
|
|
11241
|
+
"LARGE"
|
|
11242
|
+
],
|
|
11243
|
+
"enumDescriptions": [
|
|
11244
|
+
"Unspecified model type.",
|
|
11245
|
+
"Small query rephraser model. Gemini 1.0 XS model.",
|
|
11246
|
+
"Large query rephraser model. Gemini 1.0 Pro model."
|
|
11247
|
+
],
|
|
11248
|
+
"type": "string"
|
|
10685
11249
|
}
|
|
10686
11250
|
},
|
|
10687
11251
|
"type": "object"
|
|
@@ -10698,7 +11262,7 @@
|
|
|
10698
11262
|
"type": "object"
|
|
10699
11263
|
},
|
|
10700
11264
|
"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec": {
|
|
10701
|
-
"description": "Safety specification.",
|
|
11265
|
+
"description": "Safety specification. There are two use cases: 1. when only safety_spec.enable is set, the BLOCK_LOW_AND_ABOVE threshold will be applied for all categories. 2. when safety_spec.enable is set and some safety_settings are set, only specified safety_settings are applied.",
|
|
10702
11266
|
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec",
|
|
10703
11267
|
"properties": {
|
|
10704
11268
|
"enable": {
|
|
@@ -11712,7 +12276,7 @@
|
|
|
11712
12276
|
"type": "string"
|
|
11713
12277
|
},
|
|
11714
12278
|
"resources": {
|
|
11715
|
-
"description": "The type needed for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * The labels needed for this resource: * `
|
|
12279
|
+
"description": "The resources to be checked for this requirement. The type needed for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * The labels needed for this resource: * `project_number` * `location_id` * `collection_id` * `datastore_id` * `branch_id` * `discoveryengine.googleapis.com/DataStore` * The labels needed for this resource: * `project_number` * `location_id` * `collection_id` * `datastore_id`",
|
|
11716
12280
|
"items": {
|
|
11717
12281
|
"$ref": "GoogleApiMonitoredResource"
|
|
11718
12282
|
},
|
|
@@ -11733,7 +12297,7 @@
|
|
|
11733
12297
|
"type": "array"
|
|
11734
12298
|
},
|
|
11735
12299
|
"oldestMetricTimestamp": {
|
|
11736
|
-
"description": "Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the `
|
|
12300
|
+
"description": "Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the `result` may not accurately reflect any Event and Product Catalog updates performed after this time.",
|
|
11737
12301
|
"format": "google-datetime",
|
|
11738
12302
|
"type": "string"
|
|
11739
12303
|
},
|
|
@@ -12157,6 +12721,10 @@
|
|
|
12157
12721
|
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
|
|
12158
12722
|
"type": "string"
|
|
12159
12723
|
},
|
|
12724
|
+
"promoteAction": {
|
|
12725
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction",
|
|
12726
|
+
"description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
|
|
12727
|
+
},
|
|
12160
12728
|
"redirectAction": {
|
|
12161
12729
|
"$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction",
|
|
12162
12730
|
"description": "Defines a redirect-type control."
|
|
@@ -12238,6 +12806,21 @@
|
|
|
12238
12806
|
},
|
|
12239
12807
|
"type": "object"
|
|
12240
12808
|
},
|
|
12809
|
+
"GoogleCloudDiscoveryengineV1alphaControlPromoteAction": {
|
|
12810
|
+
"description": "Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store.",
|
|
12811
|
+
"id": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction",
|
|
12812
|
+
"properties": {
|
|
12813
|
+
"dataStore": {
|
|
12814
|
+
"description": "Required. Data store with which this promotion is attached to.",
|
|
12815
|
+
"type": "string"
|
|
12816
|
+
},
|
|
12817
|
+
"searchLinkPromotion": {
|
|
12818
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion",
|
|
12819
|
+
"description": "Required. Promotion attached to this action."
|
|
12820
|
+
}
|
|
12821
|
+
},
|
|
12822
|
+
"type": "object"
|
|
12823
|
+
},
|
|
12241
12824
|
"GoogleCloudDiscoveryengineV1alphaControlRedirectAction": {
|
|
12242
12825
|
"description": "Redirects a shopper to the provided URI.",
|
|
12243
12826
|
"id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction",
|
|
@@ -12884,6 +13467,17 @@
|
|
|
12884
13467
|
},
|
|
12885
13468
|
"type": "object"
|
|
12886
13469
|
},
|
|
13470
|
+
"GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest": {
|
|
13471
|
+
"description": "Request for DeleteSession method.",
|
|
13472
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest",
|
|
13473
|
+
"properties": {
|
|
13474
|
+
"name": {
|
|
13475
|
+
"description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
13476
|
+
"type": "string"
|
|
13477
|
+
}
|
|
13478
|
+
},
|
|
13479
|
+
"type": "object"
|
|
13480
|
+
},
|
|
12887
13481
|
"GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata": {
|
|
12888
13482
|
"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
12889
13483
|
"id": "GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata",
|
|
@@ -13319,7 +13913,7 @@
|
|
|
13319
13913
|
"type": "string"
|
|
13320
13914
|
},
|
|
13321
13915
|
"industryVertical": {
|
|
13322
|
-
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore:
|
|
13916
|
+
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.",
|
|
13323
13917
|
"enum": [
|
|
13324
13918
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
13325
13919
|
"GENERIC",
|
|
@@ -13858,6 +14452,10 @@
|
|
|
13858
14452
|
"type": "string"
|
|
13859
14453
|
},
|
|
13860
14454
|
"type": "array"
|
|
14455
|
+
},
|
|
14456
|
+
"updateFromLatestPredefinedSchema": {
|
|
14457
|
+
"description": "Optional. Whether to update the DataStore schema to the latest predefined schema. If true, the DataStore schema will be updated to include any FHIR fields or resource types that have been added since the last import and corresponding FHIR resources will be imported from the FHIR store. Note this field cannot be used in conjunction with `resource_types`. It should be used after initial import.",
|
|
14458
|
+
"type": "boolean"
|
|
13861
14459
|
}
|
|
13862
14460
|
},
|
|
13863
14461
|
"type": "object"
|
|
@@ -14060,6 +14658,21 @@
|
|
|
14060
14658
|
},
|
|
14061
14659
|
"type": "object"
|
|
14062
14660
|
},
|
|
14661
|
+
"GoogleCloudDiscoveryengineV1alphaGetSessionRequest": {
|
|
14662
|
+
"description": "Request for GetSession method.",
|
|
14663
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGetSessionRequest",
|
|
14664
|
+
"properties": {
|
|
14665
|
+
"includeAnswerDetails": {
|
|
14666
|
+
"description": "Optional. If set to true, the full session including all answer details will be returned.",
|
|
14667
|
+
"type": "boolean"
|
|
14668
|
+
},
|
|
14669
|
+
"name": {
|
|
14670
|
+
"description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
14671
|
+
"type": "string"
|
|
14672
|
+
}
|
|
14673
|
+
},
|
|
14674
|
+
"type": "object"
|
|
14675
|
+
},
|
|
14063
14676
|
"GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": {
|
|
14064
14677
|
"description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.",
|
|
14065
14678
|
"id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse",
|
|
@@ -14946,6 +15559,34 @@
|
|
|
14946
15559
|
},
|
|
14947
15560
|
"type": "object"
|
|
14948
15561
|
},
|
|
15562
|
+
"GoogleCloudDiscoveryengineV1alphaListSessionsRequest": {
|
|
15563
|
+
"description": "Request for ListSessions method.",
|
|
15564
|
+
"id": "GoogleCloudDiscoveryengineV1alphaListSessionsRequest",
|
|
15565
|
+
"properties": {
|
|
15566
|
+
"filter": {
|
|
15567
|
+
"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
|
|
15568
|
+
"type": "string"
|
|
15569
|
+
},
|
|
15570
|
+
"orderBy": {
|
|
15571
|
+
"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * \"update_time desc\" * \"create_time\" * \"is_pinned desc,update_time desc\": list sessions by is_pinned first, then by update_time.",
|
|
15572
|
+
"type": "string"
|
|
15573
|
+
},
|
|
15574
|
+
"pageSize": {
|
|
15575
|
+
"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
|
|
15576
|
+
"format": "int32",
|
|
15577
|
+
"type": "integer"
|
|
15578
|
+
},
|
|
15579
|
+
"pageToken": {
|
|
15580
|
+
"description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.",
|
|
15581
|
+
"type": "string"
|
|
15582
|
+
},
|
|
15583
|
+
"parent": {
|
|
15584
|
+
"description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`",
|
|
15585
|
+
"type": "string"
|
|
15586
|
+
}
|
|
15587
|
+
},
|
|
15588
|
+
"type": "object"
|
|
15589
|
+
},
|
|
14949
15590
|
"GoogleCloudDiscoveryengineV1alphaListSessionsResponse": {
|
|
14950
15591
|
"description": "Response for ListSessions method.",
|
|
14951
15592
|
"id": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse",
|
|
@@ -15477,7 +16118,7 @@
|
|
|
15477
16118
|
"id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest",
|
|
15478
16119
|
"properties": {
|
|
15479
16120
|
"filter": {
|
|
15480
|
-
"description": "Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType: `eventType = \"search\"` * Deleting all events for a specific visitor: `userPseudoId = \"visitor1024\"` * Deleting
|
|
16121
|
+
"description": "Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Note: This API only supports purging a max range of 30 days. Examples: * Deleting all events in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\" eventType = \"search\"` * Deleting all events for a specific visitor in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\" userPseudoId = \"visitor1024\"` * Deleting the past 30 days of events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.",
|
|
15481
16122
|
"type": "string"
|
|
15482
16123
|
},
|
|
15483
16124
|
"force": {
|
|
@@ -15649,7 +16290,7 @@
|
|
|
15649
16290
|
"id": "GoogleCloudDiscoveryengineV1alphaRecommendRequest",
|
|
15650
16291
|
"properties": {
|
|
15651
16292
|
"filter": {
|
|
15652
|
-
"description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (
|
|
16293
|
+
"description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (language: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (language: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.",
|
|
15653
16294
|
"type": "string"
|
|
15654
16295
|
},
|
|
15655
16296
|
"pageSize": {
|
|
@@ -16233,6 +16874,33 @@
|
|
|
16233
16874
|
},
|
|
16234
16875
|
"type": "object"
|
|
16235
16876
|
},
|
|
16877
|
+
"GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion": {
|
|
16878
|
+
"description": "Promotion proto includes uri and other helping information to display the promotion.",
|
|
16879
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion",
|
|
16880
|
+
"properties": {
|
|
16881
|
+
"description": {
|
|
16882
|
+
"description": "Optional. The Promotion description. Maximum length: 200 characters.",
|
|
16883
|
+
"type": "string"
|
|
16884
|
+
},
|
|
16885
|
+
"enabled": {
|
|
16886
|
+
"description": "Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.",
|
|
16887
|
+
"type": "boolean"
|
|
16888
|
+
},
|
|
16889
|
+
"imageUri": {
|
|
16890
|
+
"description": "Optional. The promotion thumbnail image url.",
|
|
16891
|
+
"type": "string"
|
|
16892
|
+
},
|
|
16893
|
+
"title": {
|
|
16894
|
+
"description": "Required. The title of the promotion. Maximum length: 160 characters.",
|
|
16895
|
+
"type": "string"
|
|
16896
|
+
},
|
|
16897
|
+
"uri": {
|
|
16898
|
+
"description": "Required. The URL for the page the user wants to promote.",
|
|
16899
|
+
"type": "string"
|
|
16900
|
+
}
|
|
16901
|
+
},
|
|
16902
|
+
"type": "object"
|
|
16903
|
+
},
|
|
16236
16904
|
"GoogleCloudDiscoveryengineV1alphaSearchRequest": {
|
|
16237
16905
|
"description": "Request message for SearchService.Search method.",
|
|
16238
16906
|
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequest",
|
|
@@ -16258,7 +16926,7 @@
|
|
|
16258
16926
|
"description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec."
|
|
16259
16927
|
},
|
|
16260
16928
|
"dataStoreSpecs": {
|
|
16261
|
-
"description": "Specs defining
|
|
16929
|
+
"description": "Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.",
|
|
16262
16930
|
"items": {
|
|
16263
16931
|
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec"
|
|
16264
16932
|
},
|
|
@@ -16676,6 +17344,10 @@
|
|
|
16676
17344
|
"description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.",
|
|
16677
17345
|
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec",
|
|
16678
17346
|
"properties": {
|
|
17347
|
+
"boostSpec": {
|
|
17348
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec",
|
|
17349
|
+
"description": "Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)"
|
|
17350
|
+
},
|
|
16679
17351
|
"dataStore": {
|
|
16680
17352
|
"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
|
|
16681
17353
|
"type": "string"
|
|
@@ -17003,6 +17675,13 @@
|
|
|
17003
17675
|
},
|
|
17004
17676
|
"type": "array"
|
|
17005
17677
|
},
|
|
17678
|
+
"searchLinkPromotions": {
|
|
17679
|
+
"description": "Promotions for site search.",
|
|
17680
|
+
"items": {
|
|
17681
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion"
|
|
17682
|
+
},
|
|
17683
|
+
"type": "array"
|
|
17684
|
+
},
|
|
17006
17685
|
"sessionInfo": {
|
|
17007
17686
|
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo",
|
|
17008
17687
|
"description": "Session information. Only set if SearchRequest.session is provided. See its description for more details."
|
|
@@ -17648,6 +18327,13 @@
|
|
|
17648
18327
|
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec",
|
|
17649
18328
|
"description": "The specification for personalization spec. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec."
|
|
17650
18329
|
},
|
|
18330
|
+
"promoteControlIds": {
|
|
18331
|
+
"description": "Condition promote specifications. Maximum number of specifications is 100.",
|
|
18332
|
+
"items": {
|
|
18333
|
+
"type": "string"
|
|
18334
|
+
},
|
|
18335
|
+
"type": "array"
|
|
18336
|
+
},
|
|
17651
18337
|
"rankingExpression": {
|
|
17652
18338
|
"description": "The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the 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)`.",
|
|
17653
18339
|
"type": "string"
|
|
@@ -17746,12 +18432,20 @@
|
|
|
17746
18432
|
"description": "External session proto definition.",
|
|
17747
18433
|
"id": "GoogleCloudDiscoveryengineV1alphaSession",
|
|
17748
18434
|
"properties": {
|
|
18435
|
+
"displayName": {
|
|
18436
|
+
"description": "Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.",
|
|
18437
|
+
"type": "string"
|
|
18438
|
+
},
|
|
17749
18439
|
"endTime": {
|
|
17750
18440
|
"description": "Output only. The time the session finished.",
|
|
17751
18441
|
"format": "google-datetime",
|
|
17752
18442
|
"readOnly": true,
|
|
17753
18443
|
"type": "string"
|
|
17754
18444
|
},
|
|
18445
|
+
"isPinned": {
|
|
18446
|
+
"description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.",
|
|
18447
|
+
"type": "boolean"
|
|
18448
|
+
},
|
|
17755
18449
|
"name": {
|
|
17756
18450
|
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
|
|
17757
18451
|
"type": "string"
|
|
@@ -18280,6 +18974,22 @@
|
|
|
18280
18974
|
},
|
|
18281
18975
|
"type": "object"
|
|
18282
18976
|
},
|
|
18977
|
+
"GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest": {
|
|
18978
|
+
"description": "Request for UpdateSession method.",
|
|
18979
|
+
"id": "GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest",
|
|
18980
|
+
"properties": {
|
|
18981
|
+
"session": {
|
|
18982
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession",
|
|
18983
|
+
"description": "Required. The Session to update."
|
|
18984
|
+
},
|
|
18985
|
+
"updateMask": {
|
|
18986
|
+
"description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.",
|
|
18987
|
+
"format": "google-fieldmask",
|
|
18988
|
+
"type": "string"
|
|
18989
|
+
}
|
|
18990
|
+
},
|
|
18991
|
+
"type": "object"
|
|
18992
|
+
},
|
|
18283
18993
|
"GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": {
|
|
18284
18994
|
"description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
18285
18995
|
"id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata",
|
|
@@ -18648,6 +19358,10 @@
|
|
|
18648
19358
|
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
|
|
18649
19359
|
"type": "string"
|
|
18650
19360
|
},
|
|
19361
|
+
"promoteAction": {
|
|
19362
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControlPromoteAction",
|
|
19363
|
+
"description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
|
|
19364
|
+
},
|
|
18651
19365
|
"redirectAction": {
|
|
18652
19366
|
"$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction",
|
|
18653
19367
|
"description": "Defines a redirect-type control."
|
|
@@ -18729,6 +19443,21 @@
|
|
|
18729
19443
|
},
|
|
18730
19444
|
"type": "object"
|
|
18731
19445
|
},
|
|
19446
|
+
"GoogleCloudDiscoveryengineV1betaControlPromoteAction": {
|
|
19447
|
+
"description": "Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store.",
|
|
19448
|
+
"id": "GoogleCloudDiscoveryengineV1betaControlPromoteAction",
|
|
19449
|
+
"properties": {
|
|
19450
|
+
"dataStore": {
|
|
19451
|
+
"description": "Required. Data store with which this promotion is attached to.",
|
|
19452
|
+
"type": "string"
|
|
19453
|
+
},
|
|
19454
|
+
"searchLinkPromotion": {
|
|
19455
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion",
|
|
19456
|
+
"description": "Required. Promotion attached to this action."
|
|
19457
|
+
}
|
|
19458
|
+
},
|
|
19459
|
+
"type": "object"
|
|
19460
|
+
},
|
|
18732
19461
|
"GoogleCloudDiscoveryengineV1betaControlRedirectAction": {
|
|
18733
19462
|
"description": "Redirects a shopper to the provided URI.",
|
|
18734
19463
|
"id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction",
|
|
@@ -18845,73 +19574,6 @@
|
|
|
18845
19574
|
},
|
|
18846
19575
|
"type": "object"
|
|
18847
19576
|
},
|
|
18848
|
-
"GoogleCloudDiscoveryengineV1betaCustomTuningModel": {
|
|
18849
|
-
"description": "Metadata that describes a custom tuned model.",
|
|
18850
|
-
"id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel",
|
|
18851
|
-
"properties": {
|
|
18852
|
-
"createTime": {
|
|
18853
|
-
"deprecated": true,
|
|
18854
|
-
"description": "Deprecated: Timestamp the Model was created at.",
|
|
18855
|
-
"format": "google-datetime",
|
|
18856
|
-
"type": "string"
|
|
18857
|
-
},
|
|
18858
|
-
"displayName": {
|
|
18859
|
-
"description": "The display name of the model.",
|
|
18860
|
-
"type": "string"
|
|
18861
|
-
},
|
|
18862
|
-
"errorMessage": {
|
|
18863
|
-
"description": "Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.",
|
|
18864
|
-
"type": "string"
|
|
18865
|
-
},
|
|
18866
|
-
"metrics": {
|
|
18867
|
-
"additionalProperties": {
|
|
18868
|
-
"format": "double",
|
|
18869
|
-
"type": "number"
|
|
18870
|
-
},
|
|
18871
|
-
"description": "The metrics of the trained model.",
|
|
18872
|
-
"type": "object"
|
|
18873
|
-
},
|
|
18874
|
-
"modelState": {
|
|
18875
|
-
"description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).",
|
|
18876
|
-
"enum": [
|
|
18877
|
-
"MODEL_STATE_UNSPECIFIED",
|
|
18878
|
-
"TRAINING_PAUSED",
|
|
18879
|
-
"TRAINING",
|
|
18880
|
-
"TRAINING_COMPLETE",
|
|
18881
|
-
"READY_FOR_SERVING",
|
|
18882
|
-
"TRAINING_FAILED",
|
|
18883
|
-
"NO_IMPROVEMENT",
|
|
18884
|
-
"INPUT_VALIDATION_FAILED"
|
|
18885
|
-
],
|
|
18886
|
-
"enumDescriptions": [
|
|
18887
|
-
"Default value.",
|
|
18888
|
-
"The model is in a paused training state.",
|
|
18889
|
-
"The model is currently training.",
|
|
18890
|
-
"The model has successfully completed training.",
|
|
18891
|
-
"The model is ready for serving.",
|
|
18892
|
-
"The model training failed.",
|
|
18893
|
-
"The model training finished successfully but metrics did not improve.",
|
|
18894
|
-
"Input data validation failed. Model training didn't start."
|
|
18895
|
-
],
|
|
18896
|
-
"type": "string"
|
|
18897
|
-
},
|
|
18898
|
-
"modelVersion": {
|
|
18899
|
-
"description": "The version of the model.",
|
|
18900
|
-
"format": "int64",
|
|
18901
|
-
"type": "string"
|
|
18902
|
-
},
|
|
18903
|
-
"name": {
|
|
18904
|
-
"description": "Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters.",
|
|
18905
|
-
"type": "string"
|
|
18906
|
-
},
|
|
18907
|
-
"trainingStartTime": {
|
|
18908
|
-
"description": "Timestamp the model training was initiated.",
|
|
18909
|
-
"format": "google-datetime",
|
|
18910
|
-
"type": "string"
|
|
18911
|
-
}
|
|
18912
|
-
},
|
|
18913
|
-
"type": "object"
|
|
18914
|
-
},
|
|
18915
19577
|
"GoogleCloudDiscoveryengineV1betaDataStore": {
|
|
18916
19578
|
"description": "DataStore captures global settings and configs at the DataStore level.",
|
|
18917
19579
|
"id": "GoogleCloudDiscoveryengineV1betaDataStore",
|
|
@@ -19356,7 +20018,7 @@
|
|
|
19356
20018
|
"type": "string"
|
|
19357
20019
|
},
|
|
19358
20020
|
"industryVertical": {
|
|
19359
|
-
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore:
|
|
20021
|
+
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.",
|
|
19360
20022
|
"enum": [
|
|
19361
20023
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
19362
20024
|
"GENERIC",
|
|
@@ -19922,20 +20584,6 @@
|
|
|
19922
20584
|
},
|
|
19923
20585
|
"type": "object"
|
|
19924
20586
|
},
|
|
19925
|
-
"GoogleCloudDiscoveryengineV1betaListCustomModelsResponse": {
|
|
19926
|
-
"description": "Response message for SearchTuningService.ListCustomModels method.",
|
|
19927
|
-
"id": "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse",
|
|
19928
|
-
"properties": {
|
|
19929
|
-
"models": {
|
|
19930
|
-
"description": "List of custom tuning models.",
|
|
19931
|
-
"items": {
|
|
19932
|
-
"$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel"
|
|
19933
|
-
},
|
|
19934
|
-
"type": "array"
|
|
19935
|
-
}
|
|
19936
|
-
},
|
|
19937
|
-
"type": "object"
|
|
19938
|
-
},
|
|
19939
20587
|
"GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig": {
|
|
19940
20588
|
"description": "Configuration for Natural Language Query Understanding.",
|
|
19941
20589
|
"id": "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig",
|
|
@@ -20200,6 +20848,33 @@
|
|
|
20200
20848
|
},
|
|
20201
20849
|
"type": "object"
|
|
20202
20850
|
},
|
|
20851
|
+
"GoogleCloudDiscoveryengineV1betaSearchLinkPromotion": {
|
|
20852
|
+
"description": "Promotion proto includes uri and other helping information to display the promotion.",
|
|
20853
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion",
|
|
20854
|
+
"properties": {
|
|
20855
|
+
"description": {
|
|
20856
|
+
"description": "Optional. The Promotion description. Maximum length: 200 characters.",
|
|
20857
|
+
"type": "string"
|
|
20858
|
+
},
|
|
20859
|
+
"enabled": {
|
|
20860
|
+
"description": "Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.",
|
|
20861
|
+
"type": "boolean"
|
|
20862
|
+
},
|
|
20863
|
+
"imageUri": {
|
|
20864
|
+
"description": "Optional. The promotion thumbnail image url.",
|
|
20865
|
+
"type": "string"
|
|
20866
|
+
},
|
|
20867
|
+
"title": {
|
|
20868
|
+
"description": "Required. The title of the promotion. Maximum length: 160 characters.",
|
|
20869
|
+
"type": "string"
|
|
20870
|
+
},
|
|
20871
|
+
"uri": {
|
|
20872
|
+
"description": "Required. The URL for the page the user wants to promote.",
|
|
20873
|
+
"type": "string"
|
|
20874
|
+
}
|
|
20875
|
+
},
|
|
20876
|
+
"type": "object"
|
|
20877
|
+
},
|
|
20203
20878
|
"GoogleCloudDiscoveryengineV1betaSearchRequest": {
|
|
20204
20879
|
"description": "Request message for SearchService.Search method.",
|
|
20205
20880
|
"id": "GoogleCloudDiscoveryengineV1betaSearchRequest",
|
|
@@ -20221,7 +20896,7 @@
|
|
|
20221
20896
|
"description": "A specification for configuring the behavior of content search."
|
|
20222
20897
|
},
|
|
20223
20898
|
"dataStoreSpecs": {
|
|
20224
|
-
"description": "Specs defining
|
|
20899
|
+
"description": "Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.",
|
|
20225
20900
|
"items": {
|
|
20226
20901
|
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec"
|
|
20227
20902
|
},
|
|
@@ -20639,6 +21314,10 @@
|
|
|
20639
21314
|
"description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.",
|
|
20640
21315
|
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec",
|
|
20641
21316
|
"properties": {
|
|
21317
|
+
"boostSpec": {
|
|
21318
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
|
|
21319
|
+
"description": "Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)"
|
|
21320
|
+
},
|
|
20642
21321
|
"dataStore": {
|
|
20643
21322
|
"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
|
|
20644
21323
|
"type": "string"
|