@google-cloud/discoveryengine 2.0.1 → 2.2.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 (167) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +7 -2
  3. package/build/protos/google/cloud/discoveryengine/v1/answer.proto +54 -2
  4. package/build/protos/google/cloud/discoveryengine/v1/chunk.proto +2 -1
  5. package/build/protos/google/cloud/discoveryengine/v1/common.proto +35 -6
  6. package/build/protos/google/cloud/discoveryengine/v1/control.proto +113 -2
  7. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +168 -2
  8. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +23 -4
  9. package/build/protos/google/cloud/discoveryengine/v1/document.proto +7 -2
  10. package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +1 -1
  11. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +16 -3
  12. package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +70 -9
  13. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +20 -1
  14. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +9 -5
  15. package/build/protos/google/cloud/discoveryengine/v1/rank_service.proto +3 -1
  16. package/build/protos/google/cloud/discoveryengine/v1/recommendation_service.proto +2 -2
  17. package/build/protos/google/cloud/discoveryengine/v1/safety.proto +107 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +96 -8
  19. package/build/protos/google/cloud/discoveryengine/v1/serving_config.proto +271 -0
  20. package/build/protos/google/cloud/discoveryengine/v1/serving_config_service.proto +75 -0
  21. package/build/protos/google/cloud/discoveryengine/v1/session.proto +19 -0
  22. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +27 -3
  23. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto +184 -5
  24. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +34 -0
  25. package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +16 -4
  26. package/build/protos/protos.d.ts +4390 -300
  27. package/build/protos/protos.js +13785 -2922
  28. package/build/protos/protos.json +1355 -14
  29. package/build/src/index.d.ts +4 -1
  30. package/build/src/index.js +4 -21
  31. package/build/src/v1/completion_service_client.d.ts +313 -76
  32. package/build/src/v1/completion_service_client.js +451 -262
  33. package/build/src/v1/completion_service_proto_list.json +3 -0
  34. package/build/src/v1/control_service_client.d.ts +318 -81
  35. package/build/src/v1/control_service_client.js +422 -132
  36. package/build/src/v1/control_service_proto_list.json +3 -0
  37. package/build/src/v1/conversational_search_service_client.d.ts +341 -134
  38. package/build/src/v1/conversational_search_service_client.js +395 -223
  39. package/build/src/v1/conversational_search_service_client_config.json +5 -0
  40. package/build/src/v1/conversational_search_service_proto_list.json +3 -0
  41. package/build/src/v1/data_store_service_client.d.ts +359 -122
  42. package/build/src/v1/data_store_service_client.js +460 -280
  43. package/build/src/v1/data_store_service_proto_list.json +3 -0
  44. package/build/src/v1/document_service_client.d.ts +364 -121
  45. package/build/src/v1/document_service_client.js +469 -300
  46. package/build/src/v1/document_service_proto_list.json +3 -0
  47. package/build/src/v1/engine_service_client.d.ts +340 -103
  48. package/build/src/v1/engine_service_client.js +460 -279
  49. package/build/src/v1/engine_service_proto_list.json +3 -0
  50. package/build/src/v1/gapic_metadata.json +59 -0
  51. package/build/src/v1/grounded_generation_service_client.d.ts +286 -51
  52. package/build/src/v1/grounded_generation_service_client.js +405 -100
  53. package/build/src/v1/grounded_generation_service_proto_list.json +3 -0
  54. package/build/src/v1/index.d.ts +1 -0
  55. package/build/src/v1/index.js +3 -1
  56. package/build/src/v1/project_service_client.d.ts +313 -76
  57. package/build/src/v1/project_service_client.js +434 -222
  58. package/build/src/v1/project_service_proto_list.json +3 -0
  59. package/build/src/v1/rank_service_client.d.ts +285 -48
  60. package/build/src/v1/rank_service_client.js +398 -85
  61. package/build/src/v1/rank_service_proto_list.json +3 -0
  62. package/build/src/v1/recommendation_service_client.d.ts +142 -49
  63. package/build/src/v1/recommendation_service_client.js +198 -82
  64. package/build/src/v1/recommendation_service_proto_list.json +3 -0
  65. package/build/src/v1/schema_service_client.d.ts +348 -111
  66. package/build/src/v1/schema_service_client.js +457 -273
  67. package/build/src/v1/schema_service_proto_list.json +3 -0
  68. package/build/src/v1/search_service_client.d.ts +748 -559
  69. package/build/src/v1/search_service_client.js +302 -133
  70. package/build/src/v1/search_service_proto_list.json +3 -0
  71. package/build/src/v1/search_tuning_service_client.d.ts +314 -77
  72. package/build/src/v1/search_tuning_service_client.js +439 -235
  73. package/build/src/v1/search_tuning_service_proto_list.json +3 -0
  74. package/build/src/v1/serving_config_service_client.d.ts +1851 -0
  75. package/build/src/v1/serving_config_service_client.js +2642 -0
  76. package/build/src/v1/serving_config_service_client_config.json +30 -0
  77. package/build/src/v1/serving_config_service_proto_list.json +39 -0
  78. package/build/src/v1/site_search_engine_service_client.d.ts +504 -151
  79. package/build/src/v1/site_search_engine_service_client.js +625 -351
  80. package/build/src/v1/site_search_engine_service_client_config.json +12 -0
  81. package/build/src/v1/site_search_engine_service_proto_list.json +3 -0
  82. package/build/src/v1/user_event_service_client.d.ts +335 -86
  83. package/build/src/v1/user_event_service_client.js +447 -253
  84. package/build/src/v1/user_event_service_proto_list.json +3 -0
  85. package/build/src/v1alpha/acl_config_service_client.d.ts +49 -49
  86. package/build/src/v1alpha/acl_config_service_client.js +82 -106
  87. package/build/src/v1alpha/chunk_service_client.d.ts +88 -88
  88. package/build/src/v1alpha/chunk_service_client.js +92 -120
  89. package/build/src/v1alpha/completion_service_client.d.ts +77 -77
  90. package/build/src/v1alpha/completion_service_client.js +134 -280
  91. package/build/src/v1alpha/control_service_client.d.ts +85 -85
  92. package/build/src/v1alpha/control_service_client.js +105 -151
  93. package/build/src/v1alpha/conversational_search_service_client.d.ts +143 -143
  94. package/build/src/v1alpha/conversational_search_service_client.js +145 -237
  95. package/build/src/v1alpha/data_store_service_client.d.ts +126 -126
  96. package/build/src/v1alpha/data_store_service_client.js +151 -316
  97. package/build/src/v1alpha/document_service_client.d.ts +126 -126
  98. package/build/src/v1alpha/document_service_client.js +156 -328
  99. package/build/src/v1alpha/engine_service_client.d.ts +106 -106
  100. package/build/src/v1alpha/engine_service_client.js +155 -325
  101. package/build/src/v1alpha/estimate_billing_service_client.d.ts +76 -76
  102. package/build/src/v1alpha/estimate_billing_service_client.js +118 -243
  103. package/build/src/v1alpha/evaluation_service_client.d.ts +161 -161
  104. package/build/src/v1alpha/evaluation_service_client.js +143 -295
  105. package/build/src/v1alpha/grounded_generation_service_client.d.ts +48 -48
  106. package/build/src/v1alpha/grounded_generation_service_client.js +79 -100
  107. package/build/src/v1alpha/project_service_client.d.ts +78 -78
  108. package/build/src/v1alpha/project_service_client.js +126 -262
  109. package/build/src/v1alpha/rank_service_client.d.ts +47 -47
  110. package/build/src/v1alpha/rank_service_client.js +81 -104
  111. package/build/src/v1alpha/recommendation_service_client.d.ts +47 -47
  112. package/build/src/v1alpha/recommendation_service_client.js +79 -100
  113. package/build/src/v1alpha/sample_query_service_client.d.ts +123 -123
  114. package/build/src/v1alpha/sample_query_service_client.js +144 -301
  115. package/build/src/v1alpha/sample_query_set_service_client.d.ts +94 -94
  116. package/build/src/v1alpha/sample_query_set_service_client.js +106 -153
  117. package/build/src/v1alpha/schema_service_client.d.ts +112 -112
  118. package/build/src/v1alpha/schema_service_client.js +140 -292
  119. package/build/src/v1alpha/search_service_client.d.ts +327 -327
  120. package/build/src/v1alpha/search_service_client.js +88 -112
  121. package/build/src/v1alpha/search_tuning_service_client.d.ts +77 -77
  122. package/build/src/v1alpha/search_tuning_service_client.js +122 -253
  123. package/build/src/v1alpha/serving_config_service_client.d.ts +75 -75
  124. package/build/src/v1alpha/serving_config_service_client.js +97 -133
  125. package/build/src/v1alpha/site_search_engine_service_client.d.ts +151 -151
  126. package/build/src/v1alpha/site_search_engine_service_client.js +184 -387
  127. package/build/src/v1alpha/user_event_service_client.d.ts +78 -78
  128. package/build/src/v1alpha/user_event_service_client.js +130 -271
  129. package/build/src/v1beta/completion_service_client.d.ts +78 -78
  130. package/build/src/v1beta/completion_service_client.js +136 -279
  131. package/build/src/v1beta/control_service_client.d.ts +84 -84
  132. package/build/src/v1beta/control_service_client.js +103 -147
  133. package/build/src/v1beta/conversational_search_service_client.d.ts +142 -142
  134. package/build/src/v1beta/conversational_search_service_client.js +143 -233
  135. package/build/src/v1beta/data_store_service_client.d.ts +124 -124
  136. package/build/src/v1beta/data_store_service_client.js +141 -288
  137. package/build/src/v1beta/document_service_client.d.ts +124 -124
  138. package/build/src/v1beta/document_service_client.js +150 -309
  139. package/build/src/v1beta/engine_service_client.d.ts +106 -106
  140. package/build/src/v1beta/engine_service_client.js +153 -315
  141. package/build/src/v1beta/evaluation_service_client.d.ts +161 -161
  142. package/build/src/v1beta/evaluation_service_client.js +141 -285
  143. package/build/src/v1beta/grounded_generation_service_client.d.ts +49 -49
  144. package/build/src/v1beta/grounded_generation_service_client.js +86 -114
  145. package/build/src/v1beta/project_service_client.d.ts +76 -76
  146. package/build/src/v1beta/project_service_client.js +115 -231
  147. package/build/src/v1beta/rank_service_client.d.ts +47 -47
  148. package/build/src/v1beta/rank_service_client.js +79 -99
  149. package/build/src/v1beta/recommendation_service_client.d.ts +47 -47
  150. package/build/src/v1beta/recommendation_service_client.js +77 -96
  151. package/build/src/v1beta/sample_query_service_client.d.ts +123 -123
  152. package/build/src/v1beta/sample_query_service_client.js +142 -291
  153. package/build/src/v1beta/sample_query_set_service_client.d.ts +94 -94
  154. package/build/src/v1beta/sample_query_set_service_client.js +104 -149
  155. package/build/src/v1beta/schema_service_client.d.ts +111 -111
  156. package/build/src/v1beta/schema_service_client.js +138 -282
  157. package/build/src/v1beta/search_service_client.d.ts +665 -665
  158. package/build/src/v1beta/search_service_client.js +97 -128
  159. package/build/src/v1beta/search_tuning_service_client.d.ts +77 -77
  160. package/build/src/v1beta/search_tuning_service_client.js +120 -243
  161. package/build/src/v1beta/serving_config_service_client.d.ts +75 -75
  162. package/build/src/v1beta/serving_config_service_client.js +95 -129
  163. package/build/src/v1beta/site_search_engine_service_client.d.ts +151 -151
  164. package/build/src/v1beta/site_search_engine_service_client.js +186 -386
  165. package/build/src/v1beta/user_event_service_client.d.ts +78 -78
  166. package/build/src/v1beta/user_event_service_client.js +128 -261
  167. package/package.json +4 -4
