google-api-python-client 2.141.0__py2.py3-none-any.whl → 2.142.0__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. {google_api_python_client-2.141.0.dist-info → google_api_python_client-2.142.0.dist-info}/METADATA +1 -1
  2. {google_api_python_client-2.141.0.dist-info → google_api_python_client-2.142.0.dist-info}/RECORD +81 -79
  3. googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +3 -3
  4. googleapiclient/discovery_cache/documents/aiplatform.v1.json +250 -3
  5. googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +269 -3
  6. googleapiclient/discovery_cache/documents/alloydb.v1.json +274 -36
  7. googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +378 -36
  8. googleapiclient/discovery_cache/documents/alloydb.v1beta.json +306 -36
  9. googleapiclient/discovery_cache/documents/androidpublisher.v3.json +11 -1
  10. googleapiclient/discovery_cache/documents/apikeys.v2.json +2 -2
  11. googleapiclient/discovery_cache/documents/artifactregistry.v1.json +3 -3
  12. googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +3 -3
  13. googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +3 -3
  14. googleapiclient/discovery_cache/documents/backupdr.v1.json +1 -18
  15. googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +684 -27
  16. googleapiclient/discovery_cache/documents/bigquery.v2.json +19 -34
  17. googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +21 -2
  18. googleapiclient/discovery_cache/documents/chat.v1.json +5 -5
  19. googleapiclient/discovery_cache/documents/chromemanagement.v1.json +3 -3
  20. googleapiclient/discovery_cache/documents/clouddeploy.v1.json +3 -3
  21. googleapiclient/discovery_cache/documents/cloudtasks.v2.json +3 -3
  22. googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json +3 -3
  23. googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +3 -3
  24. googleapiclient/discovery_cache/documents/compute.alpha.json +6 -485
  25. googleapiclient/discovery_cache/documents/compute.beta.json +57 -10
  26. googleapiclient/discovery_cache/documents/compute.v1.json +19 -10
  27. googleapiclient/discovery_cache/documents/connectors.v1.json +20 -1
  28. googleapiclient/discovery_cache/documents/container.v1.json +34 -1
  29. googleapiclient/discovery_cache/documents/container.v1beta1.json +16 -2
  30. googleapiclient/discovery_cache/documents/dataflow.v1b3.json +22 -7
  31. googleapiclient/discovery_cache/documents/datamigration.v1.json +137 -1
  32. googleapiclient/discovery_cache/documents/dialogflow.v2.json +5 -284
  33. googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +5 -284
  34. googleapiclient/discovery_cache/documents/dialogflow.v3.json +68 -283
  35. googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +99 -284
  36. googleapiclient/discovery_cache/documents/discoveryengine.v1.json +513 -21
  37. googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +410 -20
  38. googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +339 -21
  39. googleapiclient/discovery_cache/documents/displayvideo.v2.json +29 -16
  40. googleapiclient/discovery_cache/documents/displayvideo.v3.json +29 -15
  41. googleapiclient/discovery_cache/documents/dlp.v2.json +125 -56
  42. googleapiclient/discovery_cache/documents/documentai.v1.json +5 -1
  43. googleapiclient/discovery_cache/documents/documentai.v1beta3.json +5 -1
  44. googleapiclient/discovery_cache/documents/drive.v2.json +5 -5
  45. googleapiclient/discovery_cache/documents/drive.v3.json +4 -4
  46. googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +7 -7
  47. googleapiclient/discovery_cache/documents/gkehub.v1.json +43 -1
  48. googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +43 -1
  49. googleapiclient/discovery_cache/documents/gkehub.v1beta.json +43 -1
  50. googleapiclient/discovery_cache/documents/gkehub.v2.json +435 -0
  51. googleapiclient/discovery_cache/documents/gkehub.v2beta.json +435 -0
  52. googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +48 -1
  53. googleapiclient/discovery_cache/documents/integrations.v1.json +79 -276
  54. googleapiclient/discovery_cache/documents/manufacturers.v1.json +36 -1
  55. googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +122 -2
  56. googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +13 -3
  57. googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +24 -3
  58. googleapiclient/discovery_cache/documents/networkmanagement.v1.json +7 -3
  59. googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +309 -3
  60. googleapiclient/discovery_cache/documents/playintegrity.v1.json +4 -4
  61. googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +100 -1
  62. googleapiclient/discovery_cache/documents/redis.v1.json +144 -31
  63. googleapiclient/discovery_cache/documents/redis.v1beta1.json +144 -31
  64. googleapiclient/discovery_cache/documents/retail.v2.json +2 -2
  65. googleapiclient/discovery_cache/documents/retail.v2alpha.json +2 -2
  66. googleapiclient/discovery_cache/documents/retail.v2beta.json +2 -2
  67. googleapiclient/discovery_cache/documents/run.v2.json +148 -2
  68. googleapiclient/discovery_cache/documents/searchads360.v0.json +75 -13
  69. googleapiclient/discovery_cache/documents/securitycenter.v1.json +8 -1
  70. googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +8 -1
  71. googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +8 -1
  72. googleapiclient/discovery_cache/documents/serviceusage.v1.json +103 -1
  73. googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +103 -1
  74. googleapiclient/discovery_cache/documents/spanner.v1.json +73 -19
  75. googleapiclient/discovery_cache/documents/vmmigration.v1.json +54 -96
  76. googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +54 -96
  77. googleapiclient/discovery_cache/documents/youtube.v3.json +14 -2
  78. googleapiclient/version.py +1 -1
  79. {google_api_python_client-2.141.0.dist-info → google_api_python_client-2.142.0.dist-info}/LICENSE +0 -0
  80. {google_api_python_client-2.141.0.dist-info → google_api_python_client-2.142.0.dist-info}/WHEEL +0 -0
  81. {google_api_python_client-2.141.0.dist-info → google_api_python_client-2.142.0.dist-info}/top_level.txt +0 -0
