@google-cloud/discoveryengine 2.1.0 → 2.3.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 (172) hide show
  1. package/README.md +13 -0
  2. package/build/protos/google/cloud/discoveryengine/v1/answer.proto +17 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/chunk.proto +52 -0
  4. package/build/protos/google/cloud/discoveryengine/v1/cmek_config_service.proto +300 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/common.proto +67 -0
  6. package/build/protos/google/cloud/discoveryengine/v1/control.proto +1 -3
  7. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +3 -0
  8. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +54 -2
  9. package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +14 -0
  10. package/build/protos/google/cloud/discoveryengine/v1/document.proto +95 -4
  11. package/build/protos/google/cloud/discoveryengine/v1/document_processing_config.proto +28 -1
  12. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +131 -6
  13. package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +8 -0
  14. package/build/protos/google/cloud/discoveryengine/v1/grounding.proto +9 -0
  15. package/build/protos/google/cloud/discoveryengine/v1/identity_mapping_store.proto +84 -0
  16. package/build/protos/google/cloud/discoveryengine/v1/identity_mapping_store_service.proto +375 -0
  17. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +6 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +6 -0
  19. package/build/protos/google/cloud/discoveryengine/v1/user_license.proto +98 -0
  20. package/build/protos/google/cloud/discoveryengine/v1/user_license_service.proto +191 -0
  21. package/build/protos/protos.d.ts +5415 -578
  22. package/build/protos/protos.js +77830 -63391
  23. package/build/protos/protos.json +1537 -92
  24. package/build/src/index.d.ts +10 -1
  25. package/build/src/index.js +8 -22
  26. package/build/src/v1/cmek_config_service_client.d.ts +2287 -0
  27. package/build/src/v1/cmek_config_service_client.js +3274 -0
  28. package/build/src/v1/cmek_config_service_client_config.json +42 -0
  29. package/build/src/v1/cmek_config_service_proto_list.json +44 -0
  30. package/build/src/v1/completion_service_client.d.ts +166 -76
  31. package/build/src/v1/completion_service_client.js +258 -263
  32. package/build/src/v1/completion_service_proto_list.json +6 -1
  33. package/build/src/v1/control_service_client.d.ts +171 -81
  34. package/build/src/v1/control_service_client.js +246 -132
  35. package/build/src/v1/control_service_proto_list.json +6 -1
  36. package/build/src/v1/conversational_search_service_client.d.ts +233 -143
  37. package/build/src/v1/conversational_search_service_client.js +330 -226
  38. package/build/src/v1/conversational_search_service_proto_list.json +6 -1
  39. package/build/src/v1/data_store_service_client.d.ts +218 -122
  40. package/build/src/v1/data_store_service_client.js +273 -281
  41. package/build/src/v1/data_store_service_proto_list.json +6 -1
  42. package/build/src/v1/document_service_client.d.ts +210 -120
  43. package/build/src/v1/document_service_client.js +300 -301
  44. package/build/src/v1/document_service_proto_list.json +6 -1
  45. package/build/src/v1/engine_service_client.d.ts +193 -103
  46. package/build/src/v1/engine_service_client.js +273 -280
  47. package/build/src/v1/engine_service_proto_list.json +6 -1
  48. package/build/src/v1/gapic_metadata.json +184 -0
  49. package/build/src/v1/grounded_generation_service_client.d.ts +138 -48
  50. package/build/src/v1/grounded_generation_service_client.js +217 -100
  51. package/build/src/v1/grounded_generation_service_proto_list.json +6 -1
  52. package/build/src/v1/identity_mapping_store_service_client.d.ts +2470 -0
  53. package/build/src/v1/identity_mapping_store_service_client.js +3449 -0
  54. package/build/src/v1/identity_mapping_store_service_client_config.json +54 -0
  55. package/build/src/v1/identity_mapping_store_service_proto_list.json +44 -0
  56. package/build/src/v1/index.d.ts +3 -0
  57. package/build/src/v1/index.js +7 -1
  58. package/build/src/v1/project_service_client.d.ts +166 -76
  59. package/build/src/v1/project_service_client.js +235 -223
  60. package/build/src/v1/project_service_proto_list.json +6 -1
  61. package/build/src/v1/rank_service_client.d.ts +137 -47
  62. package/build/src/v1/rank_service_client.js +204 -85
  63. package/build/src/v1/rank_service_proto_list.json +6 -1
  64. package/build/src/v1/recommendation_service_client.d.ts +137 -47
  65. package/build/src/v1/recommendation_service_client.js +202 -82
  66. package/build/src/v1/recommendation_service_proto_list.json +6 -1
  67. package/build/src/v1/schema_service_client.d.ts +201 -111
  68. package/build/src/v1/schema_service_client.js +264 -274
  69. package/build/src/v1/schema_service_proto_list.json +6 -1
  70. package/build/src/v1/search_service_client.d.ts +661 -571
  71. package/build/src/v1/search_service_client.js +216 -113
  72. package/build/src/v1/search_service_proto_list.json +6 -1
  73. package/build/src/v1/search_tuning_service_client.d.ts +167 -77
  74. package/build/src/v1/search_tuning_service_client.js +246 -236
  75. package/build/src/v1/search_tuning_service_proto_list.json +6 -1
  76. package/build/src/v1/serving_config_service_client.d.ts +138 -48
  77. package/build/src/v1/serving_config_service_client.js +201 -80
  78. package/build/src/v1/serving_config_service_proto_list.json +6 -1
  79. package/build/src/v1/site_search_engine_service_client.d.ts +238 -148
  80. package/build/src/v1/site_search_engine_service_client.js +324 -379
  81. package/build/src/v1/site_search_engine_service_proto_list.json +6 -1
  82. package/build/src/v1/user_event_service_client.d.ts +167 -77
  83. package/build/src/v1/user_event_service_client.js +260 -254
  84. package/build/src/v1/user_event_service_proto_list.json +6 -1
  85. package/build/src/v1/user_license_service_client.d.ts +2256 -0
  86. package/build/src/v1/user_license_service_client.js +3194 -0
  87. package/build/src/v1/user_license_service_client_config.json +34 -0
  88. package/build/src/v1/user_license_service_proto_list.json +44 -0
  89. package/build/src/v1alpha/acl_config_service_client.d.ts +49 -49
  90. package/build/src/v1alpha/acl_config_service_client.js +94 -106
  91. package/build/src/v1alpha/chunk_service_client.d.ts +88 -88
  92. package/build/src/v1alpha/chunk_service_client.js +98 -120
  93. package/build/src/v1alpha/completion_service_client.d.ts +77 -77
  94. package/build/src/v1alpha/completion_service_client.js +141 -281
  95. package/build/src/v1alpha/control_service_client.d.ts +85 -85
  96. package/build/src/v1alpha/control_service_client.js +129 -151
  97. package/build/src/v1alpha/conversational_search_service_client.d.ts +143 -143
  98. package/build/src/v1alpha/conversational_search_service_client.js +211 -237
  99. package/build/src/v1alpha/data_store_service_client.d.ts +126 -126
  100. package/build/src/v1alpha/data_store_service_client.js +176 -317
  101. package/build/src/v1alpha/document_service_client.d.ts +126 -126
  102. package/build/src/v1alpha/document_service_client.js +193 -329
  103. package/build/src/v1alpha/engine_service_client.d.ts +106 -106
  104. package/build/src/v1alpha/engine_service_client.js +180 -326
  105. package/build/src/v1alpha/estimate_billing_service_client.d.ts +76 -76
  106. package/build/src/v1alpha/estimate_billing_service_client.js +119 -244
  107. package/build/src/v1alpha/evaluation_service_client.d.ts +161 -161
  108. package/build/src/v1alpha/evaluation_service_client.js +150 -296
  109. package/build/src/v1alpha/grounded_generation_service_client.d.ts +48 -48
  110. package/build/src/v1alpha/grounded_generation_service_client.js +85 -100
  111. package/build/src/v1alpha/project_service_client.d.ts +78 -78
  112. package/build/src/v1alpha/project_service_client.js +139 -263
  113. package/build/src/v1alpha/rank_service_client.d.ts +47 -47
  114. package/build/src/v1alpha/rank_service_client.js +87 -104
  115. package/build/src/v1alpha/recommendation_service_client.d.ts +47 -47
  116. package/build/src/v1alpha/recommendation_service_client.js +85 -100
  117. package/build/src/v1alpha/sample_query_service_client.d.ts +123 -123
  118. package/build/src/v1alpha/sample_query_service_client.js +169 -302
  119. package/build/src/v1alpha/sample_query_set_service_client.d.ts +94 -94
  120. package/build/src/v1alpha/sample_query_set_service_client.js +130 -153
  121. package/build/src/v1alpha/schema_service_client.d.ts +112 -112
  122. package/build/src/v1alpha/schema_service_client.js +147 -293
  123. package/build/src/v1alpha/search_service_client.d.ts +327 -327
  124. package/build/src/v1alpha/search_service_client.js +88 -112
  125. package/build/src/v1alpha/search_tuning_service_client.d.ts +77 -77
  126. package/build/src/v1alpha/search_tuning_service_client.js +129 -254
  127. package/build/src/v1alpha/serving_config_service_client.d.ts +75 -75
  128. package/build/src/v1alpha/serving_config_service_client.js +109 -133
  129. package/build/src/v1alpha/site_search_engine_service_client.d.ts +151 -151
  130. package/build/src/v1alpha/site_search_engine_service_client.js +203 -388
  131. package/build/src/v1alpha/user_event_service_client.d.ts +78 -78
  132. package/build/src/v1alpha/user_event_service_client.js +143 -272
  133. package/build/src/v1beta/completion_service_client.d.ts +78 -78
  134. package/build/src/v1beta/completion_service_client.js +149 -280
  135. package/build/src/v1beta/control_service_client.d.ts +84 -84
  136. package/build/src/v1beta/control_service_client.js +127 -147
  137. package/build/src/v1beta/conversational_search_service_client.d.ts +142 -142
  138. package/build/src/v1beta/conversational_search_service_client.js +209 -233
  139. package/build/src/v1beta/data_store_service_client.d.ts +124 -124
  140. package/build/src/v1beta/data_store_service_client.js +154 -289
  141. package/build/src/v1beta/document_service_client.d.ts +124 -124
  142. package/build/src/v1beta/document_service_client.js +181 -310
  143. package/build/src/v1beta/engine_service_client.d.ts +106 -106
  144. package/build/src/v1beta/engine_service_client.js +178 -316
  145. package/build/src/v1beta/evaluation_service_client.d.ts +161 -161
  146. package/build/src/v1beta/evaluation_service_client.js +148 -286
  147. package/build/src/v1beta/grounded_generation_service_client.d.ts +49 -49
  148. package/build/src/v1beta/grounded_generation_service_client.js +98 -114
  149. package/build/src/v1beta/project_service_client.d.ts +76 -76
  150. package/build/src/v1beta/project_service_client.js +116 -232
  151. package/build/src/v1beta/rank_service_client.d.ts +47 -47
  152. package/build/src/v1beta/rank_service_client.js +85 -99
  153. package/build/src/v1beta/recommendation_service_client.d.ts +47 -47
  154. package/build/src/v1beta/recommendation_service_client.js +83 -96
  155. package/build/src/v1beta/sample_query_service_client.d.ts +123 -123
  156. package/build/src/v1beta/sample_query_service_client.js +167 -292
  157. package/build/src/v1beta/sample_query_set_service_client.d.ts +94 -94
  158. package/build/src/v1beta/sample_query_set_service_client.js +128 -149
  159. package/build/src/v1beta/schema_service_client.d.ts +111 -111
  160. package/build/src/v1beta/schema_service_client.js +145 -283
  161. package/build/src/v1beta/search_service_client.d.ts +665 -665
  162. package/build/src/v1beta/search_service_client.js +97 -128
  163. package/build/src/v1beta/search_tuning_service_client.d.ts +77 -77
  164. package/build/src/v1beta/search_tuning_service_client.js +127 -244
  165. package/build/src/v1beta/serving_config_service_client.d.ts +75 -75
  166. package/build/src/v1beta/serving_config_service_client.js +107 -129
  167. package/build/src/v1beta/site_search_engine_service_client.d.ts +151 -151
  168. package/build/src/v1beta/site_search_engine_service_client.js +205 -387
  169. package/build/src/v1beta/user_event_service_client.d.ts +78 -78
  170. package/build/src/v1beta/user_event_service_client.js +141 -262
  171. package/package.json +7 -7
  172. package/CHANGELOG.md +0 -267
