@google-cloud/discoveryengine 2.1.0 → 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 (121) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/build/protos/protos.d.ts +31 -316
  3. package/build/protos/protos.js +146 -593
  4. package/build/protos/protos.json +25 -1
  5. package/build/src/index.d.ts +1 -1
  6. package/build/src/index.js +1 -21
  7. package/build/src/v1/completion_service_client.d.ts +76 -76
  8. package/build/src/v1/completion_service_client.js +125 -262
  9. package/build/src/v1/control_service_client.d.ts +81 -81
  10. package/build/src/v1/control_service_client.js +96 -132
  11. package/build/src/v1/conversational_search_service_client.d.ts +143 -143
  12. package/build/src/v1/conversational_search_service_client.js +138 -226
  13. package/build/src/v1/data_store_service_client.d.ts +122 -122
  14. package/build/src/v1/data_store_service_client.js +134 -280
  15. package/build/src/v1/document_service_client.d.ts +120 -120
  16. package/build/src/v1/document_service_client.js +143 -300
  17. package/build/src/v1/engine_service_client.d.ts +103 -103
  18. package/build/src/v1/engine_service_client.js +134 -279
  19. package/build/src/v1/grounded_generation_service_client.d.ts +48 -48
  20. package/build/src/v1/grounded_generation_service_client.js +79 -100
  21. package/build/src/v1/project_service_client.d.ts +76 -76
  22. package/build/src/v1/project_service_client.js +108 -222
  23. package/build/src/v1/rank_service_client.d.ts +47 -47
  24. package/build/src/v1/rank_service_client.js +72 -85
  25. package/build/src/v1/recommendation_service_client.d.ts +47 -47
  26. package/build/src/v1/recommendation_service_client.js +70 -82
  27. package/build/src/v1/schema_service_client.d.ts +111 -111
  28. package/build/src/v1/schema_service_client.js +131 -273
  29. package/build/src/v1/search_service_client.d.ts +545 -545
  30. package/build/src/v1/search_service_client.js +90 -113
  31. package/build/src/v1/search_tuning_service_client.d.ts +77 -77
  32. package/build/src/v1/search_tuning_service_client.js +113 -235
  33. package/build/src/v1/serving_config_service_client.d.ts +48 -48
  34. package/build/src/v1/serving_config_service_client.js +69 -80
  35. package/build/src/v1/site_search_engine_service_client.d.ts +148 -148
  36. package/build/src/v1/site_search_engine_service_client.js +179 -378
  37. package/build/src/v1/user_event_service_client.d.ts +77 -77
  38. package/build/src/v1/user_event_service_client.js +121 -253
  39. package/build/src/v1alpha/acl_config_service_client.d.ts +49 -49
  40. package/build/src/v1alpha/acl_config_service_client.js +82 -106
  41. package/build/src/v1alpha/chunk_service_client.d.ts +88 -88
  42. package/build/src/v1alpha/chunk_service_client.js +92 -120
  43. package/build/src/v1alpha/completion_service_client.d.ts +77 -77
  44. package/build/src/v1alpha/completion_service_client.js +134 -280
  45. package/build/src/v1alpha/control_service_client.d.ts +85 -85
  46. package/build/src/v1alpha/control_service_client.js +105 -151
  47. package/build/src/v1alpha/conversational_search_service_client.d.ts +143 -143
  48. package/build/src/v1alpha/conversational_search_service_client.js +145 -237
  49. package/build/src/v1alpha/data_store_service_client.d.ts +126 -126
  50. package/build/src/v1alpha/data_store_service_client.js +151 -316
  51. package/build/src/v1alpha/document_service_client.d.ts +126 -126
  52. package/build/src/v1alpha/document_service_client.js +156 -328
  53. package/build/src/v1alpha/engine_service_client.d.ts +106 -106
  54. package/build/src/v1alpha/engine_service_client.js +155 -325
  55. package/build/src/v1alpha/estimate_billing_service_client.d.ts +76 -76
  56. package/build/src/v1alpha/estimate_billing_service_client.js +118 -243
  57. package/build/src/v1alpha/evaluation_service_client.d.ts +161 -161
  58. package/build/src/v1alpha/evaluation_service_client.js +143 -295
  59. package/build/src/v1alpha/grounded_generation_service_client.d.ts +48 -48
  60. package/build/src/v1alpha/grounded_generation_service_client.js +79 -100
  61. package/build/src/v1alpha/project_service_client.d.ts +78 -78
  62. package/build/src/v1alpha/project_service_client.js +126 -262
  63. package/build/src/v1alpha/rank_service_client.d.ts +47 -47
  64. package/build/src/v1alpha/rank_service_client.js +81 -104
  65. package/build/src/v1alpha/recommendation_service_client.d.ts +47 -47
  66. package/build/src/v1alpha/recommendation_service_client.js +79 -100
  67. package/build/src/v1alpha/sample_query_service_client.d.ts +123 -123
  68. package/build/src/v1alpha/sample_query_service_client.js +144 -301
  69. package/build/src/v1alpha/sample_query_set_service_client.d.ts +94 -94
  70. package/build/src/v1alpha/sample_query_set_service_client.js +106 -153
  71. package/build/src/v1alpha/schema_service_client.d.ts +112 -112
  72. package/build/src/v1alpha/schema_service_client.js +140 -292
  73. package/build/src/v1alpha/search_service_client.d.ts +327 -327
  74. package/build/src/v1alpha/search_service_client.js +88 -112
  75. package/build/src/v1alpha/search_tuning_service_client.d.ts +77 -77
  76. package/build/src/v1alpha/search_tuning_service_client.js +122 -253
  77. package/build/src/v1alpha/serving_config_service_client.d.ts +75 -75
  78. package/build/src/v1alpha/serving_config_service_client.js +97 -133
  79. package/build/src/v1alpha/site_search_engine_service_client.d.ts +151 -151
  80. package/build/src/v1alpha/site_search_engine_service_client.js +184 -387
  81. package/build/src/v1alpha/user_event_service_client.d.ts +78 -78
  82. package/build/src/v1alpha/user_event_service_client.js +130 -271
  83. package/build/src/v1beta/completion_service_client.d.ts +78 -78
  84. package/build/src/v1beta/completion_service_client.js +136 -279
  85. package/build/src/v1beta/control_service_client.d.ts +84 -84
  86. package/build/src/v1beta/control_service_client.js +103 -147
  87. package/build/src/v1beta/conversational_search_service_client.d.ts +142 -142
  88. package/build/src/v1beta/conversational_search_service_client.js +143 -233
  89. package/build/src/v1beta/data_store_service_client.d.ts +124 -124
  90. package/build/src/v1beta/data_store_service_client.js +141 -288
  91. package/build/src/v1beta/document_service_client.d.ts +124 -124
  92. package/build/src/v1beta/document_service_client.js +150 -309
  93. package/build/src/v1beta/engine_service_client.d.ts +106 -106
  94. package/build/src/v1beta/engine_service_client.js +153 -315
  95. package/build/src/v1beta/evaluation_service_client.d.ts +161 -161
  96. package/build/src/v1beta/evaluation_service_client.js +141 -285
  97. package/build/src/v1beta/grounded_generation_service_client.d.ts +49 -49
  98. package/build/src/v1beta/grounded_generation_service_client.js +86 -114
  99. package/build/src/v1beta/project_service_client.d.ts +76 -76
  100. package/build/src/v1beta/project_service_client.js +115 -231
  101. package/build/src/v1beta/rank_service_client.d.ts +47 -47
  102. package/build/src/v1beta/rank_service_client.js +79 -99
  103. package/build/src/v1beta/recommendation_service_client.d.ts +47 -47
  104. package/build/src/v1beta/recommendation_service_client.js +77 -96
  105. package/build/src/v1beta/sample_query_service_client.d.ts +123 -123
  106. package/build/src/v1beta/sample_query_service_client.js +142 -291
  107. package/build/src/v1beta/sample_query_set_service_client.d.ts +94 -94
  108. package/build/src/v1beta/sample_query_set_service_client.js +104 -149
  109. package/build/src/v1beta/schema_service_client.d.ts +111 -111
  110. package/build/src/v1beta/schema_service_client.js +138 -282
  111. package/build/src/v1beta/search_service_client.d.ts +665 -665
  112. package/build/src/v1beta/search_service_client.js +97 -128
  113. package/build/src/v1beta/search_tuning_service_client.d.ts +77 -77
  114. package/build/src/v1beta/search_tuning_service_client.js +120 -243
  115. package/build/src/v1beta/serving_config_service_client.d.ts +75 -75
  116. package/build/src/v1beta/serving_config_service_client.js +95 -129
  117. package/build/src/v1beta/site_search_engine_service_client.d.ts +151 -151
  118. package/build/src/v1beta/site_search_engine_service_client.js +186 -386
  119. package/build/src/v1beta/user_event_service_client.d.ts +78 -78
  120. package/build/src/v1beta/user_event_service_client.js +128 -261
  121. package/package.json +1 -1