@@ -454,10 +454,71 @@
454
454
  "scopes": [
455
455
  "https://www.googleapis.com/auth/cloud-platform"
456
456
  ]
457
+ },
458
+ "trainCustomModel": {
459
+ "description": "Trains a custom model.",
460
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:trainCustomModel",
461
+ "httpMethod": "POST",
462
+ "id": "discoveryengine.projects.locations.collections.dataStores.trainCustomModel",
463
+ "parameterOrder": [
464
+ "dataStore"
465
+ ],
466
+ "parameters": {
467
+ "dataStore": {
468
+ "description": "Required. The resource name of the Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models.",
469
+ "location": "path",
470
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
471
+ "required": true,
472
+ "type": "string"
473
+ }
474
+ },
475
+ "path": "v1/{+dataStore}:trainCustomModel",
476
+ "request": {
477
+ "$ref": "GoogleCloudDiscoveryengineV1TrainCustomModelRequest"
478
+ },
479
+ "response": {
480
+ "$ref": "GoogleLongrunningOperation"
481
+ },
482
+ "scopes": [
483
+ "https://www.googleapis.com/auth/cloud-platform"
484
+ ]
457
485
  }
458
486
  },
459
487
  "resources": {
460
488
  "branches": {
489
+ "methods": {
490
+ "batchGetDocumentsMetadata": {
491
+ "description": "Gets index freshness metadata for Documents. Supported for website search only.",
492
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata",
493
+ "httpMethod": "GET",
494
+ "id": "discoveryengine.projects.locations.collections.dataStores.branches.batchGetDocumentsMetadata",
495
+ "parameterOrder": [
496
+ "parent"
497
+ ],
498
+ "parameters": {
499
+ "matcher.urisMatcher.uris": {
500
+ "description": "The exact URIs to match by.",
501
+ "location": "query",
502
+ "repeated": true,
503
+ "type": "string"
504
+ },
505
+ "parent": {
506
+ "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.",
507
+ "location": "path",
508
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$",
509
+ "required": true,
510
+ "type": "string"
511
+ }
512
+ },
513
+ "path": "v1/{+parent}/batchGetDocumentsMetadata",
514
+ "response": {
515
+ "$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse"
516
+ },
517
+ "scopes": [
518
+ "https://www.googleapis.com/auth/cloud-platform"
519
+ ]
520
+ }
521
+ },
461
522
  "resources": {
462
523
  "documents": {
463
524
  "methods": {
@@ -1189,6 +1250,35 @@
1189
1250
  }
1190
1251
  }
1191
1252
  },
1253
+ "customModels": {
1254
+ "methods": {
1255
+ "list": {
1256
+ "description": "Gets a list of all the custom models.",
1257
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/customModels",
1258
+ "httpMethod": "GET",
1259
+ "id": "discoveryengine.projects.locations.collections.dataStores.customModels.list",
1260
+ "parameterOrder": [
1261
+ "dataStore"
1262
+ ],
1263
+ "parameters": {
1264
+ "dataStore": {
1265
+ "description": "Required. The resource name of the parent Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from.",
1266
+ "location": "path",
1267
+ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
1268
+ "required": true,
1269
+ "type": "string"
1270
+ }
1271
+ },
1272
+ "path": "v1/{+dataStore}/customModels",
1273
+ "response": {
1274
+ "$ref": "GoogleCloudDiscoveryengineV1ListCustomModelsResponse"
1275
+ },
1276
+ "scopes": [
1277
+ "https://www.googleapis.com/auth/cloud-platform"
1278
+ ]
1279
+ }
1280
+ }
1281
+ },
1192
1282
  "models": {
1193
1283
  "resources": {
1194
1284
  "operations": {
@@ -3690,6 +3780,39 @@
3690
3780
  },
3691
3781
  "resources": {
3692
3782
  "branches": {
3783
+ "methods": {
3784
+ "batchGetDocumentsMetadata": {
3785
+ "description": "Gets index freshness metadata for Documents. Supported for website search only.",
3786
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata",
3787
+ "httpMethod": "GET",
3788
+ "id": "discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata",
3789
+ "parameterOrder": [
3790
+ "parent"
3791
+ ],
3792
+ "parameters": {
3793
+ "matcher.urisMatcher.uris": {
3794
+ "description": "The exact URIs to match by.",
3795
+ "location": "query",
3796
+ "repeated": true,
3797
+ "type": "string"
3798
+ },
3799
+ "parent": {
3800
+ "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.",
3801
+ "location": "path",
3802
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$",
3803
+ "required": true,
3804
+ "type": "string"
3805
+ }
3806
+ },
3807
+ "path": "v1/{+parent}/batchGetDocumentsMetadata",
3808
+ "response": {
3809
+ "$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse"
3810
+ },
3811
+ "scopes": [
3812
+ "https://www.googleapis.com/auth/cloud-platform"
3813
+ ]
3814
+ }
3815
+ },
3693
3816
  "resources": {
3694
3817
  "documents": {
3695
3818
  "methods": {
@@ -5851,7 +5974,7 @@
5851
5974
  }
5852
5975
  }
5853
5976
  },
5854
- "revision": "20240801",
5977
+ "revision": "20240813",
5855
5978
  "rootUrl": "https://discoveryengine.googleapis.com/",
5856
5979
  "schemas": {
5857
5980
  "GoogleApiHttpBody": {
@@ -6021,7 +6144,7 @@
6021
6144
  "type": "string"
6022
6145
  },
6023
6146
  "projectId": {
6024
- "description": "The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
6147
+ "description": "The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
6025
6148
  "type": "string"
6026
6149
  },
6027
6150
  "tableId": {
@@ -6045,7 +6168,8 @@
6045
6168
  "OUT_OF_DOMAIN_QUERY_IGNORED",
6046
6169
  "POTENTIAL_POLICY_VIOLATION",
6047
6170
  "NO_RELEVANT_CONTENT",
6048
- "JAIL_BREAKING_QUERY_IGNORED"
6171
+ "JAIL_BREAKING_QUERY_IGNORED",
6172
+ "CUSTOMER_POLICY_VIOLATION"
6049
6173
  ],
6050
6174
  "enumDescriptions": [
6051
6175
  "Default value. The answer skipped reason is not specified.",
@@ -6054,7 +6178,8 @@
6054
6178
  "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.",
6055
6179
  "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.",
6056
6180
  "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.",
6057
- "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."
6181
+ "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.",
6182
+ "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer."
6058
6183
  ],
6059
6184
  "type": "string"
6060
6185
  },
@@ -6946,6 +7071,63 @@
6946
7071
  },
6947
7072
  "type": "object"
6948
7073
  },
7074
+ "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse": {
7075
+ "description": "Response message for DocumentService.BatchGetDocumentsMetadata method.",
7076
+ "id": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse",
7077
+ "properties": {
7078
+ "documentsMetadata": {
7079
+ "description": "The metadata of the Documents.",
7080
+ "items": {
7081
+ "$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata"
7082
+ },
7083
+ "type": "array"
7084
+ }
7085
+ },
7086
+ "type": "object"
7087
+ },
7088
+ "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata": {
7089
+ "description": "The metadata of a Document.",
7090
+ "id": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata",
7091
+ "properties": {
7092
+ "lastRefreshedTime": {
7093
+ "description": "The timestamp of the last time the Document was last indexed.",
7094
+ "format": "google-datetime",
7095
+ "type": "string"
7096
+ },
7097
+ "matcherValue": {
7098
+ "$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue",
7099
+ "description": "The value of the matcher that was used to match the Document."
7100
+ },
7101
+ "status": {
7102
+ "description": "The status of the document.",
7103
+ "enum": [
7104
+ "STATUS_UNSPECIFIED",
7105
+ "STATUS_INDEXED",
7106
+ "STATUS_NOT_IN_TARGET_SITE",
7107
+ "STATUS_NOT_IN_INDEX"
7108
+ ],
7109
+ "enumDescriptions": [
7110
+ "Should never be set.",
7111
+ "The Document is indexed.",
7112
+ "The Document is not indexed because its URI is not in the TargetSite.",
7113
+ "The Document is not indexed."
7114
+ ],
7115
+ "type": "string"
7116
+ }
7117
+ },
7118
+ "type": "object"
7119
+ },
7120
+ "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue": {
7121
+ "description": "The value of the matcher that was used to match the Document.",
7122
+ "id": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue",
7123
+ "properties": {
7124
+ "uri": {
7125
+ "description": "If match by URI, the URI of the Document.",
7126
+ "type": "string"
7127
+ }
7128
+ },
7129
+ "type": "object"
7130
+ },
6949
7131
  "GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest": {
6950
7132
  "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.",
6951
7133
  "id": "GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest",
@@ -6973,7 +7155,7 @@
6973
7155
  "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format."
6974
7156
  },
6975
7157
  "projectId": {
6976
- "description": "The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
7158
+ "description": "The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
6977
7159
  "type": "string"
6978
7160
  },
6979
7161
  "tableId": {
@@ -7124,7 +7306,7 @@
7124
7306
  "type": "string"
7125
7307
  },
7126
7308
  "projectId": {
7127
- "description": "The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
7309
+ "description": "The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
7128
7310
  "type": "string"
7129
7311
  },
7130
7312
  "tableId": {
@@ -7214,6 +7396,11 @@
7214
7396
  "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, and anti_citation_indices should not be returned.",
7215
7397
  "type": "boolean"
7216
7398
  },
7399
+ "score": {
7400
+ "description": "Confidence score for the claim in the answer candidate, in the range of [0, 1].",
7401
+ "format": "double",
7402
+ "type": "number"
7403
+ },
7217
7404
  "startPos": {
7218
7405
  "description": "Position indicating the start of the claim in the answer candidate, measured in bytes.",
7219
7406
  "format": "int32",
@@ -7363,7 +7550,7 @@
7363
7550
  "type": "boolean"
7364
7551
  },
7365
7552
  "projectId": {
7366
- "description": "The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
7553
+ "description": "The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
7367
7554
  "type": "string"
7368
7555
  },
7369
7556
  "tableId": {
@@ -7524,7 +7711,7 @@
7524
7711
  "id": "GoogleCloudDiscoveryengineV1Control",
7525
7712
  "properties": {
7526
7713
  "associatedServingConfigIds": {
7527
- "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.",
7714
+ "description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.",
7528
7715
  "items": {
7529
7716
  "type": "string"
7530
7717
  },
@@ -7916,6 +8103,67 @@
7916
8103
  },
7917
8104
  "type": "object"
7918
8105
  },
8106
+ "GoogleCloudDiscoveryengineV1CustomTuningModel": {
8107
+ "description": "Metadata that describes a custom tuned model.",
8108
+ "id": "GoogleCloudDiscoveryengineV1CustomTuningModel",
8109
+ "properties": {
8110
+ "createTime": {
8111
+ "deprecated": true,
8112
+ "description": "Timestamp the Model was created at.",
8113
+ "format": "google-datetime",
8114
+ "type": "string"
8115
+ },
8116
+ "displayName": {
8117
+ "description": "The display name of the model.",
8118
+ "type": "string"
8119
+ },
8120
+ "metrics": {
8121
+ "additionalProperties": {
8122
+ "format": "double",
8123
+ "type": "number"
8124
+ },
8125
+ "description": "The metrics of the trained model.",
8126
+ "type": "object"
8127
+ },
8128
+ "modelState": {
8129
+ "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).",
8130
+ "enum": [
8131
+ "MODEL_STATE_UNSPECIFIED",
8132
+ "TRAINING_PAUSED",
8133
+ "TRAINING",
8134
+ "TRAINING_COMPLETE",
8135
+ "READY_FOR_SERVING",
8136
+ "TRAINING_FAILED",
8137
+ "NO_IMPROVEMENT"
8138
+ ],
8139
+ "enumDescriptions": [
8140
+ "Default value.",
8141
+ "The model is in a paused training state.",
8142
+ "The model is currently training.",
8143
+ "The model has successfully completed training.",
8144
+ "The model is ready for serving.",
8145
+ "The model training failed.",
8146
+ "The model training finished successfully but metrics did not improve."
8147
+ ],
8148
+ "type": "string"
8149
+ },
8150
+ "modelVersion": {
8151
+ "description": "The version of the model.",
8152
+ "format": "int64",
8153
+ "type": "string"
8154
+ },
8155
+ "name": {
8156
+ "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.",
8157
+ "type": "string"
8158
+ },
8159
+ "trainingStartTime": {
8160
+ "description": "Timestamp the model training was initiated.",
8161
+ "format": "google-datetime",
8162
+ "type": "string"
8163
+ }
8164
+ },
8165
+ "type": "object"
8166
+ },
7919
8167
  "GoogleCloudDiscoveryengineV1DataStore": {
7920
8168
  "description": "DataStore captures global settings and configs at the DataStore level.",
7921
8169
  "id": "GoogleCloudDiscoveryengineV1DataStore",
@@ -7926,13 +8174,15 @@
7926
8174
  "CONTENT_CONFIG_UNSPECIFIED",
7927
8175
  "NO_CONTENT",
7928
8176
  "CONTENT_REQUIRED",
7929
- "PUBLIC_WEBSITE"
8177
+ "PUBLIC_WEBSITE",
8178
+ "GOOGLE_WORKSPACE"
7930
8179
  ],
7931
8180
  "enumDescriptions": [
7932
8181
  "Default value.",
7933
8182
  "Only contains documents without any Document.content.",
7934
8183
  "Only contains documents with Document.content.",
7935
- "The data store is used for public website search."
8184
+ "The data store is used for public website search.",
8185
+ "The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig."
7936
8186
  ],
7937
8187
  "type": "string"
7938
8188
  },
@@ -7999,6 +8249,10 @@
7999
8249
  "startingSchema": {
8000
8250
  "$ref": "GoogleCloudDiscoveryengineV1Schema",
8001
8251
  "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)."
8252
+ },
8253
+ "workspaceConfig": {
8254
+ "$ref": "GoogleCloudDiscoveryengineV1WorkspaceConfig",
8255
+ "description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE."
8002
8256
  }
8003
8257
  },
8004
8258
  "type": "object"
@@ -9110,6 +9364,20 @@
9110
9364
  },
9111
9365
  "type": "object"
9112
9366
  },
9367
+ "GoogleCloudDiscoveryengineV1ListCustomModelsResponse": {
9368
+ "description": "Response message for SearchTuningService.ListCustomModels method.",
9369
+ "id": "GoogleCloudDiscoveryengineV1ListCustomModelsResponse",
9370
+ "properties": {
9371
+ "models": {
9372
+ "description": "List of custom tuning models.",
9373
+ "items": {
9374
+ "$ref": "GoogleCloudDiscoveryengineV1CustomTuningModel"
9375
+ },
9376
+ "type": "array"
9377
+ }
9378
+ },
9379
+ "type": "object"
9380
+ },
9113
9381
  "GoogleCloudDiscoveryengineV1ListDataStoresResponse": {
9114
9382
  "description": "Response message for DataStoreService.ListDataStores method.",
9115
9383
  "id": "GoogleCloudDiscoveryengineV1ListDataStoresResponse",
@@ -10495,7 +10763,8 @@
10495
10763
  "POTENTIAL_POLICY_VIOLATION",
10496
10764
  "LLM_ADDON_NOT_ENABLED",
10497
10765
  "NO_RELEVANT_CONTENT",
10498
- "JAIL_BREAKING_QUERY_IGNORED"
10766
+ "JAIL_BREAKING_QUERY_IGNORED",
10767
+ "CUSTOMER_POLICY_VIOLATION"
10499
10768
  ],
10500
10769
  "enumDescriptions": [
10501
10770
  "Default value. The summary skipped reason is not specified.",
@@ -10505,7 +10774,8 @@
10505
10774
  "The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.",
10506
10775
  "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.",
10507
10776
  "The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.",
10508
- "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`."
10777
+ "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`.",
10778
+ "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer."
10509
10779
  ],
10510
10780
  "type": "string"
10511
10781
  },
