@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
@@ -156,6 +156,7 @@ class UserEventServiceClient {
156
156
  projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
157
157
  projectLocationCollectionDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/controls/{control}'),
158
158
  projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
159
+ projectLocationCollectionDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
159
160
  projectLocationCollectionDataStoreDocumentProcessingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig'),
160
161
  projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
161
162
  projectLocationCollectionDataStoreSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}'),
@@ -171,6 +172,7 @@ class UserEventServiceClient {
171
172
  projectLocationDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
172
173
  projectLocationDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/controls/{control}'),
173
174
  projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
175
+ projectLocationDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
174
176
  projectLocationDataStoreDocumentProcessingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/documentProcessingConfig'),
175
177
  projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
176
178
  projectLocationDataStoreSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}'),
@@ -244,6 +246,9 @@ class UserEventServiceClient {
244
246
  {
245
247
  get: '/v1/{name=projects/*/locations/*/dataStores/*/operations/*}',
246
248
  },
249
+ {
250
+ get: '/v1/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}',
251
+ },
247
252
  { get: '/v1/{name=projects/*/locations/*/operations/*}' },
248
253
  { get: '/v1/{name=projects/*/operations/*}' },
249
254
  ],
@@ -284,6 +289,9 @@ class UserEventServiceClient {
284
289
  get: '/v1/{name=projects/*/locations/*/dataStores/*/models/*}/operations',
285
290
  },
286
291
  { get: '/v1/{name=projects/*/locations/*/dataStores/*}/operations' },
292
+ {
293
+ get: '/v1/{name=projects/*/locations/*/identity_mapping_stores/*}/operations',
294
+ },
287
295
  { get: '/v1/{name=projects/*/locations/*}/operations' },
288
296
  { get: '/v1/{name=projects/*}/operations' },
289
297
  ],
