@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
@@ -177,7 +177,7 @@ export declare class CompletionServiceClient {
177
177
  */
178
178
  completeQuery(request?: protos.google.cloud.discoveryengine.v1beta.ICompleteQueryRequest, options?: CallOptions): Promise<[
179
179
  protos.google.cloud.discoveryengine.v1beta.ICompleteQueryResponse,
180
- (protos.google.cloud.discoveryengine.v1beta.ICompleteQueryRequest | undefined),
180
+ protos.google.cloud.discoveryengine.v1beta.ICompleteQueryRequest | undefined,
181
181
  {} | undefined
182
182
  ]>;
183
183
  completeQuery(request: protos.google.cloud.discoveryengine.v1beta.ICompleteQueryRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ICompleteQueryResponse, protos.google.cloud.discoveryengine.v1beta.ICompleteQueryRequest | null | undefined, {} | null | undefined>): void;
@@ -262,7 +262,7 @@ export declare class CompletionServiceClient {
262
262
  */
263
263
  advancedCompleteQuery(request?: protos.google.cloud.discoveryengine.v1beta.IAdvancedCompleteQueryRequest, options?: CallOptions): Promise<[
264
264
  protos.google.cloud.discoveryengine.v1beta.IAdvancedCompleteQueryResponse,
265
- (protos.google.cloud.discoveryengine.v1beta.IAdvancedCompleteQueryRequest | undefined),
265
+ protos.google.cloud.discoveryengine.v1beta.IAdvancedCompleteQueryRequest | undefined,
266
266
  {} | undefined
267
267
  ]>;
268
268
  advancedCompleteQuery(request: protos.google.cloud.discoveryengine.v1beta.IAdvancedCompleteQueryRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IAdvancedCompleteQueryResponse, protos.google.cloud.discoveryengine.v1beta.IAdvancedCompleteQueryRequest | null | undefined, {} | null | undefined>): void;
@@ -450,86 +450,86 @@ export declare class CompletionServiceClient {
450
450
  */
451
451
  checkPurgeCompletionSuggestionsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.PurgeCompletionSuggestionsResponse, protos.google.cloud.discoveryengine.v1beta.PurgeCompletionSuggestionsMetadata>>;
452
452
  /**
453
- * Gets information about a location.
454
- *
455
- * @param {Object} request
456
- * The request object that will be sent.
457
- * @param {string} request.name
458
- * Resource name for the location.
459
- * @param {object} [options]
460
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
461
- * @returns {Promise} - The promise which resolves to an array.
462
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
463
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
464
- * for more details and examples.
465
- * @example
466
- * ```
467
- * const [response] = await client.getLocation(request);
468
- * ```
469
- */
453
+ * Gets information about a location.
454
+ *
455
+ * @param {Object} request
456
+ * The request object that will be sent.
457
+ * @param {string} request.name
458
+ * Resource name for the location.
459
+ * @param {object} [options]
460
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
461
+ * @returns {Promise} - The promise which resolves to an array.
462
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
463
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
464
+ * for more details and examples.
465
+ * @example
466
+ * ```
467
+ * const [response] = await client.getLocation(request);
468
+ * ```
469
+ */
470
470
  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>;
471
471
  /**
472
- * Lists information about the supported locations for this service. Returns an iterable object.
473
- *
474
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
475
- * @param {Object} request
476
- * The request object that will be sent.
477
- * @param {string} request.name
478
- * The resource that owns the locations collection, if applicable.
479
- * @param {string} request.filter
480
- * The standard list filter.
481
- * @param {number} request.pageSize
482
- * The standard list page size.
483
- * @param {string} request.pageToken
484
- * The standard list page token.
485
- * @param {object} [options]
486
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
487
- * @returns {Object}
488
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
489
- * When you iterate the returned iterable, each element will be an object representing
490
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
491
- * so you can stop the iteration when you don't need more results.
492
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
493
- * for more details and examples.
494
- * @example
495
- * ```
496
- * const iterable = client.listLocationsAsync(request);
497
- * for await (const response of iterable) {
498
- * // process response
499
- * }
500
- * ```
501
- */
472
+ * Lists information about the supported locations for this service. Returns an iterable object.
473
+ *
474
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
475
+ * @param {Object} request
476
+ * The request object that will be sent.
477
+ * @param {string} request.name
478
+ * The resource that owns the locations collection, if applicable.
479
+ * @param {string} request.filter
480
+ * The standard list filter.
481
+ * @param {number} request.pageSize
482
+ * The standard list page size.
483
+ * @param {string} request.pageToken
484
+ * The standard list page token.
485
+ * @param {object} [options]
486
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
487
+ * @returns {Object}
488
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
489
+ * When you iterate the returned iterable, each element will be an object representing
490
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
491
+ * so you can stop the iteration when you don't need more results.
492
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
493
+ * for more details and examples.
494
+ * @example
495
+ * ```
496
+ * const iterable = client.listLocationsAsync(request);
497
+ * for await (const response of iterable) {
498
+ * // process response
499
+ * }
500
+ * ```
501
+ */
502
502
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
503
503
  /**
504
- * Gets the latest state of a long-running operation. Clients can use this
505
- * method to poll the operation result at intervals as recommended by the API
506
- * service.
507
- *
508
- * @param {Object} request - The request object that will be sent.
509
- * @param {string} request.name - The name of the operation resource.
510
- * @param {Object=} options
511
- * Optional parameters. You can override the default settings for this call,
512
- * e.g, timeout, retries, paginations, etc. See {@link
513
- * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
514
- * for the details.
515
- * @param {function(?Error, ?Object)=} callback
516
- * The function which will be called with the result of the API call.
517
- *
518
- * The second parameter to the callback is an object representing
519
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
520
- * @return {Promise} - The promise which resolves to an array.
521
- * The first element of the array is an object representing
522
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
523
- * The promise has a method named "cancel" which cancels the ongoing API call.
524
- *
525
- * @example
526
- * ```
527
- * const client = longrunning.operationsClient();
528
- * const name = '';
529
- * const [response] = await client.getOperation({name});
530
- * // doThingsWith(response)
531
- * ```
532
- */
504
+ * Gets the latest state of a long-running operation. Clients can use this
505
+ * method to poll the operation result at intervals as recommended by the API
506
+ * service.
507
+ *
508
+ * @param {Object} request - The request object that will be sent.
509
+ * @param {string} request.name - The name of the operation resource.
510
+ * @param {Object=} options
511
+ * Optional parameters. You can override the default settings for this call,
512
+ * e.g, timeout, retries, paginations, etc. See {@link
513
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
514
+ * for the details.
515
+ * @param {function(?Error, ?Object)=} callback
516
+ * The function which will be called with the result of the API call.
517
+ *
518
+ * The second parameter to the callback is an object representing
519
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
520
+ * @return {Promise} - The promise which resolves to an array.
521
+ * The first element of the array is an object representing
522
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
523
+ * The promise has a method named "cancel" which cancels the ongoing API call.
524
+ *
525
+ * @example
526
+ * ```
527
+ * const client = longrunning.operationsClient();
528
+ * const name = '';
529
+ * const [response] = await client.getOperation({name});
530
+ * // doThingsWith(response)
531
+ * ```
532
+ */
533
533
  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]>;
534
534
  /**
535
535
  * Lists operations that match the specified filter in the request. If the