@@ -10774,7 +11044,7 @@
10774
11044
  "type": "string"
10775
11045
  },
10776
11046
  "projectId": {
10777
- "description": "The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
11047
+ "description": "The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
10778
11048
  "type": "string"
10779
11049
  },
10780
11050
  "tableId": {
@@ -10926,6 +11196,103 @@
10926
11196
  },
10927
11197
  "type": "object"
10928
11198
  },
11199
+ "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata": {
11200
+ "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.",
11201
+ "id": "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata",
11202
+ "properties": {
11203
+ "createTime": {
11204
+ "description": "Operation create time.",
11205
+ "format": "google-datetime",
11206
+ "type": "string"
11207
+ },
11208
+ "updateTime": {
11209
+ "description": "Operation last update time. If the operation is done, this is also the finish time.",
11210
+ "format": "google-datetime",
11211
+ "type": "string"
11212
+ }
11213
+ },
11214
+ "type": "object"
11215
+ },
11216
+ "GoogleCloudDiscoveryengineV1TrainCustomModelRequest": {
11217
+ "description": "Request message for SearchTuningService.TrainCustomModel method.",
11218
+ "id": "GoogleCloudDiscoveryengineV1TrainCustomModelRequest",
11219
+ "properties": {
11220
+ "errorConfig": {
11221
+ "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig",
11222
+ "description": "The desired location of errors incurred during the data ingestion and training."
11223
+ },
11224
+ "gcsTrainingInput": {
11225
+ "$ref": "GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput",
11226
+ "description": "Cloud Storage training input."
11227
+ },
11228
+ "modelId": {
11229
+ "description": "If not provided, a UUID will be generated.",
11230
+ "type": "string"
11231
+ },
11232
+ "modelType": {
11233
+ "description": "Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.",
11234
+ "type": "string"
11235
+ }
11236
+ },
11237
+ "type": "object"
11238
+ },
11239
+ "GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput": {
11240
+ "description": "Cloud Storage training data input.",
11241
+ "id": "GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput",
11242
+ "properties": {
11243
+ "corpusDataPath": {
11244
+ "description": "The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{\"_id\": \"doc1\", title: \"relevant doc\", \"text\": \"relevant text\"}`",
11245
+ "type": "string"
11246
+ },
11247
+ "queryDataPath": {
11248
+ "description": "The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {\"_id\": \"query1\", \"text\": \"example query\"}",
11249
+ "type": "string"
11250
+ },
11251
+ "testDataPath": {
11252
+ "description": "Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path.",
11253
+ "type": "string"
11254
+ },
11255
+ "trainDataPath": {
11256
+ "description": "Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\\tcorpus-id\\tscore` * `query1\\tdoc1\\t1`",
11257
+ "type": "string"
11258
+ }
11259
+ },
11260
+ "type": "object"
11261
+ },
11262
+ "GoogleCloudDiscoveryengineV1TrainCustomModelResponse": {
11263
+ "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.",
11264
+ "id": "GoogleCloudDiscoveryengineV1TrainCustomModelResponse",
11265
+ "properties": {
11266
+ "errorConfig": {
11267
+ "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig",
11268
+ "description": "Echoes the destination for the complete errors in the request if set."
11269
+ },
11270
+ "errorSamples": {
11271
+ "description": "A sample of errors encountered while processing the data.",
11272
+ "items": {
11273
+ "$ref": "GoogleRpcStatus"
11274
+ },
11275
+ "type": "array"
11276
+ },
11277
+ "metrics": {
11278
+ "additionalProperties": {
11279
+ "format": "double",
11280
+ "type": "number"
11281
+ },
11282
+ "description": "The metrics of the trained model.",
11283
+ "type": "object"
11284
+ },
11285
+ "modelName": {
11286
+ "description": "Fully qualified name of the CustomTuningModel.",
11287
+ "type": "string"
11288
+ },
11289
+ "modelStatus": {
11290
+ "description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.",
11291
+ "type": "string"
11292
+ }
11293
+ },
11294
+ "type": "object"
11295
+ },
10929
11296
  "GoogleCloudDiscoveryengineV1TransactionInfo": {
10930
11297
  "description": "A transaction represents the entire purchase transaction.",
10931
11298
  "id": "GoogleCloudDiscoveryengineV1TransactionInfo",
@@ -11110,6 +11477,37 @@
11110
11477
  },