@@ -293,9 +301,12 @@ class UserEventServiceClient {
293
301
  this.operationsClient = this._gaxModule
294
302
  .lro(lroOptions)
295
303
  .operationsClient(opts);
304
+ const purgeUserEventsResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1.PurgeUserEventsResponse');
305
+ const purgeUserEventsMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1.PurgeUserEventsMetadata');
296
306
  const importUserEventsResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1.ImportUserEventsResponse');
297
307
  const importUserEventsMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1.ImportUserEventsMetadata');
298
308
  this.descriptors.longrunning = {
309
+ purgeUserEvents: new this._gaxModule.LongrunningDescriptor(this.operationsClient, purgeUserEventsResponse.decode.bind(purgeUserEventsResponse), purgeUserEventsMetadata.decode.bind(purgeUserEventsMetadata)),
299
310
  importUserEvents: new this._gaxModule.LongrunningDescriptor(this.operationsClient, importUserEventsResponse.decode.bind(importUserEventsResponse), importUserEventsMetadata.decode.bind(importUserEventsMetadata)),
300
311
  };
301
312
  // Put together the default options sent with requests.
@@ -335,6 +346,7 @@ class UserEventServiceClient {
335
346
  const userEventServiceStubMethods = [
336
347
  'writeUserEvent',
337
348
  'collectUserEvent',
349
+ 'purgeUserEvents',
338
350
  'importUserEvents',
339
351
  ];
340
352
  for (const methodName of userEventServiceStubMethods) {
@@ -455,6 +467,44 @@ class UserEventServiceClient {
455
467
  this.initialize();
456
468
  return this.innerApiCalls.collectUserEvent(request, options, callback);
457
469
  }
470
+ purgeUserEvents(request, optionsOrCallback, callback) {
471
+ var _a;
472
+ request = request || {};
473
+ let options;
474
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
475
+ callback = optionsOrCallback;
476
+ options = {};
477
+ }
478
+ else {
479
+ options = optionsOrCallback;
480
+ }
481
+ options = options || {};
482
+ options.otherArgs = options.otherArgs || {};
483
+ options.otherArgs.headers = options.otherArgs.headers || {};
484
+ options.otherArgs.headers['x-goog-request-params'] =
485
+ this._gaxModule.routingHeader.fromParams({
486
+ parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
487
+ });
488
+ this.initialize();
489
+ return this.innerApiCalls.purgeUserEvents(request, options, callback);
490
+ }
491
+ /**
492
+ * Check the status of the long running operation returned by `purgeUserEvents()`.
493
+ * @param {String} name
494
+ * The operation name that will be passed.
495
+ * @returns {Promise} - The promise which resolves to an object.
496
+ * The decoded operation object has result and metadata field to get information from.
497
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
498
+ * for more details and examples.
499
+ * @example <caption>include:samples/generated/v1/user_event_service.purge_user_events.js</caption>
500
+ * region_tag:discoveryengine_v1_generated_UserEventService_PurgeUserEvents_async
501
+ */
502
+ async checkPurgeUserEventsProgress(name) {
503
+ const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
504
+ const [operation] = await this.operationsClient.getOperation(request);
505
+ const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.purgeUserEvents, this._gaxModule.createDefaultBackoffSettings());
506
+ return decodeOperation;
507
+ }
458
508
  importUserEvents(request, optionsOrCallback, callback) {
459
509
  var _a;
460
510
  request = request || {};
@@ -1126,6 +1176,75 @@ class UserEventServiceClient {
1126
1176
  matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
1127
1177
  return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).conversation;
1128
1178
  }
1179
+ /**
1180
+ * Return a fully-qualified projectLocationCollectionDataStoreCustomTuningModel resource name string.
1181
+ *
1182
+ * @param {string} project
1183
+ * @param {string} location
1184
+ * @param {string} collection
1185
+ * @param {string} data_store
1186
+ * @param {string} custom_tuning_model
1187
+ * @returns {string} Resource name string.
1188
+ */
1189
+ projectLocationCollectionDataStoreCustomTuningModelPath(project, location, collection, dataStore, customTuningModel) {
1190
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.render({
1191
+ project: project,
1192
+ location: location,
1193
+ collection: collection,
1194
+ data_store: dataStore,
1195
+ custom_tuning_model: customTuningModel,
1196
+ });
1197
+ }
1198
+ /**
1199
+ * Parse the project from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1200
+ *
1201
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1202
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1203
+ * @returns {string} A string representing the project.
1204
+ */
1205
+ matchProjectFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1206
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).project;
1207
+ }
1208
+ /**
1209
+ * Parse the location from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1210
+ *
1211
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1212
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1213
+ * @returns {string} A string representing the location.
1214
+ */
1215
+ matchLocationFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1216
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).location;
1217
+ }
1218
+ /**
1219
+ * Parse the collection from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1220
+ *
1221
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1222
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1223
+ * @returns {string} A string representing the collection.
1224
+ */
1225
+ matchCollectionFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1226
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).collection;
1227
+ }
1228
+ /**
1229
+ * Parse the data_store from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1230
+ *
1231
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1232
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1233
+ * @returns {string} A string representing the data_store.
1234
+ */
1235
+ matchDataStoreFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1236
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).data_store;
1237
+ }
1238
+ /**
1239
+ * Parse the custom_tuning_model from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1240
+ *
1241
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1242
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1243
+ * @returns {string} A string representing the custom_tuning_model.
1244
+ */
1245
+ matchCustomTuningModelFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1246
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).custom_tuning_model;
1247
+ }
1129
1248
  /**
1130
1249
  * Return a fully-qualified projectLocationCollectionDataStoreDocumentProcessingConfig resource name string.
1131
1250
  *
@@ -2125,6 +2244,63 @@ class UserEventServiceClient {
2125
2244
  matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
2126
2245
  return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).conversation;
2127
2246
  }
2247
+ /**
2248
+ * Return a fully-qualified projectLocationDataStoreCustomTuningModel resource name string.
2249
+ *
2250
+ * @param {string} project
2251
+ * @param {string} location
2252
+ * @param {string} data_store
2253
+ * @param {string} custom_tuning_model
2254
+ * @returns {string} Resource name string.
2255
+ */
2256
+ projectLocationDataStoreCustomTuningModelPath(project, location, dataStore, customTuningModel) {
2257
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.render({
2258
+ project: project,
2259
+ location: location,
2260
+ data_store: dataStore,
2261
+ custom_tuning_model: customTuningModel,
2262
+ });
2263
+ }
2264
+ /**
2265
+ * Parse the project from ProjectLocationDataStoreCustomTuningModel resource.
2266
+ *
2267
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2268
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2269
+ * @returns {string} A string representing the project.
2270
+ */
2271
+ matchProjectFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName) {
2272
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).project;
2273
+ }
2274
+ /**
2275
+ * Parse the location from ProjectLocationDataStoreCustomTuningModel resource.
2276
+ *
2277
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2278
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2279
+ * @returns {string} A string representing the location.
2280
+ */
2281
+ matchLocationFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName) {
2282
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).location;
2283
+ }
2284
+ /**
2285
+ * Parse the data_store from ProjectLocationDataStoreCustomTuningModel resource.
2286
+ *
2287
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2288
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2289
+ * @returns {string} A string representing the data_store.
2290
+ */
2291
+ matchDataStoreFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName) {
2292
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).data_store;
2293
+ }
2294
+ /**
2295
+ * Parse the custom_tuning_model from ProjectLocationDataStoreCustomTuningModel resource.
2296
+ *
2297
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2298
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2299
+ * @returns {string} A string representing the custom_tuning_model.
2300
+ */
2301
+ matchCustomTuningModelFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName) {
2302
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).custom_tuning_model;
2303
+ }
2128
2304
  /**
2129
2305
  * Return a fully-qualified projectLocationDataStoreDocumentProcessingConfig resource name string.
2130
2306
  *
@@ -51,6 +51,11 @@
51
51
  "retry_codes_name": "unavailable",
52
52
  "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
53
53
  },
54
+ "PurgeUserEvents": {
55
+ "timeout_millis": 30000,
56
+ "retry_codes_name": "unavailable",
57
+ "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
58
+ },
54
59
  "ImportUserEvents": {
55
60
  "timeout_millis": 300000,
56
61
  "retry_codes_name": "unavailable",
@@ -115,7 +115,7 @@ export declare class AclConfigServiceClient {
115
115
  getProjectId(): Promise<string>;
116
116
  getProjectId(callback: Callback<string, undefined, undefined>): void;
117
117
  /**
118
- * Default Acl Configuration for use in a location of a customer's project.
118
+ * Default ACL configuration for use in a location of a customer's project.
119
119
  * Updates will only reflect to new data stores. Existing data stores will
120
120
  * still use the old value.
121
121
  *
@@ -304,6 +304,35 @@ export declare class DocumentServiceClient {
304
304
  ]>;
305
305
  getProcessedDocument(request: protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IProcessedDocument, protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest | null | undefined, {} | null | undefined>): void;
306
306
  getProcessedDocument(request: protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IProcessedDocument, protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest | null | undefined, {} | null | undefined>): void;
307
+ /**
308
+ * Gets index freshness metadata for
309
+ * {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s. Supported for
310
+ * website search only.
311
+ *
312
+ * @param {Object} request
313
+ * The request object that will be sent.
314
+ * @param {string} request.parent
315
+ * Required. The parent branch resource name, such as
316
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
317
+ * @param {google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataRequest.Matcher} request.matcher
318
+ * Required. Matcher for the
319
+ * {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s.
320
+ * @param {object} [options]
321
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
322
+ * @returns {Promise} - The promise which resolves to an array.
323
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataResponse|BatchGetDocumentsMetadataResponse}.
324
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
325
+ * for more details and examples.
326
+ * @example <caption>include:samples/generated/v1alpha/document_service.batch_get_documents_metadata.js</caption>
327
+ * region_tag:discoveryengine_v1alpha_generated_DocumentService_BatchGetDocumentsMetadata_async
328
+ */
329
+ batchGetDocumentsMetadata(request?: protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataRequest, options?: CallOptions): Promise<[
330
+ protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataResponse,
331
+ (protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataRequest | undefined),
332
+ {} | undefined
333
+ ]>;
334
+ batchGetDocumentsMetadata(request: protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataResponse, protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataRequest | null | undefined, {} | null | undefined>): void;
335
+ batchGetDocumentsMetadata(request: protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataResponse, protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataRequest | null | undefined, {} | null | undefined>): void;
307
336
  /**
308
337
  * Bulk import of multiple
309
338
  * {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s. Request
@@ -369,6 +369,7 @@ class DocumentServiceClient {
369
369
  'importDocuments',
370
370
  'purgeDocuments',
371
371
  'getProcessedDocument',
372
+ 'batchGetDocumentsMetadata',
372
373
  ];
373
374
  for (const methodName of documentServiceStubMethods) {
374
375
  const callPromise = this.documentServiceStub.then(stub => (...args) => {
@@ -553,6 +554,27 @@ class DocumentServiceClient {
553
554
  this.initialize();
554
555
  return this.innerApiCalls.getProcessedDocument(request, options, callback);
555
556
  }
557
+ batchGetDocumentsMetadata(request, optionsOrCallback, callback) {
558
+ var _a;
559
+ request = request || {};
560
+ let options;
561
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
562
+ callback = optionsOrCallback;
563
+ options = {};
564
+ }
565
+ else {
566
+ options = optionsOrCallback;
567
+ }
568
+ options = options || {};
569
+ options.otherArgs = options.otherArgs || {};
570
+ options.otherArgs.headers = options.otherArgs.headers || {};
571
+ options.otherArgs.headers['x-goog-request-params'] =
572
+ this._gaxModule.routingHeader.fromParams({
573
+ parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
574
+ });
575
+ this.initialize();
576
+ return this.innerApiCalls.batchGetDocumentsMetadata(request, options, callback);
577
+ }
556
578
  importDocuments(request, optionsOrCallback, callback) {
557
579
  var _a;
558
580
  request = request || {};
@@ -80,6 +80,11 @@
80
80
  "timeout_millis": 30000,
81
81
  "retry_codes_name": "unavailable",
82
82
  "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
83
+ },
84
+ "BatchGetDocumentsMetadata": {
85
+ "timeout_millis": 30000,
86
+ "retry_codes_name": "unavailable",
87
+ "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
83
88
  }
84
89
  }
85
90
  }
@@ -266,6 +266,35 @@ export declare class DocumentServiceClient {
266
266
  ]>;
267
267
  deleteDocument(request: protos.google.cloud.discoveryengine.v1beta.IDeleteDocumentRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1beta.IDeleteDocumentRequest | null | undefined, {} | null | undefined>): void;
268
268
  deleteDocument(request: protos.google.cloud.discoveryengine.v1beta.IDeleteDocumentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1beta.IDeleteDocumentRequest | null | undefined, {} | null | undefined>): void;
269
+ /**
270
+ * Gets index freshness metadata for
271
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s. Supported for
272
+ * website search only.
273
+ *
274
+ * @param {Object} request
275
+ * The request object that will be sent.
276
+ * @param {string} request.parent
277
+ * Required. The parent branch resource name, such as
278
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
279
+ * @param {google.cloud.discoveryengine.v1beta.BatchGetDocumentsMetadataRequest.Matcher} request.matcher
280
+ * Required. Matcher for the
281
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s.
282
+ * @param {object} [options]
283
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
284
+ * @returns {Promise} - The promise which resolves to an array.
285
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1beta.BatchGetDocumentsMetadataResponse|BatchGetDocumentsMetadataResponse}.
286
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
287
+ * for more details and examples.
288
+ * @example <caption>include:samples/generated/v1beta/document_service.batch_get_documents_metadata.js</caption>
289
+ * region_tag:discoveryengine_v1beta_generated_DocumentService_BatchGetDocumentsMetadata_async
290
+ */
291
+ batchGetDocumentsMetadata(request?: protos.google.cloud.discoveryengine.v1beta.IBatchGetDocumentsMetadataRequest, options?: CallOptions): Promise<[
292
+ protos.google.cloud.discoveryengine.v1beta.IBatchGetDocumentsMetadataResponse,
293
+ (protos.google.cloud.discoveryengine.v1beta.IBatchGetDocumentsMetadataRequest | undefined),
294
+ {} | undefined
295
+ ]>;
296
+ batchGetDocumentsMetadata(request: protos.google.cloud.discoveryengine.v1beta.IBatchGetDocumentsMetadataRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IBatchGetDocumentsMetadataResponse, protos.google.cloud.discoveryengine.v1beta.IBatchGetDocumentsMetadataRequest | null | undefined, {} | null | undefined>): void;
297
+ batchGetDocumentsMetadata(request: protos.google.cloud.discoveryengine.v1beta.IBatchGetDocumentsMetadataRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IBatchGetDocumentsMetadataResponse, protos.google.cloud.discoveryengine.v1beta.IBatchGetDocumentsMetadataRequest | null | undefined, {} | null | undefined>): void;
269
298
  /**
270
299
  * Bulk import of multiple
271
300
  * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s. Request
@@ -420,6 +449,13 @@ export declare class DocumentServiceClient {
420
449
  *
421
450
  * @param {Object} request
422
451
  * The request object that will be sent.
452
+ * @param {google.cloud.discoveryengine.v1beta.GcsSource} request.gcsSource
453
+ * Cloud Storage location for the input content.
454
+ * Supported `data_schema`:
455
+ * * `document_id`: One valid
456
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document.id|Document.id} per line.
457
+ * @param {google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.InlineSource} request.inlineSource
458
+ * Inline source for the input content for purge.
423
459
  * @param {string} request.parent
424
460
  * Required. The parent resource name, such as
425
461
  * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
@@ -427,6 +463,8 @@ export declare class DocumentServiceClient {
427
463
  * Required. Filter matching documents to purge. Only currently supported
428
464
  * value is
429
465
  * `*` (all items).
466
+ * @param {google.cloud.discoveryengine.v1beta.PurgeErrorConfig} request.errorConfig
467
+ * The desired location of errors incurred during the purge.
430
468
  * @param {boolean} request.force
431
469
  * Actually performs the purge. If `force` is set to false, return the
432
470
  * expected purge count without deleting any documents.
@@ -361,6 +361,7 @@ class DocumentServiceClient {
361
361
  'deleteDocument',
362
362
  'importDocuments',
363
363
  'purgeDocuments',
364
+ 'batchGetDocumentsMetadata',
364
365
  ];
365
366
  for (const methodName of documentServiceStubMethods) {
366
367
  const callPromise = this.documentServiceStub.then(stub => (...args) => {
@@ -524,6 +525,27 @@ class DocumentServiceClient {
524
525
  this.initialize();
525
526
  return this.innerApiCalls.deleteDocument(request, options, callback);
526
527
  }
528
+ batchGetDocumentsMetadata(request, optionsOrCallback, callback) {
529
+ var _a;
530
+ request = request || {};
531
+ let options;
532
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
533
+ callback = optionsOrCallback;
534
+ options = {};
535
+ }
536
+ else {
537
+ options = optionsOrCallback;
538
+ }
539
+ options = options || {};
540
+ options.otherArgs = options.otherArgs || {};
541
+ options.otherArgs.headers = options.otherArgs.headers || {};
542
+ options.otherArgs.headers['x-goog-request-params'] =
543
+ this._gaxModule.routingHeader.fromParams({
544
+ parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
545
+ });
546
+ this.initialize();
547
+ return this.innerApiCalls.batchGetDocumentsMetadata(request, options, callback);
548
+ }
527
549
  importDocuments(request, optionsOrCallback, callback) {
528
550
  var _a;
529
551
  request = request || {};
@@ -75,6 +75,11 @@
75
75
  "timeout_millis": 30000,
76
76
  "retry_codes_name": "unavailable",
77
77
  "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
78
+ },
79
+ "BatchGetDocumentsMetadata": {
80
+ "timeout_millis": 30000,
81
+ "retry_codes_name": "unavailable",
82
+ "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
78
83
  }
79
84
  }
80
85
  }
@@ -205,9 +205,12 @@ export declare class SearchServiceClient {
205
205
  * object. Leave it unset if ordered by relevance. `order_by` expression is
206
206
  * case-sensitive.
207
207
  *
208
- * For more information on ordering for retail search, see
209
- * [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
210
- *
208
+ * For more information on ordering the website search results, see
209
+ * [Order web search
210
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
211
+ * For more information on ordering the healthcare search results, see
212
+ * [Order healthcare search
213
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
211
214
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
212
215
  * @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
213
216
  * Information about the end user.
@@ -370,6 +373,12 @@ export declare class SearchServiceClient {
370
373
  * Session specification.
371
374
  *
372
375
  * Can be used only when `session` is set.
376
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold} request.relevanceThreshold
377
+ * The relevance threshold of the search results.
378
+ *
379
+ * Default to Google defined threshold, leveraging a balance of
380
+ * precision and recall to deliver both highly accurate results and
381
+ * comprehensive coverage of relevant information.
373
382
  * @param {object} [options]
374
383
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
375
384
  * @returns {Promise} - The promise which resolves to an array.
@@ -478,9 +487,12 @@ export declare class SearchServiceClient {
478
487
  * object. Leave it unset if ordered by relevance. `order_by` expression is
479
488
  * case-sensitive.
480
489
  *
481
- * For more information on ordering for retail search, see
482
- * [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
483
- *
490
+ * For more information on ordering the website search results, see
491
+ * [Order web search
492
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
493
+ * For more information on ordering the healthcare search results, see
494
+ * [Order healthcare search
495
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
484
496
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
485
497
  * @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
486
498
  * Information about the end user.
@@ -643,6 +655,12 @@ export declare class SearchServiceClient {
643
655
  * Session specification.
644
656
  *
645
657
  * Can be used only when `session` is set.
658
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold} request.relevanceThreshold
659
+ * The relevance threshold of the search results.
660
+ *
661
+ * Default to Google defined threshold, leveraging a balance of
662
+ * precision and recall to deliver both highly accurate results and
663
+ * comprehensive coverage of relevant information.
646
664
  * @param {object} [options]
647
665
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
648
666
  * @returns {Stream}
@@ -746,9 +764,12 @@ export declare class SearchServiceClient {
746
764
  * object. Leave it unset if ordered by relevance. `order_by` expression is
747
765
  * case-sensitive.
748
766
  *
749
- * For more information on ordering for retail search, see
750
- * [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
751
- *
767
+ * For more information on ordering the website search results, see
768
+ * [Order web search
769
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
770
+ * For more information on ordering the healthcare search results, see
771
+ * [Order healthcare search
772
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
752
773
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
753
774
  * @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
754
775
  * Information about the end user.
@@ -911,6 +932,12 @@ export declare class SearchServiceClient {
911
932
  * Session specification.
912
933
  *
913
934
  * Can be used only when `session` is set.
935
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold} request.relevanceThreshold
936
+ * The relevance threshold of the search results.
937
+ *
938
+ * Default to Google defined threshold, leveraging a balance of
939
+ * precision and recall to deliver both highly accurate results and
940
+ * comprehensive coverage of relevant information.
914
941
  * @param {object} [options]
915
942
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
916
943
  * @returns {Object}
@@ -415,9 +415,12 @@ class SearchServiceClient {
415
415
  * object. Leave it unset if ordered by relevance. `order_by` expression is
416
416
  * case-sensitive.
417
417
  *
418
- * For more information on ordering for retail search, see
419
- * [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
420
- *
418
+ * For more information on ordering the website search results, see
419
+ * [Order web search
420
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
421
+ * For more information on ordering the healthcare search results, see
422
+ * [Order healthcare search
423
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
421
424
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
422
425
  * @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
423
426
  * Information about the end user.
@@ -580,6 +583,12 @@ class SearchServiceClient {
580
583
  * Session specification.
581
584
  *
582
585
  * Can be used only when `session` is set.
586
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold} request.relevanceThreshold
587
+ * The relevance threshold of the search results.
588
+ *
589
+ * Default to Google defined threshold, leveraging a balance of
590
+ * precision and recall to deliver both highly accurate results and
591
+ * comprehensive coverage of relevant information.
583
592
  * @param {object} [options]
584
593
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
585
594
  * @returns {Stream}
@@ -697,9 +706,12 @@ class SearchServiceClient {
697
706
  * object. Leave it unset if ordered by relevance. `order_by` expression is
698
707
  * case-sensitive.
699
708
  *
700
- * For more information on ordering for retail search, see
701
- * [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
702
- *
709
+ * For more information on ordering the website search results, see
710
+ * [Order web search
711
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
712
+ * For more information on ordering the healthcare search results, see
713
+ * [Order healthcare search
714
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
703
715
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
704
716
  * @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
705
717
  * Information about the end user.
@@ -862,6 +874,12 @@ class SearchServiceClient {
862
874
  * Session specification.
863
875
  *
864
876
  * Can be used only when `session` is set.
877
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold} request.relevanceThreshold
878
+ * The relevance threshold of the search results.
879
+ *
880
+ * Default to Google defined threshold, leveraging a balance of
881
+ * precision and recall to deliver both highly accurate results and
882
+ * comprehensive coverage of relevant information.
865
883
  * @param {object} [options]
866
884
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
867
885
  * @returns {Object}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@google-cloud/discoveryengine",
3
- "version": "1.13.0",
3
+ "version": "1.14.0",
4
4
  "description": "Discovery Engine API client for Node.js",
5
5
  "repository": {
6
6
  "type": "git",