@google-cloud/discoveryengine 1.13.0 → 1.14.0

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 (92) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +6 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/answer.proto +49 -5
  4. package/build/protos/google/cloud/discoveryengine/v1/control.proto +6 -4
  5. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +9 -9
  6. package/build/protos/google/cloud/discoveryengine/v1/custom_tuning_model.proto +96 -0
  7. package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +10 -0
  8. package/build/protos/google/cloud/discoveryengine/v1/document.proto +20 -0
  9. package/build/protos/google/cloud/discoveryengine/v1/document_processing_config.proto +2 -0
  10. package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +110 -0
  11. package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +2 -1
  12. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +13 -7
  13. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +117 -0
  14. package/build/protos/google/cloud/discoveryengine/v1/recommendation_service.proto +2 -1
  15. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +40 -16
  16. package/build/protos/google/cloud/discoveryengine/v1/search_tuning_service.proto +196 -0
  17. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +4 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +21 -0
  19. package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config_service.proto +1 -1
  20. package/build/protos/google/cloud/discoveryengine/v1alpha/answer.proto +6 -0
  21. package/build/protos/google/cloud/discoveryengine/v1alpha/control.proto +1 -1
  22. package/build/protos/google/cloud/discoveryengine/v1alpha/custom_tuning_model.proto +3 -0
  23. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +48 -0
  24. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +20 -0
  25. package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +107 -0
  26. package/build/protos/google/cloud/discoveryengine/v1alpha/grounded_generation_service.proto +2 -1
  27. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +7 -7
  28. package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +1 -1
  29. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +21 -1
  30. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +4 -0
  31. package/build/protos/google/cloud/discoveryengine/v1beta/answer.proto +47 -2
  32. package/build/protos/google/cloud/discoveryengine/v1beta/control.proto +1 -1
  33. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +3 -0
  34. package/build/protos/google/cloud/discoveryengine/v1beta/custom_tuning_model.proto +3 -0
  35. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +20 -0
  36. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +2 -0
  37. package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +114 -0
  38. package/build/protos/google/cloud/discoveryengine/v1beta/grounded_generation_service.proto +2 -1
  39. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +13 -7
  40. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +44 -0
  41. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +101 -6
  42. package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -0
  43. package/build/protos/protos.d.ts +7369 -2842
  44. package/build/protos/protos.js +13311 -2062
  45. package/build/protos/protos.json +1096 -45
  46. package/build/src/index.d.ts +4 -1
  47. package/build/src/index.js +4 -1
  48. package/build/src/v1/completion_service_client.d.ts +93 -0
  49. package/build/src/v1/completion_service_client.js +134 -0
  50. package/build/src/v1/control_service_client.d.ts +93 -0
  51. package/build/src/v1/control_service_client.js +128 -0
  52. package/build/src/v1/conversational_search_service_client.d.ts +93 -0
  53. package/build/src/v1/conversational_search_service_client.js +128 -0
  54. package/build/src/v1/data_store_service_client.d.ts +102 -0
  55. package/build/src/v1/data_store_service_client.js +134 -0
  56. package/build/src/v1/document_service_client.d.ts +131 -0
  57. package/build/src/v1/document_service_client.js +156 -0
  58. package/build/src/v1/document_service_client_config.json +5 -0
  59. package/build/src/v1/engine_service_client.d.ts +93 -0
  60. package/build/src/v1/engine_service_client.js +134 -0
  61. package/build/src/v1/grounded_generation_service_client.d.ts +93 -0
  62. package/build/src/v1/grounded_generation_service_client.js +128 -0
  63. package/build/src/v1/index.d.ts +1 -0
  64. package/build/src/v1/index.js +3 -1
  65. package/build/src/v1/project_service_client.d.ts +93 -0
  66. package/build/src/v1/project_service_client.js +134 -0
  67. package/build/src/v1/rank_service_client.d.ts +93 -0
  68. package/build/src/v1/rank_service_client.js +128 -0
  69. package/build/src/v1/recommendation_service_client.d.ts +95 -1
  70. package/build/src/v1/recommendation_service_client.js +128 -0
  71. package/build/src/v1/schema_service_client.d.ts +93 -0
  72. package/build/src/v1/schema_service_client.js +134 -0
  73. package/build/src/v1/search_service_client.d.ts +111 -9
  74. package/build/src/v1/search_service_client.js +140 -6
  75. package/build/src/v1/search_tuning_service_client.d.ts +1776 -0
  76. package/build/src/v1/search_tuning_service_client.js +2589 -0
  77. package/build/src/v1/search_tuning_service_client_config.json +34 -0
  78. package/build/src/v1/site_search_engine_service_client.d.ts +93 -0
  79. package/build/src/v1/site_search_engine_service_client.js +134 -0
  80. package/build/src/v1/user_event_service_client.d.ts +168 -0
  81. package/build/src/v1/user_event_service_client.js +176 -0
  82. package/build/src/v1/user_event_service_client_config.json +5 -0
  83. package/build/src/v1alpha/acl_config_service_client.d.ts +1 -1
  84. package/build/src/v1alpha/document_service_client.d.ts +29 -0
  85. package/build/src/v1alpha/document_service_client.js +22 -0
  86. package/build/src/v1alpha/document_service_client_config.json +5 -0
  87. package/build/src/v1beta/document_service_client.d.ts +38 -0
  88. package/build/src/v1beta/document_service_client.js +22 -0
  89. package/build/src/v1beta/document_service_client_config.json +5 -0
  90. package/build/src/v1beta/search_service_client.d.ts +36 -9
  91. package/build/src/v1beta/search_service_client.js +24 -6
  92. package/package.json +1 -1