11111
11478
  "type": "object"
11112
11479
  },
11480
+ "GoogleCloudDiscoveryengineV1WorkspaceConfig": {
11481
+ "description": "Config to store data store type configuration for workspace data",
11482
+ "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig",
11483
+ "properties": {
11484
+ "dasherCustomerId": {
11485
+ "description": "Obfuscated Dasher customer ID.",
11486
+ "type": "string"
11487
+ },
11488
+ "type": {
11489
+ "description": "The Google Workspace data source.",
11490
+ "enum": [
11491
+ "TYPE_UNSPECIFIED",
11492
+ "GOOGLE_DRIVE",
11493
+ "GOOGLE_MAIL",
11494
+ "GOOGLE_SITES",
11495
+ "GOOGLE_CALENDAR",
11496
+ "GOOGLE_GROUPS"
11497
+ ],
11498
+ "enumDescriptions": [
11499
+ "Default value.",
11500
+ "The data store is used to store content from Google Drive.",
11501
+ "The data store is used to store content from Gmail.",
11502
+ "The data store is used to store content from Google Sites.",
11503
+ "The data store is used to store content from Google Calendar.",
11504
+ "The data store is used to store content from Google Groups."
11505
+ ],
11506
+ "type": "string"
11507
+ }
11508
+ },
11509
+ "type": "object"
11510
+ },
11113
11511
  "GoogleCloudDiscoveryengineV1alphaAclConfig": {
11114
11512
  "description": "Access Control Configuration.",
11115
11513
  "id": "GoogleCloudDiscoveryengineV1alphaAclConfig",
@@ -11139,7 +11537,8 @@
11139
11537
  "OUT_OF_DOMAIN_QUERY_IGNORED",
11140
11538
  "POTENTIAL_POLICY_VIOLATION",
11141
11539
  "NO_RELEVANT_CONTENT",
11142
- "JAIL_BREAKING_QUERY_IGNORED"
11540
+ "JAIL_BREAKING_QUERY_IGNORED",
11541
+ "CUSTOMER_POLICY_VIOLATION"
11143
11542
  ],