@@ -153,7 +153,7 @@ export declare class ControlServiceClient {
153
153
  */
154
154
  createControl(request?: protos.google.cloud.discoveryengine.v1alpha.ICreateControlRequest, options?: CallOptions): Promise<[
155
155
  protos.google.cloud.discoveryengine.v1alpha.IControl,
156
- (protos.google.cloud.discoveryengine.v1alpha.ICreateControlRequest | undefined),
156
+ protos.google.cloud.discoveryengine.v1alpha.ICreateControlRequest | undefined,
157
157
  {} | undefined
158
158
  ]>;
159
159
  createControl(request: protos.google.cloud.discoveryengine.v1alpha.ICreateControlRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IControl, protos.google.cloud.discoveryengine.v1alpha.ICreateControlRequest | null | undefined, {} | null | undefined>): void;
@@ -180,7 +180,7 @@ export declare class ControlServiceClient {
180
180
  */
181
181
  deleteControl(request?: protos.google.cloud.discoveryengine.v1alpha.IDeleteControlRequest, options?: CallOptions): Promise<[
182
182
  protos.google.protobuf.IEmpty,
183
- (protos.google.cloud.discoveryengine.v1alpha.IDeleteControlRequest | undefined),
183
+ protos.google.cloud.discoveryengine.v1alpha.IDeleteControlRequest | undefined,
184
184
  {} | undefined
185
185
  ]>;
186
186
  deleteControl(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteControlRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteControlRequest | null | undefined, {} | null | undefined>): void;
@@ -216,7 +216,7 @@ export declare class ControlServiceClient {
216
216
  */
217
217
  updateControl(request?: protos.google.cloud.discoveryengine.v1alpha.IUpdateControlRequest, options?: CallOptions): Promise<[
218
218
  protos.google.cloud.discoveryengine.v1alpha.IControl,
219
- (protos.google.cloud.discoveryengine.v1alpha.IUpdateControlRequest | undefined),
219
+ protos.google.cloud.discoveryengine.v1alpha.IUpdateControlRequest | undefined,
220
220
  {} | undefined
221
221
  ]>;
222
222
  updateControl(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateControlRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IControl, protos.google.cloud.discoveryengine.v1alpha.IUpdateControlRequest | null | undefined, {} | null | undefined>): void;
@@ -240,46 +240,46 @@ export declare class ControlServiceClient {
240
240
  */
241
241
  getControl(request?: protos.google.cloud.discoveryengine.v1alpha.IGetControlRequest, options?: CallOptions): Promise<[
242
242
  protos.google.cloud.discoveryengine.v1alpha.IControl,
243
- (protos.google.cloud.discoveryengine.v1alpha.IGetControlRequest | undefined),
243
+ protos.google.cloud.discoveryengine.v1alpha.IGetControlRequest | undefined,
244
244
  {} | undefined
245
245
  ]>;
246
246
  getControl(request: protos.google.cloud.discoveryengine.v1alpha.IGetControlRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IControl, protos.google.cloud.discoveryengine.v1alpha.IGetControlRequest | null | undefined, {} | null | undefined>): void;
247
247
  getControl(request: protos.google.cloud.discoveryengine.v1alpha.IGetControlRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IControl, protos.google.cloud.discoveryengine.v1alpha.IGetControlRequest | null | undefined, {} | null | undefined>): void;
248
248
  /**
249
- * Lists all Controls by their parent
250
- * {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}.
251
- *
252
- * @param {Object} request
253
- * The request object that will be sent.
254
- * @param {string} request.parent
255
- * Required. The data store resource name. Format:
256
- * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
257
- * or
258
- * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
259
- * @param {number} [request.pageSize]
260
- * Optional. Maximum number of results to return. If unspecified, defaults
261
- * to 50. Max allowed value is 1000.
262
- * @param {string} [request.pageToken]
263
- * Optional. A page token, received from a previous `ListControls` call.
264
- * Provide this to retrieve the subsequent page.
265
- * @param {string} [request.filter]
266
- * Optional. A filter to apply on the list results. Supported features:
267
- *
268
- * * List all the products under the parent branch if
269
- * {@link protos.google.cloud.discoveryengine.v1alpha.ListControlsRequest.filter|filter}
270
- * is unset. Currently this field is unsupported.
271
- * @param {object} [options]
272
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
273
- * @returns {Promise} - The promise which resolves to an array.
274
- * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1alpha.Control|Control}.
275
- * The client library will perform auto-pagination by default: it will call the API as many
276
- * times as needed and will merge results from all the pages into this array.
277
- * Note that it can affect your quota.
278
- * We recommend using `listControlsAsync()`
279
- * method described below for async iteration which you can stop as needed.
280
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
281
- * for more details and examples.
282
- */
249
+ * Lists all Controls by their parent
250
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}.
251
+ *
252
+ * @param {Object} request
253
+ * The request object that will be sent.
254
+ * @param {string} request.parent
255
+ * Required. The data store resource name. Format:
256
+ * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
257
+ * or
258
+ * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
259
+ * @param {number} [request.pageSize]
260
+ * Optional. Maximum number of results to return. If unspecified, defaults
261
+ * to 50. Max allowed value is 1000.
262
+ * @param {string} [request.pageToken]
263
+ * Optional. A page token, received from a previous `ListControls` call.
264
+ * Provide this to retrieve the subsequent page.
265
+ * @param {string} [request.filter]
266
+ * Optional. A filter to apply on the list results. Supported features:
267
+ *
268
+ * * List all the products under the parent branch if
269
+ * {@link protos.google.cloud.discoveryengine.v1alpha.ListControlsRequest.filter|filter}
270
+ * is unset. Currently this field is unsupported.
271
+ * @param {object} [options]
272
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
273
+ * @returns {Promise} - The promise which resolves to an array.
274
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1alpha.Control|Control}.
275
+ * The client library will perform auto-pagination by default: it will call the API as many
276
+ * times as needed and will merge results from all the pages into this array.
277
+ * Note that it can affect your quota.
278
+ * We recommend using `listControlsAsync()`
279
+ * method described below for async iteration which you can stop as needed.
280
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
281
+ * for more details and examples.
282
+ */
283
283
  listControls(request?: protos.google.cloud.discoveryengine.v1alpha.IListControlsRequest, options?: CallOptions): Promise<[
284
284
  protos.google.cloud.discoveryengine.v1alpha.IControl[],
285
285
  protos.google.cloud.discoveryengine.v1alpha.IListControlsRequest | null,
@@ -357,55 +357,55 @@ export declare class ControlServiceClient {
357
357
  */
358
358
  listControlsAsync(request?: protos.google.cloud.discoveryengine.v1alpha.IListControlsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1alpha.IControl>;
359
359
  /**
360
- * Gets information about a location.
361
- *
362
- * @param {Object} request
363
- * The request object that will be sent.
364
- * @param {string} request.name
365
- * Resource name for the location.
366
- * @param {object} [options]
367
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
368
- * @returns {Promise} - The promise which resolves to an array.
369
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
370
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
371
- * for more details and examples.
372
- * @example
373
- * ```
374
- * const [response] = await client.getLocation(request);
375
- * ```
376
- */
360
+ * Gets information about a location.
361
+ *
362
+ * @param {Object} request
363
+ * The request object that will be sent.
364
+ * @param {string} request.name
365
+ * Resource name for the location.
366
+ * @param {object} [options]
367
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
368
+ * @returns {Promise} - The promise which resolves to an array.
369
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
370
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
371
+ * for more details and examples.
372
+ * @example
373
+ * ```
374
+ * const [response] = await client.getLocation(request);
375
+ * ```
376
+ */
377
377
  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>;
378
378
  /**
379
- * Lists information about the supported locations for this service. Returns an iterable object.
380
- *
381
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
382
- * @param {Object} request
383
- * The request object that will be sent.
384
- * @param {string} request.name
385
- * The resource that owns the locations collection, if applicable.
386
- * @param {string} request.filter
387
- * The standard list filter.
388
- * @param {number} request.pageSize
389
- * The standard list page size.
390
- * @param {string} request.pageToken
391
- * The standard list page token.
392
- * @param {object} [options]
393
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
394
- * @returns {Object}
395
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
396
- * When you iterate the returned iterable, each element will be an object representing
397
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
398
- * so you can stop the iteration when you don't need more results.
399
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
400
- * for more details and examples.
401
- * @example
402
- * ```
403
- * const iterable = client.listLocationsAsync(request);
404
- * for await (const response of iterable) {
405
- * // process response
406
- * }
407
- * ```
408
- */
379
+ * Lists information about the supported locations for this service. Returns an iterable object.
380
+ *
381
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
382
+ * @param {Object} request
383
+ * The request object that will be sent.
384
+ * @param {string} request.name
385
+ * The resource that owns the locations collection, if applicable.
386
+ * @param {string} request.filter
387
+ * The standard list filter.
388
+ * @param {number} request.pageSize
389
+ * The standard list page size.
390
+ * @param {string} request.pageToken
391
+ * The standard list page token.
392
+ * @param {object} [options]
393
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
394
+ * @returns {Object}
395
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
396
+ * When you iterate the returned iterable, each element will be an object representing
397
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
398
+ * so you can stop the iteration when you don't need more results.
399
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
400
+ * for more details and examples.
401
+ * @example
402
+ * ```
403
+ * const iterable = client.listLocationsAsync(request);
404
+ * for await (const response of iterable) {
405
+ * // process response
406
+ * }
407
+ * ```
408
+ */
409
409
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
410
410
  /**
411
411
  * Return a fully-qualified aclConfig resource name string.