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": "v1/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",
|
|
@@ -1719,6 +1719,40 @@
|
|
|
1719
1719
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
1720
1720
|
]
|
|
1721
1721
|
},
|
|
1722
|
+
"patch": {
|
|
1723
|
+
"description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.",
|
|
1724
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}",
|
|
1725
|
+
"httpMethod": "PATCH",
|
|
1726
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.patch",
|
|
1727
|
+
"parameterOrder": [
|
|
1728
|
+
"name"
|
|
1729
|
+
],
|
|
1730
|
+
"parameters": {
|
|
1731
|
+
"name": {
|
|
1732
|
+
"description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`",
|
|
1733
|
+
"location": "path",
|
|
1734
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
|
|
1735
|
+
"required": true,
|
|
1736
|
+
"type": "string"
|
|
1737
|
+
},
|
|
1738
|
+
"updateMask": {
|
|
1739
|
+
"description": "Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.",
|
|
1740
|
+
"format": "google-fieldmask",
|
|
1741
|
+
"location": "query",
|
|
1742
|
+
"type": "string"
|
|
1743
|
+
}
|
|
1744
|
+
},
|
|
1745
|
+
"path": "v1/{+name}",
|
|
1746
|
+
"request": {
|
|
1747
|
+
"$ref": "GoogleCloudDiscoveryengineV1ServingConfig"
|
|
1748
|
+
},
|
|
1749
|
+
"response": {
|
|
1750
|
+
"$ref": "GoogleCloudDiscoveryengineV1ServingConfig"
|
|
1751
|
+
},
|
|
1752
|
+
"scopes": [
|
|
1753
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1754
|
+
]
|
|
1755
|
+
},
|
|
1722
1756
|
"recommend": {
|
|
1723
1757
|
"description": "Makes a recommendation, which requires a contextual user event.",
|
|
1724
1758
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend",
|
|
@@ -1802,6 +1836,34 @@
|
|
|
1802
1836
|
"scopes": [
|
|
1803
1837
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
1804
1838
|
]
|
|
1839
|
+
},
|
|
1840
|
+
"streamAnswer": {
|
|
1841
|
+
"description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.",
|
|
1842
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:streamAnswer",
|
|
1843
|
+
"httpMethod": "POST",
|
|
1844
|
+
"id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.streamAnswer",
|
|
1845
|
+
"parameterOrder": [
|
|
1846
|
+
"servingConfig"
|
|
1847
|
+
],
|
|
1848
|
+
"parameters": {
|
|
1849
|
+
"servingConfig": {
|
|
1850
|
+
"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.",
|
|
1851
|
+
"location": "path",
|
|
1852
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
|
|
1853
|
+
"required": true,
|
|
1854
|
+
"type": "string"
|
|
1855
|
+
}
|
|
1856
|
+
},
|
|
1857
|
+
"path": "v1/{+servingConfig}:streamAnswer",
|
|
1858
|
+
"request": {
|
|
1859
|
+
"$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequest"
|
|
1860
|
+
},
|
|
1861
|
+
"response": {
|
|
1862
|
+
"$ref": "GoogleCloudDiscoveryengineV1AnswerQueryResponse"
|
|
1863
|
+
},
|
|
1864
|
+
"scopes": [
|
|
1865
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
1866
|
+
]
|
|
1805
1867
|
}
|
|
1806
1868
|
}
|
|
1807
1869
|
},
|
|
@@ -1869,6 +1931,11 @@
|
|
|
1869
1931
|
"name"
|
|
1870
1932
|
],
|
|
1871
1933
|
"parameters": {
|
|
1934
|
+
"includeAnswerDetails": {
|
|
1935
|
+
"description": "Optional. If set to true, the full session including all answer details will be returned.",
|
|
1936
|
+
"location": "query",
|
|
1937
|
+
"type": "boolean"
|
|
1938
|
+
},
|
|
1872
1939
|
"name": {
|
|
1873
1940
|
"description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
1874
1941
|
"location": "path",
|
|
@@ -1900,7 +1967,7 @@
|
|
|
1900
1967
|
"type": "string"
|
|
1901
1968
|
},
|
|
1902
1969
|
"orderBy": {
|
|
1903
|
-
"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\"",
|
|
1970
|
+
"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.",
|
|
1904
1971
|
"location": "query",
|
|
1905
1972
|
"type": "string"
|
|
1906
1973
|
},
|
|
@@ -2546,7 +2613,7 @@
|
|
|
2546
2613
|
"type": "string"
|
|
2547
2614
|
},
|
|
2548
2615
|
"parent": {
|
|
2549
|
-
"description": "Required. The parent
|
|
2616
|
+
"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}`.",
|
|
2550
2617
|
"location": "path",
|
|
2551
2618
|
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
|
|
2552
2619
|
"required": true,
|
|
@@ -3278,6 +3345,40 @@
|
|
|
3278
3345
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
3279
3346
|
]
|
|
3280
3347
|
},
|
|
3348
|
+
"patch": {
|
|
3349
|
+
"description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.",
|
|
3350
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}",
|
|
3351
|
+
"httpMethod": "PATCH",
|
|
3352
|
+
"id": "discoveryengine.projects.locations.collections.engines.servingConfigs.patch",
|
|
3353
|
+
"parameterOrder": [
|
|
3354
|
+
"name"
|
|
3355
|
+
],
|
|
3356
|
+
"parameters": {
|
|
3357
|
+
"name": {
|
|
3358
|
+
"description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`",
|
|
3359
|
+
"location": "path",
|
|
3360
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
|
|
3361
|
+
"required": true,
|
|
3362
|
+
"type": "string"
|
|
3363
|
+
},
|
|
3364
|
+
"updateMask": {
|
|
3365
|
+
"description": "Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.",
|
|
3366
|
+
"format": "google-fieldmask",
|
|
3367
|
+
"location": "query",
|
|
3368
|
+
"type": "string"
|
|
3369
|
+
}
|
|
3370
|
+
},
|
|
3371
|
+
"path": "v1/{+name}",
|
|
3372
|
+
"request": {
|
|
3373
|
+
"$ref": "GoogleCloudDiscoveryengineV1ServingConfig"
|
|
3374
|
+
},
|
|
3375
|
+
"response": {
|
|
3376
|
+
"$ref": "GoogleCloudDiscoveryengineV1ServingConfig"
|
|
3377
|
+
},
|
|
3378
|
+
"scopes": [
|
|
3379
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
3380
|
+
]
|
|
3381
|
+
},
|
|
3281
3382
|
"recommend": {
|
|
3282
3383
|
"description": "Makes a recommendation, which requires a contextual user event.",
|
|
3283
3384
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:recommend",
|
|
@@ -3361,6 +3462,34 @@
|
|
|
3361
3462
|
"scopes": [
|
|
3362
3463
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
3363
3464
|
]
|
|
3465
|
+
},
|
|
3466
|
+
"streamAnswer": {
|
|
3467
|
+
"description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.",
|
|
3468
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:streamAnswer",
|
|
3469
|
+
"httpMethod": "POST",
|
|
3470
|
+
"id": "discoveryengine.projects.locations.collections.engines.servingConfigs.streamAnswer",
|
|
3471
|
+
"parameterOrder": [
|
|
3472
|
+
"servingConfig"
|
|
3473
|
+
],
|
|
3474
|
+
"parameters": {
|
|
3475
|
+
"servingConfig": {
|
|
3476
|
+
"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.",
|
|
3477
|
+
"location": "path",
|
|
3478
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
|
|
3479
|
+
"required": true,
|
|
3480
|
+
"type": "string"
|
|
3481
|
+
}
|
|
3482
|
+
},
|
|
3483
|
+
"path": "v1/{+servingConfig}:streamAnswer",
|
|
3484
|
+
"request": {
|
|
3485
|
+
"$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequest"
|
|
3486
|
+
},
|
|
3487
|
+
"response": {
|
|
3488
|
+
"$ref": "GoogleCloudDiscoveryengineV1AnswerQueryResponse"
|
|
3489
|
+
},
|
|
3490
|
+
"scopes": [
|
|
3491
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
3492
|
+
]
|
|
3364
3493
|
}
|
|
3365
3494
|
}
|
|
3366
3495
|
},
|
|
@@ -3428,6 +3557,11 @@
|
|
|
3428
3557
|
"name"
|
|
3429
3558
|
],
|
|
3430
3559
|
"parameters": {
|
|
3560
|
+
"includeAnswerDetails": {
|
|
3561
|
+
"description": "Optional. If set to true, the full session including all answer details will be returned.",
|
|
3562
|
+
"location": "query",
|
|
3563
|
+
"type": "boolean"
|
|
3564
|
+
},
|
|
3431
3565
|
"name": {
|
|
3432
3566
|
"description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
3433
3567
|
"location": "path",
|
|
@@ -3459,7 +3593,7 @@
|
|
|
3459
3593
|
"type": "string"
|
|
3460
3594
|
},
|
|
3461
3595
|
"orderBy": {
|
|
3462
|
-
"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\"",
|
|
3596
|
+
"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.",
|
|
3463
3597
|
"location": "query",
|
|
3464
3598
|
"type": "string"
|
|
3465
3599
|
},
|
|
@@ -4145,7 +4279,7 @@
|
|
|
4145
4279
|
"operations": {
|
|
4146
4280
|
"methods": {
|
|
4147
4281
|
"cancel": {
|
|
4148
|
-
"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
|
|
4282
|
+
"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`.",
|
|
4149
4283
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel",
|
|
4150
4284
|
"httpMethod": "POST",
|
|
4151
4285
|
"id": "discoveryengine.projects.locations.dataStores.branches.operations.cancel",
|
|
@@ -4984,6 +5118,40 @@
|
|
|
4984
5118
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
4985
5119
|
]
|
|
4986
5120
|
},
|
|
5121
|
+
"patch": {
|
|
5122
|
+
"description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.",
|
|
5123
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}",
|
|
5124
|
+
"httpMethod": "PATCH",
|
|
5125
|
+
"id": "discoveryengine.projects.locations.dataStores.servingConfigs.patch",
|
|
5126
|
+
"parameterOrder": [
|
|
5127
|
+
"name"
|
|
5128
|
+
],
|
|
5129
|
+
"parameters": {
|
|
5130
|
+
"name": {
|
|
5131
|
+
"description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`",
|
|
5132
|
+
"location": "path",
|
|
5133
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
|
|
5134
|
+
"required": true,
|
|
5135
|
+
"type": "string"
|
|
5136
|
+
},
|
|
5137
|
+
"updateMask": {
|
|
5138
|
+
"description": "Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.",
|
|
5139
|
+
"format": "google-fieldmask",
|
|
5140
|
+
"location": "query",
|
|
5141
|
+
"type": "string"
|
|
5142
|
+
}
|
|
5143
|
+
},
|
|
5144
|
+
"path": "v1/{+name}",
|
|
5145
|
+
"request": {
|
|
5146
|
+
"$ref": "GoogleCloudDiscoveryengineV1ServingConfig"
|
|
5147
|
+
},
|
|
5148
|
+
"response": {
|
|
5149
|
+
"$ref": "GoogleCloudDiscoveryengineV1ServingConfig"
|
|
5150
|
+
},
|
|
5151
|
+
"scopes": [
|
|
5152
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
5153
|
+
]
|
|
5154
|
+
},
|
|
4987
5155
|
"recommend": {
|
|
4988
5156
|
"description": "Makes a recommendation, which requires a contextual user event.",
|
|
4989
5157
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend",
|
|
@@ -5067,6 +5235,34 @@
|
|
|
5067
5235
|
"scopes": [
|
|
5068
5236
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
5069
5237
|
]
|
|
5238
|
+
},
|
|
5239
|
+
"streamAnswer": {
|
|
5240
|
+
"description": "Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.",
|
|
5241
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:streamAnswer",
|
|
5242
|
+
"httpMethod": "POST",
|
|
5243
|
+
"id": "discoveryengine.projects.locations.dataStores.servingConfigs.streamAnswer",
|
|
5244
|
+
"parameterOrder": [
|
|
5245
|
+
"servingConfig"
|
|
5246
|
+
],
|
|
5247
|
+
"parameters": {
|
|
5248
|
+
"servingConfig": {
|
|
5249
|
+
"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.",
|
|
5250
|
+
"location": "path",
|
|
5251
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
|
|
5252
|
+
"required": true,
|
|
5253
|
+
"type": "string"
|
|
5254
|
+
}
|
|
5255
|
+
},
|
|
5256
|
+
"path": "v1/{+servingConfig}:streamAnswer",
|
|
5257
|
+
"request": {
|
|
5258
|
+
"$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequest"
|
|
5259
|
+
},
|
|
5260
|
+
"response": {
|
|
5261
|
+
"$ref": "GoogleCloudDiscoveryengineV1AnswerQueryResponse"
|
|
5262
|
+
},
|
|
5263
|
+
"scopes": [
|
|
5264
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
5265
|
+
]
|
|
5070
5266
|
}
|
|
5071
5267
|
}
|
|
5072
5268
|
},
|
|
@@ -5134,6 +5330,11 @@
|
|
|
5134
5330
|
"name"
|
|
5135
5331
|
],
|
|
5136
5332
|
"parameters": {
|
|
5333
|
+
"includeAnswerDetails": {
|
|
5334
|
+
"description": "Optional. If set to true, the full session including all answer details will be returned.",
|
|
5335
|
+
"location": "query",
|
|
5336
|
+
"type": "boolean"
|
|
5337
|
+
},
|
|
5137
5338
|
"name": {
|
|
5138
5339
|
"description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
5139
5340
|
"location": "path",
|
|
@@ -5165,7 +5366,7 @@
|
|
|
5165
5366
|
"type": "string"
|
|
5166
5367
|
},
|
|
5167
5368
|
"orderBy": {
|
|
5168
|
-
"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\"",
|
|
5369
|
+
"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.",
|
|
5169
5370
|
"location": "query",
|
|
5170
5371
|
"type": "string"
|
|
5171
5372
|
},
|
|
@@ -5605,7 +5806,7 @@
|
|
|
5605
5806
|
"type": "string"
|
|
5606
5807
|
},
|
|
5607
5808
|
"parent": {
|
|
5608
|
-
"description": "Required. The parent
|
|
5809
|
+
"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}`.",
|
|
5609
5810
|
"location": "path",
|
|
5610
5811
|
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
5611
5812
|
"required": true,
|
|
@@ -5949,7 +6150,7 @@
|
|
|
5949
6150
|
"type": "string"
|
|
5950
6151
|
},
|
|
5951
6152
|
"parent": {
|
|
5952
|
-
"description": "Required. The parent
|
|
6153
|
+
"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}`.",
|
|
5953
6154
|
"location": "path",
|
|
5954
6155
|
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
5955
6156
|
"required": true,
|
|
@@ -6042,7 +6243,7 @@
|
|
|
6042
6243
|
"operations": {
|
|
6043
6244
|
"methods": {
|
|
6044
6245
|
"cancel": {
|
|
6045
|
-
"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
|
|
6246
|
+
"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`.",
|
|
6046
6247
|
"flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel",
|
|
6047
6248
|
"httpMethod": "POST",
|
|
6048
6249
|
"id": "discoveryengine.projects.operations.cancel",
|
|
@@ -6140,7 +6341,7 @@
|
|
|
6140
6341
|
}
|
|
6141
6342
|
}
|
|
6142
6343
|
},
|
|
6143
|
-
"revision": "
|
|
6344
|
+
"revision": "20241210",
|
|
6144
6345
|
"rootUrl": "https://discoveryengine.googleapis.com/",
|
|
6145
6346
|
"schemas": {
|
|
6146
6347
|
"GoogleApiDistribution": {
|
|
@@ -6610,6 +6811,18 @@
|
|
|
6610
6811
|
"readOnly": true,
|
|
6611
6812
|
"type": "string"
|
|
6612
6813
|
},
|
|
6814
|
+
"groundingScore": {
|
|
6815
|
+
"description": "A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.",
|
|
6816
|
+
"format": "double",
|
|
6817
|
+
"type": "number"
|
|
6818
|
+
},
|
|
6819
|
+
"groundingSupports": {
|
|
6820
|
+
"description": "Optional. Grounding supports.",
|
|
6821
|
+
"items": {
|
|
6822
|
+
"$ref": "GoogleCloudDiscoveryengineV1AnswerGroundingSupport"
|
|
6823
|
+
},
|
|
6824
|
+
"type": "array"
|
|
6825
|
+
},
|
|
6613
6826
|
"name": {
|
|
6614
6827
|
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`",
|
|
6615
6828
|
"type": "string"
|
|
@@ -6638,13 +6851,15 @@
|
|
|
6638
6851
|
"STATE_UNSPECIFIED",
|
|
6639
6852
|
"IN_PROGRESS",
|
|
6640
6853
|
"FAILED",
|
|
6641
|
-
"SUCCEEDED"
|
|
6854
|
+
"SUCCEEDED",
|
|
6855
|
+
"STREAMING"
|
|
6642
6856
|
],
|
|
6643
6857
|
"enumDescriptions": [
|
|
6644
6858
|
"Unknown.",
|
|
6645
6859
|
"Answer generation is currently in progress.",
|
|
6646
6860
|
"Answer generation currently failed.",
|
|
6647
|
-
"Answer generation has succeeded."
|
|
6861
|
+
"Answer generation has succeeded.",
|
|
6862
|
+
"Answer generation is currently in progress."
|
|
6648
6863
|
],
|
|
6649
6864
|
"type": "string"
|
|
6650
6865
|
},
|
|
@@ -6693,6 +6908,39 @@
|
|
|
6693
6908
|
},
|
|
6694
6909
|
"type": "object"
|
|
6695
6910
|
},
|
|
6911
|
+
"GoogleCloudDiscoveryengineV1AnswerGroundingSupport": {
|
|
6912
|
+
"description": "Grounding support for a claim in `answer_text`.",
|
|
6913
|
+
"id": "GoogleCloudDiscoveryengineV1AnswerGroundingSupport",
|
|
6914
|
+
"properties": {
|
|
6915
|
+
"endIndex": {
|
|
6916
|
+
"description": "Required. End of the claim, exclusive.",
|
|
6917
|
+
"format": "int64",
|
|
6918
|
+
"type": "string"
|
|
6919
|
+
},
|
|
6920
|
+
"groundingCheckRequired": {
|
|
6921
|
+
"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.",
|
|
6922
|
+
"type": "boolean"
|
|
6923
|
+
},
|
|
6924
|
+
"groundingScore": {
|
|
6925
|
+
"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.",
|
|
6926
|
+
"format": "double",
|
|
6927
|
+
"type": "number"
|
|
6928
|
+
},
|
|
6929
|
+
"sources": {
|
|
6930
|
+
"description": "Optional. Citation sources for the claim.",
|
|
6931
|
+
"items": {
|
|
6932
|
+
"$ref": "GoogleCloudDiscoveryengineV1AnswerCitationSource"
|
|
6933
|
+
},
|
|
6934
|
+
"type": "array"
|
|
6935
|
+
},
|
|
6936
|
+
"startIndex": {
|
|
6937
|
+
"description": "Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).",
|
|
6938
|
+
"format": "int64",
|
|
6939
|
+
"type": "string"
|
|
6940
|
+
}
|
|
6941
|
+
},
|
|
6942
|
+
"type": "object"
|
|
6943
|
+
},
|
|
6696
6944
|
"GoogleCloudDiscoveryengineV1AnswerQueryRequest": {
|
|
6697
6945
|
"description": "Request message for ConversationalSearchService.AnswerQuery method.",
|
|
6698
6946
|
"id": "GoogleCloudDiscoveryengineV1AnswerQueryRequest",
|
|
@@ -6889,6 +7137,31 @@
|
|
|
6889
7137
|
"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.",
|
|
6890
7138
|
"format": "int32",
|
|
6891
7139
|
"type": "integer"
|
|
7140
|
+
},
|
|
7141
|
+
"modelSpec": {
|
|
7142
|
+
"$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec",
|
|
7143
|
+
"description": "Optional. Query Rephraser Model specification."
|
|
7144
|
+
}
|
|
7145
|
+
},
|
|
7146
|
+
"type": "object"
|
|
7147
|
+
},
|
|
7148
|
+
"GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec": {
|
|
7149
|
+
"description": "Query Rephraser Model specification.",
|
|
7150
|
+
"id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec",
|
|
7151
|
+
"properties": {
|
|
7152
|
+
"modelType": {
|
|
7153
|
+
"description": "Optional. Enabled query rephraser model type. If not set, it will use LARGE by default.",
|
|
7154
|
+
"enum": [
|
|
7155
|
+
"MODEL_TYPE_UNSPECIFIED",
|
|
7156
|
+
"SMALL",
|
|
7157
|
+
"LARGE"
|
|
7158
|
+
],
|
|
7159
|
+
"enumDescriptions": [
|
|
7160
|
+
"Unspecified model type.",
|
|
7161
|
+
"Small query rephraser model. Gemini 1.0 XS model.",
|
|
7162
|
+
"Large query rephraser model. Gemini 1.0 Pro model."
|
|
7163
|
+
],
|
|
7164
|
+
"type": "string"
|
|
6892
7165
|
}
|
|
6893
7166
|
},
|
|
6894
7167
|
"type": "object"
|
|
@@ -6905,7 +7178,7 @@
|
|
|
6905
7178
|
"type": "object"
|
|
6906
7179
|
},
|
|
6907
7180
|
"GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec": {
|
|
6908
|
-
"description": "Safety specification.",
|
|
7181
|
+
"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.",
|
|
6909
7182
|
"id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec",
|
|
6910
7183
|
"properties": {
|
|
6911
7184
|
"enable": {
|
|
@@ -8279,6 +8552,10 @@
|
|
|
8279
8552
|
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
|
|
8280
8553
|
"type": "string"
|
|
8281
8554
|
},
|
|
8555
|
+
"promoteAction": {
|
|
8556
|
+
"$ref": "GoogleCloudDiscoveryengineV1ControlPromoteAction",
|
|
8557
|
+
"description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
|
|
8558
|
+
},
|
|
8282
8559
|
"redirectAction": {
|
|
8283
8560
|
"$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction",
|
|
8284
8561
|
"description": "Defines a redirect-type control."
|
|
@@ -8360,6 +8637,21 @@
|
|
|
8360
8637
|
},
|
|
8361
8638
|
"type": "object"
|
|
8362
8639
|
},
|
|
8640
|
+
"GoogleCloudDiscoveryengineV1ControlPromoteAction": {
|
|
8641
|
+
"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.",
|
|
8642
|
+
"id": "GoogleCloudDiscoveryengineV1ControlPromoteAction",
|
|
8643
|
+
"properties": {
|
|
8644
|
+
"dataStore": {
|
|
8645
|
+
"description": "Required. Data store with which this promotion is attached to.",
|
|
8646
|
+
"type": "string"
|
|
8647
|
+
},
|
|
8648
|
+
"searchLinkPromotion": {
|
|
8649
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchLinkPromotion",
|
|
8650
|
+
"description": "Required. Promotion attached to this action."
|
|
8651
|
+
}
|
|
8652
|
+
},
|
|
8653
|
+
"type": "object"
|
|
8654
|
+
},
|
|
8363
8655
|
"GoogleCloudDiscoveryengineV1ControlRedirectAction": {
|
|
8364
8656
|
"description": "Redirects a shopper to the provided URI.",
|
|
8365
8657
|
"id": "GoogleCloudDiscoveryengineV1ControlRedirectAction",
|
|
@@ -9278,7 +9570,7 @@
|
|
|
9278
9570
|
"type": "string"
|
|
9279
9571
|
},
|
|
9280
9572
|
"industryVertical": {
|
|
9281
|
-
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore:
|
|
9573
|
+
"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.",
|
|
9282
9574
|
"enum": [
|
|
9283
9575
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
9284
9576
|
"GENERIC",
|
|
@@ -9492,6 +9784,10 @@
|
|
|
9492
9784
|
"type": "string"
|
|
9493
9785
|
},
|
|
9494
9786
|
"type": "array"
|
|
9787
|
+
},
|
|
9788
|
+
"updateFromLatestPredefinedSchema": {
|
|
9789
|
+
"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.",
|
|
9790
|
+
"type": "boolean"
|
|
9495
9791
|
}
|
|
9496
9792
|
},
|
|
9497
9793
|
"type": "object"
|
|
@@ -10495,7 +10791,7 @@
|
|
|
10495
10791
|
"id": "GoogleCloudDiscoveryengineV1PurgeUserEventsRequest",
|
|
10496
10792
|
"properties": {
|
|
10497
10793
|
"filter": {
|
|
10498
|
-
"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
|
|
10794
|
+
"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.",
|
|
10499
10795
|
"type": "string"
|
|
10500
10796
|
},
|
|
10501
10797
|
"force": {
|
|
@@ -10601,7 +10897,7 @@
|
|
|
10601
10897
|
"id": "GoogleCloudDiscoveryengineV1RecommendRequest",
|
|
10602
10898
|
"properties": {
|
|
10603
10899
|
"filter": {
|
|
10604
|
-
"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: * (
|
|
10900
|
+
"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.",
|
|
10605
10901
|
"type": "string"
|
|
10606
10902
|
},
|
|
10607
10903
|
"pageSize": {
|
|
@@ -10757,6 +11053,33 @@
|
|
|
10757
11053
|
},
|
|
10758
11054
|
"type": "object"
|
|
10759
11055
|
},
|
|
11056
|
+
"GoogleCloudDiscoveryengineV1SearchLinkPromotion": {
|
|
11057
|
+
"description": "Promotion proto includes uri and other helping information to display the promotion.",
|
|
11058
|
+
"id": "GoogleCloudDiscoveryengineV1SearchLinkPromotion",
|
|
11059
|
+
"properties": {
|
|
11060
|
+
"description": {
|
|
11061
|
+
"description": "Optional. The Promotion description. Maximum length: 200 characters.",
|
|
11062
|
+
"type": "string"
|
|
11063
|
+
},
|
|
11064
|
+
"enabled": {
|
|
11065
|
+
"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.",
|
|
11066
|
+
"type": "boolean"
|
|
11067
|
+
},
|
|
11068
|
+
"imageUri": {
|
|
11069
|
+
"description": "Optional. The promotion thumbnail image url.",
|
|
11070
|
+
"type": "string"
|
|
11071
|
+
},
|
|
11072
|
+
"title": {
|
|
11073
|
+
"description": "Required. The title of the promotion. Maximum length: 160 characters.",
|
|
11074
|
+
"type": "string"
|
|
11075
|
+
},
|
|
11076
|
+
"uri": {
|
|
11077
|
+
"description": "Required. The URL for the page the user wants to promote.",
|
|
11078
|
+
"type": "string"
|
|
11079
|
+
}
|
|
11080
|
+
},
|
|
11081
|
+
"type": "object"
|
|
11082
|
+
},
|
|
10760
11083
|
"GoogleCloudDiscoveryengineV1SearchRequest": {
|
|
10761
11084
|
"description": "Request message for SearchService.Search method.",
|
|
10762
11085
|
"id": "GoogleCloudDiscoveryengineV1SearchRequest",
|
|
@@ -10778,7 +11101,7 @@
|
|
|
10778
11101
|
"description": "A specification for configuring the behavior of content search."
|
|
10779
11102
|
},
|
|
10780
11103
|
"dataStoreSpecs": {
|
|
10781
|
-
"description": "Specs defining
|
|
11104
|
+
"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.",
|
|
10782
11105
|
"items": {
|
|
10783
11106
|
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec"
|
|
10784
11107
|
},
|
|
@@ -11154,6 +11477,10 @@
|
|
|
11154
11477
|
"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.",
|
|
11155
11478
|
"id": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec",
|
|
11156
11479
|
"properties": {
|
|
11480
|
+
"boostSpec": {
|
|
11481
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpec",
|
|
11482
|
+
"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)"
|
|
11483
|
+
},
|
|
11157
11484
|
"dataStore": {
|
|
11158
11485
|
"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
|
|
11159
11486
|
"type": "string"
|
|
@@ -11371,6 +11698,13 @@
|
|
|
11371
11698
|
},
|
|
11372
11699
|
"type": "array"
|
|
11373
11700
|
},
|
|
11701
|
+
"searchLinkPromotions": {
|
|
11702
|
+
"description": "Promotions for site search.",
|
|
11703
|
+
"items": {
|
|
11704
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchLinkPromotion"
|
|
11705
|
+
},
|
|
11706
|
+
"type": "array"
|
|
11707
|
+
},
|
|
11374
11708
|
"sessionInfo": {
|
|
11375
11709
|
"$ref": "GoogleCloudDiscoveryengineV1SearchResponseSessionInfo",
|
|
11376
11710
|
"description": "Session information. Only set if SearchRequest.session is provided. See its description for more details."
|
|
@@ -11664,22 +11998,200 @@
|
|
|
11664
11998
|
},
|
|
11665
11999
|
"type": "object"
|
|
11666
12000
|
},
|
|
11667
|
-
"
|
|
11668
|
-
"description": "
|
|
11669
|
-
"id": "
|
|
12001
|
+
"GoogleCloudDiscoveryengineV1ServingConfig": {
|
|
12002
|
+
"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.",
|
|
12003
|
+
"id": "GoogleCloudDiscoveryengineV1ServingConfig",
|
|
11670
12004
|
"properties": {
|
|
11671
|
-
"
|
|
11672
|
-
"description": "
|
|
11673
|
-
"
|
|
11674
|
-
"readOnly": true,
|
|
12005
|
+
"boostControlIds": {
|
|
12006
|
+
"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.",
|
|
12007
|
+
"items": {
|
|
11675
12008
|
"type": "string"
|
|
11676
12009
|
},
|
|
11677
|
-
"
|
|
11678
|
-
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
|
|
11679
|
-
"type": "string"
|
|
12010
|
+
"type": "array"
|
|
11680
12011
|
},
|
|
11681
|
-
"
|
|
11682
|
-
"description": "Output only.
|
|
12012
|
+
"createTime": {
|
|
12013
|
+
"description": "Output only. ServingConfig created timestamp.",
|
|
12014
|
+
"format": "google-datetime",
|
|
12015
|
+
"readOnly": true,
|
|
12016
|
+
"type": "string"
|
|
12017
|
+
},
|
|
12018
|
+
"displayName": {
|
|
12019
|
+
"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.",
|
|
12020
|
+
"type": "string"
|
|
12021
|
+
},
|
|
12022
|
+
"dissociateControlIds": {
|
|
12023
|
+
"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.",
|
|
12024
|
+
"items": {
|
|
12025
|
+
"type": "string"
|
|
12026
|
+
},
|
|
12027
|
+
"type": "array"
|
|
12028
|
+
},
|
|
12029
|
+
"diversityLevel": {
|
|
12030
|
+
"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.",
|
|
12031
|
+
"type": "string"
|
|
12032
|
+
},
|
|
12033
|
+
"filterControlIds": {
|
|
12034
|
+
"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.",
|
|
12035
|
+
"items": {
|
|
12036
|
+
"type": "string"
|
|
12037
|
+
},
|
|
12038
|
+
"type": "array"
|
|
12039
|
+
},
|
|
12040
|
+
"genericConfig": {
|
|
12041
|
+
"$ref": "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig",
|
|
12042
|
+
"description": "The GenericConfig of the serving configuration."
|
|
12043
|
+
},
|
|
12044
|
+
"ignoreControlIds": {
|
|
12045
|
+
"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.",
|
|
12046
|
+
"items": {
|
|
12047
|
+
"type": "string"
|
|
12048
|
+
},
|
|
12049
|
+
"type": "array"
|
|
12050
|
+
},
|
|
12051
|
+
"mediaConfig": {
|
|
12052
|
+
"$ref": "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig",
|
|
12053
|
+
"description": "The MediaConfig of the serving configuration."
|
|
12054
|
+
},
|
|
12055
|
+
"modelId": {
|
|
12056
|
+
"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.",
|
|
12057
|
+
"type": "string"
|
|
12058
|
+
},
|
|
12059
|
+
"name": {
|
|
12060
|
+
"description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`",
|
|
12061
|
+
"type": "string"
|
|
12062
|
+
},
|
|
12063
|
+
"onewaySynonymsControlIds": {
|
|
12064
|
+
"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.",
|
|
12065
|
+
"items": {
|
|
12066
|
+
"type": "string"
|
|
12067
|
+
},
|
|
12068
|
+
"type": "array"
|
|
12069
|
+
},
|
|
12070
|
+
"promoteControlIds": {
|
|
12071
|
+
"description": "Condition promote specifications. Maximum number of specifications is 100.",
|
|
12072
|
+
"items": {
|
|
12073
|
+
"type": "string"
|
|
12074
|
+
},
|
|
12075
|
+
"type": "array"
|
|
12076
|
+
},
|
|
12077
|
+
"rankingExpression": {
|
|
12078
|
+
"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)`.",
|
|
12079
|
+
"type": "string"
|
|
12080
|
+
},
|
|
12081
|
+
"redirectControlIds": {
|
|
12082
|
+
"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.",
|
|
12083
|
+
"items": {
|
|
12084
|
+
"type": "string"
|
|
12085
|
+
},
|
|
12086
|
+
"type": "array"
|
|
12087
|
+
},
|
|
12088
|
+
"replacementControlIds": {
|
|
12089
|
+
"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.",
|
|
12090
|
+
"items": {
|
|
12091
|
+
"type": "string"
|
|
12092
|
+
},
|
|
12093
|
+
"type": "array"
|
|
12094
|
+
},
|
|
12095
|
+
"solutionType": {
|
|
12096
|
+
"description": "Required. Immutable. Specifies the solution type that a serving config can be associated with.",
|
|
12097
|
+
"enum": [
|
|
12098
|
+
"SOLUTION_TYPE_UNSPECIFIED",
|
|
12099
|
+
"SOLUTION_TYPE_RECOMMENDATION",
|
|
12100
|
+
"SOLUTION_TYPE_SEARCH",
|
|
12101
|
+
"SOLUTION_TYPE_CHAT",
|
|
12102
|
+
"SOLUTION_TYPE_GENERATIVE_CHAT"
|
|
12103
|
+
],
|
|
12104
|
+
"enumDescriptions": [
|
|
12105
|
+
"Default value.",
|
|
12106
|
+
"Used for Recommendations AI.",
|
|
12107
|
+
"Used for Discovery Search.",
|
|
12108
|
+
"Used for use cases related to the Generative AI agent.",
|
|
12109
|
+
"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."
|
|
12110
|
+
],
|
|
12111
|
+
"type": "string"
|
|
12112
|
+
},
|
|
12113
|
+
"synonymsControlIds": {
|
|
12114
|
+
"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.",
|
|
12115
|
+
"items": {
|
|
12116
|
+
"type": "string"
|
|
12117
|
+
},
|
|
12118
|
+
"type": "array"
|
|
12119
|
+
},
|
|
12120
|
+
"updateTime": {
|
|
12121
|
+
"description": "Output only. ServingConfig updated timestamp.",
|
|
12122
|
+
"format": "google-datetime",
|
|
12123
|
+
"readOnly": true,
|
|
12124
|
+
"type": "string"
|
|
12125
|
+
}
|
|
12126
|
+
},
|
|
12127
|
+
"type": "object"
|
|
12128
|
+
},
|
|
12129
|
+
"GoogleCloudDiscoveryengineV1ServingConfigGenericConfig": {
|
|
12130
|
+
"description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.",
|
|
12131
|
+
"id": "GoogleCloudDiscoveryengineV1ServingConfigGenericConfig",
|
|
12132
|
+
"properties": {
|
|
12133
|
+
"contentSearchSpec": {
|
|
12134
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec",
|
|
12135
|
+
"description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store."
|
|
12136
|
+
}
|
|
12137
|
+
},
|
|
12138
|
+
"type": "object"
|
|
12139
|
+
},
|
|
12140
|
+
"GoogleCloudDiscoveryengineV1ServingConfigMediaConfig": {
|
|
12141
|
+
"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.",
|
|
12142
|
+
"id": "GoogleCloudDiscoveryengineV1ServingConfigMediaConfig",
|
|
12143
|
+
"properties": {
|
|
12144
|
+
"contentFreshnessCutoffDays": {
|
|
12145
|
+
"description": "Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.",
|
|
12146
|
+
"format": "int32",
|
|
12147
|
+
"type": "integer"
|
|
12148
|
+
},
|
|
12149
|
+
"contentWatchedPercentageThreshold": {
|
|
12150
|
+
"description": "Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.",
|
|
12151
|
+
"format": "float",
|
|
12152
|
+
"type": "number"
|
|
12153
|
+
},
|
|
12154
|
+
"contentWatchedSecondsThreshold": {
|
|
12155
|
+
"description": "Specifies the content watched minutes threshold for demotion.",
|
|
12156
|
+
"format": "float",
|
|
12157
|
+
"type": "number"
|
|
12158
|
+
},
|
|
12159
|
+
"demoteContentWatchedPastDays": {
|
|
12160
|
+
"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.",
|
|
12161
|
+
"format": "int32",
|
|
12162
|
+
"type": "integer"
|
|
12163
|
+
},
|
|
12164
|
+
"demotionEventType": {
|
|
12165
|
+
"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.",
|
|
12166
|
+
"type": "string"
|
|
12167
|
+
}
|
|
12168
|
+
},
|
|
12169
|
+
"type": "object"
|
|
12170
|
+
},
|
|
12171
|
+
"GoogleCloudDiscoveryengineV1Session": {
|
|
12172
|
+
"description": "External session proto definition.",
|
|
12173
|
+
"id": "GoogleCloudDiscoveryengineV1Session",
|
|
12174
|
+
"properties": {
|
|
12175
|
+
"displayName": {
|
|
12176
|
+
"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.",
|
|
12177
|
+
"type": "string"
|
|
12178
|
+
},
|
|
12179
|
+
"endTime": {
|
|
12180
|
+
"description": "Output only. The time the session finished.",
|
|
12181
|
+
"format": "google-datetime",
|
|
12182
|
+
"readOnly": true,
|
|
12183
|
+
"type": "string"
|
|
12184
|
+
},
|
|
12185
|
+
"isPinned": {
|
|
12186
|
+
"description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.",
|
|
12187
|
+
"type": "boolean"
|
|
12188
|
+
},
|
|
12189
|
+
"name": {
|
|
12190
|
+
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
|
|
12191
|
+
"type": "string"
|
|
12192
|
+
},
|
|
12193
|
+
"startTime": {
|
|
12194
|
+
"description": "Output only. The time the session started.",
|
|
11683
12195
|
"format": "google-datetime",
|
|
11684
12196
|
"readOnly": true,
|
|
11685
12197
|
"type": "string"
|
|
@@ -12378,6 +12890,18 @@
|
|
|
12378
12890
|
"readOnly": true,
|
|
12379
12891
|
"type": "string"
|
|
12380
12892
|
},
|
|
12893
|
+
"groundingScore": {
|
|
12894
|
+
"description": "A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.",
|
|
12895
|
+
"format": "double",
|
|
12896
|
+
"type": "number"
|
|
12897
|
+
},
|
|
12898
|
+
"groundingSupports": {
|
|
12899
|
+
"description": "Optional. Grounding supports.",
|
|
12900
|
+
"items": {
|
|
12901
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport"
|
|
12902
|
+
},
|
|
12903
|
+
"type": "array"
|
|
12904
|
+
},
|
|
12381
12905
|
"name": {
|
|
12382
12906
|
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`",
|
|
12383
12907
|
"type": "string"
|
|
@@ -12406,13 +12930,15 @@
|
|
|
12406
12930
|
"STATE_UNSPECIFIED",
|
|
12407
12931
|
"IN_PROGRESS",
|
|
12408
12932
|
"FAILED",
|
|
12409
|
-
"SUCCEEDED"
|
|
12933
|
+
"SUCCEEDED",
|
|
12934
|
+
"STREAMING"
|
|
12410
12935
|
],
|
|
12411
12936
|
"enumDescriptions": [
|
|
12412
12937
|
"Unknown.",
|
|
12413
12938
|
"Answer generation is currently in progress.",
|
|
12414
12939
|
"Answer generation currently failed.",
|
|
12415
|
-
"Answer generation has succeeded."
|
|
12940
|
+
"Answer generation has succeeded.",
|
|
12941
|
+
"Answer generation is currently in progress."
|
|
12416
12942
|
],
|
|
12417
12943
|
"type": "string"
|
|
12418
12944
|
},
|
|
@@ -12461,6 +12987,39 @@
|
|
|
12461
12987
|
},
|
|
12462
12988
|
"type": "object"
|
|
12463
12989
|
},
|
|
12990
|
+
"GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport": {
|
|
12991
|
+
"description": "Grounding support for a claim in `answer_text`.",
|
|
12992
|
+
"id": "GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport",
|
|
12993
|
+
"properties": {
|
|
12994
|
+
"endIndex": {
|
|
12995
|
+
"description": "Required. End of the claim, exclusive.",
|
|
12996
|
+
"format": "int64",
|
|
12997
|
+
"type": "string"
|
|
12998
|
+
},
|
|
12999
|
+
"groundingCheckRequired": {
|
|
13000
|
+
"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.",
|
|
13001
|
+
"type": "boolean"
|
|
13002
|
+
},
|
|
13003
|
+
"groundingScore": {
|
|
13004
|
+
"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.",
|
|
13005
|
+
"format": "double",
|
|
13006
|
+
"type": "number"
|
|
13007
|
+
},
|
|
13008
|
+
"sources": {
|
|
13009
|
+
"description": "Optional. Citation sources for the claim.",
|
|
13010
|
+
"items": {
|
|
13011
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource"
|
|
13012
|
+
},
|
|
13013
|
+
"type": "array"
|
|
13014
|
+
},
|
|
13015
|
+
"startIndex": {
|
|
13016
|
+
"description": "Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).",
|
|
13017
|
+
"format": "int64",
|
|
13018
|
+
"type": "string"
|
|
13019
|
+
}
|
|
13020
|
+
},
|
|
13021
|
+
"type": "object"
|
|
13022
|
+
},
|
|
12464
13023
|
"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": {
|
|
12465
13024
|
"description": "Query understanding information.",
|
|
12466
13025
|
"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo",
|
|
@@ -12980,6 +13539,10 @@
|
|
|
12980
13539
|
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
|
|
12981
13540
|
"type": "string"
|
|
12982
13541
|
},
|
|
13542
|
+
"promoteAction": {
|
|
13543
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction",
|
|
13544
|
+
"description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
|
|
13545
|
+
},
|
|
12983
13546
|
"redirectAction": {
|
|
12984
13547
|
"$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction",
|
|
12985
13548
|
"description": "Defines a redirect-type control."
|
|
@@ -13061,6 +13624,21 @@
|
|
|
13061
13624
|
},
|
|
13062
13625
|
"type": "object"
|
|
13063
13626
|
},
|
|
13627
|
+
"GoogleCloudDiscoveryengineV1alphaControlPromoteAction": {
|
|
13628
|
+
"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.",
|
|
13629
|
+
"id": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction",
|
|
13630
|
+
"properties": {
|
|
13631
|
+
"dataStore": {
|
|
13632
|
+
"description": "Required. Data store with which this promotion is attached to.",
|
|
13633
|
+
"type": "string"
|
|
13634
|
+
},
|
|
13635
|
+
"searchLinkPromotion": {
|
|
13636
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion",
|
|
13637
|
+
"description": "Required. Promotion attached to this action."
|
|
13638
|
+
}
|
|
13639
|
+
},
|
|
13640
|
+
"type": "object"
|
|
13641
|
+
},
|
|
13064
13642
|
"GoogleCloudDiscoveryengineV1alphaControlRedirectAction": {
|
|
13065
13643
|
"description": "Redirects a shopper to the provided URI.",
|
|
13066
13644
|
"id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction",
|
|
@@ -13199,73 +13777,6 @@
|
|
|
13199
13777
|
},
|
|
13200
13778
|
"type": "object"
|
|
13201
13779
|
},
|
|
13202
|
-
"GoogleCloudDiscoveryengineV1alphaCustomTuningModel": {
|
|
13203
|
-
"description": "Metadata that describes a custom tuned model.",
|
|
13204
|
-
"id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel",
|
|
13205
|
-
"properties": {
|
|
13206
|
-
"createTime": {
|
|
13207
|
-
"deprecated": true,
|
|
13208
|
-
"description": "Deprecated: Timestamp the Model was created at.",
|
|
13209
|
-
"format": "google-datetime",
|
|
13210
|
-
"type": "string"
|
|
13211
|
-
},
|
|
13212
|
-
"displayName": {
|
|
13213
|
-
"description": "The display name of the model.",
|
|
13214
|
-
"type": "string"
|
|
13215
|
-
},
|
|
13216
|
-
"errorMessage": {
|
|
13217
|
-
"description": "Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.",
|
|
13218
|
-
"type": "string"
|
|
13219
|
-
},
|
|
13220
|
-
"metrics": {
|
|
13221
|
-
"additionalProperties": {
|
|
13222
|
-
"format": "double",
|
|
13223
|
-
"type": "number"
|
|
13224
|
-
},
|
|
13225
|
-
"description": "The metrics of the trained model.",
|
|
13226
|
-
"type": "object"
|
|
13227
|
-
},
|
|
13228
|
-
"modelState": {
|
|
13229
|
-
"description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).",
|
|
13230
|
-
"enum": [
|
|
13231
|
-
"MODEL_STATE_UNSPECIFIED",
|
|
13232
|
-
"TRAINING_PAUSED",
|
|
13233
|
-
"TRAINING",
|
|
13234
|
-
"TRAINING_COMPLETE",
|
|
13235
|
-
"READY_FOR_SERVING",
|
|
13236
|
-
"TRAINING_FAILED",
|
|
13237
|
-
"NO_IMPROVEMENT",
|
|
13238
|
-
"INPUT_VALIDATION_FAILED"
|
|
13239
|
-
],
|
|
13240
|
-
"enumDescriptions": [
|
|
13241
|
-
"Default value.",
|
|
13242
|
-
"The model is in a paused training state.",
|
|
13243
|
-
"The model is currently training.",
|
|
13244
|
-
"The model has successfully completed training.",
|
|
13245
|
-
"The model is ready for serving.",
|
|
13246
|
-
"The model training failed.",
|
|
13247
|
-
"The model training finished successfully but metrics did not improve.",
|
|
13248
|
-
"Input data validation failed. Model training didn't start."
|
|
13249
|
-
],
|
|
13250
|
-
"type": "string"
|
|
13251
|
-
},
|
|
13252
|
-
"modelVersion": {
|
|
13253
|
-
"description": "The version of the model.",
|
|
13254
|
-
"format": "int64",
|
|
13255
|
-
"type": "string"
|
|
13256
|
-
},
|
|
13257
|
-
"name": {
|
|
13258
|
-
"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.",
|
|
13259
|
-
"type": "string"
|
|
13260
|
-
},
|
|
13261
|
-
"trainingStartTime": {
|
|
13262
|
-
"description": "Timestamp the model training was initiated.",
|
|
13263
|
-
"format": "google-datetime",
|
|
13264
|
-
"type": "string"
|
|
13265
|
-
}
|
|
13266
|
-
},
|
|
13267
|
-
"type": "object"
|
|
13268
|
-
},
|
|
13269
13780
|
"GoogleCloudDiscoveryengineV1alphaDataStore": {
|
|
13270
13781
|
"description": "DataStore captures global settings and configs at the DataStore level.",
|
|
13271
13782
|
"id": "GoogleCloudDiscoveryengineV1alphaDataStore",
|
|
@@ -13512,6 +14023,17 @@
|
|
|
13512
14023
|
},
|
|
13513
14024
|
"type": "object"
|
|
13514
14025
|
},
|
|
14026
|
+
"GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest": {
|
|
14027
|
+
"description": "Request for DeleteSession method.",
|
|
14028
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest",
|
|
14029
|
+
"properties": {
|
|
14030
|
+
"name": {
|
|
14031
|
+
"description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
14032
|
+
"type": "string"
|
|
14033
|
+
}
|
|
14034
|
+
},
|
|
14035
|
+
"type": "object"
|
|
14036
|
+
},
|
|
13515
14037
|
"GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata": {
|
|
13516
14038
|
"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
13517
14039
|
"id": "GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata",
|
|
@@ -13734,7 +14256,7 @@
|
|
|
13734
14256
|
"type": "string"
|
|
13735
14257
|
},
|
|
13736
14258
|
"industryVertical": {
|
|
13737
|
-
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore:
|
|
14259
|
+
"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.",
|
|
13738
14260
|
"enum": [
|
|
13739
14261
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
13740
14262
|
"GENERIC",
|
|
@@ -14299,6 +14821,21 @@
|
|
|
14299
14821
|
},
|
|
14300
14822
|
"type": "object"
|
|
14301
14823
|
},
|
|
14824
|
+
"GoogleCloudDiscoveryengineV1alphaGetSessionRequest": {
|
|
14825
|
+
"description": "Request for GetSession method.",
|
|
14826
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGetSessionRequest",
|
|
14827
|
+
"properties": {
|
|
14828
|
+
"includeAnswerDetails": {
|
|
14829
|
+
"description": "Optional. If set to true, the full session including all answer details will be returned.",
|
|
14830
|
+
"type": "boolean"
|
|
14831
|
+
},
|
|
14832
|
+
"name": {
|
|
14833
|
+
"description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
14834
|
+
"type": "string"
|
|
14835
|
+
}
|
|
14836
|
+
},
|
|
14837
|
+
"type": "object"
|
|
14838
|
+
},
|
|
14302
14839
|
"GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": {
|
|
14303
14840
|
"description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.",
|
|
14304
14841
|
"id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse",
|
|
@@ -14658,14 +15195,46 @@
|
|
|
14658
15195
|
},
|
|
14659
15196
|
"type": "object"
|
|
14660
15197
|
},
|
|
14661
|
-
"
|
|
14662
|
-
"description": "
|
|
14663
|
-
"id": "
|
|
15198
|
+
"GoogleCloudDiscoveryengineV1alphaListSessionsRequest": {
|
|
15199
|
+
"description": "Request for ListSessions method.",
|
|
15200
|
+
"id": "GoogleCloudDiscoveryengineV1alphaListSessionsRequest",
|
|
14664
15201
|
"properties": {
|
|
14665
|
-
"
|
|
14666
|
-
"description": "
|
|
15202
|
+
"filter": {
|
|
15203
|
+
"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
|
|
15204
|
+
"type": "string"
|
|
15205
|
+
},
|
|
15206
|
+
"orderBy": {
|
|
15207
|
+
"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.",
|
|
15208
|
+
"type": "string"
|
|
15209
|
+
},
|
|
15210
|
+
"pageSize": {
|
|
15211
|
+
"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
|
|
15212
|
+
"format": "int32",
|
|
15213
|
+
"type": "integer"
|
|
15214
|
+
},
|
|
15215
|
+
"pageToken": {
|
|
15216
|
+
"description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.",
|
|
15217
|
+
"type": "string"
|
|
15218
|
+
},
|
|
15219
|
+
"parent": {
|
|
15220
|
+
"description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`",
|
|
15221
|
+
"type": "string"
|
|
15222
|
+
}
|
|
15223
|
+
},
|
|
15224
|
+
"type": "object"
|
|
15225
|
+
},
|
|
15226
|
+
"GoogleCloudDiscoveryengineV1alphaListSessionsResponse": {
|
|
15227
|
+
"description": "Response for ListSessions method.",
|
|
15228
|
+
"id": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse",
|
|
15229
|
+
"properties": {
|
|
15230
|
+
"nextPageToken": {
|
|
15231
|
+
"description": "Pagination token, if not returned indicates the last page.",
|
|
15232
|
+
"type": "string"
|
|
15233
|
+
},
|
|
15234
|
+
"sessions": {
|
|
15235
|
+
"description": "All the Sessions for a given data store.",
|
|
14667
15236
|
"items": {
|
|
14668
|
-
"$ref": "
|
|
15237
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
|
|
14669
15238
|
},
|
|
14670
15239
|
"type": "array"
|
|
14671
15240
|
}
|
|
@@ -15207,6 +15776,33 @@
|
|
|
15207
15776
|
},
|
|
15208
15777
|
"type": "object"
|
|
15209
15778
|
},
|
|
15779
|
+
"GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion": {
|
|
15780
|
+
"description": "Promotion proto includes uri and other helping information to display the promotion.",
|
|
15781
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion",
|
|
15782
|
+
"properties": {
|
|
15783
|
+
"description": {
|
|
15784
|
+
"description": "Optional. The Promotion description. Maximum length: 200 characters.",
|
|
15785
|
+
"type": "string"
|
|
15786
|
+
},
|
|
15787
|
+
"enabled": {
|
|
15788
|
+
"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.",
|
|
15789
|
+
"type": "boolean"
|
|
15790
|
+
},
|
|
15791
|
+
"imageUri": {
|
|
15792
|
+
"description": "Optional. The promotion thumbnail image url.",
|
|
15793
|
+
"type": "string"
|
|
15794
|
+
},
|
|
15795
|
+
"title": {
|
|
15796
|
+
"description": "Required. The title of the promotion. Maximum length: 160 characters.",
|
|
15797
|
+
"type": "string"
|
|
15798
|
+
},
|
|
15799
|
+
"uri": {
|
|
15800
|
+
"description": "Required. The URL for the page the user wants to promote.",
|
|
15801
|
+
"type": "string"
|
|
15802
|
+
}
|
|
15803
|
+
},
|
|
15804
|
+
"type": "object"
|
|
15805
|
+
},
|
|
15210
15806
|
"GoogleCloudDiscoveryengineV1alphaSearchRequest": {
|
|
15211
15807
|
"description": "Request message for SearchService.Search method.",
|
|
15212
15808
|
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequest",
|
|
@@ -15232,7 +15828,7 @@
|
|
|
15232
15828
|
"description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec."
|
|
15233
15829
|
},
|
|
15234
15830
|
"dataStoreSpecs": {
|
|
15235
|
-
"description": "Specs defining
|
|
15831
|
+
"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.",
|
|
15236
15832
|
"items": {
|
|
15237
15833
|
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec"
|
|
15238
15834
|
},
|
|
@@ -15650,6 +16246,10 @@
|
|
|
15650
16246
|
"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.",
|
|
15651
16247
|
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec",
|
|
15652
16248
|
"properties": {
|
|
16249
|
+
"boostSpec": {
|
|
16250
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec",
|
|
16251
|
+
"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)"
|
|
16252
|
+
},
|
|
15653
16253
|
"dataStore": {
|
|
15654
16254
|
"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
|
|
15655
16255
|
"type": "string"
|
|
@@ -15915,12 +16515,20 @@
|
|
|
15915
16515
|
"description": "External session proto definition.",
|
|
15916
16516
|
"id": "GoogleCloudDiscoveryengineV1alphaSession",
|
|
15917
16517
|
"properties": {
|
|
16518
|
+
"displayName": {
|
|
16519
|
+
"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.",
|
|
16520
|
+
"type": "string"
|
|
16521
|
+
},
|
|
15918
16522
|
"endTime": {
|
|
15919
16523
|
"description": "Output only. The time the session finished.",
|
|
15920
16524
|
"format": "google-datetime",
|
|
15921
16525
|
"readOnly": true,
|
|
15922
16526
|
"type": "string"
|
|
15923
16527
|
},
|
|
16528
|
+
"isPinned": {
|
|
16529
|
+
"description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.",
|
|
16530
|
+
"type": "boolean"
|
|
16531
|
+
},
|
|
15924
16532
|
"name": {
|
|
15925
16533
|
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
|
|
15926
16534
|
"type": "string"
|
|
@@ -16254,6 +16862,22 @@
|
|
|
16254
16862
|
},
|
|
16255
16863
|
"type": "object"
|
|
16256
16864
|
},
|
|
16865
|
+
"GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest": {
|
|
16866
|
+
"description": "Request for UpdateSession method.",
|
|
16867
|
+
"id": "GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest",
|
|
16868
|
+
"properties": {
|
|
16869
|
+
"session": {
|
|
16870
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession",
|
|
16871
|
+
"description": "Required. The Session to update."
|
|
16872
|
+
},
|
|
16873
|
+
"updateMask": {
|
|
16874
|
+
"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.",
|
|
16875
|
+
"format": "google-fieldmask",
|
|
16876
|
+
"type": "string"
|
|
16877
|
+
}
|
|
16878
|
+
},
|
|
16879
|
+
"type": "object"
|
|
16880
|
+
},
|
|
16257
16881
|
"GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": {
|
|
16258
16882
|
"description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
16259
16883
|
"id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata",
|
|
@@ -16511,6 +17135,10 @@
|
|
|
16511
17135
|
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
|
|
16512
17136
|
"type": "string"
|
|
16513
17137
|
},
|
|
17138
|
+
"promoteAction": {
|
|
17139
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControlPromoteAction",
|
|
17140
|
+
"description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
|
|
17141
|
+
},
|
|
16514
17142
|
"redirectAction": {
|
|
16515
17143
|
"$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction",
|
|
16516
17144
|
"description": "Defines a redirect-type control."
|
|
@@ -16592,6 +17220,21 @@
|
|
|
16592
17220
|
},
|
|
16593
17221
|
"type": "object"
|
|
16594
17222
|
},
|
|
17223
|
+
"GoogleCloudDiscoveryengineV1betaControlPromoteAction": {
|
|
17224
|
+
"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.",
|
|
17225
|
+
"id": "GoogleCloudDiscoveryengineV1betaControlPromoteAction",
|
|
17226
|
+
"properties": {
|
|
17227
|
+
"dataStore": {
|
|
17228
|
+
"description": "Required. Data store with which this promotion is attached to.",
|
|
17229
|
+
"type": "string"
|
|
17230
|
+
},
|
|
17231
|
+
"searchLinkPromotion": {
|
|
17232
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion",
|
|
17233
|
+
"description": "Required. Promotion attached to this action."
|
|
17234
|
+
}
|
|
17235
|
+
},
|
|
17236
|
+
"type": "object"
|
|
17237
|
+
},
|
|
16595
17238
|
"GoogleCloudDiscoveryengineV1betaControlRedirectAction": {
|
|
16596
17239
|
"description": "Redirects a shopper to the provided URI.",
|
|
16597
17240
|
"id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction",
|
|
@@ -16708,73 +17351,6 @@
|
|
|
16708
17351
|
},
|
|
16709
17352
|
"type": "object"
|
|
16710
17353
|
},
|
|
16711
|
-
"GoogleCloudDiscoveryengineV1betaCustomTuningModel": {
|
|
16712
|
-
"description": "Metadata that describes a custom tuned model.",
|
|
16713
|
-
"id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel",
|
|
16714
|
-
"properties": {
|
|
16715
|
-
"createTime": {
|
|
16716
|
-
"deprecated": true,
|
|
16717
|
-
"description": "Deprecated: Timestamp the Model was created at.",
|
|
16718
|
-
"format": "google-datetime",
|
|
16719
|
-
"type": "string"
|
|
16720
|
-
},
|
|
16721
|
-
"displayName": {
|
|
16722
|
-
"description": "The display name of the model.",
|
|
16723
|
-
"type": "string"
|
|
16724
|
-
},
|
|
16725
|
-
"errorMessage": {
|
|
16726
|
-
"description": "Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.",
|
|
16727
|
-
"type": "string"
|
|
16728
|
-
},
|
|
16729
|
-
"metrics": {
|
|
16730
|
-
"additionalProperties": {
|
|
16731
|
-
"format": "double",
|
|
16732
|
-
"type": "number"
|
|
16733
|
-
},
|
|
16734
|
-
"description": "The metrics of the trained model.",
|
|
16735
|
-
"type": "object"
|
|
16736
|
-
},
|
|
16737
|
-
"modelState": {
|
|
16738
|
-
"description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).",
|
|
16739
|
-
"enum": [
|
|
16740
|
-
"MODEL_STATE_UNSPECIFIED",
|
|
16741
|
-
"TRAINING_PAUSED",
|
|
16742
|
-
"TRAINING",
|
|
16743
|
-
"TRAINING_COMPLETE",
|
|
16744
|
-
"READY_FOR_SERVING",
|
|
16745
|
-
"TRAINING_FAILED",
|
|
16746
|
-
"NO_IMPROVEMENT",
|
|
16747
|
-
"INPUT_VALIDATION_FAILED"
|
|
16748
|
-
],
|
|
16749
|
-
"enumDescriptions": [
|
|
16750
|
-
"Default value.",
|
|
16751
|
-
"The model is in a paused training state.",
|
|
16752
|
-
"The model is currently training.",
|
|
16753
|
-
"The model has successfully completed training.",
|
|
16754
|
-
"The model is ready for serving.",
|
|
16755
|
-
"The model training failed.",
|
|
16756
|
-
"The model training finished successfully but metrics did not improve.",
|
|
16757
|
-
"Input data validation failed. Model training didn't start."
|
|
16758
|
-
],
|
|
16759
|
-
"type": "string"
|
|
16760
|
-
},
|
|
16761
|
-
"modelVersion": {
|
|
16762
|
-
"description": "The version of the model.",
|
|
16763
|
-
"format": "int64",
|
|
16764
|
-
"type": "string"
|
|
16765
|
-
},
|
|
16766
|
-
"name": {
|
|
16767
|
-
"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.",
|
|
16768
|
-
"type": "string"
|
|
16769
|
-
},
|
|
16770
|
-
"trainingStartTime": {
|
|
16771
|
-
"description": "Timestamp the model training was initiated.",
|
|
16772
|
-
"format": "google-datetime",
|
|
16773
|
-
"type": "string"
|
|
16774
|
-
}
|
|
16775
|
-
},
|
|
16776
|
-
"type": "object"
|
|
16777
|
-
},
|
|
16778
17354
|
"GoogleCloudDiscoveryengineV1betaDataStore": {
|
|
16779
17355
|
"description": "DataStore captures global settings and configs at the DataStore level.",
|
|
16780
17356
|
"id": "GoogleCloudDiscoveryengineV1betaDataStore",
|
|
@@ -17219,7 +17795,7 @@
|
|
|
17219
17795
|
"type": "string"
|
|
17220
17796
|
},
|
|
17221
17797
|
"industryVertical": {
|
|
17222
|
-
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore:
|
|
17798
|
+
"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.",
|
|
17223
17799
|
"enum": [
|
|
17224
17800
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
17225
17801
|
"GENERIC",
|
|
@@ -17785,20 +18361,6 @@
|
|
|
17785
18361
|
},
|
|
17786
18362
|
"type": "object"
|
|
17787
18363
|
},
|
|
17788
|
-
"GoogleCloudDiscoveryengineV1betaListCustomModelsResponse": {
|
|
17789
|
-
"description": "Response message for SearchTuningService.ListCustomModels method.",
|
|
17790
|
-
"id": "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse",
|
|
17791
|
-
"properties": {
|
|
17792
|
-
"models": {
|
|
17793
|
-
"description": "List of custom tuning models.",
|
|
17794
|
-
"items": {
|
|
17795
|
-
"$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel"
|
|
17796
|
-
},
|
|
17797
|
-
"type": "array"
|
|
17798
|
-
}
|
|
17799
|
-
},
|
|
17800
|
-
"type": "object"
|
|
17801
|
-
},
|
|
17802
18364
|
"GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig": {
|
|
17803
18365
|
"description": "Configuration for Natural Language Query Understanding.",
|
|
17804
18366
|
"id": "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig",
|
|
@@ -18063,6 +18625,33 @@
|
|
|
18063
18625
|
},
|
|
18064
18626
|
"type": "object"
|
|
18065
18627
|
},
|
|
18628
|
+
"GoogleCloudDiscoveryengineV1betaSearchLinkPromotion": {
|
|
18629
|
+
"description": "Promotion proto includes uri and other helping information to display the promotion.",
|
|
18630
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion",
|
|
18631
|
+
"properties": {
|
|
18632
|
+
"description": {
|
|
18633
|
+
"description": "Optional. The Promotion description. Maximum length: 200 characters.",
|
|
18634
|
+
"type": "string"
|
|
18635
|
+
},
|
|
18636
|
+
"enabled": {
|
|
18637
|
+
"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.",
|
|
18638
|
+
"type": "boolean"
|
|
18639
|
+
},
|
|
18640
|
+
"imageUri": {
|
|
18641
|
+
"description": "Optional. The promotion thumbnail image url.",
|
|
18642
|
+
"type": "string"
|
|
18643
|
+
},
|
|
18644
|
+
"title": {
|
|
18645
|
+
"description": "Required. The title of the promotion. Maximum length: 160 characters.",
|
|
18646
|
+
"type": "string"
|
|
18647
|
+
},
|
|
18648
|
+
"uri": {
|
|
18649
|
+
"description": "Required. The URL for the page the user wants to promote.",
|
|
18650
|
+
"type": "string"
|
|
18651
|
+
}
|
|
18652
|
+
},
|
|
18653
|
+
"type": "object"
|
|
18654
|
+
},
|
|
18066
18655
|
"GoogleCloudDiscoveryengineV1betaSearchRequest": {
|
|
18067
18656
|
"description": "Request message for SearchService.Search method.",
|
|
18068
18657
|
"id": "GoogleCloudDiscoveryengineV1betaSearchRequest",
|
|
@@ -18084,7 +18673,7 @@
|
|
|
18084
18673
|
"description": "A specification for configuring the behavior of content search."
|
|
18085
18674
|
},
|
|
18086
18675
|
"dataStoreSpecs": {
|
|
18087
|
-
"description": "Specs defining
|
|
18676
|
+
"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.",
|
|
18088
18677
|
"items": {
|
|
18089
18678
|
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec"
|
|
18090
18679
|
},
|
|
@@ -18502,6 +19091,10 @@
|
|
|
18502
19091
|
"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.",
|
|
18503
19092
|
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec",
|
|
18504
19093
|
"properties": {
|
|
19094
|
+
"boostSpec": {
|
|
19095
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
|
|
19096
|
+
"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)"
|
|
19097
|
+
},
|
|
18505
19098
|
"dataStore": {
|
|
18506
19099
|
"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
|
|
18507
19100
|
"type": "string"
|