11144
11543
  "enumDescriptions": [
11145
11544
  "Default value. The answer skipped reason is not specified.",
@@ -11148,7 +11547,8 @@
11148
11547
  "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.",
11149
11548
  "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.",
11150
11549
  "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.",
11151
- "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."
11550
+ "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.",
11551
+ "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer."
11152
11552
  ],
11153
11553
  "type": "string"
11154
11554
  },
@@ -11690,7 +12090,7 @@
11690
12090
  "id": "GoogleCloudDiscoveryengineV1alphaControl",
11691
12091
  "properties": {
11692
12092
  "associatedServingConfigIds": {
11693
- "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.",
12093
+ "description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.",
11694
12094
  "items": {
11695
12095
  "type": "string"
11696
12096
  },
@@ -11986,13 +12386,15 @@
11986
12386
  "CONTENT_CONFIG_UNSPECIFIED",
11987
12387
  "NO_CONTENT",
11988
12388
  "CONTENT_REQUIRED",
11989
- "PUBLIC_WEBSITE"
12389
+ "PUBLIC_WEBSITE",
12390
+ "GOOGLE_WORKSPACE"
11990
12391
  ],
11991
12392
  "enumDescriptions": [
11992
12393
  "Default value.",
11993
12394
  "Only contains documents without any Document.content.",
11994
12395
  "Only contains documents with Document.content.",
11995
- "The data store is used for public website search."
12396
+ "The data store is used for public website search.",
12397
+ "The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig."
11996
12398
  ],
11997
12399
  "type": "string"
11998
12400
  },
