@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.
- package/CHANGELOG.md +7 -0
- package/build/protos/protos.d.ts +31 -316
- package/build/protos/protos.js +146 -593
- package/build/protos/protos.json +25 -1
- package/build/src/index.d.ts +1 -1
- package/build/src/index.js +1 -21
- package/build/src/v1/completion_service_client.d.ts +76 -76
- package/build/src/v1/completion_service_client.js +125 -262
- package/build/src/v1/control_service_client.d.ts +81 -81
- package/build/src/v1/control_service_client.js +96 -132
- package/build/src/v1/conversational_search_service_client.d.ts +143 -143
- package/build/src/v1/conversational_search_service_client.js +138 -226
- package/build/src/v1/data_store_service_client.d.ts +122 -122
- package/build/src/v1/data_store_service_client.js +134 -280
- package/build/src/v1/document_service_client.d.ts +120 -120
- package/build/src/v1/document_service_client.js +143 -300
- package/build/src/v1/engine_service_client.d.ts +103 -103
- package/build/src/v1/engine_service_client.js +134 -279
- package/build/src/v1/grounded_generation_service_client.d.ts +48 -48
- package/build/src/v1/grounded_generation_service_client.js +79 -100
- package/build/src/v1/project_service_client.d.ts +76 -76
- package/build/src/v1/project_service_client.js +108 -222
- package/build/src/v1/rank_service_client.d.ts +47 -47
- package/build/src/v1/rank_service_client.js +72 -85
- package/build/src/v1/recommendation_service_client.d.ts +47 -47
- package/build/src/v1/recommendation_service_client.js +70 -82
- package/build/src/v1/schema_service_client.d.ts +111 -111
- package/build/src/v1/schema_service_client.js +131 -273
- package/build/src/v1/search_service_client.d.ts +545 -545
- package/build/src/v1/search_service_client.js +90 -113
- package/build/src/v1/search_tuning_service_client.d.ts +77 -77
- package/build/src/v1/search_tuning_service_client.js +113 -235
- package/build/src/v1/serving_config_service_client.d.ts +48 -48
- package/build/src/v1/serving_config_service_client.js +69 -80
- package/build/src/v1/site_search_engine_service_client.d.ts +148 -148
- package/build/src/v1/site_search_engine_service_client.js +179 -378
- package/build/src/v1/user_event_service_client.d.ts +77 -77
- package/build/src/v1/user_event_service_client.js +121 -253
- 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 +1 -1
package/build/protos/protos.json
CHANGED
@@ -32922,7 +32922,10 @@
|
|
32922
32922
|
"rule": "repeated",
|
32923
32923
|
"type": "google.api.FieldBehavior",
|
32924
32924
|
"id": 1052,
|
32925
|
-
"extend": "google.protobuf.FieldOptions"
|
32925
|
+
"extend": "google.protobuf.FieldOptions",
|
32926
|
+
"options": {
|
32927
|
+
"packed": false
|
32928
|
+
}
|
32926
32929
|
},
|
32927
32930
|
"FieldBehavior": {
|
32928
32931
|
"values": {
|
@@ -33117,6 +33120,11 @@
|
|
33117
33120
|
"id": 1050,
|
33118
33121
|
"extend": "google.protobuf.ServiceOptions"
|
33119
33122
|
},
|
33123
|
+
"apiVersion": {
|
33124
|
+
"type": "string",
|
33125
|
+
"id": 525000001,
|
33126
|
+
"extend": "google.protobuf.ServiceOptions"
|
33127
|
+
},
|
33120
33128
|
"CommonLanguageSettings": {
|
33121
33129
|
"fields": {
|
33122
33130
|
"referenceDocsUri": {
|
@@ -33225,6 +33233,10 @@
|
|
33225
33233
|
"protoReferenceDocumentationUri": {
|
33226
33234
|
"type": "string",
|
33227
33235
|
"id": 110
|
33236
|
+
},
|
33237
|
+
"restReferenceDocumentationUri": {
|
33238
|
+
"type": "string",
|
33239
|
+
"id": 111
|
33228
33240
|
}
|
33229
33241
|
}
|
33230
33242
|
},
|
@@ -34519,9 +34531,21 @@
|
|
34519
34531
|
1001,
|
34520
34532
|
1001
|
34521
34533
|
],
|
34534
|
+
[
|
34535
|
+
1002,
|
34536
|
+
1002
|
34537
|
+
],
|
34538
|
+
[
|
34539
|
+
9990,
|
34540
|
+
9990
|
34541
|
+
],
|
34522
34542
|
[
|
34523
34543
|
9995,
|
34524
34544
|
9999
|
34545
|
+
],
|
34546
|
+
[
|
34547
|
+
10000,
|
34548
|
+
10000
|
34525
34549
|
]
|
34526
34550
|
],
|
34527
34551
|
"reserved": [
|
package/build/src/index.d.ts
CHANGED
@@ -33,7 +33,7 @@ declare const SiteSearchEngineServiceClient: typeof v1.SiteSearchEngineServiceCl
|
|
33
33
|
type SiteSearchEngineServiceClient = v1.SiteSearchEngineServiceClient;
|
34
34
|
declare const UserEventServiceClient: typeof v1.UserEventServiceClient;
|
35
35
|
type UserEventServiceClient = v1.UserEventServiceClient;
|
36
|
-
export { v1, v1alpha, v1beta, CompletionServiceClient, ControlServiceClient, ConversationalSearchServiceClient, DataStoreServiceClient, DocumentServiceClient, EngineServiceClient, GroundedGenerationServiceClient, ProjectServiceClient, RankServiceClient, RecommendationServiceClient, SchemaServiceClient, SearchServiceClient, SearchTuningServiceClient, ServingConfigServiceClient, SiteSearchEngineServiceClient, UserEventServiceClient
|
36
|
+
export { v1, v1alpha, v1beta, CompletionServiceClient, ControlServiceClient, ConversationalSearchServiceClient, DataStoreServiceClient, DocumentServiceClient, EngineServiceClient, GroundedGenerationServiceClient, ProjectServiceClient, RankServiceClient, RecommendationServiceClient, SchemaServiceClient, SearchServiceClient, SearchTuningServiceClient, ServingConfigServiceClient, SiteSearchEngineServiceClient, UserEventServiceClient };
|
37
37
|
declare const _default: {
|
38
38
|
v1: typeof v1;
|
39
39
|
v1alpha: typeof v1alpha;
|
package/build/src/index.js
CHANGED
@@ -56,27 +56,7 @@ const SiteSearchEngineServiceClient = v1.SiteSearchEngineServiceClient;
|
|
56
56
|
exports.SiteSearchEngineServiceClient = SiteSearchEngineServiceClient;
|
57
57
|
const UserEventServiceClient = v1.UserEventServiceClient;
|
58
58
|
exports.UserEventServiceClient = UserEventServiceClient;
|
59
|
-
exports.default = {
|
60
|
-
v1,
|
61
|
-
v1alpha,
|
62
|
-
v1beta,
|
63
|
-
CompletionServiceClient,
|
64
|
-
ControlServiceClient,
|
65
|
-
ConversationalSearchServiceClient,
|
66
|
-
DataStoreServiceClient,
|
67
|
-
DocumentServiceClient,
|
68
|
-
EngineServiceClient,
|
69
|
-
GroundedGenerationServiceClient,
|
70
|
-
ProjectServiceClient,
|
71
|
-
RankServiceClient,
|
72
|
-
RecommendationServiceClient,
|
73
|
-
SchemaServiceClient,
|
74
|
-
SearchServiceClient,
|
75
|
-
SearchTuningServiceClient,
|
76
|
-
ServingConfigServiceClient,
|
77
|
-
SiteSearchEngineServiceClient,
|
78
|
-
UserEventServiceClient,
|
79
|
-
};
|
59
|
+
exports.default = { v1, v1alpha, v1beta, CompletionServiceClient, ControlServiceClient, ConversationalSearchServiceClient, DataStoreServiceClient, DocumentServiceClient, EngineServiceClient, GroundedGenerationServiceClient, ProjectServiceClient, RankServiceClient, RecommendationServiceClient, SchemaServiceClient, SearchServiceClient, SearchTuningServiceClient, ServingConfigServiceClient, SiteSearchEngineServiceClient, UserEventServiceClient };
|
80
60
|
const protos = require("../protos/protos");
|
81
61
|
exports.protos = protos;
|
82
62
|
//# sourceMappingURL=index.js.map
|
@@ -365,86 +365,86 @@ export declare class CompletionServiceClient {
|
|
365
365
|
*/
|
366
366
|
checkPurgeCompletionSuggestionsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.PurgeCompletionSuggestionsResponse, protos.google.cloud.discoveryengine.v1.PurgeCompletionSuggestionsMetadata>>;
|
367
367
|
/**
|
368
|
-
|
369
|
-
|
370
|
-
|
371
|
-
|
372
|
-
|
373
|
-
|
374
|
-
|
375
|
-
|
376
|
-
|
377
|
-
|
378
|
-
|
379
|
-
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
|
368
|
+
* Gets information about a location.
|
369
|
+
*
|
370
|
+
* @param {Object} request
|
371
|
+
* The request object that will be sent.
|
372
|
+
* @param {string} request.name
|
373
|
+
* Resource name for the location.
|
374
|
+
* @param {object} [options]
|
375
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
|
376
|
+
* @returns {Promise} - The promise which resolves to an array.
|
377
|
+
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
|
378
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
379
|
+
* for more details and examples.
|
380
|
+
* @example
|
381
|
+
* ```
|
382
|
+
* const [response] = await client.getLocation(request);
|
383
|
+
* ```
|
384
|
+
*/
|
385
385
|
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>;
|
386
386
|
/**
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
|
395
|
-
|
396
|
-
|
397
|
-
|
398
|
-
|
399
|
-
|
400
|
-
|
401
|
-
|
402
|
-
|
403
|
-
|
404
|
-
|
405
|
-
|
406
|
-
|
407
|
-
|
408
|
-
|
409
|
-
|
410
|
-
|
411
|
-
|
412
|
-
|
413
|
-
|
414
|
-
|
415
|
-
|
416
|
-
|
387
|
+
* Lists information about the supported locations for this service. Returns an iterable object.
|
388
|
+
*
|
389
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
390
|
+
* @param {Object} request
|
391
|
+
* The request object that will be sent.
|
392
|
+
* @param {string} request.name
|
393
|
+
* The resource that owns the locations collection, if applicable.
|
394
|
+
* @param {string} request.filter
|
395
|
+
* The standard list filter.
|
396
|
+
* @param {number} request.pageSize
|
397
|
+
* The standard list page size.
|
398
|
+
* @param {string} request.pageToken
|
399
|
+
* The standard list page token.
|
400
|
+
* @param {object} [options]
|
401
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
402
|
+
* @returns {Object}
|
403
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
404
|
+
* When you iterate the returned iterable, each element will be an object representing
|
405
|
+
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
|
406
|
+
* so you can stop the iteration when you don't need more results.
|
407
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
408
|
+
* for more details and examples.
|
409
|
+
* @example
|
410
|
+
* ```
|
411
|
+
* const iterable = client.listLocationsAsync(request);
|
412
|
+
* for await (const response of iterable) {
|
413
|
+
* // process response
|
414
|
+
* }
|
415
|
+
* ```
|
416
|
+
*/
|
417
417
|
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
|
418
418
|
/**
|
419
|
-
|
420
|
-
|
421
|
-
|
422
|
-
|
423
|
-
|
424
|
-
|
425
|
-
|
426
|
-
|
427
|
-
|
428
|
-
|
429
|
-
|
430
|
-
|
431
|
-
|
432
|
-
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
440
|
-
|
441
|
-
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
|
447
|
-
|
419
|
+
* Gets the latest state of a long-running operation. Clients can use this
|
420
|
+
* method to poll the operation result at intervals as recommended by the API
|
421
|
+
* service.
|
422
|
+
*
|
423
|
+
* @param {Object} request - The request object that will be sent.
|
424
|
+
* @param {string} request.name - The name of the operation resource.
|
425
|
+
* @param {Object=} options
|
426
|
+
* Optional parameters. You can override the default settings for this call,
|
427
|
+
* e.g, timeout, retries, paginations, etc. See {@link
|
428
|
+
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
|
429
|
+
* for the details.
|
430
|
+
* @param {function(?Error, ?Object)=} callback
|
431
|
+
* The function which will be called with the result of the API call.
|
432
|
+
*
|
433
|
+
* The second parameter to the callback is an object representing
|
434
|
+
* {@link google.longrunning.Operation | google.longrunning.Operation}.
|
435
|
+
* @return {Promise} - The promise which resolves to an array.
|
436
|
+
* The first element of the array is an object representing
|
437
|
+
* {@link google.longrunning.Operation | google.longrunning.Operation}.
|
438
|
+
* The promise has a method named "cancel" which cancels the ongoing API call.
|
439
|
+
*
|
440
|
+
* @example
|
441
|
+
* ```
|
442
|
+
* const client = longrunning.operationsClient();
|
443
|
+
* const name = '';
|
444
|
+
* const [response] = await client.getOperation({name});
|
445
|
+
* // doThingsWith(response)
|
446
|
+
* ```
|
447
|
+
*/
|
448
448
|
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]>;
|
449
449
|
/**
|
450
450
|
* Lists operations that match the specified filter in the request. If the
|