@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.
- package/CHANGELOG.md +14 -0
- package/README.md +7 -2
- package/build/protos/google/cloud/discoveryengine/v1/answer.proto +54 -2
- package/build/protos/google/cloud/discoveryengine/v1/chunk.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1/common.proto +35 -6
- package/build/protos/google/cloud/discoveryengine/v1/control.proto +113 -2
- package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +168 -2
- package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +23 -4
- package/build/protos/google/cloud/discoveryengine/v1/document.proto +7 -2
- package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1/engine.proto +16 -3
- package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +70 -9
- package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +20 -1
- package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +9 -5
- package/build/protos/google/cloud/discoveryengine/v1/rank_service.proto +3 -1
- package/build/protos/google/cloud/discoveryengine/v1/recommendation_service.proto +2 -2
- package/build/protos/google/cloud/discoveryengine/v1/safety.proto +107 -0
- package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +96 -8
- package/build/protos/google/cloud/discoveryengine/v1/serving_config.proto +271 -0
- package/build/protos/google/cloud/discoveryengine/v1/serving_config_service.proto +75 -0
- package/build/protos/google/cloud/discoveryengine/v1/session.proto +19 -0
- package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +27 -3
- package/build/protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto +184 -5
- package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +34 -0
- package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +16 -4
- package/build/protos/protos.d.ts +4390 -300
- package/build/protos/protos.js +13785 -2922
- package/build/protos/protos.json +1355 -14
- package/build/src/index.d.ts +4 -1
- package/build/src/index.js +4 -21
- package/build/src/v1/completion_service_client.d.ts +313 -76
- package/build/src/v1/completion_service_client.js +451 -262
- package/build/src/v1/completion_service_proto_list.json +3 -0
- package/build/src/v1/control_service_client.d.ts +318 -81
- package/build/src/v1/control_service_client.js +422 -132
- package/build/src/v1/control_service_proto_list.json +3 -0
- package/build/src/v1/conversational_search_service_client.d.ts +341 -134
- package/build/src/v1/conversational_search_service_client.js +395 -223
- package/build/src/v1/conversational_search_service_client_config.json +5 -0
- package/build/src/v1/conversational_search_service_proto_list.json +3 -0
- package/build/src/v1/data_store_service_client.d.ts +359 -122
- package/build/src/v1/data_store_service_client.js +460 -280
- package/build/src/v1/data_store_service_proto_list.json +3 -0
- package/build/src/v1/document_service_client.d.ts +364 -121
- package/build/src/v1/document_service_client.js +469 -300
- package/build/src/v1/document_service_proto_list.json +3 -0
- package/build/src/v1/engine_service_client.d.ts +340 -103
- package/build/src/v1/engine_service_client.js +460 -279
- package/build/src/v1/engine_service_proto_list.json +3 -0
- package/build/src/v1/gapic_metadata.json +59 -0
- package/build/src/v1/grounded_generation_service_client.d.ts +286 -51
- package/build/src/v1/grounded_generation_service_client.js +405 -100
- package/build/src/v1/grounded_generation_service_proto_list.json +3 -0
- package/build/src/v1/index.d.ts +1 -0
- package/build/src/v1/index.js +3 -1
- package/build/src/v1/project_service_client.d.ts +313 -76
- package/build/src/v1/project_service_client.js +434 -222
- package/build/src/v1/project_service_proto_list.json +3 -0
- package/build/src/v1/rank_service_client.d.ts +285 -48
- package/build/src/v1/rank_service_client.js +398 -85
- package/build/src/v1/rank_service_proto_list.json +3 -0
- package/build/src/v1/recommendation_service_client.d.ts +142 -49
- package/build/src/v1/recommendation_service_client.js +198 -82
- package/build/src/v1/recommendation_service_proto_list.json +3 -0
- package/build/src/v1/schema_service_client.d.ts +348 -111
- package/build/src/v1/schema_service_client.js +457 -273
- package/build/src/v1/schema_service_proto_list.json +3 -0
- package/build/src/v1/search_service_client.d.ts +748 -559
- package/build/src/v1/search_service_client.js +302 -133
- package/build/src/v1/search_service_proto_list.json +3 -0
- package/build/src/v1/search_tuning_service_client.d.ts +314 -77
- package/build/src/v1/search_tuning_service_client.js +439 -235
- package/build/src/v1/search_tuning_service_proto_list.json +3 -0
- package/build/src/v1/serving_config_service_client.d.ts +1851 -0
- package/build/src/v1/serving_config_service_client.js +2642 -0
- package/build/src/v1/serving_config_service_client_config.json +30 -0
- package/build/src/v1/serving_config_service_proto_list.json +39 -0
- package/build/src/v1/site_search_engine_service_client.d.ts +504 -151
- package/build/src/v1/site_search_engine_service_client.js +625 -351
- package/build/src/v1/site_search_engine_service_client_config.json +12 -0
- package/build/src/v1/site_search_engine_service_proto_list.json +3 -0
- package/build/src/v1/user_event_service_client.d.ts +335 -86
- package/build/src/v1/user_event_service_client.js +447 -253
- package/build/src/v1/user_event_service_proto_list.json +3 -0
- package/build/src/v1alpha/acl_config_service_client.d.ts +49 -49
- package/build/src/v1alpha/acl_config_service_client.js +82 -106
- package/build/src/v1alpha/chunk_service_client.d.ts +88 -88
- package/build/src/v1alpha/chunk_service_client.js +92 -120
- package/build/src/v1alpha/completion_service_client.d.ts +77 -77
- package/build/src/v1alpha/completion_service_client.js +134 -280
- package/build/src/v1alpha/control_service_client.d.ts +85 -85
- package/build/src/v1alpha/control_service_client.js +105 -151
- package/build/src/v1alpha/conversational_search_service_client.d.ts +143 -143
- package/build/src/v1alpha/conversational_search_service_client.js +145 -237
- package/build/src/v1alpha/data_store_service_client.d.ts +126 -126
- package/build/src/v1alpha/data_store_service_client.js +151 -316
- package/build/src/v1alpha/document_service_client.d.ts +126 -126
- package/build/src/v1alpha/document_service_client.js +156 -328
- package/build/src/v1alpha/engine_service_client.d.ts +106 -106
- package/build/src/v1alpha/engine_service_client.js +155 -325
- package/build/src/v1alpha/estimate_billing_service_client.d.ts +76 -76
- package/build/src/v1alpha/estimate_billing_service_client.js +118 -243
- package/build/src/v1alpha/evaluation_service_client.d.ts +161 -161
- package/build/src/v1alpha/evaluation_service_client.js +143 -295
- package/build/src/v1alpha/grounded_generation_service_client.d.ts +48 -48
- package/build/src/v1alpha/grounded_generation_service_client.js +79 -100
- package/build/src/v1alpha/project_service_client.d.ts +78 -78
- package/build/src/v1alpha/project_service_client.js +126 -262
- package/build/src/v1alpha/rank_service_client.d.ts +47 -47
- package/build/src/v1alpha/rank_service_client.js +81 -104
- package/build/src/v1alpha/recommendation_service_client.d.ts +47 -47
- package/build/src/v1alpha/recommendation_service_client.js +79 -100
- package/build/src/v1alpha/sample_query_service_client.d.ts +123 -123
- package/build/src/v1alpha/sample_query_service_client.js +144 -301
- package/build/src/v1alpha/sample_query_set_service_client.d.ts +94 -94
- package/build/src/v1alpha/sample_query_set_service_client.js +106 -153
- package/build/src/v1alpha/schema_service_client.d.ts +112 -112
- package/build/src/v1alpha/schema_service_client.js +140 -292
- package/build/src/v1alpha/search_service_client.d.ts +327 -327
- package/build/src/v1alpha/search_service_client.js +88 -112
- package/build/src/v1alpha/search_tuning_service_client.d.ts +77 -77
- package/build/src/v1alpha/search_tuning_service_client.js +122 -253
- package/build/src/v1alpha/serving_config_service_client.d.ts +75 -75
- package/build/src/v1alpha/serving_config_service_client.js +97 -133
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +151 -151
- package/build/src/v1alpha/site_search_engine_service_client.js +184 -387
- package/build/src/v1alpha/user_event_service_client.d.ts +78 -78
- package/build/src/v1alpha/user_event_service_client.js +130 -271
- package/build/src/v1beta/completion_service_client.d.ts +78 -78
- package/build/src/v1beta/completion_service_client.js +136 -279
- package/build/src/v1beta/control_service_client.d.ts +84 -84
- package/build/src/v1beta/control_service_client.js +103 -147
- package/build/src/v1beta/conversational_search_service_client.d.ts +142 -142
- package/build/src/v1beta/conversational_search_service_client.js +143 -233
- package/build/src/v1beta/data_store_service_client.d.ts +124 -124
- package/build/src/v1beta/data_store_service_client.js +141 -288
- package/build/src/v1beta/document_service_client.d.ts +124 -124
- package/build/src/v1beta/document_service_client.js +150 -309
- package/build/src/v1beta/engine_service_client.d.ts +106 -106
- package/build/src/v1beta/engine_service_client.js +153 -315
- package/build/src/v1beta/evaluation_service_client.d.ts +161 -161
- package/build/src/v1beta/evaluation_service_client.js +141 -285
- package/build/src/v1beta/grounded_generation_service_client.d.ts +49 -49
- package/build/src/v1beta/grounded_generation_service_client.js +86 -114
- package/build/src/v1beta/project_service_client.d.ts +76 -76
- package/build/src/v1beta/project_service_client.js +115 -231
- package/build/src/v1beta/rank_service_client.d.ts +47 -47
- package/build/src/v1beta/rank_service_client.js +79 -99
- package/build/src/v1beta/recommendation_service_client.d.ts +47 -47
- package/build/src/v1beta/recommendation_service_client.js +77 -96
- package/build/src/v1beta/sample_query_service_client.d.ts +123 -123
- package/build/src/v1beta/sample_query_service_client.js +142 -291
- package/build/src/v1beta/sample_query_set_service_client.d.ts +94 -94
- package/build/src/v1beta/sample_query_set_service_client.js +104 -149
- package/build/src/v1beta/schema_service_client.d.ts +111 -111
- package/build/src/v1beta/schema_service_client.js +138 -282
- package/build/src/v1beta/search_service_client.d.ts +665 -665
- package/build/src/v1beta/search_service_client.js +97 -128
- package/build/src/v1beta/search_tuning_service_client.d.ts +77 -77
- package/build/src/v1beta/search_tuning_service_client.js +120 -243
- package/build/src/v1beta/serving_config_service_client.d.ts +75 -75
- package/build/src/v1beta/serving_config_service_client.js +95 -129
- package/build/src/v1beta/site_search_engine_service_client.d.ts +151 -151
- package/build/src/v1beta/site_search_engine_service_client.js +186 -386
- package/build/src/v1beta/user_event_service_client.d.ts +78 -78
- package/build/src/v1beta/user_event_service_client.js +128 -261
- package/package.json +4 -4
@@ -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
|
-
|
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
|
-
|
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
|
-
|
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
|
-
|
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
|
-
|
250
|
-
|
251
|
-
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
|
269
|
-
|
270
|
-
|
271
|
-
|
272
|
-
|
273
|
-
|
274
|
-
|
275
|
-
|
276
|
-
|
277
|
-
|
278
|
-
|
279
|
-
|
280
|
-
|
281
|
-
|
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
|
-
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
369
|
-
|
370
|
-
|
371
|
-
|
372
|
-
|
373
|
-
|
374
|
-
|
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
|
-
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
|
395
|
-
|
396
|
-
|
397
|
-
|
398
|
-
|
399
|
-
|
400
|
-
|
401
|
-
|
402
|
-
|
403
|
-
|
404
|
-
|
405
|
-
|
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.
|