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
|
@@ -779,7 +779,7 @@
|
|
|
779
779
|
"operations": {
|
|
780
780
|
"methods": {
|
|
781
781
|
"cancel": {
|
|
782
|
-
"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
|
|
782
|
+
"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`.",
|
|
783
783
|
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel",
|
|
784
784
|
"httpMethod": "POST",
|
|
785
785
|
"id": "discoveryengine.projects.locations.collections.dataStores.branches.operations.cancel",
|
|
@@ -1929,6 +1929,34 @@
|
|
|
1929
1929
|
"scopes": [
|
|
1930
1930
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
1931
1931
|
]
|
|
1932
|
+
},
|
|
1933
|
+
"streamAnswer": {
|
|
1934
|
+
"description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.",
|
|
1935
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:streamAnswer",
|
|
1936
|
+
"httpMethod": "POST",
|
|
1937
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.streamAnswer",
|
|
1938
|
+
"parameterOrder": [
|
|
1939
|
+
"servingConfig"
|
|
1940
|
+
],
|
|
1941
|
+
"parameters": {
|
|
1942
|
+
"servingConfig": {
|
|
1943
|
+
"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.",
|
|
1944
|
+
"location": "path",
|
|
1945
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
|
|
1946
|
+
"required": true,
|
|
1947
|
+
"type": "string"
|
|
1948
|
+
}
|
|
1949
|
+
},
|
|
1950
|
+
"path": "v1beta/{+servingConfig}:streamAnswer",
|
|
1951
|
+
"request": {
|
|
1952
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest"
|
|
1953
|
+
},
|
|
1954
|
+
"response": {
|
|
1955
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse"
|
|
1956
|
+
},
|
|
1957
|
+
"scopes": [
|
|
1958
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1959
|
+
]
|
|
1932
1960
|
}
|
|
1933
1961
|
}
|
|
1934
1962
|
},
|
|
@@ -1996,6 +2024,11 @@
|
|
|
1996
2024
|
"name"
|
|
1997
2025
|
],
|
|
1998
2026
|
"parameters": {
|
|
2027
|
+
"includeAnswerDetails": {
|
|
2028
|
+
"description": "Optional. If set to true, the full session including all answer details will be returned.",
|
|
2029
|
+
"location": "query",
|
|
2030
|
+
"type": "boolean"
|
|
2031
|
+
},
|
|
1999
2032
|
"name": {
|
|
2000
2033
|
"description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
2001
2034
|
"location": "path",
|
|
@@ -2027,7 +2060,7 @@
|
|
|
2027
2060
|
"type": "string"
|
|
2028
2061
|
},
|
|
2029
2062
|
"orderBy": {
|
|
2030
|
-
"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\"",
|
|
2063
|
+
"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.",
|
|
2031
2064
|
"location": "query",
|
|
2032
2065
|
"type": "string"
|
|
2033
2066
|
},
|
|
@@ -2730,7 +2763,7 @@
|
|
|
2730
2763
|
"type": "string"
|
|
2731
2764
|
},
|
|
2732
2765
|
"parent": {
|
|
2733
|
-
"description": "Required. The parent
|
|
2766
|
+
"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}`.",
|
|
2734
2767
|
"location": "path",
|
|
2735
2768
|
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
|
|
2736
2769
|
"required": true,
|
|
@@ -3756,6 +3789,34 @@
|
|
|
3756
3789
|
"scopes": [
|
|
3757
3790
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
3758
3791
|
]
|
|
3792
|
+
},
|
|
3793
|
+
"streamAnswer": {
|
|
3794
|
+
"description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.",
|
|
3795
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:streamAnswer",
|
|
3796
|
+
"httpMethod": "POST",
|
|
3797
|
+
"id": "discoveryengine.projects.locations.collections.engines.servingConfigs.streamAnswer",
|
|
3798
|
+
"parameterOrder": [
|
|
3799
|
+
"servingConfig"
|
|
3800
|
+
],
|
|
3801
|
+
"parameters": {
|
|
3802
|
+
"servingConfig": {
|
|
3803
|
+
"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.",
|
|
3804
|
+
"location": "path",
|
|
3805
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
|
|
3806
|
+
"required": true,
|
|
3807
|
+
"type": "string"
|
|
3808
|
+
}
|
|
3809
|
+
},
|
|
3810
|
+
"path": "v1beta/{+servingConfig}:streamAnswer",
|
|
3811
|
+
"request": {
|
|
3812
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest"
|
|
3813
|
+
},
|
|
3814
|
+
"response": {
|
|
3815
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse"
|
|
3816
|
+
},
|
|
3817
|
+
"scopes": [
|
|
3818
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
3819
|
+
]
|
|
3759
3820
|
}
|
|
3760
3821
|
}
|
|
3761
3822
|
},
|
|
@@ -3823,6 +3884,11 @@
|
|
|
3823
3884
|
"name"
|
|
3824
3885
|
],
|
|
3825
3886
|
"parameters": {
|
|
3887
|
+
"includeAnswerDetails": {
|
|
3888
|
+
"description": "Optional. If set to true, the full session including all answer details will be returned.",
|
|
3889
|
+
"location": "query",
|
|
3890
|
+
"type": "boolean"
|
|
3891
|
+
},
|
|
3826
3892
|
"name": {
|
|
3827
3893
|
"description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
3828
3894
|
"location": "path",
|
|
@@ -3854,7 +3920,7 @@
|
|
|
3854
3920
|
"type": "string"
|
|
3855
3921
|
},
|
|
3856
3922
|
"orderBy": {
|
|
3857
|
-
"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\"",
|
|
3923
|
+
"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.",
|
|
3858
3924
|
"location": "query",
|
|
3859
3925
|
"type": "string"
|
|
3860
3926
|
},
|
|
@@ -4540,7 +4606,7 @@
|
|
|
4540
4606
|
"operations": {
|
|
4541
4607
|
"methods": {
|
|
4542
4608
|
"cancel": {
|
|
4543
|
-
"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
|
|
4609
|
+
"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`.",
|
|
4544
4610
|
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel",
|
|
4545
4611
|
"httpMethod": "POST",
|
|
4546
4612
|
"id": "discoveryengine.projects.locations.dataStores.branches.operations.cancel",
|
|
@@ -5589,6 +5655,34 @@
|
|
|
5589
5655
|
"scopes": [
|
|
5590
5656
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
5591
5657
|
]
|
|
5658
|
+
},
|
|
5659
|
+
"streamAnswer": {
|
|
5660
|
+
"description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.",
|
|
5661
|
+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:streamAnswer",
|
|
5662
|
+
"httpMethod": "POST",
|
|
5663
|
+
"id": "discoveryengine.projects.locations.dataStores.servingConfigs.streamAnswer",
|
|
5664
|
+
"parameterOrder": [
|
|
5665
|
+
"servingConfig"
|
|
5666
|
+
],
|
|
5667
|
+
"parameters": {
|
|
5668
|
+
"servingConfig": {
|
|
5669
|
+
"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.",
|
|
5670
|
+
"location": "path",
|
|
5671
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
|
|
5672
|
+
"required": true,
|
|
5673
|
+
"type": "string"
|
|
5674
|
+
}
|
|
5675
|
+
},
|
|
5676
|
+
"path": "v1beta/{+servingConfig}:streamAnswer",
|
|
5677
|
+
"request": {
|
|
5678
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest"
|
|
5679
|
+
},
|
|
5680
|
+
"response": {
|
|
5681
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse"
|
|
5682
|
+
},
|
|
5683
|
+
"scopes": [
|
|
5684
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
5685
|
+
]
|
|
5592
5686
|
}
|
|
5593
5687
|
}
|
|
5594
5688
|
},
|
|
@@ -5656,6 +5750,11 @@
|
|
|
5656
5750
|
"name"
|
|
5657
5751
|
],
|
|
5658
5752
|
"parameters": {
|
|
5753
|
+
"includeAnswerDetails": {
|
|
5754
|
+
"description": "Optional. If set to true, the full session including all answer details will be returned.",
|
|
5755
|
+
"location": "query",
|
|
5756
|
+
"type": "boolean"
|
|
5757
|
+
},
|
|
5659
5758
|
"name": {
|
|
5660
5759
|
"description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
5661
5760
|
"location": "path",
|
|
@@ -5687,7 +5786,7 @@
|
|
|
5687
5786
|
"type": "string"
|
|
5688
5787
|
},
|
|
5689
5788
|
"orderBy": {
|
|
5690
|
-
"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\"",
|
|
5789
|
+
"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.",
|
|
5691
5790
|
"location": "query",
|
|
5692
5791
|
"type": "string"
|
|
5693
5792
|
},
|
|
@@ -6215,7 +6314,7 @@
|
|
|
6215
6314
|
"type": "string"
|
|
6216
6315
|
},
|
|
6217
6316
|
"parent": {
|
|
6218
|
-
"description": "Required. The parent
|
|
6317
|
+
"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}`.",
|
|
6219
6318
|
"location": "path",
|
|
6220
6319
|
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
6221
6320
|
"required": true,
|
|
@@ -7092,7 +7191,7 @@
|
|
|
7092
7191
|
"type": "string"
|
|
7093
7192
|
},
|
|
7094
7193
|
"parent": {
|
|
7095
|
-
"description": "Required. The parent
|
|
7194
|
+
"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}`.",
|
|
7096
7195
|
"location": "path",
|
|
7097
7196
|
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
7098
7197
|
"required": true,
|
|
@@ -7255,7 +7354,7 @@
|
|
|
7255
7354
|
}
|
|
7256
7355
|
}
|
|
7257
7356
|
},
|
|
7258
|
-
"revision": "
|
|
7357
|
+
"revision": "20241210",
|
|
7259
7358
|
"rootUrl": "https://discoveryengine.googleapis.com/",
|
|
7260
7359
|
"schemas": {
|
|
7261
7360
|
"GoogleApiDistribution": {
|
|
@@ -7812,6 +7911,10 @@
|
|
|
7812
7911
|
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
|
|
7813
7912
|
"type": "string"
|
|
7814
7913
|
},
|
|
7914
|
+
"promoteAction": {
|
|
7915
|
+
"$ref": "GoogleCloudDiscoveryengineV1ControlPromoteAction",
|
|
7916
|
+
"description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
|
|
7917
|
+
},
|
|
7815
7918
|
"redirectAction": {
|
|
7816
7919
|
"$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction",
|
|
7817
7920
|
"description": "Defines a redirect-type control."
|
|
@@ -7893,6 +7996,21 @@
|
|
|
7893
7996
|
},
|
|
7894
7997
|
"type": "object"
|
|
7895
7998
|
},
|
|
7999
|
+
"GoogleCloudDiscoveryengineV1ControlPromoteAction": {
|
|
8000
|
+
"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.",
|
|
8001
|
+
"id": "GoogleCloudDiscoveryengineV1ControlPromoteAction",
|
|
8002
|
+
"properties": {
|
|
8003
|
+
"dataStore": {
|
|
8004
|
+
"description": "Required. Data store with which this promotion is attached to.",
|
|
8005
|
+
"type": "string"
|
|
8006
|
+
},
|
|
8007
|
+
"searchLinkPromotion": {
|
|
8008
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchLinkPromotion",
|
|
8009
|
+
"description": "Required. Promotion attached to this action."
|
|
8010
|
+
}
|
|
8011
|
+
},
|
|
8012
|
+
"type": "object"
|
|
8013
|
+
},
|
|
7896
8014
|
"GoogleCloudDiscoveryengineV1ControlRedirectAction": {
|
|
7897
8015
|
"description": "Redirects a shopper to the provided URI.",
|
|
7898
8016
|
"id": "GoogleCloudDiscoveryengineV1ControlRedirectAction",
|
|
@@ -8405,7 +8523,7 @@
|
|
|
8405
8523
|
"type": "string"
|
|
8406
8524
|
},
|
|
8407
8525
|
"industryVertical": {
|
|
8408
|
-
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore:
|
|
8526
|
+
"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.",
|
|
8409
8527
|
"enum": [
|
|
8410
8528
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
8411
8529
|
"GENERIC",
|
|
@@ -8977,6 +9095,380 @@
|
|
|
8977
9095
|
},
|
|
8978
9096
|
"type": "object"
|
|
8979
9097
|
},
|
|
9098
|
+
"GoogleCloudDiscoveryengineV1SearchLinkPromotion": {
|
|
9099
|
+
"description": "Promotion proto includes uri and other helping information to display the promotion.",
|
|
9100
|
+
"id": "GoogleCloudDiscoveryengineV1SearchLinkPromotion",
|
|
9101
|
+
"properties": {
|
|
9102
|
+
"description": {
|
|
9103
|
+
"description": "Optional. The Promotion description. Maximum length: 200 characters.",
|
|
9104
|
+
"type": "string"
|
|
9105
|
+
},
|
|
9106
|
+
"enabled": {
|
|
9107
|
+
"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.",
|
|
9108
|
+
"type": "boolean"
|
|
9109
|
+
},
|
|
9110
|
+
"imageUri": {
|
|
9111
|
+
"description": "Optional. The promotion thumbnail image url.",
|
|
9112
|
+
"type": "string"
|
|
9113
|
+
},
|
|
9114
|
+
"title": {
|
|
9115
|
+
"description": "Required. The title of the promotion. Maximum length: 160 characters.",
|
|
9116
|
+
"type": "string"
|
|
9117
|
+
},
|
|
9118
|
+
"uri": {
|
|
9119
|
+
"description": "Required. The URL for the page the user wants to promote.",
|
|
9120
|
+
"type": "string"
|
|
9121
|
+
}
|
|
9122
|
+
},
|
|
9123
|
+
"type": "object"
|
|
9124
|
+
},
|
|
9125
|
+
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec": {
|
|
9126
|
+
"description": "A specification for configuring the behavior of content search.",
|
|
9127
|
+
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec",
|
|
9128
|
+
"properties": {
|
|
9129
|
+
"chunkSpec": {
|
|
9130
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec",
|
|
9131
|
+
"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"
|
|
9132
|
+
},
|
|
9133
|
+
"extractiveContentSpec": {
|
|
9134
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec",
|
|
9135
|
+
"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response."
|
|
9136
|
+
},
|
|
9137
|
+
"searchResultMode": {
|
|
9138
|
+
"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.",
|
|
9139
|
+
"enum": [
|
|
9140
|
+
"SEARCH_RESULT_MODE_UNSPECIFIED",
|
|
9141
|
+
"DOCUMENTS",
|
|
9142
|
+
"CHUNKS"
|
|
9143
|
+
],
|
|
9144
|
+
"enumDescriptions": [
|
|
9145
|
+
"Default value.",
|
|
9146
|
+
"Returns documents in the search result.",
|
|
9147
|
+
"Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
|
|
9148
|
+
],
|
|
9149
|
+
"type": "string"
|
|
9150
|
+
},
|
|
9151
|
+
"snippetSpec": {
|
|
9152
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec",
|
|
9153
|
+
"description": "If `snippetSpec` is not specified, snippets are not included in the search response."
|
|
9154
|
+
},
|
|
9155
|
+
"summarySpec": {
|
|
9156
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec",
|
|
9157
|
+
"description": "If `summarySpec` is not specified, summaries are not included in the search response."
|
|
9158
|
+
}
|
|
9159
|
+
},
|
|
9160
|
+
"type": "object"
|
|
9161
|
+
},
|
|
9162
|
+
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec": {
|
|
9163
|
+
"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",
|
|
9164
|
+
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec",
|
|
9165
|
+
"properties": {
|
|
9166
|
+
"numNextChunks": {
|
|
9167
|
+
"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.",
|
|
9168
|
+
"format": "int32",
|
|
9169
|
+
"type": "integer"
|
|
9170
|
+
},
|
|
9171
|
+
"numPreviousChunks": {
|
|
9172
|
+
"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.",
|
|
9173
|
+
"format": "int32",
|
|
9174
|
+
"type": "integer"
|
|
9175
|
+
}
|
|
9176
|
+
},
|
|
9177
|
+
"type": "object"
|
|
9178
|
+
},
|
|
9179
|
+
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec": {
|
|
9180
|
+
"description": "A specification for configuring the extractive content in a search response.",
|
|
9181
|
+
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec",
|
|
9182
|
+
"properties": {
|
|
9183
|
+
"maxExtractiveAnswerCount": {
|
|
9184
|
+
"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.",
|
|
9185
|
+
"format": "int32",
|
|
9186
|
+
"type": "integer"
|
|
9187
|
+
},
|
|
9188
|
+
"maxExtractiveSegmentCount": {
|
|
9189
|
+
"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`.",
|
|
9190
|
+
"format": "int32",
|
|
9191
|
+
"type": "integer"
|
|
9192
|
+
},
|
|
9193
|
+
"numNextSegments": {
|
|
9194
|
+
"description": "Return at most `num_next_segments` segments after each selected segments.",
|
|
9195
|
+
"format": "int32",
|
|
9196
|
+
"type": "integer"
|
|
9197
|
+
},
|
|
9198
|
+
"numPreviousSegments": {
|
|
9199
|
+
"description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.",
|
|
9200
|
+
"format": "int32",
|
|
9201
|
+
"type": "integer"
|
|
9202
|
+
},
|
|
9203
|
+
"returnExtractiveSegmentScore": {
|
|
9204
|
+
"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`.",
|
|
9205
|
+
"type": "boolean"
|
|
9206
|
+
}
|
|
9207
|
+
},
|
|
9208
|
+
"type": "object"
|
|
9209
|
+
},
|
|
9210
|
+
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec": {
|
|
9211
|
+
"description": "A specification for configuring snippets in a search response.",
|
|
9212
|
+
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec",
|
|
9213
|
+
"properties": {
|
|
9214
|
+
"maxSnippetCount": {
|
|
9215
|
+
"deprecated": true,
|
|
9216
|
+
"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.",
|
|
9217
|
+
"format": "int32",
|
|
9218
|
+
"type": "integer"
|
|
9219
|
+
},
|
|
9220
|
+
"referenceOnly": {
|
|
9221
|
+
"deprecated": true,
|
|
9222
|
+
"description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.",
|
|
9223
|
+
"type": "boolean"
|
|
9224
|
+
},
|
|
9225
|
+
"returnSnippet": {
|
|
9226
|
+
"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.",
|
|
9227
|
+
"type": "boolean"
|
|
9228
|
+
}
|
|
9229
|
+
},
|
|
9230
|
+
"type": "object"
|
|
9231
|
+
},
|
|
9232
|
+
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec": {
|
|
9233
|
+
"description": "A specification for configuring a summary returned in a search response.",
|
|
9234
|
+
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec",
|
|
9235
|
+
"properties": {
|
|
9236
|
+
"ignoreAdversarialQuery": {
|
|
9237
|
+
"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.",
|
|
9238
|
+
"type": "boolean"
|
|
9239
|
+
},
|
|
9240
|
+
"ignoreJailBreakingQuery": {
|
|
9241
|
+
"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.",
|
|
9242
|
+
"type": "boolean"
|
|
9243
|
+
},
|
|
9244
|
+
"ignoreLowRelevantContent": {
|
|
9245
|
+
"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.",
|
|
9246
|
+
"type": "boolean"
|
|
9247
|
+
},
|
|
9248
|
+
"ignoreNonSummarySeekingQuery": {
|
|
9249
|
+
"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.",
|
|
9250
|
+
"type": "boolean"
|
|
9251
|
+
},
|
|
9252
|
+
"includeCitations": {
|
|
9253
|
+
"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.",
|
|
9254
|
+
"type": "boolean"
|
|
9255
|
+
},
|
|
9256
|
+
"languageCode": {
|
|
9257
|
+
"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.",
|
|
9258
|
+
"type": "string"
|
|
9259
|
+
},
|
|
9260
|
+
"modelPromptSpec": {
|
|
9261
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec",
|
|
9262
|
+
"description": "If specified, the spec will be used to modify the prompt provided to the LLM."
|
|
9263
|
+
},
|
|
9264
|
+
"modelSpec": {
|
|
9265
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec",
|
|
9266
|
+
"description": "If specified, the spec will be used to modify the model specification provided to the LLM."
|
|
9267
|
+
},
|
|
9268
|
+
"summaryResultCount": {
|
|
9269
|
+
"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.",
|
|
9270
|
+
"format": "int32",
|
|
9271
|
+
"type": "integer"
|
|
9272
|
+
},
|
|
9273
|
+
"useSemanticChunks": {
|
|
9274
|
+
"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.",
|
|
9275
|
+
"type": "boolean"
|
|
9276
|
+
}
|
|
9277
|
+
},
|
|
9278
|
+
"type": "object"
|
|
9279
|
+
},
|
|
9280
|
+
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec": {
|
|
9281
|
+
"description": "Specification of the prompt to use with the model.",
|
|
9282
|
+
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec",
|
|
9283
|
+
"properties": {
|
|
9284
|
+
"preamble": {
|
|
9285
|
+
"description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.",
|
|
9286
|
+
"type": "string"
|
|
9287
|
+
}
|
|
9288
|
+
},
|
|
9289
|
+
"type": "object"
|
|
9290
|
+
},
|
|
9291
|
+
"GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec": {
|
|
9292
|
+
"description": "Specification of the model.",
|
|
9293
|
+
"id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec",
|
|
9294
|
+
"properties": {
|
|
9295
|
+
"version": {
|
|
9296
|
+
"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).",
|
|
9297
|
+
"type": "string"
|
|
9298
|
+
}
|
|
9299
|
+
},
|
|
9300
|
+
"type": "object"
|
|
9301
|
+
},
|
|
9302
|
+
"GoogleCloudDiscoveryengineV1ServingConfig": {
|
|
9303
|
+
"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.",
|
|
9304
|
+
"id": "GoogleCloudDiscoveryengineV1ServingConfig",
|
|
9305
|
+
"properties": {
|
|
9306
|
+
"boostControlIds": {
|
|
9307
|
+
"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.",
|
|
9308
|
+
"items": {
|
|
9309
|
+
"type": "string"
|
|
9310
|
+
},
|
|
9311
|
+
"type": "array"
|
|
9312
|
+
},
|
|
9313
|
+
"createTime": {
|
|
9314
|
+
"description": "Output only. ServingConfig created timestamp.",
|
|
9315
|
+
"format": "google-datetime",
|
|
9316
|
+
"readOnly": true,
|
|
9317
|
+
"type": "string"
|
|
9318
|
+
},
|
|
9319
|
+
"displayName": {
|
|
9320
|
+
"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.",
|
|
9321
|
+
"type": "string"
|
|
9322
|
+
},
|
|
9323
|
+
"dissociateControlIds": {
|
|
9324
|
+
"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.",
|
|
9325
|
+
"items": {
|
|
9326
|
+
"type": "string"
|
|
9327
|
+
},
|
|
9328
|
+
"type": "array"
|
|
9329
|
+
},
|
|
9330
|
+
"diversityLevel": {
|
|
9331
|
+
"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.",
|
|
9332
|
+
"type": "string"
|
|
9333
|
+
},
|
|
9334
|
+
"filterControlIds": {
|
|
9335
|
+
"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.",
|
|
9336
|
+
"items": {
|
|
9337
|
+
"type": "string"
|
|
9338
|
+
},
|
|
9339
|
+
"type": "array"
|
|
9340
|
+
},
|
|
9341
|
+
"genericConfig": {
|
|
9342
|
+
"$ref": "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig",
|
|
9343
|
+
"description": "The GenericConfig of the serving configuration."
|
|
9344
|
+
},
|
|
9345
|
+
"ignoreControlIds": {
|
|
9346
|
+
"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.",
|
|
9347
|
+
"items": {
|
|
9348
|
+
"type": "string"
|
|
9349
|
+
},
|
|
9350
|
+
"type": "array"
|
|
9351
|
+
},
|
|
9352
|
+
"mediaConfig": {
|
|
9353
|
+
"$ref": "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig",
|
|
9354
|
+
"description": "The MediaConfig of the serving configuration."
|
|
9355
|
+
},
|
|
9356
|
+
"modelId": {
|
|
9357
|
+
"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.",
|
|
9358
|
+
"type": "string"
|
|
9359
|
+
},
|
|
9360
|
+
"name": {
|
|
9361
|
+
"description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`",
|
|
9362
|
+
"type": "string"
|
|
9363
|
+
},
|
|
9364
|
+
"onewaySynonymsControlIds": {
|
|
9365
|
+
"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.",
|
|
9366
|
+
"items": {
|
|
9367
|
+
"type": "string"
|
|
9368
|
+
},
|
|
9369
|
+
"type": "array"
|
|
9370
|
+
},
|
|
9371
|
+
"promoteControlIds": {
|
|
9372
|
+
"description": "Condition promote specifications. Maximum number of specifications is 100.",
|
|
9373
|
+
"items": {
|
|
9374
|
+
"type": "string"
|
|
9375
|
+
},
|
|
9376
|
+
"type": "array"
|
|
9377
|
+
},
|
|
9378
|
+
"rankingExpression": {
|
|
9379
|
+
"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)`.",
|
|
9380
|
+
"type": "string"
|
|
9381
|
+
},
|
|
9382
|
+
"redirectControlIds": {
|
|
9383
|
+
"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.",
|
|
9384
|
+
"items": {
|
|
9385
|
+
"type": "string"
|
|
9386
|
+
},
|
|
9387
|
+
"type": "array"
|
|
9388
|
+
},
|
|
9389
|
+
"replacementControlIds": {
|
|
9390
|
+
"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.",
|
|
9391
|
+
"items": {
|
|
9392
|
+
"type": "string"
|
|
9393
|
+
},
|
|
9394
|
+
"type": "array"
|
|
9395
|
+
},
|
|
9396
|
+
"solutionType": {
|
|
9397
|
+
"description": "Required. Immutable. Specifies the solution type that a serving config can be associated with.",
|
|
9398
|
+
"enum": [
|
|
9399
|
+
"SOLUTION_TYPE_UNSPECIFIED",
|
|
9400
|
+
"SOLUTION_TYPE_RECOMMENDATION",
|
|
9401
|
+
"SOLUTION_TYPE_SEARCH",
|
|
9402
|
+
"SOLUTION_TYPE_CHAT",
|
|
9403
|
+
"SOLUTION_TYPE_GENERATIVE_CHAT"
|
|
9404
|
+
],
|
|
9405
|
+
"enumDescriptions": [
|
|
9406
|
+
"Default value.",
|
|
9407
|
+
"Used for Recommendations AI.",
|
|
9408
|
+
"Used for Discovery Search.",
|
|
9409
|
+
"Used for use cases related to the Generative AI agent.",
|
|
9410
|
+
"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."
|
|
9411
|
+
],
|
|
9412
|
+
"type": "string"
|
|
9413
|
+
},
|
|
9414
|
+
"synonymsControlIds": {
|
|
9415
|
+
"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.",
|
|
9416
|
+
"items": {
|
|
9417
|
+
"type": "string"
|
|
9418
|
+
},
|
|
9419
|
+
"type": "array"
|
|
9420
|
+
},
|
|
9421
|
+
"updateTime": {
|
|
9422
|
+
"description": "Output only. ServingConfig updated timestamp.",
|
|
9423
|
+
"format": "google-datetime",
|
|
9424
|
+
"readOnly": true,
|
|
9425
|
+
"type": "string"
|
|
9426
|
+
}
|
|
9427
|
+
},
|
|
9428
|
+
"type": "object"
|
|
9429
|
+
},
|
|
9430
|
+
"GoogleCloudDiscoveryengineV1ServingConfigGenericConfig": {
|
|
9431
|
+
"description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.",
|
|
9432
|
+
"id": "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig",
|
|
9433
|
+
"properties": {
|
|
9434
|
+
"contentSearchSpec": {
|
|
9435
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec",
|
|
9436
|
+
"description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store."
|
|
9437
|
+
}
|
|
9438
|
+
},
|
|
9439
|
+
"type": "object"
|
|
9440
|
+
},
|
|
9441
|
+
"GoogleCloudDiscoveryengineV1ServingConfigMediaConfig": {
|
|
9442
|
+
"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.",
|
|
9443
|
+
"id": "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig",
|
|
9444
|
+
"properties": {
|
|
9445
|
+
"contentFreshnessCutoffDays": {
|
|
9446
|
+
"description": "Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.",
|
|
9447
|
+
"format": "int32",
|
|
9448
|
+
"type": "integer"
|
|
9449
|
+
},
|
|
9450
|
+
"contentWatchedPercentageThreshold": {
|
|
9451
|
+
"description": "Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.",
|
|
9452
|
+
"format": "float",
|
|
9453
|
+
"type": "number"
|
|
9454
|
+
},
|
|
9455
|
+
"contentWatchedSecondsThreshold": {
|
|
9456
|
+
"description": "Specifies the content watched minutes threshold for demotion.",
|
|
9457
|
+
"format": "float",
|
|
9458
|
+
"type": "number"
|
|
9459
|
+
},
|
|
9460
|
+
"demoteContentWatchedPastDays": {
|
|
9461
|
+
"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.",
|
|
9462
|
+
"format": "int32",
|
|
9463
|
+
"type": "integer"
|
|
9464
|
+
},
|
|
9465
|
+
"demotionEventType": {
|
|
9466
|
+
"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.",
|
|
9467
|
+
"type": "string"
|
|
9468
|
+
}
|
|
9469
|
+
},
|
|
9470
|
+
"type": "object"
|
|
9471
|
+
},
|
|
8980
9472
|
"GoogleCloudDiscoveryengineV1SiteVerificationInfo": {
|
|
8981
9473
|
"description": "Verification information for target sites in advanced site search.",
|
|
8982
9474
|
"id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo",
|
|
@@ -9340,6 +9832,18 @@
|
|
|
9340
9832
|
"readOnly": true,
|
|
9341
9833
|
"type": "string"
|
|
9342
9834
|
},
|
|
9835
|
+
"groundingScore": {
|
|
9836
|
+
"description": "A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.",
|
|
9837
|
+
"format": "double",
|
|
9838
|
+
"type": "number"
|
|
9839
|
+
},
|
|
9840
|
+
"groundingSupports": {
|
|
9841
|
+
"description": "Optional. Grounding supports.",
|
|
9842
|
+
"items": {
|
|
9843
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport"
|
|
9844
|
+
},
|
|
9845
|
+
"type": "array"
|
|
9846
|
+
},
|
|
9343
9847
|
"name": {
|
|
9344
9848
|
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`",
|
|
9345
9849
|
"type": "string"
|
|
@@ -9368,13 +9872,15 @@
|
|
|
9368
9872
|
"STATE_UNSPECIFIED",
|
|
9369
9873
|
"IN_PROGRESS",
|
|
9370
9874
|
"FAILED",
|
|
9371
|
-
"SUCCEEDED"
|
|
9875
|
+
"SUCCEEDED",
|
|
9876
|
+
"STREAMING"
|
|
9372
9877
|
],
|
|
9373
9878
|
"enumDescriptions": [
|
|
9374
9879
|
"Unknown.",
|
|
9375
9880
|
"Answer generation is currently in progress.",
|
|
9376
9881
|
"Answer generation currently failed.",
|
|
9377
|
-
"Answer generation has succeeded."
|
|
9882
|
+
"Answer generation has succeeded.",
|
|
9883
|
+
"Answer generation is currently in progress."
|
|
9378
9884
|
],
|
|
9379
9885
|
"type": "string"
|
|
9380
9886
|
},
|
|
@@ -9423,6 +9929,39 @@
|
|
|
9423
9929
|
},
|
|
9424
9930
|
"type": "object"
|
|
9425
9931
|
},
|
|
9932
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport": {
|
|
9933
|
+
"description": "Grounding support for a claim in `answer_text`.",
|
|
9934
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport",
|
|
9935
|
+
"properties": {
|
|
9936
|
+
"endIndex": {
|
|
9937
|
+
"description": "Required. End of the claim, exclusive.",
|
|
9938
|
+
"format": "int64",
|
|
9939
|
+
"type": "string"
|
|
9940
|
+
},
|
|
9941
|
+
"groundingCheckRequired": {
|
|
9942
|
+
"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.",
|
|
9943
|
+
"type": "boolean"
|
|
9944
|
+
},
|
|
9945
|
+
"groundingScore": {
|
|
9946
|
+
"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.",
|
|
9947
|
+
"format": "double",
|
|
9948
|
+
"type": "number"
|
|
9949
|
+
},
|
|
9950
|
+
"sources": {
|
|
9951
|
+
"description": "Optional. Citation sources for the claim.",
|
|
9952
|
+
"items": {
|
|
9953
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource"
|
|
9954
|
+
},
|
|
9955
|
+
"type": "array"
|
|
9956
|
+
},
|
|
9957
|
+
"startIndex": {
|
|
9958
|
+
"description": "Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).",
|
|
9959
|
+
"format": "int64",
|
|
9960
|
+
"type": "string"
|
|
9961
|
+
}
|
|
9962
|
+
},
|
|
9963
|
+
"type": "object"
|
|
9964
|
+
},
|
|
9426
9965
|
"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": {
|
|
9427
9966
|
"description": "Query understanding information.",
|
|
9428
9967
|
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo",
|
|
@@ -9942,6 +10481,10 @@
|
|
|
9942
10481
|
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
|
|
9943
10482
|
"type": "string"
|
|
9944
10483
|
},
|
|
10484
|
+
"promoteAction": {
|
|
10485
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction",
|
|
10486
|
+
"description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
|
|
10487
|
+
},
|
|
9945
10488
|
"redirectAction": {
|
|
9946
10489
|
"$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction",
|
|
9947
10490
|
"description": "Defines a redirect-type control."
|
|
@@ -10023,6 +10566,21 @@
|
|
|
10023
10566
|
},
|
|
10024
10567
|
"type": "object"
|
|
10025
10568
|
},
|
|
10569
|
+
"GoogleCloudDiscoveryengineV1alphaControlPromoteAction": {
|
|
10570
|
+
"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.",
|
|
10571
|
+
"id": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction",
|
|
10572
|
+
"properties": {
|
|
10573
|
+
"dataStore": {
|
|
10574
|
+
"description": "Required. Data store with which this promotion is attached to.",
|
|
10575
|
+
"type": "string"
|
|
10576
|
+
},
|
|
10577
|
+
"searchLinkPromotion": {
|
|
10578
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion",
|
|
10579
|
+
"description": "Required. Promotion attached to this action."
|
|
10580
|
+
}
|
|
10581
|
+
},
|
|
10582
|
+
"type": "object"
|
|
10583
|
+
},
|
|
10026
10584
|
"GoogleCloudDiscoveryengineV1alphaControlRedirectAction": {
|
|
10027
10585
|
"description": "Redirects a shopper to the provided URI.",
|
|
10028
10586
|
"id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction",
|
|
@@ -10161,73 +10719,6 @@
|
|
|
10161
10719
|
},
|
|
10162
10720
|
"type": "object"
|
|
10163
10721
|
},
|
|
10164
|
-
"GoogleCloudDiscoveryengineV1alphaCustomTuningModel": {
|
|
10165
|
-
"description": "Metadata that describes a custom tuned model.",
|
|
10166
|
-
"id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel",
|
|
10167
|
-
"properties": {
|
|
10168
|
-
"createTime": {
|
|
10169
|
-
"deprecated": true,
|
|
10170
|
-
"description": "Deprecated: Timestamp the Model was created at.",
|
|
10171
|
-
"format": "google-datetime",
|
|
10172
|
-
"type": "string"
|
|
10173
|
-
},
|
|
10174
|
-
"displayName": {
|
|
10175
|
-
"description": "The display name of the model.",
|
|
10176
|
-
"type": "string"
|
|
10177
|
-
},
|
|
10178
|
-
"errorMessage": {
|
|
10179
|
-
"description": "Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.",
|
|
10180
|
-
"type": "string"
|
|
10181
|
-
},
|
|
10182
|
-
"metrics": {
|
|
10183
|
-
"additionalProperties": {
|
|
10184
|
-
"format": "double",
|
|
10185
|
-
"type": "number"
|
|
10186
|
-
},
|
|
10187
|
-
"description": "The metrics of the trained model.",
|
|
10188
|
-
"type": "object"
|
|
10189
|
-
},
|
|
10190
|
-
"modelState": {
|
|
10191
|
-
"description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).",
|
|
10192
|
-
"enum": [
|
|
10193
|
-
"MODEL_STATE_UNSPECIFIED",
|
|
10194
|
-
"TRAINING_PAUSED",
|
|
10195
|
-
"TRAINING",
|
|
10196
|
-
"TRAINING_COMPLETE",
|
|
10197
|
-
"READY_FOR_SERVING",
|
|
10198
|
-
"TRAINING_FAILED",
|
|
10199
|
-
"NO_IMPROVEMENT",
|
|
10200
|
-
"INPUT_VALIDATION_FAILED"
|
|
10201
|
-
],
|
|
10202
|
-
"enumDescriptions": [
|
|
10203
|
-
"Default value.",
|
|
10204
|
-
"The model is in a paused training state.",
|
|
10205
|
-
"The model is currently training.",
|
|
10206
|
-
"The model has successfully completed training.",
|
|
10207
|
-
"The model is ready for serving.",
|
|
10208
|
-
"The model training failed.",
|
|
10209
|
-
"The model training finished successfully but metrics did not improve.",
|
|
10210
|
-
"Input data validation failed. Model training didn't start."
|
|
10211
|
-
],
|
|
10212
|
-
"type": "string"
|
|
10213
|
-
},
|
|
10214
|
-
"modelVersion": {
|
|
10215
|
-
"description": "The version of the model.",
|
|
10216
|
-
"format": "int64",
|
|
10217
|
-
"type": "string"
|
|
10218
|
-
},
|
|
10219
|
-
"name": {
|
|
10220
|
-
"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.",
|
|
10221
|
-
"type": "string"
|
|
10222
|
-
},
|
|
10223
|
-
"trainingStartTime": {
|
|
10224
|
-
"description": "Timestamp the model training was initiated.",
|
|
10225
|
-
"format": "google-datetime",
|
|
10226
|
-
"type": "string"
|
|
10227
|
-
}
|
|
10228
|
-
},
|
|
10229
|
-
"type": "object"
|
|
10230
|
-
},
|
|
10231
10722
|
"GoogleCloudDiscoveryengineV1alphaDataStore": {
|
|
10232
10723
|
"description": "DataStore captures global settings and configs at the DataStore level.",
|
|
10233
10724
|
"id": "GoogleCloudDiscoveryengineV1alphaDataStore",
|
|
@@ -10474,6 +10965,17 @@
|
|
|
10474
10965
|
},
|
|
10475
10966
|
"type": "object"
|
|
10476
10967
|
},
|
|
10968
|
+
"GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest": {
|
|
10969
|
+
"description": "Request for DeleteSession method.",
|
|
10970
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest",
|
|
10971
|
+
"properties": {
|
|
10972
|
+
"name": {
|
|
10973
|
+
"description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
10974
|
+
"type": "string"
|
|
10975
|
+
}
|
|
10976
|
+
},
|
|
10977
|
+
"type": "object"
|
|
10978
|
+
},
|
|
10477
10979
|
"GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata": {
|
|
10478
10980
|
"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
10479
10981
|
"id": "GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata",
|
|
@@ -10696,7 +11198,7 @@
|
|
|
10696
11198
|
"type": "string"
|
|
10697
11199
|
},
|
|
10698
11200
|
"industryVertical": {
|
|
10699
|
-
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore:
|
|
11201
|
+
"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.",
|
|
10700
11202
|
"enum": [
|
|
10701
11203
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
10702
11204
|
"GENERIC",
|
|
@@ -11261,6 +11763,21 @@
|
|
|
11261
11763
|
},
|
|
11262
11764
|
"type": "object"
|
|
11263
11765
|
},
|
|
11766
|
+
"GoogleCloudDiscoveryengineV1alphaGetSessionRequest": {
|
|
11767
|
+
"description": "Request for GetSession method.",
|
|
11768
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGetSessionRequest",
|
|
11769
|
+
"properties": {
|
|
11770
|
+
"includeAnswerDetails": {
|
|
11771
|
+
"description": "Optional. If set to true, the full session including all answer details will be returned.",
|
|
11772
|
+
"type": "boolean"
|
|
11773
|
+
},
|
|
11774
|
+
"name": {
|
|
11775
|
+
"description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
11776
|
+
"type": "string"
|
|
11777
|
+
}
|
|
11778
|
+
},
|
|
11779
|
+
"type": "object"
|
|
11780
|
+
},
|
|
11264
11781
|
"GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": {
|
|
11265
11782
|
"description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.",
|
|
11266
11783
|
"id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse",
|
|
@@ -11620,14 +12137,46 @@
|
|
|
11620
12137
|
},
|
|
11621
12138
|
"type": "object"
|
|
11622
12139
|
},
|
|
11623
|
-
"
|
|
11624
|
-
"description": "
|
|
11625
|
-
"id": "
|
|
12140
|
+
"GoogleCloudDiscoveryengineV1alphaListSessionsRequest": {
|
|
12141
|
+
"description": "Request for ListSessions method.",
|
|
12142
|
+
"id": "GoogleCloudDiscoveryengineV1alphaListSessionsRequest",
|
|
11626
12143
|
"properties": {
|
|
11627
|
-
"
|
|
11628
|
-
"description": "
|
|
12144
|
+
"filter": {
|
|
12145
|
+
"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
|
|
12146
|
+
"type": "string"
|
|
12147
|
+
},
|
|
12148
|
+
"orderBy": {
|
|
12149
|
+
"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.",
|
|
12150
|
+
"type": "string"
|
|
12151
|
+
},
|
|
12152
|
+
"pageSize": {
|
|
12153
|
+
"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
|
|
12154
|
+
"format": "int32",
|
|
12155
|
+
"type": "integer"
|
|
12156
|
+
},
|
|
12157
|
+
"pageToken": {
|
|
12158
|
+
"description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.",
|
|
12159
|
+
"type": "string"
|
|
12160
|
+
},
|
|
12161
|
+
"parent": {
|
|
12162
|
+
"description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`",
|
|
12163
|
+
"type": "string"
|
|
12164
|
+
}
|
|
12165
|
+
},
|
|
12166
|
+
"type": "object"
|
|
12167
|
+
},
|
|
12168
|
+
"GoogleCloudDiscoveryengineV1alphaListSessionsResponse": {
|
|
12169
|
+
"description": "Response for ListSessions method.",
|
|
12170
|
+
"id": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse",
|
|
12171
|
+
"properties": {
|
|
12172
|
+
"nextPageToken": {
|
|
12173
|
+
"description": "Pagination token, if not returned indicates the last page.",
|
|
12174
|
+
"type": "string"
|
|
12175
|
+
},
|
|
12176
|
+
"sessions": {
|
|
12177
|
+
"description": "All the Sessions for a given data store.",
|
|
11629
12178
|
"items": {
|
|
11630
|
-
"$ref": "
|
|
12179
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
|
|
11631
12180
|
},
|
|
11632
12181
|
"type": "array"
|
|
11633
12182
|
}
|
|
@@ -12169,6 +12718,33 @@
|
|
|
12169
12718
|
},
|
|
12170
12719
|
"type": "object"
|
|
12171
12720
|
},
|
|
12721
|
+
"GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion": {
|
|
12722
|
+
"description": "Promotion proto includes uri and other helping information to display the promotion.",
|
|
12723
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion",
|
|
12724
|
+
"properties": {
|
|
12725
|
+
"description": {
|
|
12726
|
+
"description": "Optional. The Promotion description. Maximum length: 200 characters.",
|
|
12727
|
+
"type": "string"
|
|
12728
|
+
},
|
|
12729
|
+
"enabled": {
|
|
12730
|
+
"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.",
|
|
12731
|
+
"type": "boolean"
|
|
12732
|
+
},
|
|
12733
|
+
"imageUri": {
|
|
12734
|
+
"description": "Optional. The promotion thumbnail image url.",
|
|
12735
|
+
"type": "string"
|
|
12736
|
+
},
|
|
12737
|
+
"title": {
|
|
12738
|
+
"description": "Required. The title of the promotion. Maximum length: 160 characters.",
|
|
12739
|
+
"type": "string"
|
|
12740
|
+
},
|
|
12741
|
+
"uri": {
|
|
12742
|
+
"description": "Required. The URL for the page the user wants to promote.",
|
|
12743
|
+
"type": "string"
|
|
12744
|
+
}
|
|
12745
|
+
},
|
|
12746
|
+
"type": "object"
|
|
12747
|
+
},
|
|
12172
12748
|
"GoogleCloudDiscoveryengineV1alphaSearchRequest": {
|
|
12173
12749
|
"description": "Request message for SearchService.Search method.",
|
|
12174
12750
|
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequest",
|
|
@@ -12194,7 +12770,7 @@
|
|
|
12194
12770
|
"description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec."
|
|
12195
12771
|
},
|
|
12196
12772
|
"dataStoreSpecs": {
|
|
12197
|
-
"description": "Specs defining
|
|
12773
|
+
"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.",
|
|
12198
12774
|
"items": {
|
|
12199
12775
|
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec"
|
|
12200
12776
|
},
|
|
@@ -12612,6 +13188,10 @@
|
|
|
12612
13188
|
"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.",
|
|
12613
13189
|
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec",
|
|
12614
13190
|
"properties": {
|
|
13191
|
+
"boostSpec": {
|
|
13192
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec",
|
|
13193
|
+
"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)"
|
|
13194
|
+
},
|
|
12615
13195
|
"dataStore": {
|
|
12616
13196
|
"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
|
|
12617
13197
|
"type": "string"
|
|
@@ -12877,12 +13457,20 @@
|
|
|
12877
13457
|
"description": "External session proto definition.",
|
|
12878
13458
|
"id": "GoogleCloudDiscoveryengineV1alphaSession",
|
|
12879
13459
|
"properties": {
|
|
13460
|
+
"displayName": {
|
|
13461
|
+
"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.",
|
|
13462
|
+
"type": "string"
|
|
13463
|
+
},
|
|
12880
13464
|
"endTime": {
|
|
12881
13465
|
"description": "Output only. The time the session finished.",
|
|
12882
13466
|
"format": "google-datetime",
|
|
12883
13467
|
"readOnly": true,
|
|
12884
13468
|
"type": "string"
|
|
12885
13469
|
},
|
|
13470
|
+
"isPinned": {
|
|
13471
|
+
"description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.",
|
|
13472
|
+
"type": "boolean"
|
|
13473
|
+
},
|
|
12886
13474
|
"name": {
|
|
12887
13475
|
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
|
|
12888
13476
|
"type": "string"
|
|
@@ -13216,6 +13804,22 @@
|
|
|
13216
13804
|
},
|
|
13217
13805
|
"type": "object"
|
|
13218
13806
|
},
|
|
13807
|
+
"GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest": {
|
|
13808
|
+
"description": "Request for UpdateSession method.",
|
|
13809
|
+
"id": "GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest",
|
|
13810
|
+
"properties": {
|
|
13811
|
+
"session": {
|
|
13812
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession",
|
|
13813
|
+
"description": "Required. The Session to update."
|
|
13814
|
+
},
|
|
13815
|
+
"updateMask": {
|
|
13816
|
+
"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.",
|
|
13817
|
+
"format": "google-fieldmask",
|
|
13818
|
+
"type": "string"
|
|
13819
|
+
}
|
|
13820
|
+
},
|
|
13821
|
+
"type": "object"
|
|
13822
|
+
},
|
|
13219
13823
|
"GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": {
|
|
13220
13824
|
"description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
13221
13825
|
"id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata",
|
|
@@ -13616,6 +14220,18 @@
|
|
|
13616
14220
|
"readOnly": true,
|
|
13617
14221
|
"type": "string"
|
|
13618
14222
|
},
|
|
14223
|
+
"groundingScore": {
|
|
14224
|
+
"description": "A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.",
|
|
14225
|
+
"format": "double",
|
|
14226
|
+
"type": "number"
|
|
14227
|
+
},
|
|
14228
|
+
"groundingSupports": {
|
|
14229
|
+
"description": "Optional. Grounding supports.",
|
|
14230
|
+
"items": {
|
|
14231
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerGroundingSupport"
|
|
14232
|
+
},
|
|
14233
|
+
"type": "array"
|
|
14234
|
+
},
|
|
13619
14235
|
"name": {
|
|
13620
14236
|
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`",
|
|
13621
14237
|
"type": "string"
|
|
@@ -13644,13 +14260,15 @@
|
|
|
13644
14260
|
"STATE_UNSPECIFIED",
|
|
13645
14261
|
"IN_PROGRESS",
|
|
13646
14262
|
"FAILED",
|
|
13647
|
-
"SUCCEEDED"
|
|
14263
|
+
"SUCCEEDED",
|
|
14264
|
+
"STREAMING"
|
|
13648
14265
|
],
|
|
13649
14266
|
"enumDescriptions": [
|
|
13650
14267
|
"Unknown.",
|
|
13651
14268
|
"Answer generation is currently in progress.",
|
|
13652
14269
|
"Answer generation currently failed.",
|
|
13653
|
-
"Answer generation has succeeded."
|
|
14270
|
+
"Answer generation has succeeded.",
|
|
14271
|
+
"Answer generation is currently in progress."
|
|
13654
14272
|
],
|
|
13655
14273
|
"type": "string"
|
|
13656
14274
|
},
|
|
@@ -13699,6 +14317,39 @@
|
|
|
13699
14317
|
},
|
|
13700
14318
|
"type": "object"
|
|
13701
14319
|
},
|
|
14320
|
+
"GoogleCloudDiscoveryengineV1betaAnswerGroundingSupport": {
|
|
14321
|
+
"description": "Grounding support for a claim in `answer_text`.",
|
|
14322
|
+
"id": "GoogleCloudDiscoveryengineV1betaAnswerGroundingSupport",
|
|
14323
|
+
"properties": {
|
|
14324
|
+
"endIndex": {
|
|
14325
|
+
"description": "Required. End of the claim, exclusive.",
|
|
14326
|
+
"format": "int64",
|
|
14327
|
+
"type": "string"
|
|
14328
|
+
},
|
|
14329
|
+
"groundingCheckRequired": {
|
|
14330
|
+
"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.",
|
|
14331
|
+
"type": "boolean"
|
|
14332
|
+
},
|
|
14333
|
+
"groundingScore": {
|
|
14334
|
+
"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.",
|
|
14335
|
+
"format": "double",
|
|
14336
|
+
"type": "number"
|
|
14337
|
+
},
|
|
14338
|
+
"sources": {
|
|
14339
|
+
"description": "Optional. Citation sources for the claim.",
|
|
14340
|
+
"items": {
|
|
14341
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerCitationSource"
|
|
14342
|
+
},
|
|
14343
|
+
"type": "array"
|
|
14344
|
+
},
|
|
14345
|
+
"startIndex": {
|
|
14346
|
+
"description": "Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).",
|
|
14347
|
+
"format": "int64",
|
|
14348
|
+
"type": "string"
|
|
14349
|
+
}
|
|
14350
|
+
},
|
|
14351
|
+
"type": "object"
|
|
14352
|
+
},
|
|
13702
14353
|
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequest": {
|
|
13703
14354
|
"description": "Request message for ConversationalSearchService.AnswerQuery method.",
|
|
13704
14355
|
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest",
|
|
@@ -13895,6 +14546,31 @@
|
|
|
13895
14546
|
"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.",
|
|
13896
14547
|
"format": "int32",
|
|
13897
14548
|
"type": "integer"
|
|
14549
|
+
},
|
|
14550
|
+
"modelSpec": {
|
|
14551
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec",
|
|
14552
|
+
"description": "Optional. Query Rephraser Model specification."
|
|
14553
|
+
}
|
|
14554
|
+
},
|
|
14555
|
+
"type": "object"
|
|
14556
|
+
},
|
|
14557
|
+
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec": {
|
|
14558
|
+
"description": "Query Rephraser Model specification.",
|
|
14559
|
+
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec",
|
|
14560
|
+
"properties": {
|
|
14561
|
+
"modelType": {
|
|
14562
|
+
"description": "Optional. Enabled query rephraser model type. If not set, it will use LARGE by default.",
|
|
14563
|
+
"enum": [
|
|
14564
|
+
"MODEL_TYPE_UNSPECIFIED",
|
|
14565
|
+
"SMALL",
|
|
14566
|
+
"LARGE"
|
|
14567
|
+
],
|
|
14568
|
+
"enumDescriptions": [
|
|
14569
|
+
"Unspecified model type.",
|
|
14570
|
+
"Small query rephraser model. Gemini 1.0 XS model.",
|
|
14571
|
+
"Large query rephraser model. Gemini 1.0 Pro model."
|
|
14572
|
+
],
|
|
14573
|
+
"type": "string"
|
|
13898
14574
|
}
|
|
13899
14575
|
},
|
|
13900
14576
|
"type": "object"
|
|
@@ -13911,7 +14587,7 @@
|
|
|
13911
14587
|
"type": "object"
|
|
13912
14588
|
},
|
|
13913
14589
|
"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec": {
|
|
13914
|
-
"description": "Safety specification.",
|
|
14590
|
+
"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.",
|
|
13915
14591
|
"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec",
|
|
13916
14592
|
"properties": {
|
|
13917
14593
|
"enable": {
|
|
@@ -15289,6 +15965,10 @@
|
|
|
15289
15965
|
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
|
|
15290
15966
|
"type": "string"
|
|
15291
15967
|
},
|
|
15968
|
+
"promoteAction": {
|
|
15969
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControlPromoteAction",
|
|
15970
|
+
"description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
|
|
15971
|
+
},
|
|
15292
15972
|
"redirectAction": {
|
|
15293
15973
|
"$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction",
|
|
15294
15974
|
"description": "Defines a redirect-type control."
|
|
@@ -15370,6 +16050,21 @@
|
|
|
15370
16050
|
},
|
|
15371
16051
|
"type": "object"
|
|
15372
16052
|
},
|
|
16053
|
+
"GoogleCloudDiscoveryengineV1betaControlPromoteAction": {
|
|
16054
|
+
"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.",
|
|
16055
|
+
"id": "GoogleCloudDiscoveryengineV1betaControlPromoteAction",
|
|
16056
|
+
"properties": {
|
|
16057
|
+
"dataStore": {
|
|
16058
|
+
"description": "Required. Data store with which this promotion is attached to.",
|
|
16059
|
+
"type": "string"
|
|
16060
|
+
},
|
|
16061
|
+
"searchLinkPromotion": {
|
|
16062
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion",
|
|
16063
|
+
"description": "Required. Promotion attached to this action."
|
|
16064
|
+
}
|
|
16065
|
+
},
|
|
16066
|
+
"type": "object"
|
|
16067
|
+
},
|
|
15373
16068
|
"GoogleCloudDiscoveryengineV1betaControlRedirectAction": {
|
|
15374
16069
|
"description": "Redirects a shopper to the provided URI.",
|
|
15375
16070
|
"id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction",
|
|
@@ -16369,7 +17064,7 @@
|
|
|
16369
17064
|
"type": "string"
|
|
16370
17065
|
},
|
|
16371
17066
|
"industryVertical": {
|
|
16372
|
-
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore:
|
|
17067
|
+
"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.",
|
|
16373
17068
|
"enum": [
|
|
16374
17069
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
16375
17070
|
"GENERIC",
|
|
@@ -16698,6 +17393,10 @@
|
|
|
16698
17393
|
"type": "string"
|
|
16699
17394
|
},
|
|
16700
17395
|
"type": "array"
|
|
17396
|
+
},
|
|
17397
|
+
"updateFromLatestPredefinedSchema": {
|
|
17398
|
+
"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.",
|
|
17399
|
+
"type": "boolean"
|
|
16701
17400
|
}
|
|
16702
17401
|
},
|
|
16703
17402
|
"type": "object"
|
|
@@ -17913,7 +18612,7 @@
|
|
|
17913
18612
|
"id": "GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest",
|
|
17914
18613
|
"properties": {
|
|
17915
18614
|
"filter": {
|
|
17916
|
-
"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
|
|
18615
|
+
"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.",
|
|
17917
18616
|
"type": "string"
|
|
17918
18617
|
},
|
|
17919
18618
|
"force": {
|
|
@@ -18073,7 +18772,7 @@
|
|
|
18073
18772
|
"id": "GoogleCloudDiscoveryengineV1betaRecommendRequest",
|
|
18074
18773
|
"properties": {
|
|
18075
18774
|
"filter": {
|
|
18076
|
-
"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: * (
|
|
18775
|
+
"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.",
|
|
18077
18776
|
"type": "string"
|
|
18078
18777
|
},
|
|
18079
18778
|
"pageSize": {
|
|
@@ -18362,6 +19061,33 @@
|
|
|
18362
19061
|
},
|
|
18363
19062
|
"type": "object"
|
|
18364
19063
|
},
|
|
19064
|
+
"GoogleCloudDiscoveryengineV1betaSearchLinkPromotion": {
|
|
19065
|
+
"description": "Promotion proto includes uri and other helping information to display the promotion.",
|
|
19066
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion",
|
|
19067
|
+
"properties": {
|
|
19068
|
+
"description": {
|
|
19069
|
+
"description": "Optional. The Promotion description. Maximum length: 200 characters.",
|
|
19070
|
+
"type": "string"
|
|
19071
|
+
},
|
|
19072
|
+
"enabled": {
|
|
19073
|
+
"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.",
|
|
19074
|
+
"type": "boolean"
|
|
19075
|
+
},
|
|
19076
|
+
"imageUri": {
|
|
19077
|
+
"description": "Optional. The promotion thumbnail image url.",
|
|
19078
|
+
"type": "string"
|
|
19079
|
+
},
|
|
19080
|
+
"title": {
|
|
19081
|
+
"description": "Required. The title of the promotion. Maximum length: 160 characters.",
|
|
19082
|
+
"type": "string"
|
|
19083
|
+
},
|
|
19084
|
+
"uri": {
|
|
19085
|
+
"description": "Required. The URL for the page the user wants to promote.",
|
|
19086
|
+
"type": "string"
|
|
19087
|
+
}
|
|
19088
|
+
},
|
|
19089
|
+
"type": "object"
|
|
19090
|
+
},
|
|
18365
19091
|
"GoogleCloudDiscoveryengineV1betaSearchRequest": {
|
|
18366
19092
|
"description": "Request message for SearchService.Search method.",
|
|
18367
19093
|
"id": "GoogleCloudDiscoveryengineV1betaSearchRequest",
|
|
@@ -18383,7 +19109,7 @@
|
|
|
18383
19109
|
"description": "A specification for configuring the behavior of content search."
|
|
18384
19110
|
},
|
|
18385
19111
|
"dataStoreSpecs": {
|
|
18386
|
-
"description": "Specs defining
|
|
19112
|
+
"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.",
|
|
18387
19113
|
"items": {
|
|
18388
19114
|
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec"
|
|
18389
19115
|
},
|
|
@@ -18801,6 +19527,10 @@
|
|
|
18801
19527
|
"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.",
|
|
18802
19528
|
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec",
|
|
18803
19529
|
"properties": {
|
|
19530
|
+
"boostSpec": {
|
|
19531
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
|
|
19532
|
+
"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)"
|
|
19533
|
+
},
|
|
18804
19534
|
"dataStore": {
|
|
18805
19535
|
"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
|
|
18806
19536
|
"type": "string"
|
|
@@ -19128,6 +19858,13 @@
|
|
|
19128
19858
|
},
|
|
19129
19859
|
"type": "array"
|
|
19130
19860
|
},
|
|
19861
|
+
"searchLinkPromotions": {
|
|
19862
|
+
"description": "Promotions for site search.",
|
|
19863
|
+
"items": {
|
|
19864
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion"
|
|
19865
|
+
},
|
|
19866
|
+
"type": "array"
|
|
19867
|
+
},
|
|
19131
19868
|
"sessionInfo": {
|
|
19132
19869
|
"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo",
|
|
19133
19870
|
"description": "Session information. Only set if SearchRequest.session is provided. See its description for more details."
|
|
@@ -19765,6 +20502,13 @@
|
|
|
19765
20502
|
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec",
|
|
19766
20503
|
"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."
|
|
19767
20504
|
},
|
|
20505
|
+
"promoteControlIds": {
|
|
20506
|
+
"description": "Condition promote specifications. Maximum number of specifications is 100.",
|
|
20507
|
+
"items": {
|
|
20508
|
+
"type": "string"
|
|
20509
|
+
},
|
|
20510
|
+
"type": "array"
|
|
20511
|
+
},
|
|
19768
20512
|
"rankingExpression": {
|
|
19769
20513
|
"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)`.",
|
|
19770
20514
|
"type": "string"
|
|
@@ -19863,12 +20607,20 @@
|
|
|
19863
20607
|
"description": "External session proto definition.",
|
|
19864
20608
|
"id": "GoogleCloudDiscoveryengineV1betaSession",
|
|
19865
20609
|
"properties": {
|
|
20610
|
+
"displayName": {
|
|
20611
|
+
"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.",
|
|
20612
|
+
"type": "string"
|
|
20613
|
+
},
|
|
19866
20614
|
"endTime": {
|
|
19867
20615
|
"description": "Output only. The time the session finished.",
|
|
19868
20616
|
"format": "google-datetime",
|
|
19869
20617
|
"readOnly": true,
|
|
19870
20618
|
"type": "string"
|
|
19871
20619
|
},
|
|
20620
|
+
"isPinned": {
|
|
20621
|
+
"description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.",
|
|
20622
|
+
"type": "boolean"
|
|
20623
|
+
},
|
|
19872
20624
|
"name": {
|
|
19873
20625
|
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
|
|
19874
20626
|
"type": "string"
|