@@ -12068,6 +12470,10 @@
12068
12470
  "startingSchema": {
12069
12471
  "$ref": "GoogleCloudDiscoveryengineV1alphaSchema",
12070
12472
  "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)."
12473
+ },
12474
+ "workspaceConfig": {
12475
+ "$ref": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig",
12476
+ "description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE."
12071
12477
  }
12072
12478
  },
12073
12479
  "type": "object"
@@ -14678,6 +15084,37 @@
14678
15084
  },
14679
15085
  "type": "object"
14680
15086
  },
15087
+ "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig": {
15088
+ "description": "Config to store data store type configuration for workspace data",
15089
+ "id": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig",
15090
+ "properties": {
15091
+ "dasherCustomerId": {
15092
+ "description": "Obfuscated Dasher customer ID.",
15093
+ "type": "string"
15094
+ },
15095
+ "type": {
15096
+ "description": "The Google Workspace data source.",
15097
+ "enum": [
15098
+ "TYPE_UNSPECIFIED",
15099
+ "GOOGLE_DRIVE",
15100
+ "GOOGLE_MAIL",
15101
+ "GOOGLE_SITES",
15102
+ "GOOGLE_CALENDAR",
15103
+ "GOOGLE_GROUPS"
15104
+ ],
15105
+ "enumDescriptions": [
15106
+ "Default value.",
15107
+ "The data store is used to store content from Google Drive.",
15108
+ "The data store is used to store content from Gmail.",
15109
+ "The data store is used to store content from Google Sites.",
15110
+ "The data store is used to store content from Google Calendar.",
15111
+ "The data store is used to store content from Google Groups."
15112
+ ],
15113
+ "type": "string"
15114
+ }
15115
+ },
15116
+ "type": "object"
15117
+ },
14681
15118
  "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": {
14682
15119
  "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.",
14683
15120
  "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata",
@@ -14767,7 +15204,7 @@
14767
15204
  "id": "GoogleCloudDiscoveryengineV1betaControl",
14768
15205
  "properties": {
14769
15206
  "associatedServingConfigIds": {
14770
- "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.",
15207
+ "description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.",
14771
15208
  "items": {
14772
15209
  "type": "string"
14773
15210
  },
@@ -15048,13 +15485,15 @@
15048
15485
  "CONTENT_CONFIG_UNSPECIFIED",
15049
15486
  "NO_CONTENT",
15050
15487
  "CONTENT_REQUIRED",
15051
- "PUBLIC_WEBSITE"
15488
+ "PUBLIC_WEBSITE",
15489
+ "GOOGLE_WORKSPACE"
15052
15490
  ],
15053
15491
  "enumDescriptions": [
15054
15492
  "Default value.",
15055
15493
  "Only contains documents without any Document.content.",
15056
15494
  "Only contains documents with Document.content.",
15057
- "The data store is used for public website search."
15495
+ "The data store is used for public website search.",
15496
+ "The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig."
15058
15497
  ],
15059
15498
  "type": "string"
15060
15499
  },
@@ -15125,6 +15564,10 @@
15125
15564
  "startingSchema": {
15126
15565
  "$ref": "GoogleCloudDiscoveryengineV1betaSchema",
15127
15566
  "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)."
15567
+ },
15568
+ "workspaceConfig": {
15569
+ "$ref": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig",
15570
+ "description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE."
15128
15571
  }
15129
15572
  },