@@ -24,10 +24,13 @@
24
24
  "../../protos/google/cloud/discoveryengine/v1/purge_config.proto",
25
25
  "../../protos/google/cloud/discoveryengine/v1/rank_service.proto",
26
26
  "../../protos/google/cloud/discoveryengine/v1/recommendation_service.proto",
27
+ "../../protos/google/cloud/discoveryengine/v1/safety.proto",
27
28
  "../../protos/google/cloud/discoveryengine/v1/schema.proto",
28
29
  "../../protos/google/cloud/discoveryengine/v1/schema_service.proto",
29
30
  "../../protos/google/cloud/discoveryengine/v1/search_service.proto",
30
31
  "../../protos/google/cloud/discoveryengine/v1/search_tuning_service.proto",
32
+ "../../protos/google/cloud/discoveryengine/v1/serving_config.proto",
33
+ "../../protos/google/cloud/discoveryengine/v1/serving_config_service.proto",
31
34
  "../../protos/google/cloud/discoveryengine/v1/session.proto",
32
35
  "../../protos/google/cloud/discoveryengine/v1/site_search_engine.proto",
33
36
  "../../protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto",
@@ -275,33 +275,33 @@ export declare class EngineServiceClient {
275
275
  */
276
276
  checkDeleteEngineProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.discoveryengine.v1.DeleteEngineMetadata>>;
277
277
  /**
278
- * Lists all the {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s associated
279
- * with the project.
280
- *
281
- * @param {Object} request
282
- * The request object that will be sent.
283
- * @param {string} request.parent
284
- * Required. The parent resource name, such as
285
- * `projects/{project}/locations/{location}/collections/{collection_id}`.
286
- * @param {number} [request.pageSize]
287
- * Optional. Not supported.
288
- * @param {string} [request.pageToken]
289
- * Optional. Not supported.
290
- * @param {string} [request.filter]
291
- * Optional. Filter by solution type. For example:
292
- * solution_type=SOLUTION_TYPE_SEARCH
293
- * @param {object} [options]
294
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
295
- * @returns {Promise} - The promise which resolves to an array.
296
- * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}.
297
- * The client library will perform auto-pagination by default: it will call the API as many
298
- * times as needed and will merge results from all the pages into this array.
299
- * Note that it can affect your quota.
300
- * We recommend using `listEnginesAsync()`
301
- * method described below for async iteration which you can stop as needed.
302
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
303
- * for more details and examples.
304
- */
278
+ * Lists all the {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s associated
279
+ * with the project.
280
+ *
281
+ * @param {Object} request
282
+ * The request object that will be sent.
283
+ * @param {string} request.parent
284
+ * Required. The parent resource name, such as
285
+ * `projects/{project}/locations/{location}/collections/{collection_id}`.
286
+ * @param {number} [request.pageSize]
287
+ * Optional. Not supported.
288
+ * @param {string} [request.pageToken]
289
+ * Optional. Not supported.
290
+ * @param {string} [request.filter]
291
+ * Optional. Filter by solution type. For example:
292
+ * solution_type=SOLUTION_TYPE_SEARCH
293
+ * @param {object} [options]
294
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
295
+ * @returns {Promise} - The promise which resolves to an array.
296
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}.
297
+ * The client library will perform auto-pagination by default: it will call the API as many
298
+ * times as needed and will merge results from all the pages into this array.
299
+ * Note that it can affect your quota.
300
+ * We recommend using `listEnginesAsync()`
301
+ * method described below for async iteration which you can stop as needed.
302
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
303
+ * for more details and examples.
304
+ */
305
305
  listEngines(request?: protos.google.cloud.discoveryengine.v1.IListEnginesRequest, options?: CallOptions): Promise<[
306
306
  protos.google.cloud.discoveryengine.v1.IEngine[],
307
307
  protos.google.cloud.discoveryengine.v1.IListEnginesRequest | null,
@@ -365,86 +365,86 @@ export declare class EngineServiceClient {
365
365
  */
366
366
  listEnginesAsync(request?: protos.google.cloud.discoveryengine.v1.IListEnginesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.IEngine>;
367
367
  /**
368
- * Gets information about a location.
369
- *
370
- * @param {Object} request
371
- * The request object that will be sent.
372
- * @param {string} request.name
373
- * Resource name for the location.
374
- * @param {object} [options]
375
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
376
- * @returns {Promise} - The promise which resolves to an array.
377
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
378
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
379
- * for more details and examples.
380
- * @example
381
- * ```
382
- * const [response] = await client.getLocation(request);
383
- * ```
384
- */
368
+ * Gets information about a location.
369
+ *
370
+ * @param {Object} request
371
+ * The request object that will be sent.
372
+ * @param {string} request.name
373
+ * Resource name for the location.
374
+ * @param {object} [options]
375
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
376
+ * @returns {Promise} - The promise which resolves to an array.
377
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
378
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
379
+ * for more details and examples.
380
+ * @example
381
+ * ```
382
+ * const [response] = await client.getLocation(request);
383
+ * ```
384
+ */
385
385
  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>;
386
386
  /**
387
- * Lists information about the supported locations for this service. Returns an iterable object.
388
- *
389
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
390
- * @param {Object} request
391
- * The request object that will be sent.
392
- * @param {string} request.name
393
- * The resource that owns the locations collection, if applicable.
394
- * @param {string} request.filter
395
- * The standard list filter.
396
- * @param {number} request.pageSize
397
- * The standard list page size.
398
- * @param {string} request.pageToken
399
- * The standard list page token.
400
- * @param {object} [options]
401
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
402
- * @returns {Object}
403
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
404
- * When you iterate the returned iterable, each element will be an object representing
405
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
406
- * so you can stop the iteration when you don't need more results.
407
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
408
- * for more details and examples.
409
- * @example
410
- * ```
411
- * const iterable = client.listLocationsAsync(request);
412
- * for await (const response of iterable) {
413
- * // process response
414
- * }
415
- * ```
416
- */
387
+ * Lists information about the supported locations for this service. Returns an iterable object.
388
+ *
389
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
390
+ * @param {Object} request
391
+ * The request object that will be sent.
392
+ * @param {string} request.name
393
+ * The resource that owns the locations collection, if applicable.
394
+ * @param {string} request.filter
395
+ * The standard list filter.
396
+ * @param {number} request.pageSize
397
+ * The standard list page size.
398
+ * @param {string} request.pageToken
399
+ * The standard list page token.
400
+ * @param {object} [options]
401
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
402
+ * @returns {Object}
403
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
404
+ * When you iterate the returned iterable, each element will be an object representing
405
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
406
+ * so you can stop the iteration when you don't need more results.
407
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
408
+ * for more details and examples.
409
+ * @example
410
+ * ```
411
+ * const iterable = client.listLocationsAsync(request);
412
+ * for await (const response of iterable) {
413
+ * // process response
414
+ * }
415
+ * ```
416
+ */
417
417
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
418
418
  /**
419
- * Gets the latest state of a long-running operation. Clients can use this
420
- * method to poll the operation result at intervals as recommended by the API
421
- * service.
422
- *
423
- * @param {Object} request - The request object that will be sent.
424
- * @param {string} request.name - The name of the operation resource.
425
- * @param {Object=} options
426
- * Optional parameters. You can override the default settings for this call,
427
- * e.g, timeout, retries, paginations, etc. See {@link
428
- * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
429
- * for the details.
430
- * @param {function(?Error, ?Object)=} callback
431
- * The function which will be called with the result of the API call.
432
- *
433
- * The second parameter to the callback is an object representing
434
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
435
- * @return {Promise} - The promise which resolves to an array.
436
- * The first element of the array is an object representing
437
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
438
- * The promise has a method named "cancel" which cancels the ongoing API call.
439
- *
440
- * @example
441
- * ```
442
- * const client = longrunning.operationsClient();
443
- * const name = '';
444
- * const [response] = await client.getOperation({name});
445
- * // doThingsWith(response)
446
- * ```
447
- */
419
+ * Gets the latest state of a long-running operation. Clients can use this
420
+ * method to poll the operation result at intervals as recommended by the API
421
+ * service.
422
+ *
423
+ * @param {Object} request - The request object that will be sent.
424
+ * @param {string} request.name - The name of the operation resource.
425
+ * @param {Object=} options
426
+ * Optional parameters. You can override the default settings for this call,
427
+ * e.g, timeout, retries, paginations, etc. See {@link
428
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
429
+ * for the details.
430
+ * @param {function(?Error, ?Object)=} callback
431
+ * The function which will be called with the result of the API call.
432
+ *
433
+ * The second parameter to the callback is an object representing
434
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
435
+ * @return {Promise} - The promise which resolves to an array.
436
+ * The first element of the array is an object representing
437
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
438
+ * The promise has a method named "cancel" which cancels the ongoing API call.
439
+ *
440
+ * @example
441
+ * ```
442
+ * const client = longrunning.operationsClient();
443
+ * const name = '';
444
+ * const [response] = await client.getOperation({name});
445
+ * // doThingsWith(response)
446
+ * ```
447
+ */
448
448
  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]>;
449
449
  /**
450
450
  * Lists operations that match the specified filter in the request. If the
@@ -1042,6 +1042,57 @@ export declare class EngineServiceClient {
1042
1042
  * @returns {string} A string representing the schema.
1043
1043
  */
1044
1044
  matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
1045
+ /**
1046
+ * Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.
1047
+ *
1048
+ * @param {string} project
1049
+ * @param {string} location
1050
+ * @param {string} collection
1051
+ * @param {string} data_store
1052
+ * @param {string} serving_config
1053
+ * @returns {string} Resource name string.
1054
+ */
1055
+ projectLocationCollectionDataStoreServingConfigPath(project: string, location: string, collection: string, dataStore: string, servingConfig: string): string;
1056
+ /**
1057
+ * Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.
1058
+ *
1059
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1060
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1061
+ * @returns {string} A string representing the project.
1062
+ */
1063
+ matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1064
+ /**
1065
+ * Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.
1066
+ *
1067
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1068
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1069
+ * @returns {string} A string representing the location.
1070
+ */
1071
+ matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1072
+ /**
1073
+ * Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.
1074
+ *
1075
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1076
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1077
+ * @returns {string} A string representing the collection.
1078
+ */
1079
+ matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1080
+ /**
1081
+ * Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.
1082
+ *
1083
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1084
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1085
+ * @returns {string} A string representing the data_store.
1086
+ */
1087
+ matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1088
+ /**
1089
+ * Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.
1090
+ *
1091
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1092
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1093
+ * @returns {string} A string representing the serving_config.
1094
+ */
1095
+ matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1045
1096
  /**
1046
1097
  * Return a fully-qualified projectLocationCollectionDataStoreSession resource name string.
1047
1098
  *
@@ -1195,6 +1246,57 @@ export declare class EngineServiceClient {
1195
1246
  * @returns {string} A string representing the data_store.
1196
1247
  */
1197
1248
  matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
1249
+ /**
1250
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineSitemap resource name string.
1251
+ *
1252
+ * @param {string} project
1253
+ * @param {string} location
1254
+ * @param {string} collection
1255
+ * @param {string} data_store
1256
+ * @param {string} sitemap
1257
+ * @returns {string} Resource name string.
1258
+ */
1259
+ projectLocationCollectionDataStoreSiteSearchEngineSitemapPath(project: string, location: string, collection: string, dataStore: string, sitemap: string): string;
1260
+ /**
1261
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1262
+ *
1263
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1264
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1265
+ * @returns {string} A string representing the project.
1266
+ */
1267
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1268
+ /**
1269
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1270
+ *
1271
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1272
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1273
+ * @returns {string} A string representing the location.
1274
+ */
1275
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1276
+ /**
1277
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1278
+ *
1279
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1280
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1281
+ * @returns {string} A string representing the collection.
1282
+ */
1283
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1284
+ /**
1285
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1286
+ *
1287
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1288
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1289
+ * @returns {string} A string representing the data_store.
1290
+ */
1291
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1292
+ /**
1293
+ * Parse the sitemap from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1294
+ *
1295
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1296
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1297
+ * @returns {string} A string representing the sitemap.
1298
+ */
1299
+ matchSitemapFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1198
1300
  /**
1199
1301
  * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
1200
1302
  *
@@ -1348,6 +1450,57 @@ export declare class EngineServiceClient {
1348
1450
  * @returns {string} A string representing the conversation.
1349
1451
  */
1350
1452
  matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1453
+ /**
1454
+ * Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
1455
+ *
1456
+ * @param {string} project
1457
+ * @param {string} location
1458
+ * @param {string} collection
1459
+ * @param {string} engine
1460
+ * @param {string} serving_config
1461
+ * @returns {string} Resource name string.
1462
+ */
1463
+ projectLocationCollectionEngineServingConfigPath(project: string, location: string, collection: string, engine: string, servingConfig: string): string;
1464
+ /**
1465
+ * Parse the project from ProjectLocationCollectionEngineServingConfig resource.
1466
+ *
1467
+ * @param {string} projectLocationCollectionEngineServingConfigName
1468
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1469
+ * @returns {string} A string representing the project.
1470
+ */
1471
+ matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1472
+ /**
1473
+ * Parse the location from ProjectLocationCollectionEngineServingConfig resource.
1474
+ *
1475
+ * @param {string} projectLocationCollectionEngineServingConfigName
1476
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1477
+ * @returns {string} A string representing the location.
1478
+ */
1479
+ matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1480
+ /**
1481
+ * Parse the collection from ProjectLocationCollectionEngineServingConfig resource.
1482
+ *
1483
+ * @param {string} projectLocationCollectionEngineServingConfigName
1484
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1485
+ * @returns {string} A string representing the collection.
1486
+ */
1487
+ matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1488
+ /**
1489
+ * Parse the engine from ProjectLocationCollectionEngineServingConfig resource.
1490
+ *
1491
+ * @param {string} projectLocationCollectionEngineServingConfigName
1492
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1493
+ * @returns {string} A string representing the engine.
1494
+ */
1495
+ matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1496
+ /**
1497
+ * Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.
1498
+ *
1499
+ * @param {string} projectLocationCollectionEngineServingConfigName
1500
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1501
+ * @returns {string} A string representing the serving_config.
1502
+ */
1503
+ matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1351
1504
  /**
1352
1505
  * Return a fully-qualified projectLocationCollectionEngineSession resource name string.
1353
1506
  *
@@ -1804,6 +1957,48 @@ export declare class EngineServiceClient {
1804
1957
  * @returns {string} A string representing the schema.
1805
1958
  */
1806
1959
  matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1960
+ /**
1961
+ * Return a fully-qualified projectLocationDataStoreServingConfig resource name string.
1962
+ *
1963
+ * @param {string} project
1964
+ * @param {string} location
1965
+ * @param {string} data_store
1966
+ * @param {string} serving_config
1967
+ * @returns {string} Resource name string.
1968
+ */
1969
+ projectLocationDataStoreServingConfigPath(project: string, location: string, dataStore: string, servingConfig: string): string;
1970
+ /**
1971
+ * Parse the project from ProjectLocationDataStoreServingConfig resource.
1972
+ *
1973
+ * @param {string} projectLocationDataStoreServingConfigName
1974
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1975
+ * @returns {string} A string representing the project.
1976
+ */
1977
+ matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1978
+ /**
1979
+ * Parse the location from ProjectLocationDataStoreServingConfig resource.
1980
+ *
1981
+ * @param {string} projectLocationDataStoreServingConfigName
1982
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1983
+ * @returns {string} A string representing the location.
1984
+ */
1985
+ matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1986
+ /**
1987
+ * Parse the data_store from ProjectLocationDataStoreServingConfig resource.
1988
+ *
1989
+ * @param {string} projectLocationDataStoreServingConfigName
1990
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1991
+ * @returns {string} A string representing the data_store.
1992
+ */
1993
+ matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1994
+ /**
1995
+ * Parse the serving_config from ProjectLocationDataStoreServingConfig resource.
1996
+ *
1997
+ * @param {string} projectLocationDataStoreServingConfigName
1998
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1999
+ * @returns {string} A string representing the serving_config.
2000
+ */
2001
+ matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1807
2002
  /**
1808
2003
  * Return a fully-qualified projectLocationDataStoreSession resource name string.
1809
2004
  *
@@ -1930,6 +2125,48 @@ export declare class EngineServiceClient {
1930
2125
  * @returns {string} A string representing the data_store.
1931
2126
  */
1932
2127
  matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
2128
+ /**
2129
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineSitemap resource name string.
2130
+ *
2131
+ * @param {string} project
2132
+ * @param {string} location
2133
+ * @param {string} data_store
2134
+ * @param {string} sitemap
2135
+ * @returns {string} Resource name string.
2136
+ */
2137
+ projectLocationDataStoreSiteSearchEngineSitemapPath(project: string, location: string, dataStore: string, sitemap: string): string;
2138
+ /**
2139
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2140
+ *
2141
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2142
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2143
+ * @returns {string} A string representing the project.
2144
+ */
2145
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
2146
+ /**
2147
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2148
+ *
2149
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2150
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2151
+ * @returns {string} A string representing the location.
2152
+ */
2153
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
2154
+ /**
2155
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2156
+ *
2157
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2158
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2159
+ * @returns {string} A string representing the data_store.
2160
+ */
2161
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
2162
+ /**
2163
+ * Parse the sitemap from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2164
+ *
2165
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2166
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2167
+ * @returns {string} A string representing the sitemap.
2168
+ */
2169
+ matchSitemapFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
1933
2170
  /**
1934
2171
  * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
1935
2172
  *