@@ -0,0 +1,34 @@
1
+ {
2
+ "interfaces": {
3
+ "google.cloud.discoveryengine.v1.SearchTuningService": {
4
+ "retry_codes": {
5
+ "non_idempotent": [],
6
+ "idempotent": [
7
+ "DEADLINE_EXCEEDED",
8
+ "UNAVAILABLE"
9
+ ]
10
+ },
11
+ "retry_params": {
12
+ "default": {
13
+ "initial_retry_delay_millis": 100,
14
+ "retry_delay_multiplier": 1.3,
15
+ "max_retry_delay_millis": 60000,
16
+ "initial_rpc_timeout_millis": 60000,
17
+ "rpc_timeout_multiplier": 1,
18
+ "max_rpc_timeout_millis": 60000,
19
+ "total_timeout_millis": 600000
20
+ }
21
+ },
22
+ "methods": {
23
+ "TrainCustomModel": {
24
+ "retry_codes_name": "non_idempotent",
25
+ "retry_params_name": "default"
26
+ },
27
+ "ListCustomModels": {
28
+ "retry_codes_name": "non_idempotent",
29
+ "retry_params_name": "default"
30
+ }
31
+ }
32
+ }
33
+ }
34
+ }
@@ -1250,6 +1250,57 @@ export declare class SiteSearchEngineServiceClient {
1250
1250
  * @returns {string} A string representing the conversation.
1251
1251
  */
1252
1252
  matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
1253
+ /**
1254
+ * Return a fully-qualified projectLocationCollectionDataStoreCustomTuningModel resource name string.
1255
+ *
1256
+ * @param {string} project
1257
+ * @param {string} location
1258
+ * @param {string} collection
1259
+ * @param {string} data_store
1260
+ * @param {string} custom_tuning_model
1261
+ * @returns {string} Resource name string.
1262
+ */
1263
+ projectLocationCollectionDataStoreCustomTuningModelPath(project: string, location: string, collection: string, dataStore: string, customTuningModel: string): string;
1264
+ /**
1265
+ * Parse the project from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1266
+ *
1267
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1268
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1269
+ * @returns {string} A string representing the project.
1270
+ */
1271
+ matchProjectFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
1272
+ /**
1273
+ * Parse the location from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1274
+ *
1275
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1276
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1277
+ * @returns {string} A string representing the location.
1278
+ */
1279
+ matchLocationFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
1280
+ /**
1281
+ * Parse the collection from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1282
+ *
1283
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1284
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1285
+ * @returns {string} A string representing the collection.
1286
+ */
1287
+ matchCollectionFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
1288
+ /**
1289
+ * Parse the data_store from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1290
+ *
1291
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1292
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1293
+ * @returns {string} A string representing the data_store.
1294
+ */
1295
+ matchDataStoreFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
1296
+ /**
1297
+ * Parse the custom_tuning_model from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1298
+ *
1299
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1300
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1301
+ * @returns {string} A string representing the custom_tuning_model.
1302
+ */
1303
+ matchCustomTuningModelFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
1253
1304
  /**
1254
1305
  * Return a fully-qualified projectLocationCollectionDataStoreDocumentProcessingConfig resource name string.
1255
1306
  *
@@ -1988,6 +2039,48 @@ export declare class SiteSearchEngineServiceClient {
1988
2039
  * @returns {string} A string representing the conversation.
1989
2040
  */
1990
2041
  matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
2042
+ /**
2043
+ * Return a fully-qualified projectLocationDataStoreCustomTuningModel resource name string.
2044
+ *
2045
+ * @param {string} project
2046
+ * @param {string} location
2047
+ * @param {string} data_store
2048
+ * @param {string} custom_tuning_model
2049
+ * @returns {string} Resource name string.
2050
+ */
2051
+ projectLocationDataStoreCustomTuningModelPath(project: string, location: string, dataStore: string, customTuningModel: string): string;
2052
+ /**
2053
+ * Parse the project from ProjectLocationDataStoreCustomTuningModel resource.
2054
+ *
2055
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2056
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2057
+ * @returns {string} A string representing the project.
2058
+ */
2059
+ matchProjectFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;
2060
+ /**
2061
+ * Parse the location from ProjectLocationDataStoreCustomTuningModel resource.
2062
+ *
2063
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2064
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2065
+ * @returns {string} A string representing the location.
2066
+ */
2067
+ matchLocationFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;
2068
+ /**
2069
+ * Parse the data_store from ProjectLocationDataStoreCustomTuningModel resource.
2070
+ *
2071
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2072
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2073
+ * @returns {string} A string representing the data_store.
2074
+ */
2075
+ matchDataStoreFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;
2076
+ /**
2077
+ * Parse the custom_tuning_model from ProjectLocationDataStoreCustomTuningModel resource.
2078
+ *
2079
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2080
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2081
+ * @returns {string} A string representing the custom_tuning_model.
2082
+ */
2083
+ matchCustomTuningModelFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;
1991
2084
  /**
1992
2085
  * Return a fully-qualified projectLocationDataStoreDocumentProcessingConfig resource name string.
1993
2086
  *
@@ -157,6 +157,7 @@ class SiteSearchEngineServiceClient {
157
157
  projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
158
158
  projectLocationCollectionDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/controls/{control}'),
159
159
  projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
160
+ projectLocationCollectionDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
160
161
  projectLocationCollectionDataStoreDocumentProcessingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig'),
161
162
  projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
162
163
  projectLocationCollectionDataStoreSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}'),
@@ -172,6 +173,7 @@ class SiteSearchEngineServiceClient {
172
173
  projectLocationDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
173
174
  projectLocationDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/controls/{control}'),
174
175
  projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
176
+ projectLocationDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
175
177
  projectLocationDataStoreDocumentProcessingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/documentProcessingConfig'),
176
178
  projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
177
179
  projectLocationDataStoreSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}'),
@@ -252,6 +254,9 @@ class SiteSearchEngineServiceClient {
252
254
  {
253
255
  get: '/v1/{name=projects/*/locations/*/dataStores/*/operations/*}',
254
256
  },
257
+ {
258
+ get: '/v1/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}',
259
+ },
255
260
  { get: '/v1/{name=projects/*/locations/*/operations/*}' },
256
261
  { get: '/v1/{name=projects/*/operations/*}' },
257
262
  ],
@@ -292,6 +297,9 @@ class SiteSearchEngineServiceClient {
292
297
  get: '/v1/{name=projects/*/locations/*/dataStores/*/models/*}/operations',
293
298
  },
294
299
  { get: '/v1/{name=projects/*/locations/*/dataStores/*}/operations' },
300
+ {
301
+ get: '/v1/{name=projects/*/locations/*/identity_mapping_stores/*}/operations',
302
+ },
295
303
  { get: '/v1/{name=projects/*/locations/*}/operations' },
296
304
  { get: '/v1/{name=projects/*}/operations' },
297
305
  ],
@@ -1674,6 +1682,75 @@ class SiteSearchEngineServiceClient {
1674
1682
  matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
1675
1683
  return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).conversation;
1676
1684
  }
1685
+ /**
1686
+ * Return a fully-qualified projectLocationCollectionDataStoreCustomTuningModel resource name string.
1687
+ *
1688
+ * @param {string} project
1689
+ * @param {string} location
1690
+ * @param {string} collection
1691
+ * @param {string} data_store
1692
+ * @param {string} custom_tuning_model
1693
+ * @returns {string} Resource name string.
1694
+ */
1695
+ projectLocationCollectionDataStoreCustomTuningModelPath(project, location, collection, dataStore, customTuningModel) {
1696
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.render({
1697
+ project: project,
1698
+ location: location,
1699
+ collection: collection,
1700
+ data_store: dataStore,
1701
+ custom_tuning_model: customTuningModel,
1702
+ });
1703
+ }
1704
+ /**
1705
+ * Parse the project from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1706
+ *
1707
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1708
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1709
+ * @returns {string} A string representing the project.
1710
+ */
1711
+ matchProjectFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1712
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).project;
1713
+ }
1714
+ /**
1715
+ * Parse the location from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1716
+ *
1717
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1718
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1719
+ * @returns {string} A string representing the location.
1720
+ */
1721
+ matchLocationFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1722
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).location;
1723
+ }
1724
+ /**
1725
+ * Parse the collection from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1726
+ *
1727
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1728
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1729
+ * @returns {string} A string representing the collection.
1730
+ */
1731
+ matchCollectionFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1732
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).collection;
1733
+ }
1734
+ /**
1735
+ * Parse the data_store from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1736
+ *
1737
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1738
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1739
+ * @returns {string} A string representing the data_store.
1740
+ */
1741
+ matchDataStoreFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1742
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).data_store;
1743
+ }
1744
+ /**
1745
+ * Parse the custom_tuning_model from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1746
+ *
1747
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1748
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1749
+ * @returns {string} A string representing the custom_tuning_model.
1750
+ */
1751
+ matchCustomTuningModelFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1752
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).custom_tuning_model;
1753
+ }
1677
1754
  /**
1678
1755
  * Return a fully-qualified projectLocationCollectionDataStoreDocumentProcessingConfig resource name string.
1679
1756
  *
@@ -2673,6 +2750,63 @@ class SiteSearchEngineServiceClient {
2673
2750
  matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
2674
2751
  return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).conversation;
2675
2752
  }
2753
+ /**
2754
+ * Return a fully-qualified projectLocationDataStoreCustomTuningModel resource name string.
2755
+ *
2756
+ * @param {string} project
2757
+ * @param {string} location
2758
+ * @param {string} data_store
2759
+ * @param {string} custom_tuning_model
2760
+ * @returns {string} Resource name string.
2761
+ */
2762
+ projectLocationDataStoreCustomTuningModelPath(project, location, dataStore, customTuningModel) {
2763
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.render({
2764
+ project: project,
2765
+ location: location,
2766
+ data_store: dataStore,
2767
+ custom_tuning_model: customTuningModel,
2768
+ });
2769
+ }
2770
+ /**
2771
+ * Parse the project from ProjectLocationDataStoreCustomTuningModel resource.
2772
+ *
2773
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2774
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2775
+ * @returns {string} A string representing the project.
2776
+ */
2777
+ matchProjectFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName) {
2778
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).project;
2779
+ }
2780
+ /**
2781
+ * Parse the location from ProjectLocationDataStoreCustomTuningModel resource.
2782
+ *
2783
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2784
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2785
+ * @returns {string} A string representing the location.
2786
+ */
2787
+ matchLocationFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName) {
2788
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).location;
2789
+ }
2790
+ /**
2791
+ * Parse the data_store from ProjectLocationDataStoreCustomTuningModel resource.
2792
+ *
2793
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2794
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2795
+ * @returns {string} A string representing the data_store.
2796
+ */
2797
+ matchDataStoreFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName) {
2798
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).data_store;
2799
+ }
2800
+ /**
2801
+ * Parse the custom_tuning_model from ProjectLocationDataStoreCustomTuningModel resource.
2802
+ *
2803
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2804
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2805
+ * @returns {string} A string representing the custom_tuning_model.
2806
+ */
2807
+ matchCustomTuningModelFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName) {
2808
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).custom_tuning_model;
2809
+ }
2676
2810
  /**
2677
2811
  * Return a fully-qualified projectLocationDataStoreDocumentProcessingConfig resource name string.
2678
2812
  *
@@ -192,6 +192,81 @@ export declare class UserEventServiceClient {
192
192
  ]>;
193
193
  collectUserEvent(request: protos.google.cloud.discoveryengine.v1.ICollectUserEventRequest, options: CallOptions, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.discoveryengine.v1.ICollectUserEventRequest | null | undefined, {} | null | undefined>): void;
194
194
  collectUserEvent(request: protos.google.cloud.discoveryengine.v1.ICollectUserEventRequest, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.discoveryengine.v1.ICollectUserEventRequest | null | undefined, {} | null | undefined>): void;
195
+ /**
196
+ * Deletes permanently all user events specified by the filter provided.
197
+ * Depending on the number of events specified by the filter, this operation
198
+ * could take hours or days to complete. To test a filter, use the list
199
+ * command first.
200
+ *
201
+ * @param {Object} request
202
+ * The request object that will be sent.
203
+ * @param {string} request.parent
204
+ * Required. The resource name of the catalog under which the events are
205
+ * created. The format is
206
+ * `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`
207
+ * @param {string} request.filter
208
+ * Required. The filter string to specify the events to be deleted with a
209
+ * length limit of 5,000 characters. The eligible fields for filtering are:
210
+ *
211
+ * * `eventType`: Double quoted
212
+ * {@link protos.google.cloud.discoveryengine.v1.UserEvent.event_type|UserEvent.event_type}
213
+ * string.
214
+ * * `eventTime`: in ISO 8601 "zulu" format.
215
+ * * `userPseudoId`: Double quoted string. Specifying this will delete all
216
+ * events associated with a visitor.
217
+ * * `userId`: Double quoted string. Specifying this will delete all events
218
+ * associated with a user.
219
+ *
220
+ * Examples:
221
+ *
222
+ * * Deleting all events in a time range:
223
+ * `eventTime > "2012-04-23T18:25:43.511Z"
224
+ * eventTime < "2012-04-23T18:30:43.511Z"`
225
+ * * Deleting specific eventType:
226
+ * `eventType = "search"`
227
+ * * Deleting all events for a specific visitor:
228
+ * `userPseudoId = "visitor1024"`
229
+ * * Deleting all events inside a DataStore:
230
+ * `*`
231
+ *
232
+ * The filtering fields are assumed to have an implicit AND.
233
+ * @param {boolean} request.force
234
+ * The `force` field is currently not supported. Purge user event requests
235
+ * will permanently delete all purgeable events. Once the development is
236
+ * complete:
237
+ * If `force` is set to false, the method will return the expected
238
+ * purge count without deleting any user events. This field will default to
239
+ * false if not included in the request.
240
+ * @param {object} [options]
241
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
242
+ * @returns {Promise} - The promise which resolves to an array.
243
+ * The first element of the array is an object representing
244
+ * a long running operation. Its `promise()` method returns a promise
245
+ * you can `await` for.
246
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
247
+ * for more details and examples.
248
+ * @example <caption>include:samples/generated/v1/user_event_service.purge_user_events.js</caption>
249
+ * region_tag:discoveryengine_v1_generated_UserEventService_PurgeUserEvents_async
250
+ */
251
+ purgeUserEvents(request?: protos.google.cloud.discoveryengine.v1.IPurgeUserEventsRequest, options?: CallOptions): Promise<[
252
+ LROperation<protos.google.cloud.discoveryengine.v1.IPurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1.IPurgeUserEventsMetadata>,
253
+ protos.google.longrunning.IOperation | undefined,
254
+ {} | undefined
255
+ ]>;
256
+ purgeUserEvents(request: protos.google.cloud.discoveryengine.v1.IPurgeUserEventsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1.IPurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1.IPurgeUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
257
+ purgeUserEvents(request: protos.google.cloud.discoveryengine.v1.IPurgeUserEventsRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1.IPurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1.IPurgeUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
258
+ /**
259
+ * Check the status of the long running operation returned by `purgeUserEvents()`.
260
+ * @param {String} name
261
+ * The operation name that will be passed.
262
+ * @returns {Promise} - The promise which resolves to an object.
263
+ * The decoded operation object has result and metadata field to get information from.
264
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
265
+ * for more details and examples.
266
+ * @example <caption>include:samples/generated/v1/user_event_service.purge_user_events.js</caption>
267
+ * region_tag:discoveryengine_v1_generated_UserEventService_PurgeUserEvents_async
268
+ */
269
+ checkPurgeUserEventsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.PurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1.PurgeUserEventsMetadata>>;
195
270
  /**
196
271
  * Bulk import of user events. Request processing might be
197
272
  * synchronous. Events that already exist are skipped.
@@ -746,6 +821,57 @@ export declare class UserEventServiceClient {
746
821
  * @returns {string} A string representing the conversation.
747
822
  */
748
823
  matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
824
+ /**
825
+ * Return a fully-qualified projectLocationCollectionDataStoreCustomTuningModel resource name string.
826
+ *
827
+ * @param {string} project
828
+ * @param {string} location
829
+ * @param {string} collection
830
+ * @param {string} data_store
831
+ * @param {string} custom_tuning_model
832
+ * @returns {string} Resource name string.
833
+ */
834
+ projectLocationCollectionDataStoreCustomTuningModelPath(project: string, location: string, collection: string, dataStore: string, customTuningModel: string): string;
835
+ /**
836
+ * Parse the project from ProjectLocationCollectionDataStoreCustomTuningModel resource.
837
+ *
838
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
839
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
840
+ * @returns {string} A string representing the project.
841
+ */
842
+ matchProjectFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
843
+ /**
844
+ * Parse the location from ProjectLocationCollectionDataStoreCustomTuningModel resource.
845
+ *
846
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
847
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
848
+ * @returns {string} A string representing the location.
849
+ */
850
+ matchLocationFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
851
+ /**
852
+ * Parse the collection from ProjectLocationCollectionDataStoreCustomTuningModel resource.
853
+ *
854
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
855
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
856
+ * @returns {string} A string representing the collection.
857
+ */
858
+ matchCollectionFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
859
+ /**
860
+ * Parse the data_store from ProjectLocationCollectionDataStoreCustomTuningModel resource.
861
+ *
862
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
863
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
864
+ * @returns {string} A string representing the data_store.
865
+ */
866
+ matchDataStoreFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
867
+ /**
868
+ * Parse the custom_tuning_model from ProjectLocationCollectionDataStoreCustomTuningModel resource.
869
+ *
870
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
871
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
872
+ * @returns {string} A string representing the custom_tuning_model.
873
+ */
874
+ matchCustomTuningModelFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;
749
875
  /**
750
876
  * Return a fully-qualified projectLocationCollectionDataStoreDocumentProcessingConfig resource name string.
751
877
  *
@@ -1484,6 +1610,48 @@ export declare class UserEventServiceClient {
1484
1610
  * @returns {string} A string representing the conversation.
1485
1611
  */
1486
1612
  matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1613
+ /**
1614
+ * Return a fully-qualified projectLocationDataStoreCustomTuningModel resource name string.
1615
+ *
1616
+ * @param {string} project
1617
+ * @param {string} location
1618
+ * @param {string} data_store
1619
+ * @param {string} custom_tuning_model
1620
+ * @returns {string} Resource name string.
1621
+ */
1622
+ projectLocationDataStoreCustomTuningModelPath(project: string, location: string, dataStore: string, customTuningModel: string): string;
1623
+ /**
1624
+ * Parse the project from ProjectLocationDataStoreCustomTuningModel resource.
1625
+ *
1626
+ * @param {string} projectLocationDataStoreCustomTuningModelName
1627
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
1628
+ * @returns {string} A string representing the project.
1629
+ */
1630
+ matchProjectFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;
1631
+ /**
1632
+ * Parse the location from ProjectLocationDataStoreCustomTuningModel resource.
1633
+ *
1634
+ * @param {string} projectLocationDataStoreCustomTuningModelName
1635
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
1636
+ * @returns {string} A string representing the location.
1637
+ */
1638
+ matchLocationFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;
1639
+ /**
1640
+ * Parse the data_store from ProjectLocationDataStoreCustomTuningModel resource.
1641
+ *
1642
+ * @param {string} projectLocationDataStoreCustomTuningModelName
1643
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
1644
+ * @returns {string} A string representing the data_store.
1645
+ */
1646
+ matchDataStoreFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;
1647
+ /**
1648
+ * Parse the custom_tuning_model from ProjectLocationDataStoreCustomTuningModel resource.
1649
+ *
1650
+ * @param {string} projectLocationDataStoreCustomTuningModelName
1651
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
1652
+ * @returns {string} A string representing the custom_tuning_model.
1653
+ */
1654
+ matchCustomTuningModelFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;
1487
1655
  /**
1488
1656
  * Return a fully-qualified projectLocationDataStoreDocumentProcessingConfig resource name string.
1489
1657
  *