@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
@@ -96,28 +96,18 @@ class RecommendationServiceClient {
|
|
96
96
|
*/
|
97
97
|
constructor(opts, gaxInstance) {
|
98
98
|
// Ensure that options include all the required fields.
|
99
|
-
const staticMembers = this
|
100
|
-
|
101
|
-
if (opts?.universe_domain &&
|
102
|
-
opts?.universeDomain &&
|
103
|
-
opts?.universe_domain !== opts?.universeDomain) {
|
99
|
+
const staticMembers = this.constructor;
|
100
|
+
if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
|
104
101
|
throw new Error('Please set either universe_domain or universeDomain, but not both.');
|
105
102
|
}
|
106
|
-
const universeDomainEnvVar = typeof process === 'object' && typeof process.env === 'object'
|
107
|
-
|
108
|
-
: undefined;
|
109
|
-
this._universeDomain =
|
110
|
-
opts?.universeDomain ??
|
111
|
-
opts?.universe_domain ??
|
112
|
-
universeDomainEnvVar ??
|
113
|
-
'googleapis.com';
|
103
|
+
const universeDomainEnvVar = (typeof process === 'object' && typeof process.env === 'object') ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN'] : undefined;
|
104
|
+
this._universeDomain = opts?.universeDomain ?? opts?.universe_domain ?? universeDomainEnvVar ?? 'googleapis.com';
|
114
105
|
this._servicePath = 'discoveryengine.' + this._universeDomain;
|
115
106
|
const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
|
116
107
|
this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
|
117
108
|
const port = opts?.port || staticMembers.port;
|
118
109
|
const clientConfig = opts?.clientConfig ?? {};
|
119
|
-
const fallback = opts?.fallback ??
|
120
|
-
(typeof window !== 'undefined' && typeof window?.fetch === 'function');
|
110
|
+
const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
|
121
111
|
opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
|
122
112
|
// Request numeric enum values if REST transport is used.
|
123
113
|
opts.numericEnums = true;
|
@@ -147,7 +137,10 @@ class RecommendationServiceClient {
|
|
147
137
|
}
|
148
138
|
this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
|
149
139
|
// Determine the client header string.
|
150
|
-
const clientHeader = [
|
140
|
+
const clientHeader = [
|
141
|
+
`gax/${this._gaxModule.version}`,
|
142
|
+
`gapic/${version}`,
|
143
|
+
];
|
151
144
|
if (typeof process === 'object' && 'versions' in process) {
|
152
145
|
clientHeader.push(`gl-node/${process.versions.node}`);
|
153
146
|
}
|
@@ -236,11 +229,10 @@ class RecommendationServiceClient {
|
|
236
229
|
}
|
237
230
|
// Put together the "service stub" for
|
238
231
|
// google.cloud.discoveryengine.v1beta.RecommendationService.
|
239
|
-
this.recommendationServiceStub = this._gaxGrpc.createStub(this._opts.fallback
|
240
|
-
|
241
|
-
|
242
|
-
|
243
|
-
.RecommendationService, this._opts, this._providedCustomServicePath);
|
232
|
+
this.recommendationServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
|
233
|
+
this._protos.lookupService('google.cloud.discoveryengine.v1beta.RecommendationService') :
|
234
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
235
|
+
this._protos.google.cloud.discoveryengine.v1beta.RecommendationService, this._opts, this._providedCustomServicePath);
|
244
236
|
// Iterate over each of the methods that the service provides
|
245
237
|
// and create an API call method for each.
|
246
238
|
const recommendationServiceStubMethods = ['recommend'];
|
@@ -266,8 +258,7 @@ class RecommendationServiceClient {
|
|
266
258
|
* @returns {string} The DNS address for this service.
|
267
259
|
*/
|
268
260
|
static get servicePath() {
|
269
|
-
if (typeof process === 'object' &&
|
270
|
-
typeof process.emitWarning === 'function') {
|
261
|
+
if (typeof process === 'object' && typeof process.emitWarning === 'function') {
|
271
262
|
process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
|
272
263
|
}
|
273
264
|
return 'discoveryengine.googleapis.com';
|
@@ -278,8 +269,7 @@ class RecommendationServiceClient {
|
|
278
269
|
* @returns {string} The DNS address for this service.
|
279
270
|
*/
|
280
271
|
static get apiEndpoint() {
|
281
|
-
if (typeof process === 'object' &&
|
282
|
-
typeof process.emitWarning === 'function') {
|
272
|
+
if (typeof process === 'object' && typeof process.emitWarning === 'function') {
|
283
273
|
process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
|
284
274
|
}
|
285
275
|
return 'discoveryengine.googleapis.com';
|
@@ -307,7 +297,9 @@ class RecommendationServiceClient {
|
|
307
297
|
* @returns {string[]} List of default scopes.
|
308
298
|
*/
|
309
299
|
static get scopes() {
|
310
|
-
return [
|
300
|
+
return [
|
301
|
+
'https://www.googleapis.com/auth/cloud-platform'
|
302
|
+
];
|
311
303
|
}
|
312
304
|
/**
|
313
305
|
* Return the project ID used by this class.
|
@@ -333,13 +325,10 @@ class RecommendationServiceClient {
|
|
333
325
|
options = options || {};
|
334
326
|
options.otherArgs = options.otherArgs || {};
|
335
327
|
options.otherArgs.headers = options.otherArgs.headers || {};
|
336
|
-
options.otherArgs.headers['x-goog-request-params'] =
|
337
|
-
|
338
|
-
serving_config: request.servingConfig ?? '',
|
339
|
-
});
|
340
|
-
this.initialize().catch(err => {
|
341
|
-
throw err;
|
328
|
+
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
|
329
|
+
'serving_config': request.servingConfig ?? '',
|
342
330
|
});
|
331
|
+
this.initialize().catch(err => { throw err; });
|
343
332
|
this._log.info('recommend request %j', request);
|
344
333
|
const wrappedCallback = callback
|
345
334
|
? (error, response, options, rawResponse) => {
|
@@ -347,65 +336,64 @@ class RecommendationServiceClient {
|
|
347
336
|
callback(error, response, options, rawResponse); // We verified callback above.
|
348
337
|
}
|
349
338
|
: undefined;
|
350
|
-
return this.innerApiCalls
|
351
|
-
.recommend(request, options, wrappedCallback)
|
339
|
+
return this.innerApiCalls.recommend(request, options, wrappedCallback)
|
352
340
|
?.then(([response, options, rawResponse]) => {
|
353
341
|
this._log.info('recommend response %j', response);
|
354
342
|
return [response, options, rawResponse];
|
355
343
|
});
|
356
344
|
}
|
357
345
|
/**
|
358
|
-
|
359
|
-
|
360
|
-
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
369
|
-
|
370
|
-
|
371
|
-
|
372
|
-
|
373
|
-
|
374
|
-
|
346
|
+
* Gets information about a location.
|
347
|
+
*
|
348
|
+
* @param {Object} request
|
349
|
+
* The request object that will be sent.
|
350
|
+
* @param {string} request.name
|
351
|
+
* Resource name for the location.
|
352
|
+
* @param {object} [options]
|
353
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
|
354
|
+
* @returns {Promise} - The promise which resolves to an array.
|
355
|
+
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
|
356
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
357
|
+
* for more details and examples.
|
358
|
+
* @example
|
359
|
+
* ```
|
360
|
+
* const [response] = await client.getLocation(request);
|
361
|
+
* ```
|
362
|
+
*/
|
375
363
|
getLocation(request, options, callback) {
|
376
364
|
return this.locationsClient.getLocation(request, options, callback);
|
377
365
|
}
|
378
366
|
/**
|
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
|
-
|
367
|
+
* Lists information about the supported locations for this service. Returns an iterable object.
|
368
|
+
*
|
369
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
370
|
+
* @param {Object} request
|
371
|
+
* The request object that will be sent.
|
372
|
+
* @param {string} request.name
|
373
|
+
* The resource that owns the locations collection, if applicable.
|
374
|
+
* @param {string} request.filter
|
375
|
+
* The standard list filter.
|
376
|
+
* @param {number} request.pageSize
|
377
|
+
* The standard list page size.
|
378
|
+
* @param {string} request.pageToken
|
379
|
+
* The standard list page token.
|
380
|
+
* @param {object} [options]
|
381
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
382
|
+
* @returns {Object}
|
383
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
384
|
+
* When you iterate the returned iterable, each element will be an object representing
|
385
|
+
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
|
386
|
+
* so you can stop the iteration when you don't need more results.
|
387
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
388
|
+
* for more details and examples.
|
389
|
+
* @example
|
390
|
+
* ```
|
391
|
+
* const iterable = client.listLocationsAsync(request);
|
392
|
+
* for await (const response of iterable) {
|
393
|
+
* // process response
|
394
|
+
* }
|
395
|
+
* ```
|
396
|
+
*/
|
409
397
|
listLocationsAsync(request, options) {
|
410
398
|
return this.locationsClient.listLocationsAsync(request, options);
|
411
399
|
}
|
@@ -492,8 +480,7 @@ class RecommendationServiceClient {
|
|
492
480
|
* @returns {string} A string representing the project.
|
493
481
|
*/
|
494
482
|
matchProjectFromEvaluationName(evaluationName) {
|
495
|
-
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
496
|
-
.project;
|
483
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName).project;
|
497
484
|
}
|
498
485
|
/**
|
499
486
|
* Parse the location from Evaluation resource.
|
@@ -503,8 +490,7 @@ class RecommendationServiceClient {
|
|
503
490
|
* @returns {string} A string representing the location.
|
504
491
|
*/
|
505
492
|
matchLocationFromEvaluationName(evaluationName) {
|
506
|
-
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
507
|
-
.location;
|
493
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName).location;
|
508
494
|
}
|
509
495
|
/**
|
510
496
|
* Parse the evaluation from Evaluation resource.
|
@@ -514,8 +500,7 @@ class RecommendationServiceClient {
|
|
514
500
|
* @returns {string} A string representing the evaluation.
|
515
501
|
*/
|
516
502
|
matchEvaluationFromEvaluationName(evaluationName) {
|
517
|
-
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
518
|
-
.evaluation;
|
503
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName).evaluation;
|
519
504
|
}
|
520
505
|
/**
|
521
506
|
* Return a fully-qualified groundingConfig resource name string.
|
@@ -2753,8 +2738,7 @@ class RecommendationServiceClient {
|
|
2753
2738
|
* @returns {string} A string representing the project.
|
2754
2739
|
*/
|
2755
2740
|
matchProjectFromSampleQueryName(sampleQueryName) {
|
2756
|
-
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2757
|
-
.project;
|
2741
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).project;
|
2758
2742
|
}
|
2759
2743
|
/**
|
2760
2744
|
* Parse the location from SampleQuery resource.
|
@@ -2764,8 +2748,7 @@ class RecommendationServiceClient {
|
|
2764
2748
|
* @returns {string} A string representing the location.
|
2765
2749
|
*/
|
2766
2750
|
matchLocationFromSampleQueryName(sampleQueryName) {
|
2767
|
-
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2768
|
-
.location;
|
2751
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).location;
|
2769
2752
|
}
|
2770
2753
|
/**
|
2771
2754
|
* Parse the sample_query_set from SampleQuery resource.
|
@@ -2775,8 +2758,7 @@ class RecommendationServiceClient {
|
|
2775
2758
|
* @returns {string} A string representing the sample_query_set.
|
2776
2759
|
*/
|
2777
2760
|
matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
|
2778
|
-
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2779
|
-
.sample_query_set;
|
2761
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).sample_query_set;
|
2780
2762
|
}
|
2781
2763
|
/**
|
2782
2764
|
* Parse the sample_query from SampleQuery resource.
|
@@ -2786,8 +2768,7 @@ class RecommendationServiceClient {
|
|
2786
2768
|
* @returns {string} A string representing the sample_query.
|
2787
2769
|
*/
|
2788
2770
|
matchSampleQueryFromSampleQueryName(sampleQueryName) {
|
2789
|
-
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2790
|
-
.sample_query;
|
2771
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).sample_query;
|
2791
2772
|
}
|
2792
2773
|
/**
|
2793
2774
|
* Return a fully-qualified sampleQuerySet resource name string.
|
@@ -2846,7 +2827,7 @@ class RecommendationServiceClient {
|
|
2846
2827
|
this._log.info('ending gRPC channel');
|
2847
2828
|
this._terminated = true;
|
2848
2829
|
stub.close();
|
2849
|
-
this.locationsClient.close();
|
2830
|
+
this.locationsClient.close().catch(err => { throw err; });
|
2850
2831
|
});
|
2851
2832
|
}
|
2852
2833
|
return Promise.resolve();
|
@@ -146,7 +146,7 @@ export declare class SampleQueryServiceClient {
|
|
146
146
|
*/
|
147
147
|
getSampleQuery(request?: protos.google.cloud.discoveryengine.v1beta.IGetSampleQueryRequest, options?: CallOptions): Promise<[
|
148
148
|
protos.google.cloud.discoveryengine.v1beta.ISampleQuery,
|
149
|
-
|
149
|
+
protos.google.cloud.discoveryengine.v1beta.IGetSampleQueryRequest | undefined,
|
150
150
|
{} | undefined
|
151
151
|
]>;
|
152
152
|
getSampleQuery(request: protos.google.cloud.discoveryengine.v1beta.IGetSampleQueryRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ISampleQuery, protos.google.cloud.discoveryengine.v1beta.IGetSampleQueryRequest | null | undefined, {} | null | undefined>): void;
|
@@ -192,7 +192,7 @@ export declare class SampleQueryServiceClient {
|
|
192
192
|
*/
|
193
193
|
createSampleQuery(request?: protos.google.cloud.discoveryengine.v1beta.ICreateSampleQueryRequest, options?: CallOptions): Promise<[
|
194
194
|
protos.google.cloud.discoveryengine.v1beta.ISampleQuery,
|
195
|
-
|
195
|
+
protos.google.cloud.discoveryengine.v1beta.ICreateSampleQueryRequest | undefined,
|
196
196
|
{} | undefined
|
197
197
|
]>;
|
198
198
|
createSampleQuery(request: protos.google.cloud.discoveryengine.v1beta.ICreateSampleQueryRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ISampleQuery, protos.google.cloud.discoveryengine.v1beta.ICreateSampleQueryRequest | null | undefined, {} | null | undefined>): void;
|
@@ -225,7 +225,7 @@ export declare class SampleQueryServiceClient {
|
|
225
225
|
*/
|
226
226
|
updateSampleQuery(request?: protos.google.cloud.discoveryengine.v1beta.IUpdateSampleQueryRequest, options?: CallOptions): Promise<[
|
227
227
|
protos.google.cloud.discoveryengine.v1beta.ISampleQuery,
|
228
|
-
|
228
|
+
protos.google.cloud.discoveryengine.v1beta.IUpdateSampleQueryRequest | undefined,
|
229
229
|
{} | undefined
|
230
230
|
]>;
|
231
231
|
updateSampleQuery(request: protos.google.cloud.discoveryengine.v1beta.IUpdateSampleQueryRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ISampleQuery, protos.google.cloud.discoveryengine.v1beta.IUpdateSampleQueryRequest | null | undefined, {} | null | undefined>): void;
|
@@ -257,7 +257,7 @@ export declare class SampleQueryServiceClient {
|
|
257
257
|
*/
|
258
258
|
deleteSampleQuery(request?: protos.google.cloud.discoveryengine.v1beta.IDeleteSampleQueryRequest, options?: CallOptions): Promise<[
|
259
259
|
protos.google.protobuf.IEmpty,
|
260
|
-
|
260
|
+
protos.google.cloud.discoveryengine.v1beta.IDeleteSampleQueryRequest | undefined,
|
261
261
|
{} | undefined
|
262
262
|
]>;
|
263
263
|
deleteSampleQuery(request: protos.google.cloud.discoveryengine.v1beta.IDeleteSampleQueryRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1beta.IDeleteSampleQueryRequest | null | undefined, {} | null | undefined>): void;
|
@@ -320,49 +320,49 @@ export declare class SampleQueryServiceClient {
|
|
320
320
|
*/
|
321
321
|
checkImportSampleQueriesProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.ImportSampleQueriesResponse, protos.google.cloud.discoveryengine.v1beta.ImportSampleQueriesMetadata>>;
|
322
322
|
/**
|
323
|
-
|
324
|
-
|
325
|
-
|
326
|
-
|
327
|
-
|
328
|
-
|
329
|
-
|
330
|
-
|
331
|
-
|
332
|
-
|
333
|
-
|
334
|
-
|
335
|
-
|
336
|
-
|
337
|
-
|
338
|
-
|
339
|
-
|
340
|
-
|
341
|
-
|
342
|
-
|
343
|
-
|
344
|
-
|
345
|
-
|
346
|
-
|
347
|
-
|
348
|
-
|
349
|
-
|
350
|
-
|
351
|
-
|
352
|
-
|
353
|
-
|
354
|
-
|
355
|
-
|
356
|
-
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
323
|
+
* Gets a list of
|
324
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SampleQuery|SampleQuery}s.
|
325
|
+
*
|
326
|
+
* @param {Object} request
|
327
|
+
* The request object that will be sent.
|
328
|
+
* @param {string} request.parent
|
329
|
+
* Required. The parent sample query set resource name, such as
|
330
|
+
* `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
|
331
|
+
*
|
332
|
+
* If the caller does not have permission to list
|
333
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SampleQuery|SampleQuery}s under this
|
334
|
+
* sample query set, regardless of whether or not this sample query set
|
335
|
+
* exists, a `PERMISSION_DENIED` error is returned.
|
336
|
+
* @param {number} request.pageSize
|
337
|
+
* Maximum number of
|
338
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SampleQuery|SampleQuery}s to return.
|
339
|
+
* If unspecified, defaults to 100. The maximum allowed value is 1000. Values
|
340
|
+
* above 1000 will be coerced to 1000.
|
341
|
+
*
|
342
|
+
* If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
343
|
+
* @param {string} request.pageToken
|
344
|
+
* A page token
|
345
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.ListSampleQueriesResponse.next_page_token|ListSampleQueriesResponse.next_page_token},
|
346
|
+
* received from a previous
|
347
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries|SampleQueryService.ListSampleQueries}
|
348
|
+
* call. Provide this to retrieve the subsequent page.
|
349
|
+
*
|
350
|
+
* When paginating, all other parameters provided to
|
351
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SampleQueryService.ListSampleQueries|SampleQueryService.ListSampleQueries}
|
352
|
+
* must match the call that provided the page token. Otherwise, an
|
353
|
+
* `INVALID_ARGUMENT` error is returned.
|
354
|
+
* @param {object} [options]
|
355
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
356
|
+
* @returns {Promise} - The promise which resolves to an array.
|
357
|
+
* The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1beta.SampleQuery|SampleQuery}.
|
358
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
359
|
+
* times as needed and will merge results from all the pages into this array.
|
360
|
+
* Note that it can affect your quota.
|
361
|
+
* We recommend using `listSampleQueriesAsync()`
|
362
|
+
* method described below for async iteration which you can stop as needed.
|
363
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
364
|
+
* for more details and examples.
|
365
|
+
*/
|
366
366
|
listSampleQueries(request?: protos.google.cloud.discoveryengine.v1beta.IListSampleQueriesRequest, options?: CallOptions): Promise<[
|
367
367
|
protos.google.cloud.discoveryengine.v1beta.ISampleQuery[],
|
368
368
|
protos.google.cloud.discoveryengine.v1beta.IListSampleQueriesRequest | null,
|
@@ -458,86 +458,86 @@ export declare class SampleQueryServiceClient {
|
|
458
458
|
*/
|
459
459
|
listSampleQueriesAsync(request?: protos.google.cloud.discoveryengine.v1beta.IListSampleQueriesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1beta.ISampleQuery>;
|
460
460
|
/**
|
461
|
-
|
462
|
-
|
463
|
-
|
464
|
-
|
465
|
-
|
466
|
-
|
467
|
-
|
468
|
-
|
469
|
-
|
470
|
-
|
471
|
-
|
472
|
-
|
473
|
-
|
474
|
-
|
475
|
-
|
476
|
-
|
477
|
-
|
461
|
+
* Gets information about a location.
|
462
|
+
*
|
463
|
+
* @param {Object} request
|
464
|
+
* The request object that will be sent.
|
465
|
+
* @param {string} request.name
|
466
|
+
* Resource name for the location.
|
467
|
+
* @param {object} [options]
|
468
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
|
469
|
+
* @returns {Promise} - The promise which resolves to an array.
|
470
|
+
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
|
471
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
472
|
+
* for more details and examples.
|
473
|
+
* @example
|
474
|
+
* ```
|
475
|
+
* const [response] = await client.getLocation(request);
|
476
|
+
* ```
|
477
|
+
*/
|
478
478
|
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>;
|
479
479
|
/**
|
480
|
-
|
481
|
-
|
482
|
-
|
483
|
-
|
484
|
-
|
485
|
-
|
486
|
-
|
487
|
-
|
488
|
-
|
489
|
-
|
490
|
-
|
491
|
-
|
492
|
-
|
493
|
-
|
494
|
-
|
495
|
-
|
496
|
-
|
497
|
-
|
498
|
-
|
499
|
-
|
500
|
-
|
501
|
-
|
502
|
-
|
503
|
-
|
504
|
-
|
505
|
-
|
506
|
-
|
507
|
-
|
508
|
-
|
509
|
-
|
480
|
+
* Lists information about the supported locations for this service. Returns an iterable object.
|
481
|
+
*
|
482
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
483
|
+
* @param {Object} request
|
484
|
+
* The request object that will be sent.
|
485
|
+
* @param {string} request.name
|
486
|
+
* The resource that owns the locations collection, if applicable.
|
487
|
+
* @param {string} request.filter
|
488
|
+
* The standard list filter.
|
489
|
+
* @param {number} request.pageSize
|
490
|
+
* The standard list page size.
|
491
|
+
* @param {string} request.pageToken
|
492
|
+
* The standard list page token.
|
493
|
+
* @param {object} [options]
|
494
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
495
|
+
* @returns {Object}
|
496
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
497
|
+
* When you iterate the returned iterable, each element will be an object representing
|
498
|
+
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
|
499
|
+
* so you can stop the iteration when you don't need more results.
|
500
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
501
|
+
* for more details and examples.
|
502
|
+
* @example
|
503
|
+
* ```
|
504
|
+
* const iterable = client.listLocationsAsync(request);
|
505
|
+
* for await (const response of iterable) {
|
506
|
+
* // process response
|
507
|
+
* }
|
508
|
+
* ```
|
509
|
+
*/
|
510
510
|
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
|
511
511
|
/**
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
|
516
|
-
|
517
|
-
|
518
|
-
|
519
|
-
|
520
|
-
|
521
|
-
|
522
|
-
|
523
|
-
|
524
|
-
|
525
|
-
|
526
|
-
|
527
|
-
|
528
|
-
|
529
|
-
|
530
|
-
|
531
|
-
|
532
|
-
|
533
|
-
|
534
|
-
|
535
|
-
|
536
|
-
|
537
|
-
|
538
|
-
|
539
|
-
|
540
|
-
|
512
|
+
* Gets the latest state of a long-running operation. Clients can use this
|
513
|
+
* method to poll the operation result at intervals as recommended by the API
|
514
|
+
* service.
|
515
|
+
*
|
516
|
+
* @param {Object} request - The request object that will be sent.
|
517
|
+
* @param {string} request.name - The name of the operation resource.
|
518
|
+
* @param {Object=} options
|
519
|
+
* Optional parameters. You can override the default settings for this call,
|
520
|
+
* e.g, timeout, retries, paginations, etc. See {@link
|
521
|
+
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
|
522
|
+
* for the details.
|
523
|
+
* @param {function(?Error, ?Object)=} callback
|
524
|
+
* The function which will be called with the result of the API call.
|
525
|
+
*
|
526
|
+
* The second parameter to the callback is an object representing
|
527
|
+
* {@link google.longrunning.Operation | google.longrunning.Operation}.
|
528
|
+
* @return {Promise} - The promise which resolves to an array.
|
529
|
+
* The first element of the array is an object representing
|
530
|
+
* {@link google.longrunning.Operation | google.longrunning.Operation}.
|
531
|
+
* The promise has a method named "cancel" which cancels the ongoing API call.
|
532
|
+
*
|
533
|
+
* @example
|
534
|
+
* ```
|
535
|
+
* const client = longrunning.operationsClient();
|
536
|
+
* const name = '';
|
537
|
+
* const [response] = await client.getOperation({name});
|
538
|
+
* // doThingsWith(response)
|
539
|
+
* ```
|
540
|
+
*/
|
541
541
|
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]>;
|
542
542
|
/**
|
543
543
|
* Lists operations that match the specified filter in the request. If the
|