@@ -96,28 +96,18 @@ class RecommendationServiceClient {
96
96
  */
97
97
  constructor(opts, gaxInstance) {
98
98
  // Ensure that options include all the required fields.
99
- const staticMembers = this
100
- .constructor;
101
- if (opts?.universe_domain &&
102
- opts?.universeDomain &&
103
- opts?.universe_domain !== opts?.universeDomain) {
99
+ const staticMembers = this.constructor;
100
+ if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
104
101
  throw new Error('Please set either universe_domain or universeDomain, but not both.');
105
102
  }
106
- const universeDomainEnvVar = typeof process === 'object' && typeof process.env === 'object'
107
- ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN']
108
- : undefined;
109
- this._universeDomain =
110
- opts?.universeDomain ??
111
- opts?.universe_domain ??
112
- universeDomainEnvVar ??
113
- 'googleapis.com';
103
+ const universeDomainEnvVar = (typeof process === 'object' && typeof process.env === 'object') ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN'] : undefined;
104
+ this._universeDomain = opts?.universeDomain ?? opts?.universe_domain ?? universeDomainEnvVar ?? 'googleapis.com';
114
105
  this._servicePath = 'discoveryengine.' + this._universeDomain;
115
106
  const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
116
107
  this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
117
108
  const port = opts?.port || staticMembers.port;
118
109
  const clientConfig = opts?.clientConfig ?? {};
119
- const fallback = opts?.fallback ??
120
- (typeof window !== 'undefined' && typeof window?.fetch === 'function');
110
+ const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
121
111
  opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
122
112
  // Request numeric enum values if REST transport is used.
123
113
  opts.numericEnums = true;
@@ -147,7 +137,10 @@ class RecommendationServiceClient {
147
137
  }
148
138
  this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
149
139
  // Determine the client header string.
150
- const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
140
+ const clientHeader = [
141
+ `gax/${this._gaxModule.version}`,
142
+ `gapic/${version}`,
143
+ ];
151
144
  if (typeof process === 'object' && 'versions' in process) {
152
145
  clientHeader.push(`gl-node/${process.versions.node}`);
153
146
  }
@@ -236,11 +229,10 @@ class RecommendationServiceClient {
236
229
  }
237
230
  // Put together the "service stub" for
238
231
  // google.cloud.discoveryengine.v1beta.RecommendationService.
239
- this.recommendationServiceStub = this._gaxGrpc.createStub(this._opts.fallback
240
- ? this._protos.lookupService('google.cloud.discoveryengine.v1beta.RecommendationService')
241
- : // eslint-disable-next-line @typescript-eslint/no-explicit-any
242
- this._protos.google.cloud.discoveryengine.v1beta
243
- .RecommendationService, this._opts, this._providedCustomServicePath);
232
+ this.recommendationServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
233
+ this._protos.lookupService('google.cloud.discoveryengine.v1beta.RecommendationService') :
234
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
235
+ this._protos.google.cloud.discoveryengine.v1beta.RecommendationService, this._opts, this._providedCustomServicePath);
244
236
  // Iterate over each of the methods that the service provides
245
237
  // and create an API call method for each.
246
238
  const recommendationServiceStubMethods = ['recommend'];
@@ -266,8 +258,7 @@ class RecommendationServiceClient {
266
258
  * @returns {string} The DNS address for this service.
267
259
  */
268
260
  static get servicePath() {
269
- if (typeof process === 'object' &&
270
- typeof process.emitWarning === 'function') {
261
+ if (typeof process === 'object' && typeof process.emitWarning === 'function') {
271
262
  process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
272
263
  }
273
264
  return 'discoveryengine.googleapis.com';
@@ -278,8 +269,7 @@ class RecommendationServiceClient {
278
269
  * @returns {string} The DNS address for this service.
279
270
  */
280
271
  static get apiEndpoint() {
281
- if (typeof process === 'object' &&
282
- typeof process.emitWarning === 'function') {
272
+ if (typeof process === 'object' && typeof process.emitWarning === 'function') {
283
273
  process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
284
274
  }
285
275
  return 'discoveryengine.googleapis.com';
@@ -307,7 +297,9 @@ class RecommendationServiceClient {
307
297
  * @returns {string[]} List of default scopes.
308
298
  */
309
299
  static get scopes() {
310
- return ['https://www.googleapis.com/auth/cloud-platform'];
300
+ return [
301
+ 'https://www.googleapis.com/auth/cloud-platform'
302
+ ];
311
303
  }
312
304
  /**
313
305
  * Return the project ID used by this class.
@@ -333,13 +325,10 @@ class RecommendationServiceClient {
333
325
  options = options || {};
334
326
  options.otherArgs = options.otherArgs || {};
335
327
  options.otherArgs.headers = options.otherArgs.headers || {};
336
- options.otherArgs.headers['x-goog-request-params'] =
337
- this._gaxModule.routingHeader.fromParams({
338
- serving_config: request.servingConfig ?? '',
339
- });
340
- this.initialize().catch(err => {
341
- throw err;
328
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
329
+ 'serving_config': request.servingConfig ?? '',
342
330
  });
331
+ this.initialize().catch(err => { throw err; });
343
332
  this._log.info('recommend request %j', request);
344
333
  const wrappedCallback = callback
345
334
  ? (error, response, options, rawResponse) => {
@@ -347,65 +336,70 @@ class RecommendationServiceClient {
347
336
  callback(error, response, options, rawResponse); // We verified callback above.
348
337
  }
349
338
  : undefined;
350
- return this.innerApiCalls
351
- .recommend(request, options, wrappedCallback)
339
+ return this.innerApiCalls.recommend(request, options, wrappedCallback)
352
340
  ?.then(([response, options, rawResponse]) => {
353
341
  this._log.info('recommend response %j', response);
354
342
  return [response, options, rawResponse];
343
+ }).catch((error) => {
344
+ if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
345
+ const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
346
+ error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
347
+ }
348
+ throw error;
355
349
  });
356
350
  }
357
351
  /**
358
- * Gets information about a location.
359
- *
360
- * @param {Object} request
361
- * The request object that will be sent.
362
- * @param {string} request.name
363
- * Resource name for the location.
364
- * @param {object} [options]
365
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
366
- * @returns {Promise} - The promise which resolves to an array.
367
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
368
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
369
- * for more details and examples.
370
- * @example
371
- * ```
372
- * const [response] = await client.getLocation(request);
373
- * ```
374
- */
352
+ * Gets information about a location.
353
+ *
354
+ * @param {Object} request
355
+ * The request object that will be sent.
356
+ * @param {string} request.name
357
+ * Resource name for the location.
358
+ * @param {object} [options]
359
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
360
+ * @returns {Promise} - The promise which resolves to an array.
361
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
362
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
363
+ * for more details and examples.
364
+ * @example
365
+ * ```
366
+ * const [response] = await client.getLocation(request);
367
+ * ```
368
+ */
375
369
  getLocation(request, options, callback) {
376
370
  return this.locationsClient.getLocation(request, options, callback);
377
371
  }
378
372
  /**
379
- * Lists information about the supported locations for this service. Returns an iterable object.
380
- *
381
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
382
- * @param {Object} request
383
- * The request object that will be sent.
384
- * @param {string} request.name
385
- * The resource that owns the locations collection, if applicable.
386
- * @param {string} request.filter
387
- * The standard list filter.
388
- * @param {number} request.pageSize
389
- * The standard list page size.
390
- * @param {string} request.pageToken
391
- * The standard list page token.
392
- * @param {object} [options]
393
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
394
- * @returns {Object}
395
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
396
- * When you iterate the returned iterable, each element will be an object representing
397
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
398
- * so you can stop the iteration when you don't need more results.
399
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
400
- * for more details and examples.
401
- * @example
402
- * ```
403
- * const iterable = client.listLocationsAsync(request);
404
- * for await (const response of iterable) {
405
- * // process response
406
- * }
407
- * ```
408
- */
373
+ * Lists information about the supported locations for this service. Returns an iterable object.
374
+ *
375
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
376
+ * @param {Object} request
377
+ * The request object that will be sent.
378
+ * @param {string} request.name
379
+ * The resource that owns the locations collection, if applicable.
380
+ * @param {string} request.filter
381
+ * The standard list filter.
382
+ * @param {number} request.pageSize
383
+ * The standard list page size.
384
+ * @param {string} request.pageToken
385
+ * The standard list page token.
386
+ * @param {object} [options]
387
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
388
+ * @returns {Object}
389
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
390
+ * When you iterate the returned iterable, each element will be an object representing
391
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
392
+ * so you can stop the iteration when you don't need more results.
393
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
394
+ * for more details and examples.
395
+ * @example
396
+ * ```
397
+ * const iterable = client.listLocationsAsync(request);
398
+ * for await (const response of iterable) {
399
+ * // process response
400
+ * }
401
+ * ```
402
+ */
409
403
  listLocationsAsync(request, options) {
410
404
  return this.locationsClient.listLocationsAsync(request, options);
411
405
  }
@@ -492,8 +486,7 @@ class RecommendationServiceClient {
492
486
  * @returns {string} A string representing the project.
493
487
  */
494
488
  matchProjectFromEvaluationName(evaluationName) {
495
- return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
496
- .project;
489
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName).project;
497
490
  }
498
491
  /**
499
492
  * Parse the location from Evaluation resource.
@@ -503,8 +496,7 @@ class RecommendationServiceClient {
503
496
  * @returns {string} A string representing the location.
504
497
  */
505
498
  matchLocationFromEvaluationName(evaluationName) {
506
- return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
507
- .location;
499
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName).location;
508
500
  }
509
501
  /**
510
502
  * Parse the evaluation from Evaluation resource.
@@ -514,8 +506,7 @@ class RecommendationServiceClient {
514
506
  * @returns {string} A string representing the evaluation.
515
507
  */
516
508
  matchEvaluationFromEvaluationName(evaluationName) {
517
- return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
518
- .evaluation;
509
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName).evaluation;
519
510
  }
520
511
  /**
521
512
  * Return a fully-qualified groundingConfig resource name string.
@@ -2753,8 +2744,7 @@ class RecommendationServiceClient {
2753
2744
  * @returns {string} A string representing the project.
2754
2745
  */
2755
2746
  matchProjectFromSampleQueryName(sampleQueryName) {
2756
- return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2757
- .project;
2747
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).project;
2758
2748
  }
2759
2749
  /**
2760
2750
  * Parse the location from SampleQuery resource.
@@ -2764,8 +2754,7 @@ class RecommendationServiceClient {
2764
2754
  * @returns {string} A string representing the location.
2765
2755
  */
2766
2756
  matchLocationFromSampleQueryName(sampleQueryName) {
2767
- return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2768
- .location;
2757
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).location;
2769
2758
  }
2770
2759
  /**
2771
2760
  * Parse the sample_query_set from SampleQuery resource.
@@ -2775,8 +2764,7 @@ class RecommendationServiceClient {
2775
2764
  * @returns {string} A string representing the sample_query_set.
2776
2765
  */
2777
2766
  matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
2778
- return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2779
- .sample_query_set;
2767
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).sample_query_set;
2780
2768
  }
2781
2769
  /**
2782
2770
  * Parse the sample_query from SampleQuery resource.
@@ -2786,8 +2774,7 @@ class RecommendationServiceClient {
2786
2774
  * @returns {string} A string representing the sample_query.
2787
2775
  */
2788
2776
  matchSampleQueryFromSampleQueryName(sampleQueryName) {
2789
- return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2790
- .sample_query;
2777
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).sample_query;
2791
2778
  }
2792
2779
  /**
2793
2780
  * Return a fully-qualified sampleQuerySet resource name string.
@@ -2846,7 +2833,7 @@ class RecommendationServiceClient {
2846
2833
  this._log.info('ending gRPC channel');
2847
2834
  this._terminated = true;
2848
2835
  stub.close();
2849
- this.locationsClient.close();
2836
+ this.locationsClient.close().catch(err => { throw err; });
2850
2837
  });
2851
2838
  }
2852
2839
  return Promise.resolve();
@@ -146,7 +146,7 @@ export declare class SampleQueryServiceClient {
146
146
  */
147
147
  getSampleQuery(request?: protos.google.cloud.discoveryengine.v1beta.IGetSampleQueryRequest, options?: CallOptions): Promise<[
148
148
  protos.google.cloud.discoveryengine.v1beta.ISampleQuery,
149
- (protos.google.cloud.discoveryengine.v1beta.IGetSampleQueryRequest | undefined),
149
+ protos.google.cloud.discoveryengine.v1beta.IGetSampleQueryRequest | undefined,
150
150
  {} | undefined
151
151
  ]>;
152
152
  getSampleQuery(request: protos.google.cloud.discoveryengine.v1beta.IGetSampleQueryRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ISampleQuery, protos.google.cloud.discoveryengine.v1beta.IGetSampleQueryRequest | null | undefined, {} | null | undefined>): void;
@@ -192,7 +192,7 @@ export declare class SampleQueryServiceClient {
192
192
  */
193
193
  createSampleQuery(request?: protos.google.cloud.discoveryengine.v1beta.ICreateSampleQueryRequest, options?: CallOptions): Promise<[
194
194
  protos.google.cloud.discoveryengine.v1beta.ISampleQuery,
195
- (protos.google.cloud.discoveryengine.v1beta.ICreateSampleQueryRequest | undefined),
195
+ protos.google.cloud.discoveryengine.v1beta.ICreateSampleQueryRequest | undefined,
196
196
  {} | undefined
197
197
  ]>;
198
198
  createSampleQuery(request: protos.google.cloud.discoveryengine.v1beta.ICreateSampleQueryRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ISampleQuery, protos.google.cloud.discoveryengine.v1beta.ICreateSampleQueryRequest | null | undefined, {} | null | undefined>): void;
@@ -225,7 +225,7 @@ export declare class SampleQueryServiceClient {
225
225
  */
226
226
  updateSampleQuery(request?: protos.google.cloud.discoveryengine.v1beta.IUpdateSampleQueryRequest, options?: CallOptions): Promise<[
227
227
  protos.google.cloud.discoveryengine.v1beta.ISampleQuery,
228
- (protos.google.cloud.discoveryengine.v1beta.IUpdateSampleQueryRequest | undefined),
228
+ protos.google.cloud.discoveryengine.v1beta.IUpdateSampleQueryRequest | undefined,
229
229
  {} | undefined
230
230
  ]>;
231
231
  updateSampleQuery(request: protos.google.cloud.discoveryengine.v1beta.IUpdateSampleQueryRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ISampleQuery, protos.google.cloud.discoveryengine.v1beta.IUpdateSampleQueryRequest | null | undefined, {} | null | undefined>): void;
@@ -257,7 +257,7 @@ export declare class SampleQueryServiceClient {
257
257
  */
258
258
  deleteSampleQuery(request?: protos.google.cloud.discoveryengine.v1beta.IDeleteSampleQueryRequest, options?: CallOptions): Promise<[
259
259
  protos.google.protobuf.IEmpty,
260
- (protos.google.cloud.discoveryengine.v1beta.IDeleteSampleQueryRequest | undefined),
260
+ protos.google.cloud.discoveryengine.v1beta.IDeleteSampleQueryRequest | undefined,
261
261
  {} | undefined
262
262
  ]>;
263
263
  deleteSampleQuery(request: protos.google.cloud.discoveryengine.v1beta.IDeleteSampleQueryRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1beta.IDeleteSampleQueryRequest | null | undefined, {} | null | undefined>): void;
@@ -320,49 +320,49 @@ export declare class SampleQueryServiceClient {
320
320
  */
321
321
  checkImportSampleQueriesProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.ImportSampleQueriesResponse, protos.google.cloud.discoveryengine.v1beta.ImportSampleQueriesMetadata>>;
322
322
  /**
323
- * Gets a list of
324
- * {@link protos.google.cloud.discoveryengine.v1beta.SampleQuery|SampleQuery}s.
325
- *
326
- * @param {Object} request
327
- * The request object that will be sent.
328
- * @param {string} request.parent
329
- * Required. The parent sample query set resource name, such as
330
- * `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
331
- *
332
- * If the caller does not have permission to list
333
- * {@link protos.google.cloud.discoveryengine.v1beta.SampleQuery|SampleQuery}s under this
334
- * sample query set, regardless of whether or not this sample query set
335
- * exists, a `PERMISSION_DENIED` error is returned.
336
- * @param {number} request.pageSize
337
- * Maximum number of
338
- * {@link protos.google.cloud.discoveryengine.v1beta.SampleQuery|SampleQuery}s to return.
339
- * If unspecified, defaults to 100. The maximum allowed value is 1000. Values
340
- * above 1000 will be coerced to 1000.
341
- *
342
- * If this field is negative, an `INVALID_ARGUMENT` error is returned.
343
- * @param {string} request.pageToken
344
- * A page token
345
- * {@link protos.google.cloud.discoveryengine.v1beta.ListSampleQueriesResponse.next_page_token|ListSampleQueriesResponse.next_page_token},
346
- * received from a previous
347
- * {@link protos.google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries|SampleQueryService.ListSampleQueries}
348
- * call. Provide this to retrieve the subsequent page.
349
- *
350
- * When paginating, all other parameters provided to
351
- * {@link protos.google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries|SampleQueryService.ListSampleQueries}
352
- * must match the call that provided the page token. Otherwise, an
353
- * `INVALID_ARGUMENT` error is returned.
354
- * @param {object} [options]
355
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
356
- * @returns {Promise} - The promise which resolves to an array.
357
- * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1beta.SampleQuery|SampleQuery}.
358
- * The client library will perform auto-pagination by default: it will call the API as many
359
- * times as needed and will merge results from all the pages into this array.
360
- * Note that it can affect your quota.
361
- * We recommend using `listSampleQueriesAsync()`
362
- * method described below for async iteration which you can stop as needed.
363
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
364
- * for more details and examples.
365
- */
323
+ * Gets a list of
324
+ * {@link protos.google.cloud.discoveryengine.v1beta.SampleQuery|SampleQuery}s.
325
+ *
326
+ * @param {Object} request
327
+ * The request object that will be sent.
328
+ * @param {string} request.parent
329
+ * Required. The parent sample query set resource name, such as
330
+ * `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
331
+ *
332
+ * If the caller does not have permission to list
333
+ * {@link protos.google.cloud.discoveryengine.v1beta.SampleQuery|SampleQuery}s under this
334
+ * sample query set, regardless of whether or not this sample query set
335
+ * exists, a `PERMISSION_DENIED` error is returned.
336
+ * @param {number} request.pageSize
337
+ * Maximum number of
338
+ * {@link protos.google.cloud.discoveryengine.v1beta.SampleQuery|SampleQuery}s to return.
339
+ * If unspecified, defaults to 100. The maximum allowed value is 1000. Values
340
+ * above 1000 will be coerced to 1000.
341
+ *
342
+ * If this field is negative, an `INVALID_ARGUMENT` error is returned.
343
+ * @param {string} request.pageToken
344
+ * A page token
345
+ * {@link protos.google.cloud.discoveryengine.v1beta.ListSampleQueriesResponse.next_page_token|ListSampleQueriesResponse.next_page_token},
346
+ * received from a previous
347
+ * {@link protos.google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries|SampleQueryService.ListSampleQueries}
348
+ * call. Provide this to retrieve the subsequent page.
349
+ *
350
+ * When paginating, all other parameters provided to
351
+ * {@link protos.google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries|SampleQueryService.ListSampleQueries}
352
+ * must match the call that provided the page token. Otherwise, an
353
+ * `INVALID_ARGUMENT` error is returned.
354
+ * @param {object} [options]
355
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
356
+ * @returns {Promise} - The promise which resolves to an array.
357
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1beta.SampleQuery|SampleQuery}.
358
+ * The client library will perform auto-pagination by default: it will call the API as many
359
+ * times as needed and will merge results from all the pages into this array.
360
+ * Note that it can affect your quota.
361
+ * We recommend using `listSampleQueriesAsync()`
362
+ * method described below for async iteration which you can stop as needed.
363
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
364
+ * for more details and examples.
365
+ */
366
366
  listSampleQueries(request?: protos.google.cloud.discoveryengine.v1beta.IListSampleQueriesRequest, options?: CallOptions): Promise<[
367
367
  protos.google.cloud.discoveryengine.v1beta.ISampleQuery[],
368
368
  protos.google.cloud.discoveryengine.v1beta.IListSampleQueriesRequest | null,
@@ -458,86 +458,86 @@ export declare class SampleQueryServiceClient {
458
458
  */
459
459
  listSampleQueriesAsync(request?: protos.google.cloud.discoveryengine.v1beta.IListSampleQueriesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1beta.ISampleQuery>;
460
460
  /**
461
- * Gets information about a location.
462
- *
463
- * @param {Object} request
464
- * The request object that will be sent.
465
- * @param {string} request.name
466
- * Resource name for the location.
467
- * @param {object} [options]
468
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
469
- * @returns {Promise} - The promise which resolves to an array.
470
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
471
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
472
- * for more details and examples.
473
- * @example
474
- * ```
475
- * const [response] = await client.getLocation(request);
476
- * ```
477
- */
461
+ * Gets information about a location.
462
+ *
463
+ * @param {Object} request
464
+ * The request object that will be sent.
465
+ * @param {string} request.name
466
+ * Resource name for the location.
467
+ * @param {object} [options]
468
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
469
+ * @returns {Promise} - The promise which resolves to an array.
470
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
471
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
472
+ * for more details and examples.
473
+ * @example
474
+ * ```
475
+ * const [response] = await client.getLocation(request);
476
+ * ```
477
+ */
478
478
  getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
479
479
  /**
480
- * Lists information about the supported locations for this service. Returns an iterable object.
481
- *
482
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
483
- * @param {Object} request
484
- * The request object that will be sent.
485
- * @param {string} request.name
486
- * The resource that owns the locations collection, if applicable.
487
- * @param {string} request.filter
488
- * The standard list filter.
489
- * @param {number} request.pageSize
490
- * The standard list page size.
491
- * @param {string} request.pageToken
492
- * The standard list page token.
493
- * @param {object} [options]
494
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
495
- * @returns {Object}
496
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
497
- * When you iterate the returned iterable, each element will be an object representing
498
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
499
- * so you can stop the iteration when you don't need more results.
500
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
501
- * for more details and examples.
502
- * @example
503
- * ```
504
- * const iterable = client.listLocationsAsync(request);
505
- * for await (const response of iterable) {
506
- * // process response
507
- * }
508
- * ```
509
- */
480
+ * Lists information about the supported locations for this service. Returns an iterable object.
481
+ *
482
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
483
+ * @param {Object} request
484
+ * The request object that will be sent.
485
+ * @param {string} request.name
486
+ * The resource that owns the locations collection, if applicable.
487
+ * @param {string} request.filter
488
+ * The standard list filter.
489
+ * @param {number} request.pageSize
490
+ * The standard list page size.
491
+ * @param {string} request.pageToken
492
+ * The standard list page token.
493
+ * @param {object} [options]
494
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
495
+ * @returns {Object}
496
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
497
+ * When you iterate the returned iterable, each element will be an object representing
498
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
499
+ * so you can stop the iteration when you don't need more results.
500
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
501
+ * for more details and examples.
502
+ * @example
503
+ * ```
504
+ * const iterable = client.listLocationsAsync(request);
505
+ * for await (const response of iterable) {
506
+ * // process response
507
+ * }
508
+ * ```
509
+ */
510
510
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
511
511
  /**
512
- * Gets the latest state of a long-running operation. Clients can use this
513
- * method to poll the operation result at intervals as recommended by the API
514
- * service.
515
- *
516
- * @param {Object} request - The request object that will be sent.
517
- * @param {string} request.name - The name of the operation resource.
518
- * @param {Object=} options
519
- * Optional parameters. You can override the default settings for this call,
520
- * e.g, timeout, retries, paginations, etc. See {@link
521
- * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
522
- * for the details.
523
- * @param {function(?Error, ?Object)=} callback
524
- * The function which will be called with the result of the API call.
525
- *
526
- * The second parameter to the callback is an object representing
527
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
528
- * @return {Promise} - The promise which resolves to an array.
529
- * The first element of the array is an object representing
530
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
531
- * The promise has a method named "cancel" which cancels the ongoing API call.
532
- *
533
- * @example
534
- * ```
535
- * const client = longrunning.operationsClient();
536
- * const name = '';
537
- * const [response] = await client.getOperation({name});
538
- * // doThingsWith(response)
539
- * ```
540
- */
512
+ * Gets the latest state of a long-running operation. Clients can use this
513
+ * method to poll the operation result at intervals as recommended by the API
514
+ * service.
515
+ *
516
+ * @param {Object} request - The request object that will be sent.
517
+ * @param {string} request.name - The name of the operation resource.
518
+ * @param {Object=} options
519
+ * Optional parameters. You can override the default settings for this call,
520
+ * e.g, timeout, retries, paginations, etc. See {@link
521
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
522
+ * for the details.
523
+ * @param {function(?Error, ?Object)=} callback
524
+ * The function which will be called with the result of the API call.
525
+ *
526
+ * The second parameter to the callback is an object representing
527
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
528
+ * @return {Promise} - The promise which resolves to an array.
529
+ * The first element of the array is an object representing
530
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
531
+ * The promise has a method named "cancel" which cancels the ongoing API call.
532
+ *
533
+ * @example
534
+ * ```
535
+ * const client = longrunning.operationsClient();
536
+ * const name = '';
537
+ * const [response] = await client.getOperation({name});
538
+ * // doThingsWith(response)
539
+ * ```
540
+ */
541
541
  getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
542
542
  /**
543
543
  * Lists operations that match the specified filter in the request. If the