google-api-python-client 2.153.0__py2.py3-none-any.whl → 2.155.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.153.0.dist-info → google_api_python_client-2.155.0.dist-info}/METADATA +1 -1
- {google_api_python_client-2.153.0.dist-info → google_api_python_client-2.155.0.dist-info}/RECORD +216 -211
- googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +11 -3
- googleapiclient/discovery_cache/documents/addressvalidation.v1.json +8 -8
- googleapiclient/discovery_cache/documents/admin.directory_v1.json +6 -2
- googleapiclient/discovery_cache/documents/admin.directoryv1.json +6 -2
- googleapiclient/discovery_cache/documents/adsense.v2.json +3 -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 +3479 -185
- googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +1607 -308
- googleapiclient/discovery_cache/documents/alloydb.v1.json +81 -1
- googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +112 -1
- googleapiclient/discovery_cache/documents/alloydb.v1beta.json +112 -1
- googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json +5 -1
- googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json +11 -1
- googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json +3 -3
- googleapiclient/discovery_cache/documents/androidenterprise.v1.json +66 -4
- googleapiclient/discovery_cache/documents/androidmanagement.v1.json +28 -12
- googleapiclient/discovery_cache/documents/androidpublisher.v3.json +37 -1
- googleapiclient/discovery_cache/documents/apigee.v1.json +32 -1
- 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/authorizedbuyersmarketplace.v1.json +3 -3
- googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json +3 -3
- googleapiclient/discovery_cache/documents/backupdr.v1.json +2 -2
- googleapiclient/discovery_cache/documents/batch.v1.json +10 -10
- googleapiclient/discovery_cache/documents/beyondcorp.v1.json +1 -69
- googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +1 -69
- googleapiclient/discovery_cache/documents/bigquery.v2.json +20 -6
- googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +8 -8
- googleapiclient/discovery_cache/documents/binaryauthorization.v1.json +1 -2
- googleapiclient/discovery_cache/documents/chat.v1.json +5 -5
- googleapiclient/discovery_cache/documents/checks.v1alpha.json +496 -6
- googleapiclient/discovery_cache/documents/chromemanagement.v1.json +763 -1
- 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 +11 -7
- googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +5 -1
- googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +5 -1
- googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +5 -1
- googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +5 -1
- googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/cloudchannel.v1.json +13 -13
- googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +2 -2
- googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +2 -2
- googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +2 -2
- googleapiclient/discovery_cache/documents/cloudidentity.v1.json +33 -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 +3 -3
- googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudsearch.v1.json +1 -63
- googleapiclient/discovery_cache/documents/cloudshell.v1.json +2 -2
- googleapiclient/discovery_cache/documents/cloudtasks.v2.json +2 -2
- googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +3 -3
- googleapiclient/discovery_cache/documents/compute.alpha.json +1170 -164
- googleapiclient/discovery_cache/documents/compute.beta.json +935 -72
- googleapiclient/discovery_cache/documents/compute.v1.json +2980 -1157
- googleapiclient/discovery_cache/documents/config.v1.json +3 -3
- googleapiclient/discovery_cache/documents/connectors.v1.json +334 -48
- googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +21 -5
- googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +108 -963
- googleapiclient/discovery_cache/documents/container.v1.json +2 -2
- googleapiclient/discovery_cache/documents/container.v1beta1.json +6 -4
- 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 +12 -12
- googleapiclient/discovery_cache/documents/datacatalog.v1.json +2 -2
- googleapiclient/discovery_cache/documents/dataform.v1beta1.json +6 -225
- 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 +13 -3
- googleapiclient/discovery_cache/documents/datamigration.v1.json +330 -7
- googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +16 -7
- googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +16 -7
- googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +16 -7
- googleapiclient/discovery_cache/documents/developerconnect.v1.json +2 -2
- googleapiclient/discovery_cache/documents/dialogflow.v2.json +20 -20
- googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +11 -11
- googleapiclient/discovery_cache/documents/dialogflow.v3.json +8 -8
- googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +11 -11
- googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +4 -115
- googleapiclient/discovery_cache/documents/discoveryengine.v1.json +867 -107
- googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +884 -130
- googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +940 -116
- googleapiclient/discovery_cache/documents/displayvideo.v2.json +19 -7
- googleapiclient/discovery_cache/documents/displayvideo.v3.json +25 -11
- googleapiclient/discovery_cache/documents/dlp.v2.json +13 -5
- googleapiclient/discovery_cache/documents/drive.v3.json +148 -107
- googleapiclient/discovery_cache/documents/eventarc.v1.json +23 -9
- googleapiclient/discovery_cache/documents/fcm.v1.json +2 -2
- googleapiclient/discovery_cache/documents/file.v1.json +2 -2
- googleapiclient/discovery_cache/documents/file.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +2 -2
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +216 -6
- googleapiclient/discovery_cache/documents/firebasedatabase.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 +181 -1
- googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json +112 -1
- googleapiclient/discovery_cache/documents/forms.v1.json +33 -1
- googleapiclient/discovery_cache/documents/gkebackup.v1.json +2 -2
- googleapiclient/discovery_cache/documents/gkehub.v1.json +11 -1
- googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +11 -1
- googleapiclient/discovery_cache/documents/gkehub.v1beta.json +11 -1
- googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +11 -1
- googleapiclient/discovery_cache/documents/gkeonprem.v1.json +7 -2
- googleapiclient/discovery_cache/documents/healthcare.v1.json +22 -22
- googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +3 -3
- 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/integrations.v1.json +107 -19
- googleapiclient/discovery_cache/documents/language.v1beta2.json +4 -4
- googleapiclient/discovery_cache/documents/language.v2.json +10 -10
- googleapiclient/discovery_cache/documents/localservices.v1.json +3 -3
- googleapiclient/discovery_cache/documents/looker.v1.json +2 -2
- googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +23 -23
- googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +4 -4
- googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +3 -3
- 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 +7 -3
- 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 +720 -7
- 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 +256 -8
- googleapiclient/discovery_cache/documents/netapp.v1beta1.json +256 -8
- googleapiclient/discovery_cache/documents/networkmanagement.v1.json +22 -7
- googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +22 -7
- googleapiclient/discovery_cache/documents/networksecurity.v1.json +562 -8
- googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +2223 -1040
- googleapiclient/discovery_cache/documents/networkservices.v1.json +572 -37
- googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +273 -37
- googleapiclient/discovery_cache/documents/notebooks.v1.json +6 -6
- googleapiclient/discovery_cache/documents/notebooks.v2.json +2 -2
- 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/parallelstore.v1.json +975 -0
- googleapiclient/discovery_cache/documents/parallelstore.v1beta.json +980 -0
- googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +4 -4
- 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 +8 -8
- googleapiclient/discovery_cache/documents/pubsublite.v1.json +2 -2
- googleapiclient/discovery_cache/documents/redis.v1.json +628 -2
- googleapiclient/discovery_cache/documents/redis.v1beta1.json +629 -3
- googleapiclient/discovery_cache/documents/retail.v2.json +30 -12
- googleapiclient/discovery_cache/documents/retail.v2alpha.json +30 -12
- googleapiclient/discovery_cache/documents/retail.v2beta.json +30 -12
- googleapiclient/discovery_cache/documents/run.v2.json +27 -4
- googleapiclient/discovery_cache/documents/secretmanager.v1.json +2 -2
- googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +2 -2
- googleapiclient/discovery_cache/documents/securitycenter.v1.json +540 -4
- googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +463 -4
- googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +462 -3
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +14 -3
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +19 -4
- googleapiclient/discovery_cache/documents/servicemanagement.v1.json +17 -2
- googleapiclient/discovery_cache/documents/servicenetworking.v1.json +9 -2
- googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +8 -1
- googleapiclient/discovery_cache/documents/serviceusage.v1.json +14 -3
- googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +13 -2
- googleapiclient/discovery_cache/documents/spanner.v1.json +6 -6
- googleapiclient/discovery_cache/documents/speech.v1.json +21 -1
- googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +21 -1
- googleapiclient/discovery_cache/documents/sqladmin.v1.json +157 -84
- googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +157 -96
- googleapiclient/discovery_cache/documents/storage.v1.json +23 -2
- googleapiclient/discovery_cache/documents/sts.v1.json +9 -2
- googleapiclient/discovery_cache/documents/sts.v1beta.json +8 -1
- googleapiclient/discovery_cache/documents/tagmanager.v2.json +5 -1
- googleapiclient/discovery_cache/documents/texttospeech.v1.json +2 -2
- googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +2 -1
- 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 +121 -2
- googleapiclient/discovery_cache/documents/webrisk.v1.json +2 -2
- 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.153.0.dist-info → google_api_python_client-2.155.0.dist-info}/LICENSE +0 -0
- {google_api_python_client-2.153.0.dist-info → google_api_python_client-2.155.0.dist-info}/WHEEL +0 -0
- {google_api_python_client-2.153.0.dist-info → google_api_python_client-2.155.0.dist-info}/top_level.txt +0 -0
|
@@ -15,6 +15,28 @@
|
|
|
15
15
|
"description": "Discovery Engine API.",
|
|
16
16
|
"discoveryVersion": "v1",
|
|
17
17
|
"documentationLink": "https://cloud.google.com/generative-ai-app-builder/docs/",
|
|
18
|
+
"endpoints": [
|
|
19
|
+
{
|
|
20
|
+
"description": "Regional Endpoint",
|
|
21
|
+
"endpointUrl": "https://discoveryengine.asia-northeast1.rep.googleapis.com/",
|
|
22
|
+
"location": "asia-northeast1"
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"description": "Regional Endpoint",
|
|
26
|
+
"endpointUrl": "https://discoveryengine.europe-west2.rep.googleapis.com/",
|
|
27
|
+
"location": "europe-west2"
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"description": "Regional Endpoint",
|
|
31
|
+
"endpointUrl": "https://discoveryengine.us.rep.googleapis.com/",
|
|
32
|
+
"location": "us"
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"description": "Regional Endpoint",
|
|
36
|
+
"endpointUrl": "https://discoveryengine.eu.rep.googleapis.com/",
|
|
37
|
+
"location": "eu"
|
|
38
|
+
}
|
|
39
|
+
],
|
|
18
40
|
"fullyEncodeReservedExpansion": true,
|
|
19
41
|
"icons": {
|
|
20
42
|
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
|
@@ -757,7 +779,7 @@
|
|
|
757
779
|
"operations": {
|
|
758
780
|
"methods": {
|
|
759
781
|
"cancel": {
|
|
760
|
-
"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`.",
|
|
761
783
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel",
|
|
762
784
|
"httpMethod": "POST",
|
|
763
785
|
"id": "discoveryengine.projects.locations.collections.dataStores.branches.operations.cancel",
|
|
@@ -1697,6 +1719,40 @@
|
|
|
1697
1719
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
1698
1720
|
]
|
|
1699
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
|
+
},
|
|
1700
1756
|
"recommend": {
|
|
1701
1757
|
"description": "Makes a recommendation, which requires a contextual user event.",
|
|
1702
1758
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend",
|
|
@@ -1780,6 +1836,34 @@
|
|
|
1780
1836
|
"scopes": [
|
|
1781
1837
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
1782
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
|
+
]
|
|
1783
1867
|
}
|
|
1784
1868
|
}
|
|
1785
1869
|
},
|
|
@@ -1847,6 +1931,11 @@
|
|
|
1847
1931
|
"name"
|
|
1848
1932
|
],
|
|
1849
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
|
+
},
|
|
1850
1939
|
"name": {
|
|
1851
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}`",
|
|
1852
1941
|
"location": "path",
|
|
@@ -1878,7 +1967,7 @@
|
|
|
1878
1967
|
"type": "string"
|
|
1879
1968
|
},
|
|
1880
1969
|
"orderBy": {
|
|
1881
|
-
"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.",
|
|
1882
1971
|
"location": "query",
|
|
1883
1972
|
"type": "string"
|
|
1884
1973
|
},
|
|
@@ -2524,7 +2613,7 @@
|
|
|
2524
2613
|
"type": "string"
|
|
2525
2614
|
},
|
|
2526
2615
|
"parent": {
|
|
2527
|
-
"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}`.",
|
|
2528
2617
|
"location": "path",
|
|
2529
2618
|
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
|
|
2530
2619
|
"required": true,
|
|
@@ -3256,6 +3345,40 @@
|
|
|
3256
3345
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
3257
3346
|
]
|
|
3258
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
|
+
},
|
|
3259
3382
|
"recommend": {
|
|
3260
3383
|
"description": "Makes a recommendation, which requires a contextual user event.",
|
|
3261
3384
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:recommend",
|
|
@@ -3339,6 +3462,34 @@
|
|
|
3339
3462
|
"scopes": [
|
|
3340
3463
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
3341
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
|
+
]
|
|
3342
3493
|
}
|
|
3343
3494
|
}
|
|
3344
3495
|
},
|
|
@@ -3406,6 +3557,11 @@
|
|
|
3406
3557
|
"name"
|
|
3407
3558
|
],
|
|
3408
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
|
+
},
|
|
3409
3565
|
"name": {
|
|
3410
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}`",
|
|
3411
3567
|
"location": "path",
|
|
@@ -3437,7 +3593,7 @@
|
|
|
3437
3593
|
"type": "string"
|
|
3438
3594
|
},
|
|
3439
3595
|
"orderBy": {
|
|
3440
|
-
"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.",
|
|
3441
3597
|
"location": "query",
|
|
3442
3598
|
"type": "string"
|
|
3443
3599
|
},
|
|
@@ -4123,7 +4279,7 @@
|
|
|
4123
4279
|
"operations": {
|
|
4124
4280
|
"methods": {
|
|
4125
4281
|
"cancel": {
|
|
4126
|
-
"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`.",
|
|
4127
4283
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel",
|
|
4128
4284
|
"httpMethod": "POST",
|
|
4129
4285
|
"id": "discoveryengine.projects.locations.dataStores.branches.operations.cancel",
|
|
@@ -4962,6 +5118,40 @@
|
|
|
4962
5118
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
4963
5119
|
]
|
|
4964
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
|
+
},
|
|
4965
5155
|
"recommend": {
|
|
4966
5156
|
"description": "Makes a recommendation, which requires a contextual user event.",
|
|
4967
5157
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend",
|
|
@@ -5045,6 +5235,34 @@
|
|
|
5045
5235
|
"scopes": [
|
|
5046
5236
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
5047
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
|
+
]
|
|
5048
5266
|
}
|
|
5049
5267
|
}
|
|
5050
5268
|
},
|
|
@@ -5112,6 +5330,11 @@
|
|
|
5112
5330
|
"name"
|
|
5113
5331
|
],
|
|
5114
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
|
+
},
|
|
5115
5338
|
"name": {
|
|
5116
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}`",
|
|
5117
5340
|
"location": "path",
|
|
@@ -5143,7 +5366,7 @@
|
|
|
5143
5366
|
"type": "string"
|
|
5144
5367
|
},
|
|
5145
5368
|
"orderBy": {
|
|
5146
|
-
"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.",
|
|
5147
5370
|
"location": "query",
|
|
5148
5371
|
"type": "string"
|
|
5149
5372
|
},
|
|
@@ -5583,7 +5806,7 @@
|
|
|
5583
5806
|
"type": "string"
|
|
5584
5807
|
},
|
|
5585
5808
|
"parent": {
|
|
5586
|
-
"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}`.",
|
|
5587
5810
|
"location": "path",
|
|
5588
5811
|
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
5589
5812
|
"required": true,
|
|
@@ -5927,7 +6150,7 @@
|
|
|
5927
6150
|
"type": "string"
|
|
5928
6151
|
},
|
|
5929
6152
|
"parent": {
|
|
5930
|
-
"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}`.",
|
|
5931
6154
|
"location": "path",
|
|
5932
6155
|
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
5933
6156
|
"required": true,
|
|
@@ -5952,6 +6175,34 @@
|
|
|
5952
6175
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
5953
6176
|
]
|
|
5954
6177
|
},
|
|
6178
|
+
"import": {
|
|
6179
|
+
"description": "Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.",
|
|
6180
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userEvents:import",
|
|
6181
|
+
"httpMethod": "POST",
|
|
6182
|
+
"id": "discoveryengine.projects.locations.userEvents.import",
|
|
6183
|
+
"parameterOrder": [
|
|
6184
|
+
"parent"
|
|
6185
|
+
],
|
|
6186
|
+
"parameters": {
|
|
6187
|
+
"parent": {
|
|
6188
|
+
"description": "Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`",
|
|
6189
|
+
"location": "path",
|
|
6190
|
+
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
|
6191
|
+
"required": true,
|
|
6192
|
+
"type": "string"
|
|
6193
|
+
}
|
|
6194
|
+
},
|
|
6195
|
+
"path": "v1/{+parent}/userEvents:import",
|
|
6196
|
+
"request": {
|
|
6197
|
+
"$ref": "GoogleCloudDiscoveryengineV1ImportUserEventsRequest"
|
|
6198
|
+
},
|
|
6199
|
+
"response": {
|
|
6200
|
+
"$ref": "GoogleLongrunningOperation"
|
|
6201
|
+
},
|
|
6202
|
+
"scopes": [
|
|
6203
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
6204
|
+
]
|
|
6205
|
+
},
|
|
5955
6206
|
"write": {
|
|
5956
6207
|
"description": "Writes a single user event.",
|
|
5957
6208
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userEvents:write",
|
|
@@ -5992,7 +6243,7 @@
|
|
|
5992
6243
|
"operations": {
|
|
5993
6244
|
"methods": {
|
|
5994
6245
|
"cancel": {
|
|
5995
|
-
"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`.",
|
|
5996
6247
|
"flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel",
|
|
5997
6248
|
"httpMethod": "POST",
|
|
5998
6249
|
"id": "discoveryengine.projects.operations.cancel",
|
|
@@ -6090,7 +6341,7 @@
|
|
|
6090
6341
|
}
|
|
6091
6342
|
}
|
|
6092
6343
|
},
|
|
6093
|
-
"revision": "
|
|
6344
|
+
"revision": "20241206",
|
|
6094
6345
|
"rootUrl": "https://discoveryengine.googleapis.com/",
|
|
6095
6346
|
"schemas": {
|
|
6096
6347
|
"GoogleApiDistribution": {
|
|
@@ -6560,6 +6811,18 @@
|
|
|
6560
6811
|
"readOnly": true,
|
|
6561
6812
|
"type": "string"
|
|
6562
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
|
+
},
|
|
6563
6826
|
"name": {
|
|
6564
6827
|
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`",
|
|
6565
6828
|
"type": "string"
|
|
@@ -6588,13 +6851,15 @@
|
|
|
6588
6851
|
"STATE_UNSPECIFIED",
|
|
6589
6852
|
"IN_PROGRESS",
|
|
6590
6853
|
"FAILED",
|
|
6591
|
-
"SUCCEEDED"
|
|
6854
|
+
"SUCCEEDED",
|
|
6855
|
+
"STREAMING"
|
|
6592
6856
|
],
|
|
6593
6857
|
"enumDescriptions": [
|
|
6594
6858
|
"Unknown.",
|
|
6595
6859
|
"Answer generation is currently in progress.",
|
|
6596
6860
|
"Answer generation currently failed.",
|
|
6597
|
-
"Answer generation has succeeded."
|
|
6861
|
+
"Answer generation has succeeded.",
|
|
6862
|
+
"Answer generation is currently in progress."
|
|
6598
6863
|
],
|
|
6599
6864
|
"type": "string"
|
|
6600
6865
|
},
|
|
@@ -6643,6 +6908,39 @@
|
|
|
6643
6908
|
},
|
|
6644
6909
|
"type": "object"
|
|
6645
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
|
+
},
|
|
6646
6944
|
"GoogleCloudDiscoveryengineV1AnswerQueryRequest": {
|
|
6647
6945
|
"description": "Request message for ConversationalSearchService.AnswerQuery method.",
|
|
6648
6946
|
"id": "GoogleCloudDiscoveryengineV1AnswerQueryRequest",
|
|
@@ -6763,6 +7061,20 @@
|
|
|
6763
7061
|
"description": "Grounding specification.",
|
|
6764
7062
|
"id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec",
|
|
6765
7063
|
"properties": {
|
|
7064
|
+
"filteringLevel": {
|
|
7065
|
+
"description": "Optional. Specifies whether to enable the filtering based on grounding score and at what level.",
|
|
7066
|
+
"enum": [
|
|
7067
|
+
"FILTERING_LEVEL_UNSPECIFIED",
|
|
7068
|
+
"FILTERING_LEVEL_LOW",
|
|
7069
|
+
"FILTERING_LEVEL_HIGH"
|
|
7070
|
+
],
|
|
7071
|
+
"enumDescriptions": [
|
|
7072
|
+
"Default is no filter",
|
|
7073
|
+
"Filter answers based on a low threshold.",
|
|
7074
|
+
"Filter answers based on a high threshold."
|
|
7075
|
+
],
|
|
7076
|
+
"type": "string"
|
|
7077
|
+
},
|
|
6766
7078
|
"includeGroundingSupports": {
|
|
6767
7079
|
"description": "Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim.",
|
|
6768
7080
|
"type": "boolean"
|
|
@@ -6825,6 +7137,31 @@
|
|
|
6825
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.",
|
|
6826
7138
|
"format": "int32",
|
|
6827
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"
|
|
6828
7165
|
}
|
|
6829
7166
|
},
|
|
6830
7167
|
"type": "object"
|
|
@@ -6841,7 +7178,7 @@
|
|
|
6841
7178
|
"type": "object"
|
|
6842
7179
|
},
|
|
6843
7180
|
"GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec": {
|
|
6844
|
-
"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.",
|
|
6845
7182
|
"id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec",
|
|
6846
7183
|
"properties": {
|
|
6847
7184
|
"enable": {
|
|
@@ -6904,7 +7241,7 @@
|
|
|
6904
7241
|
"enumDescriptions": [
|
|
6905
7242
|
"Default value.",
|
|
6906
7243
|
"Returns documents in the search result.",
|
|
6907
|
-
"Returns chunks in the search result. Only available if the
|
|
7244
|
+
"Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
|
|
6908
7245
|
],
|
|
6909
7246
|
"type": "string"
|
|
6910
7247
|
}
|
|
@@ -7815,7 +8152,7 @@
|
|
|
7815
8152
|
"type": "integer"
|
|
7816
8153
|
},
|
|
7817
8154
|
"groundingCheckRequired": {
|
|
7818
|
-
"description": "Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices
|
|
8155
|
+
"description": "Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices should not be returned.",
|
|
7819
8156
|
"type": "boolean"
|
|
7820
8157
|
},
|
|
7821
8158
|
"startPos": {
|
|
@@ -7877,7 +8214,7 @@
|
|
|
7877
8214
|
"description": "Page span of the chunk."
|
|
7878
8215
|
},
|
|
7879
8216
|
"relevanceScore": {
|
|
7880
|
-
"description": "Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on
|
|
8217
|
+
"description": "Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchResponse.",
|
|
7881
8218
|
"format": "double",
|
|
7882
8219
|
"readOnly": true,
|
|
7883
8220
|
"type": "number"
|
|
@@ -8215,6 +8552,10 @@
|
|
|
8215
8552
|
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
|
|
8216
8553
|
"type": "string"
|
|
8217
8554
|
},
|
|
8555
|
+
"promoteAction": {
|
|
8556
|
+
"$ref": "GoogleCloudDiscoveryengineV1ControlPromoteAction",
|
|
8557
|
+
"description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
|
|
8558
|
+
},
|
|
8218
8559
|
"redirectAction": {
|
|
8219
8560
|
"$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction",
|
|
8220
8561
|
"description": "Defines a redirect-type control."
|
|
@@ -8296,6 +8637,21 @@
|
|
|
8296
8637
|
},
|
|
8297
8638
|
"type": "object"
|
|
8298
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
|
+
},
|
|
8299
8655
|
"GoogleCloudDiscoveryengineV1ControlRedirectAction": {
|
|
8300
8656
|
"description": "Redirects a shopper to the provided URI.",
|
|
8301
8657
|
"id": "GoogleCloudDiscoveryengineV1ControlRedirectAction",
|
|
@@ -9006,7 +9362,12 @@
|
|
|
9006
9362
|
"description": "Detailed document information associated with a user event.",
|
|
9007
9363
|
"id": "GoogleCloudDiscoveryengineV1DocumentInfo",
|
|
9008
9364
|
"properties": {
|
|
9009
|
-
"
|
|
9365
|
+
"conversionValue": {
|
|
9366
|
+
"description": "Optional. The conversion value associated with this Document. Must be set if UserEvent.event_type is \"conversion\". For example, a value of 1000 signifies that 1000 seconds were spent viewing a Document for the `watch` conversion type.",
|
|
9367
|
+
"format": "float",
|
|
9368
|
+
"type": "number"
|
|
9369
|
+
},
|
|
9370
|
+
"id": {
|
|
9010
9371
|
"description": "The Document resource ID.",
|
|
9011
9372
|
"type": "string"
|
|
9012
9373
|
},
|
|
@@ -9382,80 +9743,6 @@
|
|
|
9382
9743
|
},
|
|
9383
9744
|
"type": "object"
|
|
9384
9745
|
},
|
|
9385
|
-
"GoogleCloudDiscoveryengineV1Feedback": {
|
|
9386
|
-
"description": "Information about the user feedback. This information will be used for logging and metrics purpose.",
|
|
9387
|
-
"id": "GoogleCloudDiscoveryengineV1Feedback",
|
|
9388
|
-
"properties": {
|
|
9389
|
-
"comment": {
|
|
9390
|
-
"description": "Optional. The additional user comment of the feedback if user gives a thumb down.",
|
|
9391
|
-
"type": "string"
|
|
9392
|
-
},
|
|
9393
|
-
"conversationInfo": {
|
|
9394
|
-
"$ref": "GoogleCloudDiscoveryengineV1FeedbackConversationInfo",
|
|
9395
|
-
"description": "The related conversation information when user gives feedback."
|
|
9396
|
-
},
|
|
9397
|
-
"feedbackType": {
|
|
9398
|
-
"description": "Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details.",
|
|
9399
|
-
"enum": [
|
|
9400
|
-
"FEEDBACK_TYPE_UNSPECIFIED",
|
|
9401
|
-
"LIKE",
|
|
9402
|
-
"DISLIKE"
|
|
9403
|
-
],
|
|
9404
|
-
"enumDescriptions": [
|
|
9405
|
-
"Unspecified feedback type.",
|
|
9406
|
-
"The user gives a positive feedback.",
|
|
9407
|
-
"The user gives a negative feedback."
|
|
9408
|
-
],
|
|
9409
|
-
"type": "string"
|
|
9410
|
-
},
|
|
9411
|
-
"llmModelVersion": {
|
|
9412
|
-
"description": "The version of the LLM model that was used to generate the response.",
|
|
9413
|
-
"type": "string"
|
|
9414
|
-
},
|
|
9415
|
-
"reasons": {
|
|
9416
|
-
"description": "Optional. The reason if user gives a thumb down.",
|
|
9417
|
-
"items": {
|
|
9418
|
-
"enum": [
|
|
9419
|
-
"REASON_UNSPECIFIED",
|
|
9420
|
-
"INACCURATE_RESPONSE",
|
|
9421
|
-
"NOT_RELEVANT",
|
|
9422
|
-
"INCOMPREHENSIVE",
|
|
9423
|
-
"OFFENSIVE_OR_UNSAFE",
|
|
9424
|
-
"BAD_CIATION",
|
|
9425
|
-
"FORMAT_AND_STYLES"
|
|
9426
|
-
],
|
|
9427
|
-
"enumDescriptions": [
|
|
9428
|
-
"Unspecified reason.",
|
|
9429
|
-
"The response is inaccurate.",
|
|
9430
|
-
"The response is not relevant.",
|
|
9431
|
-
"The response is incomprehensive.",
|
|
9432
|
-
"The response is offensive or unsafe.",
|
|
9433
|
-
"The response is not well-associated with the query.",
|
|
9434
|
-
"The response is not well-formatted."
|
|
9435
|
-
],
|
|
9436
|
-
"type": "string"
|
|
9437
|
-
},
|
|
9438
|
-
"type": "array"
|
|
9439
|
-
}
|
|
9440
|
-
},
|
|
9441
|
-
"type": "object"
|
|
9442
|
-
},
|
|
9443
|
-
"GoogleCloudDiscoveryengineV1FeedbackConversationInfo": {
|
|
9444
|
-
"description": "The conversation information such as the question index and session name.",
|
|
9445
|
-
"id": "GoogleCloudDiscoveryengineV1FeedbackConversationInfo",
|
|
9446
|
-
"properties": {
|
|
9447
|
-
"questionIndex": {
|
|
9448
|
-
"description": "The index of the user input within the conversation messages.",
|
|
9449
|
-
"format": "int32",
|
|
9450
|
-
"type": "integer"
|
|
9451
|
-
},
|
|
9452
|
-
"session": {
|
|
9453
|
-
"description": "Name of the newly generated or continued session.",
|
|
9454
|
-
"type": "string"
|
|
9455
|
-
}
|
|
9456
|
-
},
|
|
9457
|
-
"type": "object"
|
|
9458
|
-
},
|
|
9459
9746
|
"GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse": {
|
|
9460
9747
|
"description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.",
|
|
9461
9748
|
"id": "GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse",
|
|
@@ -9497,6 +9784,10 @@
|
|
|
9497
9784
|
"type": "string"
|
|
9498
9785
|
},
|
|
9499
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"
|
|
9500
9791
|
}
|
|
9501
9792
|
},
|
|
9502
9793
|
"type": "object"
|
|
@@ -10500,7 +10791,7 @@
|
|
|
10500
10791
|
"id": "GoogleCloudDiscoveryengineV1PurgeUserEventsRequest",
|
|
10501
10792
|
"properties": {
|
|
10502
10793
|
"filter": {
|
|
10503
|
-
"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.",
|
|
10504
10795
|
"type": "string"
|
|
10505
10796
|
},
|
|
10506
10797
|
"force": {
|
|
@@ -10590,7 +10881,7 @@
|
|
|
10590
10881
|
"type": "string"
|
|
10591
10882
|
},
|
|
10592
10883
|
"score": {
|
|
10593
|
-
"description": "The score of this record based on the given query and selected model.",
|
|
10884
|
+
"description": "The score of this record based on the given query and selected model. The score will be rounded to 2 decimal places. If the score is close to 0, it will be rounded to 0.0001 to avoid returning unset.",
|
|
10594
10885
|
"format": "float",
|
|
10595
10886
|
"type": "number"
|
|
10596
10887
|
},
|
|
@@ -10606,7 +10897,7 @@
|
|
|
10606
10897
|
"id": "GoogleCloudDiscoveryengineV1RecommendRequest",
|
|
10607
10898
|
"properties": {
|
|
10608
10899
|
"filter": {
|
|
10609
|
-
"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.",
|
|
10610
10901
|
"type": "string"
|
|
10611
10902
|
},
|
|
10612
10903
|
"pageSize": {
|
|
@@ -10762,6 +11053,33 @@
|
|
|
10762
11053
|
},
|
|
10763
11054
|
"type": "object"
|
|
10764
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
|
+
},
|
|
10765
11083
|
"GoogleCloudDiscoveryengineV1SearchRequest": {
|
|
10766
11084
|
"description": "Request message for SearchService.Search method.",
|
|
10767
11085
|
"id": "GoogleCloudDiscoveryengineV1SearchRequest",
|
|
@@ -10783,7 +11101,7 @@
|
|
|
10783
11101
|
"description": "A specification for configuring the behavior of content search."
|
|
10784
11102
|
},
|
|
10785
11103
|
"dataStoreSpecs": {
|
|
10786
|
-
"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.",
|
|
10787
11105
|
"items": {
|
|
10788
11106
|
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec"
|
|
10789
11107
|
},
|
|
@@ -11000,7 +11318,7 @@
|
|
|
11000
11318
|
"enumDescriptions": [
|
|
11001
11319
|
"Default value.",
|
|
11002
11320
|
"Returns documents in the search result.",
|
|
11003
|
-
"Returns chunks in the search result. Only available if the
|
|
11321
|
+
"Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
|
|
11004
11322
|
],
|
|
11005
11323
|
"type": "string"
|
|
11006
11324
|
},
|
|
@@ -11159,6 +11477,10 @@
|
|
|
11159
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.",
|
|
11160
11478
|
"id": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec",
|
|
11161
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
|
+
},
|
|
11162
11484
|
"dataStore": {
|
|
11163
11485
|
"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
|
|
11164
11486
|
"type": "string"
|
|
@@ -11376,6 +11698,13 @@
|
|
|
11376
11698
|
},
|
|
11377
11699
|
"type": "array"
|
|
11378
11700
|
},
|
|
11701
|
+
"searchLinkPromotions": {
|
|
11702
|
+
"description": "Promotions for site search.",
|
|
11703
|
+
"items": {
|
|
11704
|
+
"$ref": "GoogleCloudDiscoveryengineV1SearchLinkPromotion"
|
|
11705
|
+
},
|
|
11706
|
+
"type": "array"
|
|
11707
|
+
},
|
|
11379
11708
|
"sessionInfo": {
|
|
11380
11709
|
"$ref": "GoogleCloudDiscoveryengineV1SearchResponseSessionInfo",
|
|
11381
11710
|
"description": "Session information. Only set if SearchRequest.session is provided. See its description for more details."
|
|
@@ -11669,16 +11998,194 @@
|
|
|
11669
11998
|
},
|
|
11670
11999
|
"type": "object"
|
|
11671
12000
|
},
|
|
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",
|
|
12004
|
+
"properties": {
|
|
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": {
|
|
12008
|
+
"type": "string"
|
|
12009
|
+
},
|
|
12010
|
+
"type": "array"
|
|
12011
|
+
},
|
|
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
|
+
},
|
|
11672
12171
|
"GoogleCloudDiscoveryengineV1Session": {
|
|
11673
12172
|
"description": "External session proto definition.",
|
|
11674
12173
|
"id": "GoogleCloudDiscoveryengineV1Session",
|
|
11675
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
|
+
},
|
|
11676
12179
|
"endTime": {
|
|
11677
12180
|
"description": "Output only. The time the session finished.",
|
|
11678
12181
|
"format": "google-datetime",
|
|
11679
12182
|
"readOnly": true,
|
|
11680
12183
|
"type": "string"
|
|
11681
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
|
+
},
|
|
11682
12189
|
"name": {
|
|
11683
12190
|
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
|
|
11684
12191
|
"type": "string"
|
|
@@ -11723,6 +12230,11 @@
|
|
|
11723
12230
|
"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
|
|
11724
12231
|
"type": "string"
|
|
11725
12232
|
},
|
|
12233
|
+
"detailedAnswer": {
|
|
12234
|
+
"$ref": "GoogleCloudDiscoveryengineV1Answer",
|
|
12235
|
+
"description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.",
|
|
12236
|
+
"readOnly": true
|
|
12237
|
+
},
|
|
11726
12238
|
"query": {
|
|
11727
12239
|
"$ref": "GoogleCloudDiscoveryengineV1Query",
|
|
11728
12240
|
"description": "The user query."
|
|
@@ -12140,6 +12652,10 @@
|
|
|
12140
12652
|
"$ref": "GoogleCloudDiscoveryengineV1CompletionInfo",
|
|
12141
12653
|
"description": "CompletionService.CompleteQuery details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search."
|
|
12142
12654
|
},
|
|
12655
|
+
"conversionType": {
|
|
12656
|
+
"description": "Optional. Conversion type. Required if UserEvent.event_type is `conversion`. This is a customer-defined conversion name in lowercase letters or numbers separated by \"-\", such as \"watch\", \"good-visit\" etc. Do not set the field if UserEvent.event_type is not `conversion`. This mixes the custom conversion event with predefined events like `search`, `view-item` etc.",
|
|
12657
|
+
"type": "string"
|
|
12658
|
+
},
|
|
12143
12659
|
"dataStore": {
|
|
12144
12660
|
"description": "The DataStore resource full name, of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Optional. Only required for user events whose data store can't by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted.",
|
|
12145
12661
|
"type": "string"
|
|
@@ -12165,13 +12681,9 @@
|
|
|
12165
12681
|
"type": "string"
|
|
12166
12682
|
},
|
|
12167
12683
|
"eventType": {
|
|
12168
|
-
"description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc.",
|
|
12684
|
+
"description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.",
|
|
12169
12685
|
"type": "string"
|
|
12170
12686
|
},
|
|
12171
|
-
"feedback": {
|
|
12172
|
-
"$ref": "GoogleCloudDiscoveryengineV1Feedback",
|
|
12173
|
-
"description": "Optional. This field is optional except for the `add-feedback` event types."
|
|
12174
|
-
},
|
|
12175
12687
|
"filter": {
|
|
12176
12688
|
"description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
|
|
12177
12689
|
"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",
|
|
@@ -13512,6 +14090,17 @@
|
|
|
13512
14090
|
},
|
|
13513
14091
|
"type": "object"
|
|
13514
14092
|
},
|
|
14093
|
+
"GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest": {
|
|
14094
|
+
"description": "Request for DeleteSession method.",
|
|
14095
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest",
|
|
14096
|
+
"properties": {
|
|
14097
|
+
"name": {
|
|
14098
|
+
"description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
14099
|
+
"type": "string"
|
|
14100
|
+
}
|
|
14101
|
+
},
|
|
14102
|
+
"type": "object"
|
|
14103
|
+
},
|
|
13515
14104
|
"GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata": {
|
|
13516
14105
|
"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
13517
14106
|
"id": "GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata",
|
|
@@ -14299,6 +14888,21 @@
|
|
|
14299
14888
|
},
|
|
14300
14889
|
"type": "object"
|
|
14301
14890
|
},
|
|
14891
|
+
"GoogleCloudDiscoveryengineV1alphaGetSessionRequest": {
|
|
14892
|
+
"description": "Request for GetSession method.",
|
|
14893
|
+
"id": "GoogleCloudDiscoveryengineV1alphaGetSessionRequest",
|
|
14894
|
+
"properties": {
|
|
14895
|
+
"includeAnswerDetails": {
|
|
14896
|
+
"description": "Optional. If set to true, the full session including all answer details will be returned.",
|
|
14897
|
+
"type": "boolean"
|
|
14898
|
+
},
|
|
14899
|
+
"name": {
|
|
14900
|
+
"description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`",
|
|
14901
|
+
"type": "string"
|
|
14902
|
+
}
|
|
14903
|
+
},
|
|
14904
|
+
"type": "object"
|
|
14905
|
+
},
|
|
14302
14906
|
"GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": {
|
|
14303
14907
|
"description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.",
|
|
14304
14908
|
"id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse",
|
|
@@ -14672,6 +15276,52 @@
|
|
|
14672
15276
|
},
|
|
14673
15277
|
"type": "object"
|
|
14674
15278
|
},
|
|
15279
|
+
"GoogleCloudDiscoveryengineV1alphaListSessionsRequest": {
|
|
15280
|
+
"description": "Request for ListSessions method.",
|
|
15281
|
+
"id": "GoogleCloudDiscoveryengineV1alphaListSessionsRequest",
|
|
15282
|
+
"properties": {
|
|
15283
|
+
"filter": {
|
|
15284
|
+
"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"",
|
|
15285
|
+
"type": "string"
|
|
15286
|
+
},
|
|
15287
|
+
"orderBy": {
|
|
15288
|
+
"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.",
|
|
15289
|
+
"type": "string"
|
|
15290
|
+
},
|
|
15291
|
+
"pageSize": {
|
|
15292
|
+
"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.",
|
|
15293
|
+
"format": "int32",
|
|
15294
|
+
"type": "integer"
|
|
15295
|
+
},
|
|
15296
|
+
"pageToken": {
|
|
15297
|
+
"description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.",
|
|
15298
|
+
"type": "string"
|
|
15299
|
+
},
|
|
15300
|
+
"parent": {
|
|
15301
|
+
"description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`",
|
|
15302
|
+
"type": "string"
|
|
15303
|
+
}
|
|
15304
|
+
},
|
|
15305
|
+
"type": "object"
|
|
15306
|
+
},
|
|
15307
|
+
"GoogleCloudDiscoveryengineV1alphaListSessionsResponse": {
|
|
15308
|
+
"description": "Response for ListSessions method.",
|
|
15309
|
+
"id": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse",
|
|
15310
|
+
"properties": {
|
|
15311
|
+
"nextPageToken": {
|
|
15312
|
+
"description": "Pagination token, if not returned indicates the last page.",
|
|
15313
|
+
"type": "string"
|
|
15314
|
+
},
|
|
15315
|
+
"sessions": {
|
|
15316
|
+
"description": "All the Sessions for a given data store.",
|
|
15317
|
+
"items": {
|
|
15318
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession"
|
|
15319
|
+
},
|
|
15320
|
+
"type": "array"
|
|
15321
|
+
}
|
|
15322
|
+
},
|
|
15323
|
+
"type": "object"
|
|
15324
|
+
},
|
|
14675
15325
|
"GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig": {
|
|
14676
15326
|
"description": "Configuration for Natural Language Query Understanding.",
|
|
14677
15327
|
"id": "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig",
|
|
@@ -15207,6 +15857,33 @@
|
|
|
15207
15857
|
},
|
|
15208
15858
|
"type": "object"
|
|
15209
15859
|
},
|
|
15860
|
+
"GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion": {
|
|
15861
|
+
"description": "Promotion proto includes uri and other helping information to display the promotion.",
|
|
15862
|
+
"id": "GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion",
|
|
15863
|
+
"properties": {
|
|
15864
|
+
"description": {
|
|
15865
|
+
"description": "Optional. The Promotion description. Maximum length: 200 characters.",
|
|
15866
|
+
"type": "string"
|
|
15867
|
+
},
|
|
15868
|
+
"enabled": {
|
|
15869
|
+
"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.",
|
|
15870
|
+
"type": "boolean"
|
|
15871
|
+
},
|
|
15872
|
+
"imageUri": {
|
|
15873
|
+
"description": "Optional. The promotion thumbnail image url.",
|
|
15874
|
+
"type": "string"
|
|
15875
|
+
},
|
|
15876
|
+
"title": {
|
|
15877
|
+
"description": "Required. The title of the promotion. Maximum length: 160 characters.",
|
|
15878
|
+
"type": "string"
|
|
15879
|
+
},
|
|
15880
|
+
"uri": {
|
|
15881
|
+
"description": "Required. The URL for the page the user wants to promote.",
|
|
15882
|
+
"type": "string"
|
|
15883
|
+
}
|
|
15884
|
+
},
|
|
15885
|
+
"type": "object"
|
|
15886
|
+
},
|
|
15210
15887
|
"GoogleCloudDiscoveryengineV1alphaSearchRequest": {
|
|
15211
15888
|
"description": "Request message for SearchService.Search method.",
|
|
15212
15889
|
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequest",
|
|
@@ -15232,7 +15909,7 @@
|
|
|
15232
15909
|
"description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec."
|
|
15233
15910
|
},
|
|
15234
15911
|
"dataStoreSpecs": {
|
|
15235
|
-
"description": "Specs defining
|
|
15912
|
+
"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
15913
|
"items": {
|
|
15237
15914
|
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec"
|
|
15238
15915
|
},
|
|
@@ -15491,7 +16168,7 @@
|
|
|
15491
16168
|
"enumDescriptions": [
|
|
15492
16169
|
"Default value.",
|
|
15493
16170
|
"Returns documents in the search result.",
|
|
15494
|
-
"Returns chunks in the search result. Only available if the
|
|
16171
|
+
"Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
|
|
15495
16172
|
],
|
|
15496
16173
|
"type": "string"
|
|
15497
16174
|
},
|
|
@@ -15650,6 +16327,10 @@
|
|
|
15650
16327
|
"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
16328
|
"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec",
|
|
15652
16329
|
"properties": {
|
|
16330
|
+
"boostSpec": {
|
|
16331
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec",
|
|
16332
|
+
"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)"
|
|
16333
|
+
},
|
|
15653
16334
|
"dataStore": {
|
|
15654
16335
|
"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
|
|
15655
16336
|
"type": "string"
|
|
@@ -15915,12 +16596,20 @@
|
|
|
15915
16596
|
"description": "External session proto definition.",
|
|
15916
16597
|
"id": "GoogleCloudDiscoveryengineV1alphaSession",
|
|
15917
16598
|
"properties": {
|
|
16599
|
+
"displayName": {
|
|
16600
|
+
"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.",
|
|
16601
|
+
"type": "string"
|
|
16602
|
+
},
|
|
15918
16603
|
"endTime": {
|
|
15919
16604
|
"description": "Output only. The time the session finished.",
|
|
15920
16605
|
"format": "google-datetime",
|
|
15921
16606
|
"readOnly": true,
|
|
15922
16607
|
"type": "string"
|
|
15923
16608
|
},
|
|
16609
|
+
"isPinned": {
|
|
16610
|
+
"description": "Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.",
|
|
16611
|
+
"type": "boolean"
|
|
16612
|
+
},
|
|
15924
16613
|
"name": {
|
|
15925
16614
|
"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`",
|
|
15926
16615
|
"type": "string"
|
|
@@ -15965,6 +16654,11 @@
|
|
|
15965
16654
|
"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
|
|
15966
16655
|
"type": "string"
|
|
15967
16656
|
},
|
|
16657
|
+
"detailedAnswer": {
|
|
16658
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaAnswer",
|
|
16659
|
+
"description": "Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.",
|
|
16660
|
+
"readOnly": true
|
|
16661
|
+
},
|
|
15968
16662
|
"query": {
|
|
15969
16663
|
"$ref": "GoogleCloudDiscoveryengineV1alphaQuery",
|
|
15970
16664
|
"description": "The user query."
|
|
@@ -16249,6 +16943,22 @@
|
|
|
16249
16943
|
},
|
|
16250
16944
|
"type": "object"
|
|
16251
16945
|
},
|
|
16946
|
+
"GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest": {
|
|
16947
|
+
"description": "Request for UpdateSession method.",
|
|
16948
|
+
"id": "GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest",
|
|
16949
|
+
"properties": {
|
|
16950
|
+
"session": {
|
|
16951
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaSession",
|
|
16952
|
+
"description": "Required. The Session to update."
|
|
16953
|
+
},
|
|
16954
|
+
"updateMask": {
|
|
16955
|
+
"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.",
|
|
16956
|
+
"format": "google-fieldmask",
|
|
16957
|
+
"type": "string"
|
|
16958
|
+
}
|
|
16959
|
+
},
|
|
16960
|
+
"type": "object"
|
|
16961
|
+
},
|
|
16252
16962
|
"GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": {
|
|
16253
16963
|
"description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
16254
16964
|
"id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata",
|
|
@@ -16506,6 +17216,10 @@
|
|
|
16506
17216
|
"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`",
|
|
16507
17217
|
"type": "string"
|
|
16508
17218
|
},
|
|
17219
|
+
"promoteAction": {
|
|
17220
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaControlPromoteAction",
|
|
17221
|
+
"description": "Promote certain links based on predefined trigger queries. This now only supports basic site search."
|
|
17222
|
+
},
|
|
16509
17223
|
"redirectAction": {
|
|
16510
17224
|
"$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction",
|
|
16511
17225
|
"description": "Defines a redirect-type control."
|
|
@@ -16587,6 +17301,21 @@
|
|
|
16587
17301
|
},
|
|
16588
17302
|
"type": "object"
|
|
16589
17303
|
},
|
|
17304
|
+
"GoogleCloudDiscoveryengineV1betaControlPromoteAction": {
|
|
17305
|
+
"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.",
|
|
17306
|
+
"id": "GoogleCloudDiscoveryengineV1betaControlPromoteAction",
|
|
17307
|
+
"properties": {
|
|
17308
|
+
"dataStore": {
|
|
17309
|
+
"description": "Required. Data store with which this promotion is attached to.",
|
|
17310
|
+
"type": "string"
|
|
17311
|
+
},
|
|
17312
|
+
"searchLinkPromotion": {
|
|
17313
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion",
|
|
17314
|
+
"description": "Required. Promotion attached to this action."
|
|
17315
|
+
}
|
|
17316
|
+
},
|
|
17317
|
+
"type": "object"
|
|
17318
|
+
},
|
|
16590
17319
|
"GoogleCloudDiscoveryengineV1betaControlRedirectAction": {
|
|
16591
17320
|
"description": "Redirects a shopper to the provided URI.",
|
|
16592
17321
|
"id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction",
|
|
@@ -18058,6 +18787,33 @@
|
|
|
18058
18787
|
},
|
|
18059
18788
|
"type": "object"
|
|
18060
18789
|
},
|
|
18790
|
+
"GoogleCloudDiscoveryengineV1betaSearchLinkPromotion": {
|
|
18791
|
+
"description": "Promotion proto includes uri and other helping information to display the promotion.",
|
|
18792
|
+
"id": "GoogleCloudDiscoveryengineV1betaSearchLinkPromotion",
|
|
18793
|
+
"properties": {
|
|
18794
|
+
"description": {
|
|
18795
|
+
"description": "Optional. The Promotion description. Maximum length: 200 characters.",
|
|
18796
|
+
"type": "string"
|
|
18797
|
+
},
|
|
18798
|
+
"enabled": {
|
|
18799
|
+
"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.",
|
|
18800
|
+
"type": "boolean"
|
|
18801
|
+
},
|
|
18802
|
+
"imageUri": {
|
|
18803
|
+
"description": "Optional. The promotion thumbnail image url.",
|
|
18804
|
+
"type": "string"
|
|
18805
|
+
},
|
|
18806
|
+
"title": {
|
|
18807
|
+
"description": "Required. The title of the promotion. Maximum length: 160 characters.",
|
|
18808
|
+
"type": "string"
|
|
18809
|
+
},
|
|
18810
|
+
"uri": {
|
|
18811
|
+
"description": "Required. The URL for the page the user wants to promote.",
|
|
18812
|
+
"type": "string"
|
|
18813
|
+
}
|
|
18814
|
+
},
|
|
18815
|
+
"type": "object"
|
|
18816
|
+
},
|
|
18061
18817
|
"GoogleCloudDiscoveryengineV1betaSearchRequest": {
|
|
18062
18818
|
"description": "Request message for SearchService.Search method.",
|
|
18063
18819
|
"id": "GoogleCloudDiscoveryengineV1betaSearchRequest",
|
|
@@ -18079,7 +18835,7 @@
|
|
|
18079
18835
|
"description": "A specification for configuring the behavior of content search."
|
|
18080
18836
|
},
|
|
18081
18837
|
"dataStoreSpecs": {
|
|
18082
|
-
"description": "Specs defining
|
|
18838
|
+
"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.",
|
|
18083
18839
|
"items": {
|
|
18084
18840
|
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec"
|
|
18085
18841
|
},
|
|
@@ -18338,7 +19094,7 @@
|
|
|
18338
19094
|
"enumDescriptions": [
|
|
18339
19095
|
"Default value.",
|
|
18340
19096
|
"Returns documents in the search result.",
|
|
18341
|
-
"Returns chunks in the search result. Only available if the
|
|
19097
|
+
"Returns chunks in the search result. Only available if the DocumentProcessingConfig.chunking_config is specified."
|
|
18342
19098
|
],
|
|
18343
19099
|
"type": "string"
|
|
18344
19100
|
},
|
|
@@ -18497,6 +19253,10 @@
|
|
|
18497
19253
|
"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.",
|
|
18498
19254
|
"id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec",
|
|
18499
19255
|
"properties": {
|
|
19256
|
+
"boostSpec": {
|
|
19257
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
|
|
19258
|
+
"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)"
|
|
19259
|
+
},
|
|
18500
19260
|
"dataStore": {
|
|
18501
19261
|
"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
|
|
18502
19262
|
"type": "string"
|