15130
15573
  "type": "object"
@@ -16274,6 +16717,24 @@
16274
16717
  "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.",
16275
16718
  "type": "string"
16276
16719
  },
16720
+ "relevanceThreshold": {
16721
+ "description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.",
16722
+ "enum": [
16723
+ "RELEVANCE_THRESHOLD_UNSPECIFIED",
16724
+ "LOWEST",
16725
+ "LOW",
16726
+ "MEDIUM",
16727
+ "HIGH"
16728
+ ],
16729
+ "enumDescriptions": [
16730
+ "Default value. In this case, server behavior defaults to Google defined threshold.",
16731
+ "Lowest relevance threshold.",
16732
+ "Low relevance threshold.",
16733
+ "Medium relevance threshold.",
16734
+ "High relevance threshold."
16735
+ ],
16736
+ "type": "string"
16737
+ },
16277
16738
  "safeSearch": {
16278
16739
  "description": "Whether to turn on safe search. This is only supported for website search.",
16279
16740
  "type": "boolean"
@@ -17070,6 +17531,37 @@
17070
17531
  },
17071
17532
  "type": "object"
17072
17533
  },
17534
+ "GoogleCloudDiscoveryengineV1betaWorkspaceConfig": {
17535
+ "description": "Config to store data store type configuration for workspace data",
17536
+ "id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig",
17537
+ "properties": {
17538
+ "dasherCustomerId": {
17539
+ "description": "Obfuscated Dasher customer ID.",
17540
+ "type": "string"
17541
+ },
17542
+ "type": {
17543
+ "description": "The Google Workspace data source.",
17544
+ "enum": [
17545
+ "TYPE_UNSPECIFIED",
17546
+ "GOOGLE_DRIVE",
17547
+ "GOOGLE_MAIL",
17548
+ "GOOGLE_SITES",
17549
+ "GOOGLE_CALENDAR",
17550
+ "GOOGLE_GROUPS"
17551
+ ],
17552
+ "enumDescriptions": [
17553
+ "Default value.",
17554
+ "The data store is used to store content from Google Drive.",
17555
+ "The data store is used to store content from Gmail.",
17556
+ "The data store is used to store content from Google Sites.",
17557
+ "The data store is used to store content from Google Calendar.",
17558
+ "The data store is used to store content from Google Groups."
17559
+ ],
17560
+ "type": "string"
17561
+ }
17562
+ },
17563
+ "type": "object"
17564
+ },
17073
17565
  "GoogleLongrunningCancelOperationRequest": {
17074
17566
  "description": "The request message for Operations.CancelOperation.",
17075
17567
  "id": "GoogleLongrunningCancelOperationRequest",