google-api-python-client 2.168.0__py3-none-any.whl → 2.170.0__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.168.0.dist-info → google_api_python_client-2.170.0.dist-info}/METADATA +1 -1
- {google_api_python_client-2.168.0.dist-info → google_api_python_client-2.170.0.dist-info}/RECORD +203 -198
- googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json +2 -2
- googleapiclient/discovery_cache/documents/admin.datatransferv1.json +2 -2
- googleapiclient/discovery_cache/documents/admin.directory_v1.json +29 -5
- googleapiclient/discovery_cache/documents/admin.directoryv1.json +29 -5
- googleapiclient/discovery_cache/documents/admin.reports_v1.json +8 -10
- googleapiclient/discovery_cache/documents/admin.reportsv1.json +8 -10
- googleapiclient/discovery_cache/documents/adsense.v2.json +2 -2
- googleapiclient/discovery_cache/documents/aiplatform.v1.json +568 -25
- googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +1103 -351
- googleapiclient/discovery_cache/documents/alloydb.v1.json +68 -11
- googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +68 -11
- googleapiclient/discovery_cache/documents/alloydb.v1beta.json +68 -11
- googleapiclient/discovery_cache/documents/analyticshub.v1.json +37 -36
- googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +71 -19
- googleapiclient/discovery_cache/documents/androidmanagement.v1.json +598 -16
- googleapiclient/discovery_cache/documents/androidpublisher.v3.json +465 -6
- googleapiclient/discovery_cache/documents/apigee.v1.json +15 -13
- googleapiclient/discovery_cache/documents/apihub.v1.json +5865 -0
- googleapiclient/discovery_cache/documents/appengine.v1.json +111 -1
- googleapiclient/discovery_cache/documents/appengine.v1alpha.json +52 -1
- googleapiclient/discovery_cache/documents/appengine.v1beta.json +111 -1
- googleapiclient/discovery_cache/documents/artifactregistry.v1.json +31 -5
- googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +29 -3
- googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +29 -3
- googleapiclient/discovery_cache/documents/backupdr.v1.json +325 -3
- googleapiclient/discovery_cache/documents/bigquery.v2.json +52 -8
- googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +25 -25
- googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +283 -23
- googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +7 -3
- googleapiclient/discovery_cache/documents/blockchainnodeengine.v1.json +4 -2
- googleapiclient/discovery_cache/documents/certificatemanager.v1.json +7 -1
- googleapiclient/discovery_cache/documents/chat.v1.json +43 -41
- googleapiclient/discovery_cache/documents/chromepolicy.v1.json +2 -2
- googleapiclient/discovery_cache/documents/civicinfo.v2.json +1 -391
- googleapiclient/discovery_cache/documents/classroom.v1.json +18 -18
- googleapiclient/discovery_cache/documents/cloudbuild.v1.json +50 -3
- googleapiclient/discovery_cache/documents/cloudbuild.v2.json +6 -1
- googleapiclient/discovery_cache/documents/cloudchannel.v1.json +21 -7
- googleapiclient/discovery_cache/documents/clouddeploy.v1.json +3 -3
- googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +12 -2
- 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/cloudkms.v1.json +11 -6
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json +14 -1
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json +14 -1
- googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +96 -4
- googleapiclient/discovery_cache/documents/compute.alpha.json +287 -48
- googleapiclient/discovery_cache/documents/compute.beta.json +25240 -22195
- googleapiclient/discovery_cache/documents/compute.v1.json +2567 -278
- googleapiclient/discovery_cache/documents/connectors.v1.json +203 -74
- googleapiclient/discovery_cache/documents/connectors.v2.json +12 -1
- googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +1767 -256
- googleapiclient/discovery_cache/documents/container.v1.json +35 -1
- googleapiclient/discovery_cache/documents/container.v1beta1.json +35 -1
- googleapiclient/discovery_cache/documents/containeranalysis.v1.json +110 -8
- googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +110 -10
- googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/content.v2.1.json +2 -2
- googleapiclient/discovery_cache/documents/css.v1.json +5 -5
- googleapiclient/discovery_cache/documents/datacatalog.v1.json +4 -4
- googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/dataflow.v1b3.json +11 -3
- googleapiclient/discovery_cache/documents/dataform.v1beta1.json +228 -2
- googleapiclient/discovery_cache/documents/datamigration.v1.json +55 -3
- googleapiclient/discovery_cache/documents/dataplex.v1.json +1225 -61
- googleapiclient/discovery_cache/documents/datastream.v1.json +14 -4
- googleapiclient/discovery_cache/documents/developerconnect.v1.json +5 -3
- googleapiclient/discovery_cache/documents/dialogflow.v2.json +112 -3
- googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +76 -3
- googleapiclient/discovery_cache/documents/dialogflow.v3.json +5567 -3864
- googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +75 -8
- googleapiclient/discovery_cache/documents/discoveryengine.v1.json +852 -48
- googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +895 -62
- googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +880 -58
- googleapiclient/discovery_cache/documents/displayvideo.v2.json +43 -19
- googleapiclient/discovery_cache/documents/displayvideo.v3.json +214 -53
- googleapiclient/discovery_cache/documents/displayvideo.v4.json +208 -47
- googleapiclient/discovery_cache/documents/dlp.v2.json +4 -4
- googleapiclient/discovery_cache/documents/documentai.v1.json +20 -1
- googleapiclient/discovery_cache/documents/documentai.v1beta3.json +165 -1
- googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json +2 -2
- googleapiclient/discovery_cache/documents/drive.v2.json +18 -5
- googleapiclient/discovery_cache/documents/drive.v3.json +15 -3
- googleapiclient/discovery_cache/documents/file.v1.json +5 -6
- googleapiclient/discovery_cache/documents/file.v1beta1.json +5 -6
- googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json +2642 -0
- googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json +2714 -0
- googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +33 -3
- googleapiclient/discovery_cache/documents/forms.v1.json +9 -9
- googleapiclient/discovery_cache/documents/gkebackup.v1.json +76 -2
- googleapiclient/discovery_cache/documents/gkehub.v1.json +5 -3
- googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +148 -4
- googleapiclient/discovery_cache/documents/gkehub.v1beta.json +5 -3
- googleapiclient/discovery_cache/documents/gkehub.v2.json +3 -1
- googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +3 -1
- googleapiclient/discovery_cache/documents/gkehub.v2beta.json +3 -1
- googleapiclient/discovery_cache/documents/gkeonprem.v1.json +6 -1
- googleapiclient/discovery_cache/documents/healthcare.v1.json +23 -23
- googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +28 -28
- googleapiclient/discovery_cache/documents/iam.v1.json +21 -17
- googleapiclient/discovery_cache/documents/iam.v2.json +2 -2
- googleapiclient/discovery_cache/documents/iam.v2beta.json +2 -2
- googleapiclient/discovery_cache/documents/iamcredentials.v1.json +113 -2
- googleapiclient/discovery_cache/documents/integrations.v1.json +417 -33
- googleapiclient/discovery_cache/documents/language.v1.json +7 -1
- googleapiclient/discovery_cache/documents/language.v1beta2.json +7 -1
- googleapiclient/discovery_cache/documents/language.v2.json +7 -1
- googleapiclient/discovery_cache/documents/licensing.v1.json +2 -2
- googleapiclient/discovery_cache/documents/lifesciences.v2beta.json +7 -1
- googleapiclient/discovery_cache/documents/managedkafka.v1.json +1897 -1
- googleapiclient/discovery_cache/documents/meet.v2.json +2 -2
- googleapiclient/discovery_cache/documents/memcache.v1.json +11 -1
- googleapiclient/discovery_cache/documents/memcache.v1beta2.json +11 -1
- googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +479 -15
- googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +5 -5
- googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json +999 -0
- googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1beta.json +566 -0
- googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/metastore.v1.json +37 -1
- googleapiclient/discovery_cache/documents/metastore.v1alpha.json +37 -1
- googleapiclient/discovery_cache/documents/metastore.v1beta.json +37 -1
- googleapiclient/discovery_cache/documents/migrationcenter.v1.json +48 -1
- googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +6 -4
- googleapiclient/discovery_cache/documents/monitoring.v1.json +6 -1
- googleapiclient/discovery_cache/documents/monitoring.v3.json +2 -2
- googleapiclient/discovery_cache/documents/netapp.v1.json +54 -2
- googleapiclient/discovery_cache/documents/netapp.v1beta1.json +53 -2
- googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +155 -7
- googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +41 -1
- googleapiclient/discovery_cache/documents/networkmanagement.v1.json +15 -4
- googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +15 -4
- googleapiclient/discovery_cache/documents/networksecurity.v1.json +2363 -1082
- googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/networkservices.v1.json +36 -2
- googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +73 -2
- googleapiclient/discovery_cache/documents/notebooks.v1.json +7 -1
- googleapiclient/discovery_cache/documents/notebooks.v2.json +53 -13
- googleapiclient/discovery_cache/documents/observability.v1.json +2 -2
- googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +96 -4
- googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +96 -4
- googleapiclient/discovery_cache/documents/oracledatabase.v1.json +53 -8
- googleapiclient/discovery_cache/documents/orgpolicy.v2.json +5 -1
- googleapiclient/discovery_cache/documents/osconfig.v1.json +37 -1
- googleapiclient/discovery_cache/documents/osconfig.v1alpha.json +37 -1
- googleapiclient/discovery_cache/documents/osconfig.v1beta.json +37 -1
- googleapiclient/discovery_cache/documents/osconfig.v2.json +40 -4
- googleapiclient/discovery_cache/documents/osconfig.v2beta.json +40 -4
- googleapiclient/discovery_cache/documents/oslogin.v1alpha.json +2 -2
- googleapiclient/discovery_cache/documents/oslogin.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/parallelstore.v1.json +7 -7
- googleapiclient/discovery_cache/documents/parallelstore.v1beta.json +7 -7
- googleapiclient/discovery_cache/documents/people.v1.json +2 -2
- googleapiclient/discovery_cache/documents/places.v1.json +8 -4
- googleapiclient/discovery_cache/documents/realtimebidding.v1.json +7 -1
- googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +72 -1
- googleapiclient/discovery_cache/documents/redis.v1.json +48 -9
- googleapiclient/discovery_cache/documents/redis.v1beta1.json +48 -9
- googleapiclient/discovery_cache/documents/reseller.v1.json +14 -14
- googleapiclient/discovery_cache/documents/retail.v2.json +8 -20
- googleapiclient/discovery_cache/documents/retail.v2alpha.json +2 -7
- googleapiclient/discovery_cache/documents/retail.v2beta.json +15 -21
- googleapiclient/discovery_cache/documents/run.v1.json +93 -2
- googleapiclient/discovery_cache/documents/run.v2.json +61 -26
- googleapiclient/discovery_cache/documents/securitycenter.v1.json +85 -2
- googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +81 -1
- googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +81 -1
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +2 -2
- googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/servicecontrol.v2.json +3 -3
- googleapiclient/discovery_cache/documents/servicemanagement.v1.json +2 -2
- googleapiclient/discovery_cache/documents/servicenetworking.v1.json +2 -2
- googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/serviceusage.v1.json +2 -2
- googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/sheets.v4.json +225 -5
- googleapiclient/discovery_cache/documents/solar.v1.json +7 -7
- googleapiclient/discovery_cache/documents/sqladmin.v1.json +130 -91
- googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +126 -90
- googleapiclient/discovery_cache/documents/storage.v1.json +29 -4
- googleapiclient/discovery_cache/documents/storagetransfer.v1.json +30 -5
- googleapiclient/discovery_cache/documents/sts.v1.json +6 -1
- googleapiclient/discovery_cache/documents/sts.v1beta.json +6 -1
- googleapiclient/discovery_cache/documents/texttospeech.v1.json +11 -3
- googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +11 -3
- googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +16 -1
- googleapiclient/discovery_cache/documents/trafficdirector.v3.json +6 -2
- googleapiclient/discovery_cache/documents/translate.v3.json +7 -1
- googleapiclient/discovery_cache/documents/translate.v3beta1.json +7 -1
- googleapiclient/discovery_cache/documents/vpcaccess.v1.json +7 -1
- googleapiclient/discovery_cache/documents/vpcaccess.v1beta1.json +7 -1
- googleapiclient/discovery_cache/documents/walletobjects.v1.json +23 -23
- googleapiclient/discovery_cache/documents/workloadmanager.v1.json +5 -251
- googleapiclient/discovery_cache/documents/workspaceevents.v1.json +9 -9
- googleapiclient/discovery_cache/documents/youtube.v3.json +2 -1
- googleapiclient/version.py +1 -1
- {google_api_python_client-2.168.0.dist-info → google_api_python_client-2.170.0.dist-info}/LICENSE +0 -0
- {google_api_python_client-2.168.0.dist-info → google_api_python_client-2.170.0.dist-info}/WHEEL +0 -0
- {google_api_python_client-2.168.0.dist-info → google_api_python_client-2.170.0.dist-info}/top_level.txt +0 -0
|
@@ -635,7 +635,7 @@
|
|
|
635
635
|
],
|
|
636
636
|
"parameters": {
|
|
637
637
|
"name": {
|
|
638
|
-
"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
|
|
638
|
+
"description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
|
|
639
639
|
"location": "path",
|
|
640
640
|
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
|
|
641
641
|
"required": true,
|
|
@@ -3127,7 +3127,7 @@
|
|
|
3127
3127
|
],
|
|
3128
3128
|
"parameters": {
|
|
3129
3129
|
"name": {
|
|
3130
|
-
"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.",
|
|
3130
|
+
"description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.",
|
|
3131
3131
|
"location": "path",
|
|
3132
3132
|
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
|
|
3133
3133
|
"required": true,
|
|
@@ -3507,6 +3507,34 @@
|
|
|
3507
3507
|
},
|
|
3508
3508
|
"operations": {
|
|
3509
3509
|
"methods": {
|
|
3510
|
+
"cancel": {
|
|
3511
|
+
"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`.",
|
|
3512
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations/{operationsId}:cancel",
|
|
3513
|
+
"httpMethod": "POST",
|
|
3514
|
+
"id": "discoveryengine.projects.locations.collections.engines.operations.cancel",
|
|
3515
|
+
"parameterOrder": [
|
|
3516
|
+
"name"
|
|
3517
|
+
],
|
|
3518
|
+
"parameters": {
|
|
3519
|
+
"name": {
|
|
3520
|
+
"description": "The name of the operation resource to be cancelled.",
|
|
3521
|
+
"location": "path",
|
|
3522
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/operations/[^/]+$",
|
|
3523
|
+
"required": true,
|
|
3524
|
+
"type": "string"
|
|
3525
|
+
}
|
|
3526
|
+
},
|
|
3527
|
+
"path": "v1/{+name}:cancel",
|
|
3528
|
+
"request": {
|
|
3529
|
+
"$ref": "GoogleLongrunningCancelOperationRequest"
|
|
3530
|
+
},
|
|
3531
|
+
"response": {
|
|
3532
|
+
"$ref": "GoogleProtobufEmpty"
|
|
3533
|
+
},
|
|
3534
|
+
"scopes": [
|
|
3535
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
3536
|
+
]
|
|
3537
|
+
},
|
|
3510
3538
|
"get": {
|
|
3511
3539
|
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
|
|
3512
3540
|
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations/{operationsId}",
|
|
@@ -4251,7 +4279,7 @@
|
|
|
4251
4279
|
],
|
|
4252
4280
|
"parameters": {
|
|
4253
4281
|
"name": {
|
|
4254
|
-
"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
|
|
4282
|
+
"description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
|
|
4255
4283
|
"location": "path",
|
|
4256
4284
|
"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
|
|
4257
4285
|
"required": true,
|
|
@@ -6841,6 +6869,85 @@
|
|
|
6841
6869
|
]
|
|
6842
6870
|
}
|
|
6843
6871
|
}
|
|
6872
|
+
},
|
|
6873
|
+
"userStores": {
|
|
6874
|
+
"methods": {
|
|
6875
|
+
"batchUpdateUserLicenses": {
|
|
6876
|
+
"description": "Updates the User License. This method is used for batch assign/unassign licenses to users.",
|
|
6877
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}:batchUpdateUserLicenses",
|
|
6878
|
+
"httpMethod": "POST",
|
|
6879
|
+
"id": "discoveryengine.projects.locations.userStores.batchUpdateUserLicenses",
|
|
6880
|
+
"parameterOrder": [
|
|
6881
|
+
"parent"
|
|
6882
|
+
],
|
|
6883
|
+
"parameters": {
|
|
6884
|
+
"parent": {
|
|
6885
|
+
"description": "Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`.",
|
|
6886
|
+
"location": "path",
|
|
6887
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$",
|
|
6888
|
+
"required": true,
|
|
6889
|
+
"type": "string"
|
|
6890
|
+
}
|
|
6891
|
+
},
|
|
6892
|
+
"path": "v1/{+parent}:batchUpdateUserLicenses",
|
|
6893
|
+
"request": {
|
|
6894
|
+
"$ref": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest"
|
|
6895
|
+
},
|
|
6896
|
+
"response": {
|
|
6897
|
+
"$ref": "GoogleLongrunningOperation"
|
|
6898
|
+
},
|
|
6899
|
+
"scopes": [
|
|
6900
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
6901
|
+
]
|
|
6902
|
+
}
|
|
6903
|
+
},
|
|
6904
|
+
"resources": {
|
|
6905
|
+
"userLicenses": {
|
|
6906
|
+
"methods": {
|
|
6907
|
+
"list": {
|
|
6908
|
+
"description": "Lists the User Licenses.",
|
|
6909
|
+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/userLicenses",
|
|
6910
|
+
"httpMethod": "GET",
|
|
6911
|
+
"id": "discoveryengine.projects.locations.userStores.userLicenses.list",
|
|
6912
|
+
"parameterOrder": [
|
|
6913
|
+
"parent"
|
|
6914
|
+
],
|
|
6915
|
+
"parameters": {
|
|
6916
|
+
"filter": {
|
|
6917
|
+
"description": "Optional. Filter for the list request. Supported fields: * `license_assignment_state` Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.",
|
|
6918
|
+
"location": "query",
|
|
6919
|
+
"type": "string"
|
|
6920
|
+
},
|
|
6921
|
+
"pageSize": {
|
|
6922
|
+
"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.",
|
|
6923
|
+
"format": "int32",
|
|
6924
|
+
"location": "query",
|
|
6925
|
+
"type": "integer"
|
|
6926
|
+
},
|
|
6927
|
+
"pageToken": {
|
|
6928
|
+
"description": "Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token.",
|
|
6929
|
+
"location": "query",
|
|
6930
|
+
"type": "string"
|
|
6931
|
+
},
|
|
6932
|
+
"parent": {
|
|
6933
|
+
"description": "Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`.",
|
|
6934
|
+
"location": "path",
|
|
6935
|
+
"pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$",
|
|
6936
|
+
"required": true,
|
|
6937
|
+
"type": "string"
|
|
6938
|
+
}
|
|
6939
|
+
},
|
|
6940
|
+
"path": "v1/{+parent}/userLicenses",
|
|
6941
|
+
"response": {
|
|
6942
|
+
"$ref": "GoogleCloudDiscoveryengineV1ListUserLicensesResponse"
|
|
6943
|
+
},
|
|
6944
|
+
"scopes": [
|
|
6945
|
+
"https://www.googleapis.com/auth/cloud-platform"
|
|
6946
|
+
]
|
|
6947
|
+
}
|
|
6948
|
+
}
|
|
6949
|
+
}
|
|
6950
|
+
}
|
|
6844
6951
|
}
|
|
6845
6952
|
}
|
|
6846
6953
|
},
|
|
@@ -6945,7 +7052,7 @@
|
|
|
6945
7052
|
}
|
|
6946
7053
|
}
|
|
6947
7054
|
},
|
|
6948
|
-
"revision": "
|
|
7055
|
+
"revision": "20250514",
|
|
6949
7056
|
"rootUrl": "https://discoveryengine.googleapis.com/",
|
|
6950
7057
|
"schemas": {
|
|
6951
7058
|
"GoogleApiDistribution": {
|
|
@@ -7424,7 +7531,9 @@
|
|
|
7424
7531
|
"JAIL_BREAKING_QUERY_IGNORED",
|
|
7425
7532
|
"CUSTOMER_POLICY_VIOLATION",
|
|
7426
7533
|
"NON_ANSWER_SEEKING_QUERY_IGNORED_V2",
|
|
7427
|
-
"LOW_GROUNDED_ANSWER"
|
|
7534
|
+
"LOW_GROUNDED_ANSWER",
|
|
7535
|
+
"USER_DEFINED_CLASSIFICATION_QUERY_IGNORED",
|
|
7536
|
+
"UNHELPFUL_ANSWER"
|
|
7428
7537
|
],
|
|
7429
7538
|
"enumDescriptions": [
|
|
7430
7539
|
"Default value. The answer skipped reason is not specified.",
|
|
@@ -7436,7 +7545,9 @@
|
|
|
7436
7545
|
"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.",
|
|
7437
7546
|
"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.",
|
|
7438
7547
|
"The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent.",
|
|
7439
|
-
"The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated."
|
|
7548
|
+
"The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated.",
|
|
7549
|
+
"The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification.",
|
|
7550
|
+
"The unhelpful answer case. Google skips the answer if the answer is not helpful. This can be due to a variety of factors, including but not limited to: the query is not answerable, the answer is not relevant to the query, or the answer is not well-formatted."
|
|
7440
7551
|
],
|
|
7441
7552
|
"type": "string"
|
|
7442
7553
|
},
|
|
@@ -7569,6 +7680,60 @@
|
|
|
7569
7680
|
},
|
|
7570
7681
|
"type": "object"
|
|
7571
7682
|
},
|
|
7683
|
+
"GoogleCloudDiscoveryengineV1AnswerGenerationSpec": {
|
|
7684
|
+
"description": "The specification for answer generation.",
|
|
7685
|
+
"id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec",
|
|
7686
|
+
"properties": {
|
|
7687
|
+
"userDefinedClassifierSpec": {
|
|
7688
|
+
"$ref": "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec",
|
|
7689
|
+
"description": "Optional. The specification for user specified classifier spec."
|
|
7690
|
+
}
|
|
7691
|
+
},
|
|
7692
|
+
"type": "object"
|
|
7693
|
+
},
|
|
7694
|
+
"GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec": {
|
|
7695
|
+
"description": "The specification for user defined classifier.",
|
|
7696
|
+
"id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSpec",
|
|
7697
|
+
"properties": {
|
|
7698
|
+
"enableUserDefinedClassifier": {
|
|
7699
|
+
"description": "Optional. Whether or not to enable and include user defined classifier.",
|
|
7700
|
+
"type": "boolean"
|
|
7701
|
+
},
|
|
7702
|
+
"modelId": {
|
|
7703
|
+
"description": "Optional. The model id to be used for the user defined classifier.",
|
|
7704
|
+
"type": "string"
|
|
7705
|
+
},
|
|
7706
|
+
"preamble": {
|
|
7707
|
+
"description": "Optional. The preamble to be used for the user defined classifier.",
|
|
7708
|
+
"type": "string"
|
|
7709
|
+
},
|
|
7710
|
+
"seed": {
|
|
7711
|
+
"description": "Optional. The seed value to be used for the user defined classifier.",
|
|
7712
|
+
"format": "int32",
|
|
7713
|
+
"type": "integer"
|
|
7714
|
+
},
|
|
7715
|
+
"taskMarker": {
|
|
7716
|
+
"description": "Optional. The task marker to be used for the user defined classifier.",
|
|
7717
|
+
"type": "string"
|
|
7718
|
+
},
|
|
7719
|
+
"temperature": {
|
|
7720
|
+
"description": "Optional. The temperature value to be used for the user defined classifier.",
|
|
7721
|
+
"format": "double",
|
|
7722
|
+
"type": "number"
|
|
7723
|
+
},
|
|
7724
|
+
"topK": {
|
|
7725
|
+
"description": "Optional. The top-k value to be used for the user defined classifier.",
|
|
7726
|
+
"format": "int64",
|
|
7727
|
+
"type": "string"
|
|
7728
|
+
},
|
|
7729
|
+
"topP": {
|
|
7730
|
+
"description": "Optional. The top-p value to be used for the user defined classifier.",
|
|
7731
|
+
"format": "double",
|
|
7732
|
+
"type": "number"
|
|
7733
|
+
}
|
|
7734
|
+
},
|
|
7735
|
+
"type": "object"
|
|
7736
|
+
},
|
|
7572
7737
|
"GoogleCloudDiscoveryengineV1AnswerGroundingSupport": {
|
|
7573
7738
|
"description": "Grounding support for a claim in `answer_text`.",
|
|
7574
7739
|
"id": "GoogleCloudDiscoveryengineV1AnswerGroundingSupport",
|
|
@@ -7829,14 +7994,16 @@
|
|
|
7829
7994
|
"ADVERSARIAL_QUERY",
|
|
7830
7995
|
"NON_ANSWER_SEEKING_QUERY",
|
|
7831
7996
|
"JAIL_BREAKING_QUERY",
|
|
7832
|
-
"NON_ANSWER_SEEKING_QUERY_V2"
|
|
7997
|
+
"NON_ANSWER_SEEKING_QUERY_V2",
|
|
7998
|
+
"USER_DEFINED_CLASSIFICATION_QUERY"
|
|
7833
7999
|
],
|
|
7834
8000
|
"enumDescriptions": [
|
|
7835
8001
|
"Unspecified query classification type.",
|
|
7836
8002
|
"Adversarial query classification type.",
|
|
7837
8003
|
"Non-answer-seeking query classification type, for chit chat.",
|
|
7838
8004
|
"Jail-breaking query classification type.",
|
|
7839
|
-
"Non-answer-seeking query classification type, for no clear intent."
|
|
8005
|
+
"Non-answer-seeking query classification type, for no clear intent.",
|
|
8006
|
+
"User defined query classification type."
|
|
7840
8007
|
],
|
|
7841
8008
|
"type": "string"
|
|
7842
8009
|
},
|
|
@@ -8219,14 +8386,16 @@
|
|
|
8219
8386
|
"ADVERSARIAL_QUERY",
|
|
8220
8387
|
"NON_ANSWER_SEEKING_QUERY",
|
|
8221
8388
|
"JAIL_BREAKING_QUERY",
|
|
8222
|
-
"NON_ANSWER_SEEKING_QUERY_V2"
|
|
8389
|
+
"NON_ANSWER_SEEKING_QUERY_V2",
|
|
8390
|
+
"USER_DEFINED_CLASSIFICATION_QUERY"
|
|
8223
8391
|
],
|
|
8224
8392
|
"enumDescriptions": [
|
|
8225
8393
|
"Unspecified query classification type.",
|
|
8226
8394
|
"Adversarial query classification type.",
|
|
8227
8395
|
"Non-answer-seeking query classification type, for chit chat.",
|
|
8228
8396
|
"Jail-breaking query classification type.",
|
|
8229
|
-
"Non-answer-seeking query classification type, for no clear intent."
|
|
8397
|
+
"Non-answer-seeking query classification type, for no clear intent.",
|
|
8398
|
+
"User defined query classification type."
|
|
8230
8399
|
],
|
|
8231
8400
|
"type": "string"
|
|
8232
8401
|
}
|
|
@@ -8653,6 +8822,44 @@
|
|
|
8653
8822
|
},
|
|
8654
8823
|
"type": "object"
|
|
8655
8824
|
},
|
|
8825
|
+
"GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest": {
|
|
8826
|
+
"description": "Request message for UserLicenseService.BatchUpdateUserLicenses method.",
|
|
8827
|
+
"id": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest",
|
|
8828
|
+
"properties": {
|
|
8829
|
+
"deleteUnassignedUserLicenses": {
|
|
8830
|
+
"description": "Optional. If true, if user licenses removed associated license config, the user license will be deleted. By default which is false, the user license will be updated to unassigned state.",
|
|
8831
|
+
"type": "boolean"
|
|
8832
|
+
},
|
|
8833
|
+
"gcsSource": {
|
|
8834
|
+
"$ref": "GoogleCloudDiscoveryengineV1GcsSource",
|
|
8835
|
+
"description": "Cloud Storage location for the input content."
|
|
8836
|
+
},
|
|
8837
|
+
"inlineSource": {
|
|
8838
|
+
"$ref": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource",
|
|
8839
|
+
"description": "The inline source for the input content for document embeddings."
|
|
8840
|
+
}
|
|
8841
|
+
},
|
|
8842
|
+
"type": "object"
|
|
8843
|
+
},
|
|
8844
|
+
"GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource": {
|
|
8845
|
+
"description": "The inline source for the input config for BatchUpdateUserLicenses method.",
|
|
8846
|
+
"id": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource",
|
|
8847
|
+
"properties": {
|
|
8848
|
+
"updateMask": {
|
|
8849
|
+
"description": "Optional. The list of fields to update.",
|
|
8850
|
+
"format": "google-fieldmask",
|
|
8851
|
+
"type": "string"
|
|
8852
|
+
},
|
|
8853
|
+
"userLicenses": {
|
|
8854
|
+
"description": "Required. A list of user licenses to update. Each user license must have a valid UserLicense.user_principal.",
|
|
8855
|
+
"items": {
|
|
8856
|
+
"$ref": "GoogleCloudDiscoveryengineV1UserLicense"
|
|
8857
|
+
},
|
|
8858
|
+
"type": "array"
|
|
8859
|
+
}
|
|
8860
|
+
},
|
|
8861
|
+
"type": "object"
|
|
8862
|
+
},
|
|
8656
8863
|
"GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest": {
|
|
8657
8864
|
"description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.",
|
|
8658
8865
|
"id": "GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest",
|
|
@@ -8939,6 +9146,11 @@
|
|
|
8939
9146
|
"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.",
|
|
8940
9147
|
"type": "boolean"
|
|
8941
9148
|
},
|
|
9149
|
+
"score": {
|
|
9150
|
+
"description": "Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true.",
|
|
9151
|
+
"format": "double",
|
|
9152
|
+
"type": "number"
|
|
9153
|
+
},
|
|
8942
9154
|
"startPos": {
|
|
8943
9155
|
"description": "Position indicating the start of the claim in the answer candidate, measured in bytes. Note that this is not measured in characters and, therefore, must be rendered in the user interface keeping in mind that some characters may take more than one byte. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent).",
|
|
8944
9156
|
"format": "int32",
|
|
@@ -8955,6 +9167,10 @@
|
|
|
8955
9167
|
"description": "The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6.",
|
|
8956
9168
|
"format": "double",
|
|
8957
9169
|
"type": "number"
|
|
9170
|
+
},
|
|
9171
|
+
"enableClaimLevelScore": {
|
|
9172
|
+
"description": "The control flag that enables claim-level grounding score in the response.",
|
|
9173
|
+
"type": "boolean"
|
|
8958
9174
|
}
|
|
8959
9175
|
},
|
|
8960
9176
|
"type": "object"
|
|
@@ -9380,7 +9596,7 @@
|
|
|
9380
9596
|
},
|
|
9381
9597
|
"promoteAction": {
|
|
9382
9598
|
"$ref": "GoogleCloudDiscoveryengineV1ControlPromoteAction",
|
|
9383
|
-
"description": "Promote certain links based on predefined trigger queries.
|
|
9599
|
+
"description": "Promote certain links based on predefined trigger queries."
|
|
9384
9600
|
},
|
|
9385
9601
|
"redirectAction": {
|
|
9386
9602
|
"$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction",
|
|
@@ -10005,7 +10221,7 @@
|
|
|
10005
10221
|
"type": "string"
|
|
10006
10222
|
},
|
|
10007
10223
|
"name": {
|
|
10008
|
-
"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
|
|
10224
|
+
"description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
|
|
10009
10225
|
"type": "string"
|
|
10010
10226
|
},
|
|
10011
10227
|
"servingConfigDataStore": {
|
|
@@ -10086,7 +10302,7 @@
|
|
|
10086
10302
|
"id": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore",
|
|
10087
10303
|
"properties": {
|
|
10088
10304
|
"disabledForServing": {
|
|
10089
|
-
"description": "If set true, the DataStore will not be available for serving search requests.",
|
|
10305
|
+
"description": "Optional. If set true, the DataStore will not be available for serving search requests.",
|
|
10090
10306
|
"type": "boolean"
|
|
10091
10307
|
}
|
|
10092
10308
|
},
|
|
@@ -10340,7 +10556,7 @@
|
|
|
10340
10556
|
"id": "GoogleCloudDiscoveryengineV1DocumentContent",
|
|
10341
10557
|
"properties": {
|
|
10342
10558
|
"mimeType": {
|
|
10343
|
-
"description": "The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml.",
|
|
10559
|
+
"description": "The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml.",
|
|
10344
10560
|
"type": "string"
|
|
10345
10561
|
},
|
|
10346
10562
|
"rawBytes": {
|
|
@@ -10508,6 +10724,27 @@
|
|
|
10508
10724
|
"enableTableAnnotation": {
|
|
10509
10725
|
"description": "Optional. If true, the LLM based annotation is added to the table during parsing.",
|
|
10510
10726
|
"type": "boolean"
|
|
10727
|
+
},
|
|
10728
|
+
"excludeHtmlClasses": {
|
|
10729
|
+
"description": "Optional. List of HTML classes to exclude from the parsed content.",
|
|
10730
|
+
"items": {
|
|
10731
|
+
"type": "string"
|
|
10732
|
+
},
|
|
10733
|
+
"type": "array"
|
|
10734
|
+
},
|
|
10735
|
+
"excludeHtmlElements": {
|
|
10736
|
+
"description": "Optional. List of HTML elements to exclude from the parsed content.",
|
|
10737
|
+
"items": {
|
|
10738
|
+
"type": "string"
|
|
10739
|
+
},
|
|
10740
|
+
"type": "array"
|
|
10741
|
+
},
|
|
10742
|
+
"excludeHtmlIds": {
|
|
10743
|
+
"description": "Optional. List of HTML ids to exclude from the parsed content.",
|
|
10744
|
+
"items": {
|
|
10745
|
+
"type": "string"
|
|
10746
|
+
},
|
|
10747
|
+
"type": "array"
|
|
10511
10748
|
}
|
|
10512
10749
|
},
|
|
10513
10750
|
"type": "object"
|
|
@@ -10599,7 +10836,7 @@
|
|
|
10599
10836
|
"type": "string"
|
|
10600
10837
|
},
|
|
10601
10838
|
"dataStoreIds": {
|
|
10602
|
-
"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.",
|
|
10839
|
+
"description": "Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.",
|
|
10603
10840
|
"items": {
|
|
10604
10841
|
"type": "string"
|
|
10605
10842
|
},
|
|
@@ -10614,7 +10851,7 @@
|
|
|
10614
10851
|
"type": "string"
|
|
10615
10852
|
},
|
|
10616
10853
|
"industryVertical": {
|
|
10617
|
-
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.",
|
|
10854
|
+
"description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.",
|
|
10618
10855
|
"enum": [
|
|
10619
10856
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
10620
10857
|
"GENERIC",
|
|
@@ -10629,8 +10866,12 @@
|
|
|
10629
10866
|
],
|
|
10630
10867
|
"type": "string"
|
|
10631
10868
|
},
|
|
10869
|
+
"mediaRecommendationEngineConfig": {
|
|
10870
|
+
"$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig",
|
|
10871
|
+
"description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical."
|
|
10872
|
+
},
|
|
10632
10873
|
"name": {
|
|
10633
|
-
"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.",
|
|
10874
|
+
"description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.",
|
|
10634
10875
|
"type": "string"
|
|
10635
10876
|
},
|
|
10636
10877
|
"searchEngineConfig": {
|
|
@@ -10728,6 +10969,97 @@
|
|
|
10728
10969
|
},
|
|
10729
10970
|
"type": "object"
|
|
10730
10971
|
},
|
|
10972
|
+
"GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig": {
|
|
10973
|
+
"description": "Additional config specs for a Media Recommendation engine.",
|
|
10974
|
+
"id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig",
|
|
10975
|
+
"properties": {
|
|
10976
|
+
"engineFeaturesConfig": {
|
|
10977
|
+
"$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig",
|
|
10978
|
+
"description": "Optional. Additional engine features config."
|
|
10979
|
+
},
|
|
10980
|
+
"optimizationObjective": {
|
|
10981
|
+
"description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`",
|
|
10982
|
+
"type": "string"
|
|
10983
|
+
},
|
|
10984
|
+
"optimizationObjectiveConfig": {
|
|
10985
|
+
"$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig",
|
|
10986
|
+
"description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)."
|
|
10987
|
+
},
|
|
10988
|
+
"trainingState": {
|
|
10989
|
+
"description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.",
|
|
10990
|
+
"enum": [
|
|
10991
|
+
"TRAINING_STATE_UNSPECIFIED",
|
|
10992
|
+
"PAUSED",
|
|
10993
|
+
"TRAINING"
|
|
10994
|
+
],
|
|
10995
|
+
"enumDescriptions": [
|
|
10996
|
+
"Unspecified training state.",
|
|
10997
|
+
"The engine training is paused.",
|
|
10998
|
+
"The engine is training."
|
|
10999
|
+
],
|
|
11000
|
+
"type": "string"
|
|
11001
|
+
},
|
|
11002
|
+
"type": {
|
|
11003
|
+
"description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.",
|
|
11004
|
+
"type": "string"
|
|
11005
|
+
}
|
|
11006
|
+
},
|
|
11007
|
+
"type": "object"
|
|
11008
|
+
},
|
|
11009
|
+
"GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig": {
|
|
11010
|
+
"description": "More feature configs of the selected engine type.",
|
|
11011
|
+
"id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig",
|
|
11012
|
+
"properties": {
|
|
11013
|
+
"mostPopularConfig": {
|
|
11014
|
+
"$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig",
|
|
11015
|
+
"description": "Most popular engine feature config."
|
|
11016
|
+
},
|
|
11017
|
+
"recommendedForYouConfig": {
|
|
11018
|
+
"$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig",
|
|
11019
|
+
"description": "Recommended for you engine feature config."
|
|
11020
|
+
}
|
|
11021
|
+
},
|
|
11022
|
+
"type": "object"
|
|
11023
|
+
},
|
|
11024
|
+
"GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig": {
|
|
11025
|
+
"description": "Feature configurations that are required for creating a Most Popular engine.",
|
|
11026
|
+
"id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigMostPopularFeatureConfig",
|
|
11027
|
+
"properties": {
|
|
11028
|
+
"timeWindowDays": {
|
|
11029
|
+
"description": "The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.",
|
|
11030
|
+
"format": "int64",
|
|
11031
|
+
"type": "string"
|
|
11032
|
+
}
|
|
11033
|
+
},
|
|
11034
|
+
"type": "object"
|
|
11035
|
+
},
|
|
11036
|
+
"GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": {
|
|
11037
|
+
"description": "Custom threshold for `cvr` optimization_objective.",
|
|
11038
|
+
"id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig",
|
|
11039
|
+
"properties": {
|
|
11040
|
+
"targetField": {
|
|
11041
|
+
"description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.",
|
|
11042
|
+
"type": "string"
|
|
11043
|
+
},
|
|
11044
|
+
"targetFieldValueFloat": {
|
|
11045
|
+
"description": "Required. The threshold to be applied to the target (e.g., 0.5).",
|
|
11046
|
+
"format": "float",
|
|
11047
|
+
"type": "number"
|
|
11048
|
+
}
|
|
11049
|
+
},
|
|
11050
|
+
"type": "object"
|
|
11051
|
+
},
|
|
11052
|
+
"GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": {
|
|
11053
|
+
"description": "Additional feature configurations for creating a `recommended-for-you` engine.",
|
|
11054
|
+
"id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig",
|
|
11055
|
+
"properties": {
|
|
11056
|
+
"contextEventType": {
|
|
11057
|
+
"description": "The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.",
|
|
11058
|
+
"type": "string"
|
|
11059
|
+
}
|
|
11060
|
+
},
|
|
11061
|
+
"type": "object"
|
|
11062
|
+
},
|
|
10731
11063
|
"GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": {
|
|
10732
11064
|
"description": "Configurations for a Search Engine.",
|
|
10733
11065
|
"id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig",
|
|
@@ -10772,6 +11104,10 @@
|
|
|
10772
11104
|
"description": "Text content of the fact chunk. Can be at most 10K characters long.",
|
|
10773
11105
|
"type": "string"
|
|
10774
11106
|
},
|
|
11107
|
+
"domain": {
|
|
11108
|
+
"description": "The domain of the source.",
|
|
11109
|
+
"type": "string"
|
|
11110
|
+
},
|
|
10775
11111
|
"index": {
|
|
10776
11112
|
"description": "The index of this chunk. Currently, only used for the streaming mode.",
|
|
10777
11113
|
"format": "int32",
|
|
@@ -10787,6 +11123,14 @@
|
|
|
10787
11123
|
},
|
|
10788
11124
|
"description": "More fine-grained information for the source reference.",
|
|
10789
11125
|
"type": "object"
|
|
11126
|
+
},
|
|
11127
|
+
"title": {
|
|
11128
|
+
"description": "The title of the source.",
|
|
11129
|
+
"type": "string"
|
|
11130
|
+
},
|
|
11131
|
+
"uri": {
|
|
11132
|
+
"description": "The URI of the source.",
|
|
11133
|
+
"type": "string"
|
|
10790
11134
|
}
|
|
10791
11135
|
},
|
|
10792
11136
|
"type": "object"
|
|
@@ -11676,6 +12020,24 @@
|
|
|
11676
12020
|
},
|
|
11677
12021
|
"type": "object"
|
|
11678
12022
|
},
|
|
12023
|
+
"GoogleCloudDiscoveryengineV1ListUserLicensesResponse": {
|
|
12024
|
+
"description": "Response message for UserLicenseService.ListUserLicenses.",
|
|
12025
|
+
"id": "GoogleCloudDiscoveryengineV1ListUserLicensesResponse",
|
|
12026
|
+
"properties": {
|
|
12027
|
+
"nextPageToken": {
|
|
12028
|
+
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
|
|
12029
|
+
"type": "string"
|
|
12030
|
+
},
|
|
12031
|
+
"userLicenses": {
|
|
12032
|
+
"description": "All the customer's UserLicenses.",
|
|
12033
|
+
"items": {
|
|
12034
|
+
"$ref": "GoogleCloudDiscoveryengineV1UserLicense"
|
|
12035
|
+
},
|
|
12036
|
+
"type": "array"
|
|
12037
|
+
}
|
|
12038
|
+
},
|
|
12039
|
+
"type": "object"
|
|
12040
|
+
},
|
|
11679
12041
|
"GoogleCloudDiscoveryengineV1MediaInfo": {
|
|
11680
12042
|
"description": "Media-specific user event information.",
|
|
11681
12043
|
"id": "GoogleCloudDiscoveryengineV1MediaInfo",
|
|
@@ -12884,6 +13246,10 @@
|
|
|
12884
13246
|
"$ref": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpec",
|
|
12885
13247
|
"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)"
|
|
12886
13248
|
},
|
|
13249
|
+
"customSearchOperators": {
|
|
13250
|
+
"description": "Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).",
|
|
13251
|
+
"type": "string"
|
|
13252
|
+
},
|
|
12887
13253
|
"dataStore": {
|
|
12888
13254
|
"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
|
|
12889
13255
|
"type": "string"
|
|
@@ -13449,6 +13815,10 @@
|
|
|
13449
13815
|
"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.",
|
|
13450
13816
|
"id": "GoogleCloudDiscoveryengineV1ServingConfig",
|
|
13451
13817
|
"properties": {
|
|
13818
|
+
"answerGenerationSpec": {
|
|
13819
|
+
"$ref": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec",
|
|
13820
|
+
"description": "Optional. The specification for answer generation."
|
|
13821
|
+
},
|
|
13452
13822
|
"boostControlIds": {
|
|
13453
13823
|
"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.",
|
|
13454
13824
|
"items": {
|
|
@@ -14247,12 +14617,72 @@
|
|
|
14247
14617
|
},
|
|
14248
14618
|
"type": "object"
|
|
14249
14619
|
},
|
|
14250
|
-
"
|
|
14251
|
-
"description": "
|
|
14252
|
-
"id": "
|
|
14620
|
+
"GoogleCloudDiscoveryengineV1UserLicense": {
|
|
14621
|
+
"description": "User License information assigned by the admin.",
|
|
14622
|
+
"id": "GoogleCloudDiscoveryengineV1UserLicense",
|
|
14253
14623
|
"properties": {
|
|
14254
|
-
"
|
|
14255
|
-
"description": "
|
|
14624
|
+
"createTime": {
|
|
14625
|
+
"description": "Output only. User created timestamp.",
|
|
14626
|
+
"format": "google-datetime",
|
|
14627
|
+
"readOnly": true,
|
|
14628
|
+
"type": "string"
|
|
14629
|
+
},
|
|
14630
|
+
"lastLoginTime": {
|
|
14631
|
+
"description": "Output only. User last logged in time. If the user has not logged in yet, this field will be empty.",
|
|
14632
|
+
"format": "google-datetime",
|
|
14633
|
+
"readOnly": true,
|
|
14634
|
+
"type": "string"
|
|
14635
|
+
},
|
|
14636
|
+
"licenseAssignmentState": {
|
|
14637
|
+
"description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;",
|
|
14638
|
+
"enum": [
|
|
14639
|
+
"LICENSE_ASSIGNMENT_STATE_UNSPECIFIED",
|
|
14640
|
+
"ASSIGNED",
|
|
14641
|
+
"UNASSIGNED",
|
|
14642
|
+
"NO_LICENSE",
|
|
14643
|
+
"NO_LICENSE_ATTEMPTED_LOGIN"
|
|
14644
|
+
],
|
|
14645
|
+
"enumDescriptions": [
|
|
14646
|
+
"Default value.",
|
|
14647
|
+
"License assigned to the user.",
|
|
14648
|
+
"No license assigned to the user. Deprecated, translated to NO_LICENSE.",
|
|
14649
|
+
"No license assigned to the user.",
|
|
14650
|
+
"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)."
|
|
14651
|
+
],
|
|
14652
|
+
"readOnly": true,
|
|
14653
|
+
"type": "string"
|
|
14654
|
+
},
|
|
14655
|
+
"licenseConfig": {
|
|
14656
|
+
"description": "Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.",
|
|
14657
|
+
"type": "string"
|
|
14658
|
+
},
|
|
14659
|
+
"updateTime": {
|
|
14660
|
+
"description": "Output only. User update timestamp.",
|
|
14661
|
+
"format": "google-datetime",
|
|
14662
|
+
"readOnly": true,
|
|
14663
|
+
"type": "string"
|
|
14664
|
+
},
|
|
14665
|
+
"user": {
|
|
14666
|
+
"description": "Optional. The full resource name of the User, in the format of `projects/{project}/locations/{location}/userStores/{user_store}/users/{user_id}`. This field must be a UTF-8 encoded string with a length limit of 2048 characters. If the user field is empty, it's indicating the user has not logged in yet and no User entity is created.",
|
|
14667
|
+
"type": "string"
|
|
14668
|
+
},
|
|
14669
|
+
"userPrincipal": {
|
|
14670
|
+
"description": "Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.",
|
|
14671
|
+
"type": "string"
|
|
14672
|
+
},
|
|
14673
|
+
"userProfile": {
|
|
14674
|
+
"description": "Optional. The user profile. We user user full name(First name + Last name) as user profile.",
|
|
14675
|
+
"type": "string"
|
|
14676
|
+
}
|
|
14677
|
+
},
|
|
14678
|
+
"type": "object"
|
|
14679
|
+
},
|
|
14680
|
+
"GoogleCloudDiscoveryengineV1WorkspaceConfig": {
|
|
14681
|
+
"description": "Config to store data store type configuration for workspace data",
|
|
14682
|
+
"id": "GoogleCloudDiscoveryengineV1WorkspaceConfig",
|
|
14683
|
+
"properties": {
|
|
14684
|
+
"dasherCustomerId": {
|
|
14685
|
+
"description": "Obfuscated Dasher customer ID.",
|
|
14256
14686
|
"type": "string"
|
|
14257
14687
|
},
|
|
14258
14688
|
"superAdminEmailAddress": {
|
|
@@ -14406,7 +14836,9 @@
|
|
|
14406
14836
|
"JAIL_BREAKING_QUERY_IGNORED",
|
|
14407
14837
|
"CUSTOMER_POLICY_VIOLATION",
|
|
14408
14838
|
"NON_ANSWER_SEEKING_QUERY_IGNORED_V2",
|
|
14409
|
-
"LOW_GROUNDED_ANSWER"
|
|
14839
|
+
"LOW_GROUNDED_ANSWER",
|
|
14840
|
+
"USER_DEFINED_CLASSIFICATION_QUERY_IGNORED",
|
|
14841
|
+
"UNHELPFUL_ANSWER"
|
|
14410
14842
|
],
|
|
14411
14843
|
"enumDescriptions": [
|
|
14412
14844
|
"Default value. The answer skipped reason is not specified.",
|
|
@@ -14418,7 +14850,9 @@
|
|
|
14418
14850
|
"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.",
|
|
14419
14851
|
"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.",
|
|
14420
14852
|
"The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent.",
|
|
14421
|
-
"The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated."
|
|
14853
|
+
"The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated.",
|
|
14854
|
+
"The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification.",
|
|
14855
|
+
"The unhelpful answer case. Google skips the answer if the answer is not helpful. This can be due to a variety of factors, including but not limited to: the query is not answerable, the answer is not relevant to the query, or the answer is not well-formatted."
|
|
14422
14856
|
],
|
|
14423
14857
|
"type": "string"
|
|
14424
14858
|
},
|
|
@@ -14665,14 +15099,16 @@
|
|
|
14665
15099
|
"ADVERSARIAL_QUERY",
|
|
14666
15100
|
"NON_ANSWER_SEEKING_QUERY",
|
|
14667
15101
|
"JAIL_BREAKING_QUERY",
|
|
14668
|
-
"NON_ANSWER_SEEKING_QUERY_V2"
|
|
15102
|
+
"NON_ANSWER_SEEKING_QUERY_V2",
|
|
15103
|
+
"USER_DEFINED_CLASSIFICATION_QUERY"
|
|
14669
15104
|
],
|
|
14670
15105
|
"enumDescriptions": [
|
|
14671
15106
|
"Unspecified query classification type.",
|
|
14672
15107
|
"Adversarial query classification type.",
|
|
14673
15108
|
"Non-answer-seeking query classification type, for chit chat.",
|
|
14674
15109
|
"Jail-breaking query classification type.",
|
|
14675
|
-
"Non-answer-seeking query classification type, for no clear intent."
|
|
15110
|
+
"Non-answer-seeking query classification type, for no clear intent.",
|
|
15111
|
+
"User defined query classification type."
|
|
14676
15112
|
],
|
|
14677
15113
|
"type": "string"
|
|
14678
15114
|
}
|
|
@@ -15017,12 +15453,14 @@
|
|
|
15017
15453
|
"enum": [
|
|
15018
15454
|
"CONNECTOR_MODE_UNSPECIFIED",
|
|
15019
15455
|
"DATA_INGESTION",
|
|
15020
|
-
"ACTIONS"
|
|
15456
|
+
"ACTIONS",
|
|
15457
|
+
"END_USER_AUTHENTICATION"
|
|
15021
15458
|
],
|
|
15022
15459
|
"enumDescriptions": [
|
|
15023
15460
|
"Connector mode unspecified.",
|
|
15024
15461
|
"Connector utilized for data ingestion.",
|
|
15025
|
-
"Connector utilized for Actions"
|
|
15462
|
+
"Connector utilized for Actions",
|
|
15463
|
+
"Connector utilized for End User Authentication."
|
|
15026
15464
|
],
|
|
15027
15465
|
"type": "string"
|
|
15028
15466
|
},
|
|
@@ -15062,6 +15500,54 @@
|
|
|
15062
15500
|
},
|
|
15063
15501
|
"type": "object"
|
|
15064
15502
|
},
|
|
15503
|
+
"GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata": {
|
|
15504
|
+
"description": "Metadata related to the progress of the UserLicenseService.BatchUpdateUserLicenses operation. This will be returned by the google.longrunning.Operation.metadata field.",
|
|
15505
|
+
"id": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata",
|
|
15506
|
+
"properties": {
|
|
15507
|
+
"createTime": {
|
|
15508
|
+
"description": "Operation create time.",
|
|
15509
|
+
"format": "google-datetime",
|
|
15510
|
+
"type": "string"
|
|
15511
|
+
},
|
|
15512
|
+
"failureCount": {
|
|
15513
|
+
"description": "Count of user licenses that failed to be updated.",
|
|
15514
|
+
"format": "int64",
|
|
15515
|
+
"type": "string"
|
|
15516
|
+
},
|
|
15517
|
+
"successCount": {
|
|
15518
|
+
"description": "Count of user licenses successfully updated.",
|
|
15519
|
+
"format": "int64",
|
|
15520
|
+
"type": "string"
|
|
15521
|
+
},
|
|
15522
|
+
"updateTime": {
|
|
15523
|
+
"description": "Operation last update time. If the operation is done, this is also the finish time.",
|
|
15524
|
+
"format": "google-datetime",
|
|
15525
|
+
"type": "string"
|
|
15526
|
+
}
|
|
15527
|
+
},
|
|
15528
|
+
"type": "object"
|
|
15529
|
+
},
|
|
15530
|
+
"GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse": {
|
|
15531
|
+
"description": "Response message for UserLicenseService.BatchUpdateUserLicenses method.",
|
|
15532
|
+
"id": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse",
|
|
15533
|
+
"properties": {
|
|
15534
|
+
"errorSamples": {
|
|
15535
|
+
"description": "A sample of errors encountered while processing the request.",
|
|
15536
|
+
"items": {
|
|
15537
|
+
"$ref": "GoogleRpcStatus"
|
|
15538
|
+
},
|
|
15539
|
+
"type": "array"
|
|
15540
|
+
},
|
|
15541
|
+
"userLicenses": {
|
|
15542
|
+
"description": "UserLicenses successfully updated.",
|
|
15543
|
+
"items": {
|
|
15544
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaUserLicense"
|
|
15545
|
+
},
|
|
15546
|
+
"type": "array"
|
|
15547
|
+
}
|
|
15548
|
+
},
|
|
15549
|
+
"type": "object"
|
|
15550
|
+
},
|
|
15065
15551
|
"GoogleCloudDiscoveryengineV1alphaCmekConfig": {
|
|
15066
15552
|
"description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.",
|
|
15067
15553
|
"id": "GoogleCloudDiscoveryengineV1alphaCmekConfig",
|
|
@@ -15406,13 +15892,15 @@
|
|
|
15406
15892
|
"SYNC_TYPE_UNSPECIFIED",
|
|
15407
15893
|
"FULL",
|
|
15408
15894
|
"INCREMENTAL",
|
|
15409
|
-
"REALTIME"
|
|
15895
|
+
"REALTIME",
|
|
15896
|
+
"SCALA_SYNC"
|
|
15410
15897
|
],
|
|
15411
15898
|
"enumDescriptions": [
|
|
15412
15899
|
"Sync type unspecified.",
|
|
15413
15900
|
"Sync triggers full sync of all documents.",
|
|
15414
15901
|
"Incremental sync of updated documents.",
|
|
15415
|
-
"Realtime sync."
|
|
15902
|
+
"Realtime sync.",
|
|
15903
|
+
"Scala sync."
|
|
15416
15904
|
],
|
|
15417
15905
|
"type": "string"
|
|
15418
15906
|
}
|
|
@@ -15478,7 +15966,7 @@
|
|
|
15478
15966
|
},
|
|
15479
15967
|
"promoteAction": {
|
|
15480
15968
|
"$ref": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction",
|
|
15481
|
-
"description": "Promote certain links based on predefined trigger queries.
|
|
15969
|
+
"description": "Promote certain links based on predefined trigger queries."
|
|
15482
15970
|
},
|
|
15483
15971
|
"redirectAction": {
|
|
15484
15972
|
"$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction",
|
|
@@ -15788,6 +16276,10 @@
|
|
|
15788
16276
|
"description": "Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.",
|
|
15789
16277
|
"id": "GoogleCloudDiscoveryengineV1alphaDataConnector",
|
|
15790
16278
|
"properties": {
|
|
16279
|
+
"aclEnabled": {
|
|
16280
|
+
"description": "Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.",
|
|
16281
|
+
"type": "boolean"
|
|
16282
|
+
},
|
|
15791
16283
|
"actionConfig": {
|
|
15792
16284
|
"$ref": "GoogleCloudDiscoveryengineV1alphaActionConfig",
|
|
15793
16285
|
"description": "Optional. Action configurations to make the connector support actions."
|
|
@@ -15800,7 +16292,7 @@
|
|
|
15800
16292
|
"type": "array"
|
|
15801
16293
|
},
|
|
15802
16294
|
"autoRunDisabled": {
|
|
15803
|
-
"description": "Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync.",
|
|
16295
|
+
"description": "Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs",
|
|
15804
16296
|
"type": "boolean"
|
|
15805
16297
|
},
|
|
15806
16298
|
"bapConfig": {
|
|
@@ -15825,8 +16317,29 @@
|
|
|
15825
16317
|
"readOnly": true,
|
|
15826
16318
|
"type": "array"
|
|
15827
16319
|
},
|
|
16320
|
+
"connectorModes": {
|
|
16321
|
+
"description": "Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.",
|
|
16322
|
+
"items": {
|
|
16323
|
+
"enum": [
|
|
16324
|
+
"CONNECTOR_MODE_UNSPECIFIED",
|
|
16325
|
+
"DATA_INGESTION",
|
|
16326
|
+
"ACTIONS",
|
|
16327
|
+
"FEDERATED",
|
|
16328
|
+
"EUA"
|
|
16329
|
+
],
|
|
16330
|
+
"enumDescriptions": [
|
|
16331
|
+
"Connector mode unspecified.",
|
|
16332
|
+
"Connector utilized for data ingestion.",
|
|
16333
|
+
"Connector utilized for actions.",
|
|
16334
|
+
"Connector utilized for federated search.",
|
|
16335
|
+
"Connector utilized for End User Authentication."
|
|
16336
|
+
],
|
|
16337
|
+
"type": "string"
|
|
16338
|
+
},
|
|
16339
|
+
"type": "array"
|
|
16340
|
+
},
|
|
15828
16341
|
"connectorType": {
|
|
15829
|
-
"description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is
|
|
16342
|
+
"description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.",
|
|
15830
16343
|
"enum": [
|
|
15831
16344
|
"CONNECTOR_TYPE_UNSPECIFIED",
|
|
15832
16345
|
"THIRD_PARTY",
|
|
@@ -15837,7 +16350,8 @@
|
|
|
15837
16350
|
"GOOGLE_CALENDAR",
|
|
15838
16351
|
"GOOGLE_DRIVE",
|
|
15839
16352
|
"NATIVE_CLOUD_IDENTITY",
|
|
15840
|
-
"THIRD_PARTY_FEDERATED"
|
|
16353
|
+
"THIRD_PARTY_FEDERATED",
|
|
16354
|
+
"THIRD_PARTY_EUA"
|
|
15841
16355
|
],
|
|
15842
16356
|
"enumDescriptions": [
|
|
15843
16357
|
"Default value.",
|
|
@@ -15849,11 +16363,16 @@
|
|
|
15849
16363
|
"Google Calendar connector.",
|
|
15850
16364
|
"Google Drive connector.",
|
|
15851
16365
|
"Native Cloud Identity connector for people search powered by People API.",
|
|
15852
|
-
"Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API."
|
|
16366
|
+
"Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.",
|
|
16367
|
+
"Connector utilized for End User Authentication features."
|
|
15853
16368
|
],
|
|
15854
16369
|
"readOnly": true,
|
|
15855
16370
|
"type": "string"
|
|
15856
16371
|
},
|
|
16372
|
+
"createEuaSaas": {
|
|
16373
|
+
"description": "Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.",
|
|
16374
|
+
"type": "boolean"
|
|
16375
|
+
},
|
|
15857
16376
|
"createTime": {
|
|
15858
16377
|
"description": "Output only. Timestamp the DataConnector was created at.",
|
|
15859
16378
|
"format": "google-datetime",
|
|
@@ -15871,6 +16390,10 @@
|
|
|
15871
16390
|
},
|
|
15872
16391
|
"type": "array"
|
|
15873
16392
|
},
|
|
16393
|
+
"endUserConfig": {
|
|
16394
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig",
|
|
16395
|
+
"description": "Optional. Any params and credentials used specifically for EUA connectors."
|
|
16396
|
+
},
|
|
15874
16397
|
"entities": {
|
|
15875
16398
|
"description": "List of entities from the connected data source to ingest.",
|
|
15876
16399
|
"items": {
|
|
@@ -15896,6 +16419,15 @@
|
|
|
15896
16419
|
"$ref": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig",
|
|
15897
16420
|
"description": "The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector."
|
|
15898
16421
|
},
|
|
16422
|
+
"incrementalRefreshInterval": {
|
|
16423
|
+
"description": "Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days.",
|
|
16424
|
+
"format": "google-duration",
|
|
16425
|
+
"type": "string"
|
|
16426
|
+
},
|
|
16427
|
+
"incrementalSyncDisabled": {
|
|
16428
|
+
"description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled.",
|
|
16429
|
+
"type": "boolean"
|
|
16430
|
+
},
|
|
15899
16431
|
"kmsKeyName": {
|
|
15900
16432
|
"description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.",
|
|
15901
16433
|
"type": "string"
|
|
@@ -16006,12 +16538,14 @@
|
|
|
16006
16538
|
"enum": [
|
|
16007
16539
|
"PERIODIC",
|
|
16008
16540
|
"STREAMING",
|
|
16009
|
-
"UNSPECIFIED"
|
|
16541
|
+
"UNSPECIFIED",
|
|
16542
|
+
"SCALA_SYNC"
|
|
16010
16543
|
],
|
|
16011
16544
|
"enumDescriptions": [
|
|
16012
16545
|
"The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.",
|
|
16013
16546
|
"The data will be synced in real time.",
|
|
16014
|
-
"Connector that doesn't ingest data will have this value"
|
|
16547
|
+
"Connector that doesn't ingest data will have this value",
|
|
16548
|
+
"The data will be synced with Scala Sync, a data ingestion solution."
|
|
16015
16549
|
],
|
|
16016
16550
|
"type": "string"
|
|
16017
16551
|
},
|
|
@@ -16024,6 +16558,29 @@
|
|
|
16024
16558
|
},
|
|
16025
16559
|
"type": "object"
|
|
16026
16560
|
},
|
|
16561
|
+
"GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig": {
|
|
16562
|
+
"description": "Any params and credentials used specifically for EUA connectors.",
|
|
16563
|
+
"id": "GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig",
|
|
16564
|
+
"properties": {
|
|
16565
|
+
"additionalParams": {
|
|
16566
|
+
"additionalProperties": {
|
|
16567
|
+
"description": "Properties of the object.",
|
|
16568
|
+
"type": "any"
|
|
16569
|
+
},
|
|
16570
|
+
"description": "Optional. Any additional parameters needed for EUA.",
|
|
16571
|
+
"type": "object"
|
|
16572
|
+
},
|
|
16573
|
+
"authParams": {
|
|
16574
|
+
"additionalProperties": {
|
|
16575
|
+
"description": "Properties of the object.",
|
|
16576
|
+
"type": "any"
|
|
16577
|
+
},
|
|
16578
|
+
"description": "Optional. Any authentication parameters specific to EUA connectors.",
|
|
16579
|
+
"type": "object"
|
|
16580
|
+
}
|
|
16581
|
+
},
|
|
16582
|
+
"type": "object"
|
|
16583
|
+
},
|
|
16027
16584
|
"GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig": {
|
|
16028
16585
|
"description": "The configuration for realtime sync to store additional params for realtime sync.",
|
|
16029
16586
|
"id": "GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig",
|
|
@@ -16179,7 +16736,7 @@
|
|
|
16179
16736
|
"description": "Language info for DataStore."
|
|
16180
16737
|
},
|
|
16181
16738
|
"name": {
|
|
16182
|
-
"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
|
|
16739
|
+
"description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
|
|
16183
16740
|
"type": "string"
|
|
16184
16741
|
},
|
|
16185
16742
|
"naturalLanguageQueryUnderstandingConfig": {
|
|
@@ -16264,7 +16821,7 @@
|
|
|
16264
16821
|
"id": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore",
|
|
16265
16822
|
"properties": {
|
|
16266
16823
|
"disabledForServing": {
|
|
16267
|
-
"description": "If set true, the DataStore will not be available for serving search requests.",
|
|
16824
|
+
"description": "Optional. If set true, the DataStore will not be available for serving search requests.",
|
|
16268
16825
|
"type": "boolean"
|
|
16269
16826
|
}
|
|
16270
16827
|
},
|
|
@@ -16594,6 +17151,27 @@
|
|
|
16594
17151
|
"enableTableAnnotation": {
|
|
16595
17152
|
"description": "Optional. If true, the LLM based annotation is added to the table during parsing.",
|
|
16596
17153
|
"type": "boolean"
|
|
17154
|
+
},
|
|
17155
|
+
"excludeHtmlClasses": {
|
|
17156
|
+
"description": "Optional. List of HTML classes to exclude from the parsed content.",
|
|
17157
|
+
"items": {
|
|
17158
|
+
"type": "string"
|
|
17159
|
+
},
|
|
17160
|
+
"type": "array"
|
|
17161
|
+
},
|
|
17162
|
+
"excludeHtmlElements": {
|
|
17163
|
+
"description": "Optional. List of HTML elements to exclude from the parsed content.",
|
|
17164
|
+
"items": {
|
|
17165
|
+
"type": "string"
|
|
17166
|
+
},
|
|
17167
|
+
"type": "array"
|
|
17168
|
+
},
|
|
17169
|
+
"excludeHtmlIds": {
|
|
17170
|
+
"description": "Optional. List of HTML ids to exclude from the parsed content.",
|
|
17171
|
+
"items": {
|
|
17172
|
+
"type": "string"
|
|
17173
|
+
},
|
|
17174
|
+
"type": "array"
|
|
16597
17175
|
}
|
|
16598
17176
|
},
|
|
16599
17177
|
"type": "object"
|
|
@@ -16664,7 +17242,7 @@
|
|
|
16664
17242
|
"type": "string"
|
|
16665
17243
|
},
|
|
16666
17244
|
"dataStoreIds": {
|
|
16667
|
-
"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.",
|
|
17245
|
+
"description": "Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.",
|
|
16668
17246
|
"items": {
|
|
16669
17247
|
"type": "string"
|
|
16670
17248
|
},
|
|
@@ -16679,7 +17257,7 @@
|
|
|
16679
17257
|
"type": "string"
|
|
16680
17258
|
},
|
|
16681
17259
|
"industryVertical": {
|
|
16682
|
-
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.",
|
|
17260
|
+
"description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.",
|
|
16683
17261
|
"enum": [
|
|
16684
17262
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
16685
17263
|
"GENERIC",
|
|
@@ -16699,7 +17277,7 @@
|
|
|
16699
17277
|
"description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical."
|
|
16700
17278
|
},
|
|
16701
17279
|
"name": {
|
|
16702
|
-
"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.",
|
|
17280
|
+
"description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.",
|
|
16703
17281
|
"type": "string"
|
|
16704
17282
|
},
|
|
16705
17283
|
"recommendationMetadata": {
|
|
@@ -16810,6 +17388,10 @@
|
|
|
16810
17388
|
"description": "Additional config specs for a Media Recommendation engine.",
|
|
16811
17389
|
"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig",
|
|
16812
17390
|
"properties": {
|
|
17391
|
+
"engineFeaturesConfig": {
|
|
17392
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig",
|
|
17393
|
+
"description": "Optional. Additional engine features config."
|
|
17394
|
+
},
|
|
16813
17395
|
"optimizationObjective": {
|
|
16814
17396
|
"description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`",
|
|
16815
17397
|
"type": "string"
|
|
@@ -16839,6 +17421,33 @@
|
|
|
16839
17421
|
},
|
|
16840
17422
|
"type": "object"
|
|
16841
17423
|
},
|
|
17424
|
+
"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig": {
|
|
17425
|
+
"description": "More feature configs of the selected engine type.",
|
|
17426
|
+
"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig",
|
|
17427
|
+
"properties": {
|
|
17428
|
+
"mostPopularConfig": {
|
|
17429
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig",
|
|
17430
|
+
"description": "Most popular engine feature config."
|
|
17431
|
+
},
|
|
17432
|
+
"recommendedForYouConfig": {
|
|
17433
|
+
"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig",
|
|
17434
|
+
"description": "Recommended for you engine feature config."
|
|
17435
|
+
}
|
|
17436
|
+
},
|
|
17437
|
+
"type": "object"
|
|
17438
|
+
},
|
|
17439
|
+
"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig": {
|
|
17440
|
+
"description": "Feature configurations that are required for creating a Most Popular engine.",
|
|
17441
|
+
"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig",
|
|
17442
|
+
"properties": {
|
|
17443
|
+
"timeWindowDays": {
|
|
17444
|
+
"description": "The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.",
|
|
17445
|
+
"format": "int64",
|
|
17446
|
+
"type": "string"
|
|
17447
|
+
}
|
|
17448
|
+
},
|
|
17449
|
+
"type": "object"
|
|
17450
|
+
},
|
|
16842
17451
|
"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": {
|
|
16843
17452
|
"description": "Custom threshold for `cvr` optimization_objective.",
|
|
16844
17453
|
"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig",
|
|
@@ -16855,6 +17464,17 @@
|
|
|
16855
17464
|
},
|
|
16856
17465
|
"type": "object"
|
|
16857
17466
|
},
|
|
17467
|
+
"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": {
|
|
17468
|
+
"description": "Additional feature configurations for creating a `recommended-for-you` engine.",
|
|
17469
|
+
"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig",
|
|
17470
|
+
"properties": {
|
|
17471
|
+
"contextEventType": {
|
|
17472
|
+
"description": "The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.",
|
|
17473
|
+
"type": "string"
|
|
17474
|
+
}
|
|
17475
|
+
},
|
|
17476
|
+
"type": "object"
|
|
17477
|
+
},
|
|
16858
17478
|
"GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": {
|
|
16859
17479
|
"description": "Additional information of a recommendation engine.",
|
|
16860
17480
|
"id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata",
|
|
@@ -18910,6 +19530,10 @@
|
|
|
18910
19530
|
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec",
|
|
18911
19531
|
"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)"
|
|
18912
19532
|
},
|
|
19533
|
+
"customSearchOperators": {
|
|
19534
|
+
"description": "Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).",
|
|
19535
|
+
"type": "string"
|
|
19536
|
+
},
|
|
18913
19537
|
"dataStore": {
|
|
18914
19538
|
"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
|
|
18915
19539
|
"type": "string"
|
|
@@ -19689,6 +20313,66 @@
|
|
|
19689
20313
|
},
|
|
19690
20314
|
"type": "object"
|
|
19691
20315
|
},
|
|
20316
|
+
"GoogleCloudDiscoveryengineV1alphaUserLicense": {
|
|
20317
|
+
"description": "User License information assigned by the admin.",
|
|
20318
|
+
"id": "GoogleCloudDiscoveryengineV1alphaUserLicense",
|
|
20319
|
+
"properties": {
|
|
20320
|
+
"createTime": {
|
|
20321
|
+
"description": "Output only. User created timestamp.",
|
|
20322
|
+
"format": "google-datetime",
|
|
20323
|
+
"readOnly": true,
|
|
20324
|
+
"type": "string"
|
|
20325
|
+
},
|
|
20326
|
+
"lastLoginTime": {
|
|
20327
|
+
"description": "Output only. User last logged in time. If the user has not logged in yet, this field will be empty.",
|
|
20328
|
+
"format": "google-datetime",
|
|
20329
|
+
"readOnly": true,
|
|
20330
|
+
"type": "string"
|
|
20331
|
+
},
|
|
20332
|
+
"licenseAssignmentState": {
|
|
20333
|
+
"description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;",
|
|
20334
|
+
"enum": [
|
|
20335
|
+
"LICENSE_ASSIGNMENT_STATE_UNSPECIFIED",
|
|
20336
|
+
"ASSIGNED",
|
|
20337
|
+
"UNASSIGNED",
|
|
20338
|
+
"NO_LICENSE",
|
|
20339
|
+
"NO_LICENSE_ATTEMPTED_LOGIN"
|
|
20340
|
+
],
|
|
20341
|
+
"enumDescriptions": [
|
|
20342
|
+
"Default value.",
|
|
20343
|
+
"License assigned to the user.",
|
|
20344
|
+
"No license assigned to the user. Deprecated, translated to NO_LICENSE.",
|
|
20345
|
+
"No license assigned to the user.",
|
|
20346
|
+
"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)."
|
|
20347
|
+
],
|
|
20348
|
+
"readOnly": true,
|
|
20349
|
+
"type": "string"
|
|
20350
|
+
},
|
|
20351
|
+
"licenseConfig": {
|
|
20352
|
+
"description": "Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.",
|
|
20353
|
+
"type": "string"
|
|
20354
|
+
},
|
|
20355
|
+
"updateTime": {
|
|
20356
|
+
"description": "Output only. User update timestamp.",
|
|
20357
|
+
"format": "google-datetime",
|
|
20358
|
+
"readOnly": true,
|
|
20359
|
+
"type": "string"
|
|
20360
|
+
},
|
|
20361
|
+
"user": {
|
|
20362
|
+
"description": "Optional. The full resource name of the User, in the format of `projects/{project}/locations/{location}/userStores/{user_store}/users/{user_id}`. This field must be a UTF-8 encoded string with a length limit of 2048 characters. If the user field is empty, it's indicating the user has not logged in yet and no User entity is created.",
|
|
20363
|
+
"type": "string"
|
|
20364
|
+
},
|
|
20365
|
+
"userPrincipal": {
|
|
20366
|
+
"description": "Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.",
|
|
20367
|
+
"type": "string"
|
|
20368
|
+
},
|
|
20369
|
+
"userProfile": {
|
|
20370
|
+
"description": "Optional. The user profile. We user user full name(First name + Last name) as user profile.",
|
|
20371
|
+
"type": "string"
|
|
20372
|
+
}
|
|
20373
|
+
},
|
|
20374
|
+
"type": "object"
|
|
20375
|
+
},
|
|
19692
20376
|
"GoogleCloudDiscoveryengineV1alphaWorkspaceConfig": {
|
|
19693
20377
|
"description": "Config to store data store type configuration for workspace data",
|
|
19694
20378
|
"id": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig",
|
|
@@ -19953,7 +20637,7 @@
|
|
|
19953
20637
|
},
|
|
19954
20638
|
"promoteAction": {
|
|
19955
20639
|
"$ref": "GoogleCloudDiscoveryengineV1betaControlPromoteAction",
|
|
19956
|
-
"description": "Promote certain links based on predefined trigger queries.
|
|
20640
|
+
"description": "Promote certain links based on predefined trigger queries."
|
|
19957
20641
|
},
|
|
19958
20642
|
"redirectAction": {
|
|
19959
20643
|
"$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction",
|
|
@@ -20344,7 +21028,7 @@
|
|
|
20344
21028
|
"description": "Language info for DataStore."
|
|
20345
21029
|
},
|
|
20346
21030
|
"name": {
|
|
20347
|
-
"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
|
|
21031
|
+
"description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
|
|
20348
21032
|
"type": "string"
|
|
20349
21033
|
},
|
|
20350
21034
|
"naturalLanguageQueryUnderstandingConfig": {
|
|
@@ -20429,7 +21113,7 @@
|
|
|
20429
21113
|
"id": "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore",
|
|
20430
21114
|
"properties": {
|
|
20431
21115
|
"disabledForServing": {
|
|
20432
|
-
"description": "If set true, the DataStore will not be available for serving search requests.",
|
|
21116
|
+
"description": "Optional. If set true, the DataStore will not be available for serving search requests.",
|
|
20433
21117
|
"type": "boolean"
|
|
20434
21118
|
}
|
|
20435
21119
|
},
|
|
@@ -20672,6 +21356,27 @@
|
|
|
20672
21356
|
"enableTableAnnotation": {
|
|
20673
21357
|
"description": "Optional. If true, the LLM based annotation is added to the table during parsing.",
|
|
20674
21358
|
"type": "boolean"
|
|
21359
|
+
},
|
|
21360
|
+
"excludeHtmlClasses": {
|
|
21361
|
+
"description": "Optional. List of HTML classes to exclude from the parsed content.",
|
|
21362
|
+
"items": {
|
|
21363
|
+
"type": "string"
|
|
21364
|
+
},
|
|
21365
|
+
"type": "array"
|
|
21366
|
+
},
|
|
21367
|
+
"excludeHtmlElements": {
|
|
21368
|
+
"description": "Optional. List of HTML elements to exclude from the parsed content.",
|
|
21369
|
+
"items": {
|
|
21370
|
+
"type": "string"
|
|
21371
|
+
},
|
|
21372
|
+
"type": "array"
|
|
21373
|
+
},
|
|
21374
|
+
"excludeHtmlIds": {
|
|
21375
|
+
"description": "Optional. List of HTML ids to exclude from the parsed content.",
|
|
21376
|
+
"items": {
|
|
21377
|
+
"type": "string"
|
|
21378
|
+
},
|
|
21379
|
+
"type": "array"
|
|
20675
21380
|
}
|
|
20676
21381
|
},
|
|
20677
21382
|
"type": "object"
|
|
@@ -20742,7 +21447,7 @@
|
|
|
20742
21447
|
"type": "string"
|
|
20743
21448
|
},
|
|
20744
21449
|
"dataStoreIds": {
|
|
20745
|
-
"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.",
|
|
21450
|
+
"description": "Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.",
|
|
20746
21451
|
"items": {
|
|
20747
21452
|
"type": "string"
|
|
20748
21453
|
},
|
|
@@ -20757,7 +21462,7 @@
|
|
|
20757
21462
|
"type": "string"
|
|
20758
21463
|
},
|
|
20759
21464
|
"industryVertical": {
|
|
20760
|
-
"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.",
|
|
21465
|
+
"description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.",
|
|
20761
21466
|
"enum": [
|
|
20762
21467
|
"INDUSTRY_VERTICAL_UNSPECIFIED",
|
|
20763
21468
|
"GENERIC",
|
|
@@ -20772,8 +21477,12 @@
|
|
|
20772
21477
|
],
|
|
20773
21478
|
"type": "string"
|
|
20774
21479
|
},
|
|
21480
|
+
"mediaRecommendationEngineConfig": {
|
|
21481
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig",
|
|
21482
|
+
"description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical."
|
|
21483
|
+
},
|
|
20775
21484
|
"name": {
|
|
20776
|
-
"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.",
|
|
21485
|
+
"description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.",
|
|
20777
21486
|
"type": "string"
|
|
20778
21487
|
},
|
|
20779
21488
|
"searchEngineConfig": {
|
|
@@ -20871,6 +21580,97 @@
|
|
|
20871
21580
|
},
|
|
20872
21581
|
"type": "object"
|
|
20873
21582
|
},
|
|
21583
|
+
"GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig": {
|
|
21584
|
+
"description": "Additional config specs for a Media Recommendation engine.",
|
|
21585
|
+
"id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig",
|
|
21586
|
+
"properties": {
|
|
21587
|
+
"engineFeaturesConfig": {
|
|
21588
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig",
|
|
21589
|
+
"description": "Optional. Additional engine features config."
|
|
21590
|
+
},
|
|
21591
|
+
"optimizationObjective": {
|
|
21592
|
+
"description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`",
|
|
21593
|
+
"type": "string"
|
|
21594
|
+
},
|
|
21595
|
+
"optimizationObjectiveConfig": {
|
|
21596
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig",
|
|
21597
|
+
"description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)."
|
|
21598
|
+
},
|
|
21599
|
+
"trainingState": {
|
|
21600
|
+
"description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.",
|
|
21601
|
+
"enum": [
|
|
21602
|
+
"TRAINING_STATE_UNSPECIFIED",
|
|
21603
|
+
"PAUSED",
|
|
21604
|
+
"TRAINING"
|
|
21605
|
+
],
|
|
21606
|
+
"enumDescriptions": [
|
|
21607
|
+
"Unspecified training state.",
|
|
21608
|
+
"The engine training is paused.",
|
|
21609
|
+
"The engine is training."
|
|
21610
|
+
],
|
|
21611
|
+
"type": "string"
|
|
21612
|
+
},
|
|
21613
|
+
"type": {
|
|
21614
|
+
"description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.",
|
|
21615
|
+
"type": "string"
|
|
21616
|
+
}
|
|
21617
|
+
},
|
|
21618
|
+
"type": "object"
|
|
21619
|
+
},
|
|
21620
|
+
"GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig": {
|
|
21621
|
+
"description": "More feature configs of the selected engine type.",
|
|
21622
|
+
"id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig",
|
|
21623
|
+
"properties": {
|
|
21624
|
+
"mostPopularConfig": {
|
|
21625
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig",
|
|
21626
|
+
"description": "Most popular engine feature config."
|
|
21627
|
+
},
|
|
21628
|
+
"recommendedForYouConfig": {
|
|
21629
|
+
"$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig",
|
|
21630
|
+
"description": "Recommended for you engine feature config."
|
|
21631
|
+
}
|
|
21632
|
+
},
|
|
21633
|
+
"type": "object"
|
|
21634
|
+
},
|
|
21635
|
+
"GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig": {
|
|
21636
|
+
"description": "Feature configurations that are required for creating a Most Popular engine.",
|
|
21637
|
+
"id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigMostPopularFeatureConfig",
|
|
21638
|
+
"properties": {
|
|
21639
|
+
"timeWindowDays": {
|
|
21640
|
+
"description": "The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine.",
|
|
21641
|
+
"format": "int64",
|
|
21642
|
+
"type": "string"
|
|
21643
|
+
}
|
|
21644
|
+
},
|
|
21645
|
+
"type": "object"
|
|
21646
|
+
},
|
|
21647
|
+
"GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": {
|
|
21648
|
+
"description": "Custom threshold for `cvr` optimization_objective.",
|
|
21649
|
+
"id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig",
|
|
21650
|
+
"properties": {
|
|
21651
|
+
"targetField": {
|
|
21652
|
+
"description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.",
|
|
21653
|
+
"type": "string"
|
|
21654
|
+
},
|
|
21655
|
+
"targetFieldValueFloat": {
|
|
21656
|
+
"description": "Required. The threshold to be applied to the target (e.g., 0.5).",
|
|
21657
|
+
"format": "float",
|
|
21658
|
+
"type": "number"
|
|
21659
|
+
}
|
|
21660
|
+
},
|
|
21661
|
+
"type": "object"
|
|
21662
|
+
},
|
|
21663
|
+
"GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig": {
|
|
21664
|
+
"description": "Additional feature configurations for creating a `recommended-for-you` engine.",
|
|
21665
|
+
"id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigRecommendedForYouFeatureConfig",
|
|
21666
|
+
"properties": {
|
|
21667
|
+
"contextEventType": {
|
|
21668
|
+
"description": "The type of event with which the engine is queried at prediction time. If set to `generic`, only `view-item`, `media-play`,and `media-complete` will be used as `context-event` in engine training. If set to `view-home-page`, `view-home-page` will also be used as `context-events` in addition to `view-item`, `media-play`, and `media-complete`. Currently supported for the `recommended-for-you` engine. Currently supported values: `view-home-page`, `generic`.",
|
|
21669
|
+
"type": "string"
|
|
21670
|
+
}
|
|
21671
|
+
},
|
|
21672
|
+
"type": "object"
|
|
21673
|
+
},
|
|
20874
21674
|
"GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": {
|
|
20875
21675
|
"description": "Configurations for a Search Engine.",
|
|
20876
21676
|
"id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig",
|
|
@@ -22232,6 +23032,10 @@
|
|
|
22232
23032
|
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
|
|
22233
23033
|
"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)"
|
|
22234
23034
|
},
|
|
23035
|
+
"customSearchOperators": {
|
|
23036
|
+
"description": "Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).",
|
|
23037
|
+
"type": "string"
|
|
23038
|
+
},
|
|
22235
23039
|
"dataStore": {
|
|
22236
23040
|
"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
|
|
22237
23041
|
"type": "string"
|