@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",
@@ -177,7 +177,7 @@ export declare class DocumentServiceClient {
177
177
  * Otherwise, an `ALREADY_EXISTS` error is returned.
178
178
  *
179
179
  * This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
180
- * standard with a length limit of 63 characters. Otherwise, an
180
+ * standard with a length limit of 128 characters. Otherwise, an
181
181
  * `INVALID_ARGUMENT` error is returned.
182
182
  * @param {object} [options]
183
183
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
@@ -290,7 +290,7 @@ export declare class DocumentServiceClient {
290
290
  */
291
291
  batchGetDocumentsMetadata(request?: protos.google.cloud.discoveryengine.v1.IBatchGetDocumentsMetadataRequest, options?: CallOptions): Promise<[
292
292
  protos.google.cloud.discoveryengine.v1.IBatchGetDocumentsMetadataResponse,
293
- (protos.google.cloud.discoveryengine.v1.IBatchGetDocumentsMetadataRequest | undefined),
293
+ protos.google.cloud.discoveryengine.v1.IBatchGetDocumentsMetadataRequest | undefined,
294
294
  {} | undefined
295
295
  ]>;
296
296
  batchGetDocumentsMetadata(request: protos.google.cloud.discoveryengine.v1.IBatchGetDocumentsMetadataRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IBatchGetDocumentsMetadataResponse, protos.google.cloud.discoveryengine.v1.IBatchGetDocumentsMetadataRequest | null | undefined, {} | null | undefined>): void;
@@ -398,6 +398,12 @@ export declare class DocumentServiceClient {
398
398
  * * {@link protos.google.cloud.discoveryengine.v1.CloudSqlSource|CloudSqlSource}.
399
399
  * * {@link protos.google.cloud.discoveryengine.v1.FirestoreSource|FirestoreSource}.
400
400
  * * {@link protos.google.cloud.discoveryengine.v1.BigtableSource|BigtableSource}.
401
+ * @param {boolean} [request.forceRefreshContent]
402
+ * Optional. Whether to force refresh the unstructured content of the
403
+ * documents.
404
+ *
405
+ * If set to `true`, the content part of the documents will be refreshed
406
+ * regardless of the update status of the referencing content.
401
407
  * @param {object} [options]
402
408
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
403
409
  * @returns {Promise} - The promise which resolves to an array.
@@ -498,49 +504,49 @@ export declare class DocumentServiceClient {
498
504
  */
499
505
  checkPurgeDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.PurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1.PurgeDocumentsMetadata>>;
500
506
  /**
501
- * Gets a list of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s.
502
- *
503
- * @param {Object} request
504
- * The request object that will be sent.
505
- * @param {string} request.parent
506
- * Required. The parent branch resource name, such as
507
- * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
508
- * Use `default_branch` as the branch ID, to list documents under the default
509
- * branch.
510
- *
511
- * If the caller does not have permission to list
512
- * {@link protos.google.cloud.discoveryengine.v1.Document|Document}s under this branch,
513
- * regardless of whether or not this branch exists, a `PERMISSION_DENIED`
514
- * error is returned.
515
- * @param {number} request.pageSize
516
- * Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
517
- * return. If unspecified, defaults to 100. The maximum allowed value is 1000.
518
- * Values above 1000 are set to 1000.
519
- *
520
- * If this field is negative, an `INVALID_ARGUMENT` error is returned.
521
- * @param {string} request.pageToken
522
- * A page token
523
- * {@link protos.google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
524
- * received from a previous
525
- * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
526
- * call. Provide this to retrieve the subsequent page.
527
- *
528
- * When paginating, all other parameters provided to
529
- * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
530
- * must match the call that provided the page token. Otherwise, an
531
- * `INVALID_ARGUMENT` error is returned.
532
- * @param {object} [options]
533
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
534
- * @returns {Promise} - The promise which resolves to an array.
535
- * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
536
- * The client library will perform auto-pagination by default: it will call the API as many
537
- * times as needed and will merge results from all the pages into this array.
538
- * Note that it can affect your quota.
539
- * We recommend using `listDocumentsAsync()`
540
- * method described below for async iteration which you can stop as needed.
541
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
542
- * for more details and examples.
543
- */
507
+ * Gets a list of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s.
508
+ *
509
+ * @param {Object} request
510
+ * The request object that will be sent.
511
+ * @param {string} request.parent
512
+ * Required. The parent branch resource name, such as
513
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
514
+ * Use `default_branch` as the branch ID, to list documents under the default
515
+ * branch.
516
+ *
517
+ * If the caller does not have permission to list
518
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document}s under this branch,
519
+ * regardless of whether or not this branch exists, a `PERMISSION_DENIED`
520
+ * error is returned.
521
+ * @param {number} request.pageSize
522
+ * Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
523
+ * return. If unspecified, defaults to 100. The maximum allowed value is 1000.
524
+ * Values above 1000 are set to 1000.
525
+ *
526
+ * If this field is negative, an `INVALID_ARGUMENT` error is returned.
527
+ * @param {string} request.pageToken
528
+ * A page token
529
+ * {@link protos.google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
530
+ * received from a previous
531
+ * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
532
+ * call. Provide this to retrieve the subsequent page.
533
+ *
534
+ * When paginating, all other parameters provided to
535
+ * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
536
+ * must match the call that provided the page token. Otherwise, an
537
+ * `INVALID_ARGUMENT` error is returned.
538
+ * @param {object} [options]
539
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
540
+ * @returns {Promise} - The promise which resolves to an array.
541
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
542
+ * The client library will perform auto-pagination by default: it will call the API as many
543
+ * times as needed and will merge results from all the pages into this array.
544
+ * Note that it can affect your quota.
545
+ * We recommend using `listDocumentsAsync()`
546
+ * method described below for async iteration which you can stop as needed.
547
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
548
+ * for more details and examples.
549
+ */
544
550
  listDocuments(request?: protos.google.cloud.discoveryengine.v1.IListDocumentsRequest, options?: CallOptions): Promise<[
545
551
  protos.google.cloud.discoveryengine.v1.IDocument[],
546
552
  protos.google.cloud.discoveryengine.v1.IListDocumentsRequest | null,
@@ -638,86 +644,86 @@ export declare class DocumentServiceClient {
638
644
  */
639
645
  listDocumentsAsync(request?: protos.google.cloud.discoveryengine.v1.IListDocumentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.IDocument>;
640
646
  /**
641
- * Gets information about a location.
642
- *
643
- * @param {Object} request
644
- * The request object that will be sent.
645
- * @param {string} request.name
646
- * Resource name for the location.
647
- * @param {object} [options]
648
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
649
- * @returns {Promise} - The promise which resolves to an array.
650
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
651
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
652
- * for more details and examples.
653
- * @example
654
- * ```
655
- * const [response] = await client.getLocation(request);
656
- * ```
657
- */
647
+ * Gets information about a location.
648
+ *
649
+ * @param {Object} request
650
+ * The request object that will be sent.
651
+ * @param {string} request.name
652
+ * Resource name for the location.
653
+ * @param {object} [options]
654
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
655
+ * @returns {Promise} - The promise which resolves to an array.
656
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
657
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
658
+ * for more details and examples.
659
+ * @example
660
+ * ```
661
+ * const [response] = await client.getLocation(request);
662
+ * ```
663
+ */
658
664
  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>;
659
665
  /**
660
- * Lists information about the supported locations for this service. Returns an iterable object.
661
- *
662
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
663
- * @param {Object} request
664
- * The request object that will be sent.
665
- * @param {string} request.name
666
- * The resource that owns the locations collection, if applicable.
667
- * @param {string} request.filter
668
- * The standard list filter.
669
- * @param {number} request.pageSize
670
- * The standard list page size.
671
- * @param {string} request.pageToken
672
- * The standard list page token.
673
- * @param {object} [options]
674
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
675
- * @returns {Object}
676
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
677
- * When you iterate the returned iterable, each element will be an object representing
678
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
679
- * so you can stop the iteration when you don't need more results.
680
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
681
- * for more details and examples.
682
- * @example
683
- * ```
684
- * const iterable = client.listLocationsAsync(request);
685
- * for await (const response of iterable) {
686
- * // process response
687
- * }
688
- * ```
689
- */
666
+ * Lists information about the supported locations for this service. Returns an iterable object.
667
+ *
668
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
669
+ * @param {Object} request
670
+ * The request object that will be sent.
671
+ * @param {string} request.name
672
+ * The resource that owns the locations collection, if applicable.
673
+ * @param {string} request.filter
674
+ * The standard list filter.
675
+ * @param {number} request.pageSize
676
+ * The standard list page size.
677
+ * @param {string} request.pageToken
678
+ * The standard list page token.
679
+ * @param {object} [options]
680
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
681
+ * @returns {Object}
682
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
683
+ * When you iterate the returned iterable, each element will be an object representing
684
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
685
+ * so you can stop the iteration when you don't need more results.
686
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
687
+ * for more details and examples.
688
+ * @example
689
+ * ```
690
+ * const iterable = client.listLocationsAsync(request);
691
+ * for await (const response of iterable) {
692
+ * // process response
693
+ * }
694
+ * ```
695
+ */
690
696
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
691
697
  /**
692
- * Gets the latest state of a long-running operation. Clients can use this
693
- * method to poll the operation result at intervals as recommended by the API
694
- * service.
695
- *
696
- * @param {Object} request - The request object that will be sent.
697
- * @param {string} request.name - The name of the operation resource.
698
- * @param {Object=} options
699
- * Optional parameters. You can override the default settings for this call,
700
- * e.g, timeout, retries, paginations, etc. See {@link
701
- * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
702
- * for the details.
703
- * @param {function(?Error, ?Object)=} callback
704
- * The function which will be called with the result of the API call.
705
- *
706
- * The second parameter to the callback is an object representing
707
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
708
- * @return {Promise} - The promise which resolves to an array.
709
- * The first element of the array is an object representing
710
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
711
- * The promise has a method named "cancel" which cancels the ongoing API call.
712
- *
713
- * @example
714
- * ```
715
- * const client = longrunning.operationsClient();
716
- * const name = '';
717
- * const [response] = await client.getOperation({name});
718
- * // doThingsWith(response)
719
- * ```
720
- */
698
+ * Gets the latest state of a long-running operation. Clients can use this
699
+ * method to poll the operation result at intervals as recommended by the API
700
+ * service.
701
+ *
702
+ * @param {Object} request - The request object that will be sent.
703
+ * @param {string} request.name - The name of the operation resource.
704
+ * @param {Object=} options
705
+ * Optional parameters. You can override the default settings for this call,
706
+ * e.g, timeout, retries, paginations, etc. See {@link
707
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
708
+ * for the details.
709
+ * @param {function(?Error, ?Object)=} callback
710
+ * The function which will be called with the result of the API call.
711
+ *
712
+ * The second parameter to the callback is an object representing
713
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
714
+ * @return {Promise} - The promise which resolves to an array.
715
+ * The first element of the array is an object representing
716
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
717
+ * The promise has a method named "cancel" which cancels the ongoing API call.
718
+ *
719
+ * @example
720
+ * ```
721
+ * const client = longrunning.operationsClient();
722
+ * const name = '';
723
+ * const [response] = await client.getOperation({name});
724
+ * // doThingsWith(response)
725
+ * ```
726
+ */
721
727
  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]>;
722
728
  /**
723
729
  * Lists operations that match the specified filter in the request. If the
@@ -1333,6 +1339,57 @@ export declare class DocumentServiceClient {
1333
1339
  * @returns {string} A string representing the schema.
1334
1340
  */
1335
1341
  matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
1342
+ /**
1343
+ * Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.
1344
+ *
1345
+ * @param {string} project
1346
+ * @param {string} location
1347
+ * @param {string} collection
1348
+ * @param {string} data_store
1349
+ * @param {string} serving_config
1350
+ * @returns {string} Resource name string.
1351
+ */
1352
+ projectLocationCollectionDataStoreServingConfigPath(project: string, location: string, collection: string, dataStore: string, servingConfig: string): string;
1353
+ /**
1354
+ * Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.
1355
+ *
1356
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1357
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1358
+ * @returns {string} A string representing the project.
1359
+ */
1360
+ matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1361
+ /**
1362
+ * Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.
1363
+ *
1364
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1365
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1366
+ * @returns {string} A string representing the location.
1367
+ */
1368
+ matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1369
+ /**
1370
+ * Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.
1371
+ *
1372
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1373
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1374
+ * @returns {string} A string representing the collection.
1375
+ */
1376
+ matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1377
+ /**
1378
+ * Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.
1379
+ *
1380
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1381
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1382
+ * @returns {string} A string representing the data_store.
1383
+ */
1384
+ matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1385
+ /**
1386
+ * Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.
1387
+ *
1388
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1389
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1390
+ * @returns {string} A string representing the serving_config.
1391
+ */
1392
+ matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1336
1393
  /**
1337
1394
  * Return a fully-qualified projectLocationCollectionDataStoreSession resource name string.
1338
1395
  *
@@ -1486,6 +1543,57 @@ export declare class DocumentServiceClient {
1486
1543
  * @returns {string} A string representing the data_store.
1487
1544
  */
1488
1545
  matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
1546
+ /**
1547
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineSitemap resource name string.
1548
+ *
1549
+ * @param {string} project
1550
+ * @param {string} location
1551
+ * @param {string} collection
1552
+ * @param {string} data_store
1553
+ * @param {string} sitemap
1554
+ * @returns {string} Resource name string.
1555
+ */
1556
+ projectLocationCollectionDataStoreSiteSearchEngineSitemapPath(project: string, location: string, collection: string, dataStore: string, sitemap: string): string;
1557
+ /**
1558
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1559
+ *
1560
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1561
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1562
+ * @returns {string} A string representing the project.
1563
+ */
1564
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1565
+ /**
1566
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1567
+ *
1568
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1569
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1570
+ * @returns {string} A string representing the location.
1571
+ */
1572
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1573
+ /**
1574
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1575
+ *
1576
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1577
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1578
+ * @returns {string} A string representing the collection.
1579
+ */
1580
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1581
+ /**
1582
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1583
+ *
1584
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1585
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1586
+ * @returns {string} A string representing the data_store.
1587
+ */
1588
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1589
+ /**
1590
+ * Parse the sitemap from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1591
+ *
1592
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1593
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1594
+ * @returns {string} A string representing the sitemap.
1595
+ */
1596
+ matchSitemapFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1489
1597
  /**
1490
1598
  * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
1491
1599
  *
@@ -1639,6 +1747,57 @@ export declare class DocumentServiceClient {
1639
1747
  * @returns {string} A string representing the conversation.
1640
1748
  */
1641
1749
  matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1750
+ /**
1751
+ * Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
1752
+ *
1753
+ * @param {string} project
1754
+ * @param {string} location
1755
+ * @param {string} collection
1756
+ * @param {string} engine
1757
+ * @param {string} serving_config
1758
+ * @returns {string} Resource name string.
1759
+ */
1760
+ projectLocationCollectionEngineServingConfigPath(project: string, location: string, collection: string, engine: string, servingConfig: string): string;
1761
+ /**
1762
+ * Parse the project from ProjectLocationCollectionEngineServingConfig resource.
1763
+ *
1764
+ * @param {string} projectLocationCollectionEngineServingConfigName
1765
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1766
+ * @returns {string} A string representing the project.
1767
+ */
1768
+ matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1769
+ /**
1770
+ * Parse the location from ProjectLocationCollectionEngineServingConfig resource.
1771
+ *
1772
+ * @param {string} projectLocationCollectionEngineServingConfigName
1773
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1774
+ * @returns {string} A string representing the location.
1775
+ */
1776
+ matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1777
+ /**
1778
+ * Parse the collection from ProjectLocationCollectionEngineServingConfig resource.
1779
+ *
1780
+ * @param {string} projectLocationCollectionEngineServingConfigName
1781
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1782
+ * @returns {string} A string representing the collection.
1783
+ */
1784
+ matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1785
+ /**
1786
+ * Parse the engine from ProjectLocationCollectionEngineServingConfig resource.
1787
+ *
1788
+ * @param {string} projectLocationCollectionEngineServingConfigName
1789
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1790
+ * @returns {string} A string representing the engine.
1791
+ */
1792
+ matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1793
+ /**
1794
+ * Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.
1795
+ *
1796
+ * @param {string} projectLocationCollectionEngineServingConfigName
1797
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1798
+ * @returns {string} A string representing the serving_config.
1799
+ */
1800
+ matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1642
1801
  /**
1643
1802
  * Return a fully-qualified projectLocationCollectionEngineSession resource name string.
1644
1803
  *
@@ -2137,6 +2296,48 @@ export declare class DocumentServiceClient {
2137
2296
  * @returns {string} A string representing the schema.
2138
2297
  */
2139
2298
  matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
2299
+ /**
2300
+ * Return a fully-qualified projectLocationDataStoreServingConfig resource name string.
2301
+ *
2302
+ * @param {string} project
2303
+ * @param {string} location
2304
+ * @param {string} data_store
2305
+ * @param {string} serving_config
2306
+ * @returns {string} Resource name string.
2307
+ */
2308
+ projectLocationDataStoreServingConfigPath(project: string, location: string, dataStore: string, servingConfig: string): string;
2309
+ /**
2310
+ * Parse the project from ProjectLocationDataStoreServingConfig resource.
2311
+ *
2312
+ * @param {string} projectLocationDataStoreServingConfigName
2313
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
2314
+ * @returns {string} A string representing the project.
2315
+ */
2316
+ matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
2317
+ /**
2318
+ * Parse the location from ProjectLocationDataStoreServingConfig resource.
2319
+ *
2320
+ * @param {string} projectLocationDataStoreServingConfigName
2321
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
2322
+ * @returns {string} A string representing the location.
2323
+ */
2324
+ matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
2325
+ /**
2326
+ * Parse the data_store from ProjectLocationDataStoreServingConfig resource.
2327
+ *
2328
+ * @param {string} projectLocationDataStoreServingConfigName
2329
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
2330
+ * @returns {string} A string representing the data_store.
2331
+ */
2332
+ matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
2333
+ /**
2334
+ * Parse the serving_config from ProjectLocationDataStoreServingConfig resource.
2335
+ *
2336
+ * @param {string} projectLocationDataStoreServingConfigName
2337
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
2338
+ * @returns {string} A string representing the serving_config.
2339
+ */
2340
+ matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
2140
2341
  /**
2141
2342
  * Return a fully-qualified projectLocationDataStoreSession resource name string.
2142
2343
  *
@@ -2263,6 +2464,48 @@ export declare class DocumentServiceClient {
2263
2464
  * @returns {string} A string representing the data_store.
2264
2465
  */
2265
2466
  matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
2467
+ /**
2468
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineSitemap resource name string.
2469
+ *
2470
+ * @param {string} project
2471
+ * @param {string} location
2472
+ * @param {string} data_store
2473
+ * @param {string} sitemap
2474
+ * @returns {string} Resource name string.
2475
+ */
2476
+ projectLocationDataStoreSiteSearchEngineSitemapPath(project: string, location: string, dataStore: string, sitemap: string): string;
2477
+ /**
2478
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2479
+ *
2480
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2481
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2482
+ * @returns {string} A string representing the project.
2483
+ */
2484
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
2485
+ /**
2486
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2487
+ *
2488
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2489
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2490
+ * @returns {string} A string representing the location.
2491
+ */
2492
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
2493
+ /**
2494
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2495
+ *
2496
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2497
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2498
+ * @returns {string} A string representing the data_store.
2499
+ */
2500
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
2501
+ /**
2502
+ * Parse the sitemap from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2503
+ *
2504
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2505
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2506
+ * @returns {string} A string representing the sitemap.
2507
+ */
2508
+ matchSitemapFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
2266
2509
  /**
2267
2510
  * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
2268
2511
  *