@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
@@ -148,7 +148,7 @@ export declare class UserEventServiceClient {
148
148
  */
149
149
  writeUserEvent(request?: protos.google.cloud.discoveryengine.v1alpha.IWriteUserEventRequest, options?: CallOptions): Promise<[
150
150
  protos.google.cloud.discoveryengine.v1alpha.IUserEvent,
151
- (protos.google.cloud.discoveryengine.v1alpha.IWriteUserEventRequest | undefined),
151
+ protos.google.cloud.discoveryengine.v1alpha.IWriteUserEventRequest | undefined,
152
152
  {} | undefined
153
153
  ]>;
154
154
  writeUserEvent(request: protos.google.cloud.discoveryengine.v1alpha.IWriteUserEventRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IUserEvent, protos.google.cloud.discoveryengine.v1alpha.IWriteUserEventRequest | null | undefined, {} | null | undefined>): void;
@@ -188,7 +188,7 @@ export declare class UserEventServiceClient {
188
188
  */
189
189
  collectUserEvent(request?: protos.google.cloud.discoveryengine.v1alpha.ICollectUserEventRequest, options?: CallOptions): Promise<[
190
190
  protos.google.api.IHttpBody,
191
- (protos.google.cloud.discoveryengine.v1alpha.ICollectUserEventRequest | undefined),
191
+ protos.google.cloud.discoveryengine.v1alpha.ICollectUserEventRequest | undefined,
192
192
  {} | undefined
193
193
  ]>;
194
194
  collectUserEvent(request: protos.google.cloud.discoveryengine.v1alpha.ICollectUserEventRequest, options: CallOptions, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.discoveryengine.v1alpha.ICollectUserEventRequest | null | undefined, {} | null | undefined>): void;
@@ -322,86 +322,86 @@ export declare class UserEventServiceClient {
322
322
  */
323
323
  checkImportUserEventsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.ImportUserEventsResponse, protos.google.cloud.discoveryengine.v1alpha.ImportUserEventsMetadata>>;
324
324
  /**
325
- * Gets information about a location.
326
- *
327
- * @param {Object} request
328
- * The request object that will be sent.
329
- * @param {string} request.name
330
- * Resource name for the location.
331
- * @param {object} [options]
332
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
333
- * @returns {Promise} - The promise which resolves to an array.
334
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
335
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
336
- * for more details and examples.
337
- * @example
338
- * ```
339
- * const [response] = await client.getLocation(request);
340
- * ```
341
- */
325
+ * Gets information about a location.
326
+ *
327
+ * @param {Object} request
328
+ * The request object that will be sent.
329
+ * @param {string} request.name
330
+ * Resource name for the location.
331
+ * @param {object} [options]
332
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
333
+ * @returns {Promise} - The promise which resolves to an array.
334
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
335
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
336
+ * for more details and examples.
337
+ * @example
338
+ * ```
339
+ * const [response] = await client.getLocation(request);
340
+ * ```
341
+ */
342
342
  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>;
343
343
  /**
344
- * Lists information about the supported locations for this service. Returns an iterable object.
345
- *
346
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
347
- * @param {Object} request
348
- * The request object that will be sent.
349
- * @param {string} request.name
350
- * The resource that owns the locations collection, if applicable.
351
- * @param {string} request.filter
352
- * The standard list filter.
353
- * @param {number} request.pageSize
354
- * The standard list page size.
355
- * @param {string} request.pageToken
356
- * The standard list page token.
357
- * @param {object} [options]
358
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
359
- * @returns {Object}
360
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
361
- * When you iterate the returned iterable, each element will be an object representing
362
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
363
- * so you can stop the iteration when you don't need more results.
364
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
365
- * for more details and examples.
366
- * @example
367
- * ```
368
- * const iterable = client.listLocationsAsync(request);
369
- * for await (const response of iterable) {
370
- * // process response
371
- * }
372
- * ```
373
- */
344
+ * Lists information about the supported locations for this service. Returns an iterable object.
345
+ *
346
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
347
+ * @param {Object} request
348
+ * The request object that will be sent.
349
+ * @param {string} request.name
350
+ * The resource that owns the locations collection, if applicable.
351
+ * @param {string} request.filter
352
+ * The standard list filter.
353
+ * @param {number} request.pageSize
354
+ * The standard list page size.
355
+ * @param {string} request.pageToken
356
+ * The standard list page token.
357
+ * @param {object} [options]
358
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
359
+ * @returns {Object}
360
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
361
+ * When you iterate the returned iterable, each element will be an object representing
362
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
363
+ * so you can stop the iteration when you don't need more results.
364
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
365
+ * for more details and examples.
366
+ * @example
367
+ * ```
368
+ * const iterable = client.listLocationsAsync(request);
369
+ * for await (const response of iterable) {
370
+ * // process response
371
+ * }
372
+ * ```
373
+ */
374
374
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
375
375
  /**
376
- * Gets the latest state of a long-running operation. Clients can use this
377
- * method to poll the operation result at intervals as recommended by the API
378
- * service.
379
- *
380
- * @param {Object} request - The request object that will be sent.
381
- * @param {string} request.name - The name of the operation resource.
382
- * @param {Object=} options
383
- * Optional parameters. You can override the default settings for this call,
384
- * e.g, timeout, retries, paginations, etc. See {@link
385
- * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
386
- * for the details.
387
- * @param {function(?Error, ?Object)=} callback
388
- * The function which will be called with the result of the API call.
389
- *
390
- * The second parameter to the callback is an object representing
391
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
392
- * @return {Promise} - The promise which resolves to an array.
393
- * The first element of the array is an object representing
394
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
395
- * The promise has a method named "cancel" which cancels the ongoing API call.
396
- *
397
- * @example
398
- * ```
399
- * const client = longrunning.operationsClient();
400
- * const name = '';
401
- * const [response] = await client.getOperation({name});
402
- * // doThingsWith(response)
403
- * ```
404
- */
376
+ * Gets the latest state of a long-running operation. Clients can use this
377
+ * method to poll the operation result at intervals as recommended by the API
378
+ * service.
379
+ *
380
+ * @param {Object} request - The request object that will be sent.
381
+ * @param {string} request.name - The name of the operation resource.
382
+ * @param {Object=} options
383
+ * Optional parameters. You can override the default settings for this call,
384
+ * e.g, timeout, retries, paginations, etc. See {@link
385
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
386
+ * for the details.
387
+ * @param {function(?Error, ?Object)=} callback
388
+ * The function which will be called with the result of the API call.
389
+ *
390
+ * The second parameter to the callback is an object representing
391
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
392
+ * @return {Promise} - The promise which resolves to an array.
393
+ * The first element of the array is an object representing
394
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
395
+ * The promise has a method named "cancel" which cancels the ongoing API call.
396
+ *
397
+ * @example
398
+ * ```
399
+ * const client = longrunning.operationsClient();
400
+ * const name = '';
401
+ * const [response] = await client.getOperation({name});
402
+ * // doThingsWith(response)
403
+ * ```
404
+ */
405
405
  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]>;
406
406
  /**
407
407
  * Lists operations that match the specified filter in the request. If the