@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
@@ -175,55 +175,55 @@ export declare class RankServiceClient {
|
|
175
175
|
rank(request: protos.google.cloud.discoveryengine.v1alpha.IRankRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IRankResponse, protos.google.cloud.discoveryengine.v1alpha.IRankRequest | null | undefined, {} | null | undefined>): void;
|
176
176
|
rank(request: protos.google.cloud.discoveryengine.v1alpha.IRankRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IRankResponse, protos.google.cloud.discoveryengine.v1alpha.IRankRequest | null | undefined, {} | null | undefined>): void;
|
177
177
|
/**
|
178
|
-
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
|
185
|
-
|
186
|
-
|
187
|
-
|
188
|
-
|
189
|
-
|
190
|
-
|
191
|
-
|
192
|
-
|
193
|
-
|
194
|
-
|
178
|
+
* Gets information about a location.
|
179
|
+
*
|
180
|
+
* @param {Object} request
|
181
|
+
* The request object that will be sent.
|
182
|
+
* @param {string} request.name
|
183
|
+
* Resource name for the location.
|
184
|
+
* @param {object} [options]
|
185
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
|
186
|
+
* @returns {Promise} - The promise which resolves to an array.
|
187
|
+
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
|
188
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
189
|
+
* for more details and examples.
|
190
|
+
* @example
|
191
|
+
* ```
|
192
|
+
* const [response] = await client.getLocation(request);
|
193
|
+
* ```
|
194
|
+
*/
|
195
195
|
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>;
|
196
196
|
/**
|
197
|
-
|
198
|
-
|
199
|
-
|
200
|
-
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
|
209
|
-
|
210
|
-
|
211
|
-
|
212
|
-
|
213
|
-
|
214
|
-
|
215
|
-
|
216
|
-
|
217
|
-
|
218
|
-
|
219
|
-
|
220
|
-
|
221
|
-
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
|
226
|
-
|
197
|
+
* Lists information about the supported locations for this service. Returns an iterable object.
|
198
|
+
*
|
199
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
200
|
+
* @param {Object} request
|
201
|
+
* The request object that will be sent.
|
202
|
+
* @param {string} request.name
|
203
|
+
* The resource that owns the locations collection, if applicable.
|
204
|
+
* @param {string} request.filter
|
205
|
+
* The standard list filter.
|
206
|
+
* @param {number} request.pageSize
|
207
|
+
* The standard list page size.
|
208
|
+
* @param {string} request.pageToken
|
209
|
+
* The standard list page token.
|
210
|
+
* @param {object} [options]
|
211
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
212
|
+
* @returns {Object}
|
213
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
214
|
+
* When you iterate the returned iterable, each element will be an object representing
|
215
|
+
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
|
216
|
+
* so you can stop the iteration when you don't need more results.
|
217
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
218
|
+
* for more details and examples.
|
219
|
+
* @example
|
220
|
+
* ```
|
221
|
+
* const iterable = client.listLocationsAsync(request);
|
222
|
+
* for await (const response of iterable) {
|
223
|
+
* // process response
|
224
|
+
* }
|
225
|
+
* ```
|
226
|
+
*/
|
227
227
|
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
|
228
228
|
/**
|
229
229
|
* Return a fully-qualified aclConfig resource name string.
|
@@ -97,26 +97,17 @@ class RankServiceClient {
|
|
97
97
|
constructor(opts, gaxInstance) {
|
98
98
|
// Ensure that options include all the required fields.
|
99
99
|
const staticMembers = this.constructor;
|
100
|
-
if (opts?.universe_domain &&
|
101
|
-
opts?.universeDomain &&
|
102
|
-
opts?.universe_domain !== opts?.universeDomain) {
|
100
|
+
if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
|
103
101
|
throw new Error('Please set either universe_domain or universeDomain, but not both.');
|
104
102
|
}
|
105
|
-
const universeDomainEnvVar = typeof process === 'object' && typeof process.env === 'object'
|
106
|
-
|
107
|
-
: undefined;
|
108
|
-
this._universeDomain =
|
109
|
-
opts?.universeDomain ??
|
110
|
-
opts?.universe_domain ??
|
111
|
-
universeDomainEnvVar ??
|
112
|
-
'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';
|
113
105
|
this._servicePath = 'discoveryengine.' + this._universeDomain;
|
114
106
|
const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
|
115
107
|
this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
|
116
108
|
const port = opts?.port || staticMembers.port;
|
117
109
|
const clientConfig = opts?.clientConfig ?? {};
|
118
|
-
const fallback = opts?.fallback ??
|
119
|
-
(typeof window !== 'undefined' && typeof window?.fetch === 'function');
|
110
|
+
const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
|
120
111
|
opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
|
121
112
|
// Request numeric enum values if REST transport is used.
|
122
113
|
opts.numericEnums = true;
|
@@ -146,7 +137,10 @@ class RankServiceClient {
|
|
146
137
|
}
|
147
138
|
this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
|
148
139
|
// Determine the client header string.
|
149
|
-
const clientHeader = [
|
140
|
+
const clientHeader = [
|
141
|
+
`gax/${this._gaxModule.version}`,
|
142
|
+
`gapic/${version}`,
|
143
|
+
];
|
150
144
|
if (typeof process === 'object' && 'versions' in process) {
|
151
145
|
clientHeader.push(`gl-node/${process.versions.node}`);
|
152
146
|
}
|
@@ -234,11 +228,10 @@ class RankServiceClient {
|
|
234
228
|
}
|
235
229
|
// Put together the "service stub" for
|
236
230
|
// google.cloud.discoveryengine.v1alpha.RankService.
|
237
|
-
this.rankServiceStub = this._gaxGrpc.createStub(this._opts.fallback
|
238
|
-
|
239
|
-
|
240
|
-
|
241
|
-
.RankService, this._opts, this._providedCustomServicePath);
|
231
|
+
this.rankServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
|
232
|
+
this._protos.lookupService('google.cloud.discoveryengine.v1alpha.RankService') :
|
233
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
234
|
+
this._protos.google.cloud.discoveryengine.v1alpha.RankService, this._opts, this._providedCustomServicePath);
|
242
235
|
// Iterate over each of the methods that the service provides
|
243
236
|
// and create an API call method for each.
|
244
237
|
const rankServiceStubMethods = ['rank'];
|
@@ -264,8 +257,7 @@ class RankServiceClient {
|
|
264
257
|
* @returns {string} The DNS address for this service.
|
265
258
|
*/
|
266
259
|
static get servicePath() {
|
267
|
-
if (typeof process === 'object' &&
|
268
|
-
typeof process.emitWarning === 'function') {
|
260
|
+
if (typeof process === 'object' && typeof process.emitWarning === 'function') {
|
269
261
|
process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
|
270
262
|
}
|
271
263
|
return 'discoveryengine.googleapis.com';
|
@@ -276,8 +268,7 @@ class RankServiceClient {
|
|
276
268
|
* @returns {string} The DNS address for this service.
|
277
269
|
*/
|
278
270
|
static get apiEndpoint() {
|
279
|
-
if (typeof process === 'object' &&
|
280
|
-
typeof process.emitWarning === 'function') {
|
271
|
+
if (typeof process === 'object' && typeof process.emitWarning === 'function') {
|
281
272
|
process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
|
282
273
|
}
|
283
274
|
return 'discoveryengine.googleapis.com';
|
@@ -305,7 +296,9 @@ class RankServiceClient {
|
|
305
296
|
* @returns {string[]} List of default scopes.
|
306
297
|
*/
|
307
298
|
static get scopes() {
|
308
|
-
return [
|
299
|
+
return [
|
300
|
+
'https://www.googleapis.com/auth/cloud-platform'
|
301
|
+
];
|
309
302
|
}
|
310
303
|
/**
|
311
304
|
* Return the project ID used by this class.
|
@@ -331,13 +324,10 @@ class RankServiceClient {
|
|
331
324
|
options = options || {};
|
332
325
|
options.otherArgs = options.otherArgs || {};
|
333
326
|
options.otherArgs.headers = options.otherArgs.headers || {};
|
334
|
-
options.otherArgs.headers['x-goog-request-params'] =
|
335
|
-
|
336
|
-
ranking_config: request.rankingConfig ?? '',
|
337
|
-
});
|
338
|
-
this.initialize().catch(err => {
|
339
|
-
throw err;
|
327
|
+
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
|
328
|
+
'ranking_config': request.rankingConfig ?? '',
|
340
329
|
});
|
330
|
+
this.initialize().catch(err => { throw err; });
|
341
331
|
this._log.info('rank request %j', request);
|
342
332
|
const wrappedCallback = callback
|
343
333
|
? (error, response, options, rawResponse) => {
|
@@ -345,65 +335,64 @@ class RankServiceClient {
|
|
345
335
|
callback(error, response, options, rawResponse); // We verified callback above.
|
346
336
|
}
|
347
337
|
: undefined;
|
348
|
-
return this.innerApiCalls
|
349
|
-
.rank(request, options, wrappedCallback)
|
338
|
+
return this.innerApiCalls.rank(request, options, wrappedCallback)
|
350
339
|
?.then(([response, options, rawResponse]) => {
|
351
340
|
this._log.info('rank response %j', response);
|
352
341
|
return [response, options, rawResponse];
|
353
342
|
});
|
354
343
|
}
|
355
344
|
/**
|
356
|
-
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
369
|
-
|
370
|
-
|
371
|
-
|
372
|
-
|
345
|
+
* Gets information about a location.
|
346
|
+
*
|
347
|
+
* @param {Object} request
|
348
|
+
* The request object that will be sent.
|
349
|
+
* @param {string} request.name
|
350
|
+
* Resource name for the location.
|
351
|
+
* @param {object} [options]
|
352
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
|
353
|
+
* @returns {Promise} - The promise which resolves to an array.
|
354
|
+
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
|
355
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
356
|
+
* for more details and examples.
|
357
|
+
* @example
|
358
|
+
* ```
|
359
|
+
* const [response] = await client.getLocation(request);
|
360
|
+
* ```
|
361
|
+
*/
|
373
362
|
getLocation(request, options, callback) {
|
374
363
|
return this.locationsClient.getLocation(request, options, callback);
|
375
364
|
}
|
376
365
|
/**
|
377
|
-
|
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
|
-
|
366
|
+
* Lists information about the supported locations for this service. Returns an iterable object.
|
367
|
+
*
|
368
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
369
|
+
* @param {Object} request
|
370
|
+
* The request object that will be sent.
|
371
|
+
* @param {string} request.name
|
372
|
+
* The resource that owns the locations collection, if applicable.
|
373
|
+
* @param {string} request.filter
|
374
|
+
* The standard list filter.
|
375
|
+
* @param {number} request.pageSize
|
376
|
+
* The standard list page size.
|
377
|
+
* @param {string} request.pageToken
|
378
|
+
* The standard list page token.
|
379
|
+
* @param {object} [options]
|
380
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
381
|
+
* @returns {Object}
|
382
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
383
|
+
* When you iterate the returned iterable, each element will be an object representing
|
384
|
+
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
|
385
|
+
* so you can stop the iteration when you don't need more results.
|
386
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
387
|
+
* for more details and examples.
|
388
|
+
* @example
|
389
|
+
* ```
|
390
|
+
* const iterable = client.listLocationsAsync(request);
|
391
|
+
* for await (const response of iterable) {
|
392
|
+
* // process response
|
393
|
+
* }
|
394
|
+
* ```
|
395
|
+
*/
|
407
396
|
listLocationsAsync(request, options) {
|
408
397
|
return this.locationsClient.listLocationsAsync(request, options);
|
409
398
|
}
|
@@ -431,8 +420,7 @@ class RankServiceClient {
|
|
431
420
|
* @returns {string} A string representing the project.
|
432
421
|
*/
|
433
422
|
matchProjectFromAclConfigName(aclConfigName) {
|
434
|
-
return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName)
|
435
|
-
.project;
|
423
|
+
return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName).project;
|
436
424
|
}
|
437
425
|
/**
|
438
426
|
* Parse the location from AclConfig resource.
|
@@ -442,8 +430,7 @@ class RankServiceClient {
|
|
442
430
|
* @returns {string} A string representing the location.
|
443
431
|
*/
|
444
432
|
matchLocationFromAclConfigName(aclConfigName) {
|
445
|
-
return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName)
|
446
|
-
.location;
|
433
|
+
return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName).location;
|
447
434
|
}
|
448
435
|
/**
|
449
436
|
* Return a fully-qualified engine resource name string.
|
@@ -525,8 +512,7 @@ class RankServiceClient {
|
|
525
512
|
* @returns {string} A string representing the project.
|
526
513
|
*/
|
527
514
|
matchProjectFromEvaluationName(evaluationName) {
|
528
|
-
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
529
|
-
.project;
|
515
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName).project;
|
530
516
|
}
|
531
517
|
/**
|
532
518
|
* Parse the location from Evaluation resource.
|
@@ -536,8 +522,7 @@ class RankServiceClient {
|
|
536
522
|
* @returns {string} A string representing the location.
|
537
523
|
*/
|
538
524
|
matchLocationFromEvaluationName(evaluationName) {
|
539
|
-
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
540
|
-
.location;
|
525
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName).location;
|
541
526
|
}
|
542
527
|
/**
|
543
528
|
* Parse the evaluation from Evaluation resource.
|
@@ -547,8 +532,7 @@ class RankServiceClient {
|
|
547
532
|
* @returns {string} A string representing the evaluation.
|
548
533
|
*/
|
549
534
|
matchEvaluationFromEvaluationName(evaluationName) {
|
550
|
-
return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
|
551
|
-
.evaluation;
|
535
|
+
return this.pathTemplates.evaluationPathTemplate.match(evaluationName).evaluation;
|
552
536
|
}
|
553
537
|
/**
|
554
538
|
* Return a fully-qualified project resource name string.
|
@@ -2613,8 +2597,7 @@ class RankServiceClient {
|
|
2613
2597
|
* @returns {string} A string representing the project.
|
2614
2598
|
*/
|
2615
2599
|
matchProjectFromRankingConfigName(rankingConfigName) {
|
2616
|
-
return this.pathTemplates.rankingConfigPathTemplate.match(rankingConfigName)
|
2617
|
-
.project;
|
2600
|
+
return this.pathTemplates.rankingConfigPathTemplate.match(rankingConfigName).project;
|
2618
2601
|
}
|
2619
2602
|
/**
|
2620
2603
|
* Parse the location from RankingConfig resource.
|
@@ -2624,8 +2607,7 @@ class RankServiceClient {
|
|
2624
2607
|
* @returns {string} A string representing the location.
|
2625
2608
|
*/
|
2626
2609
|
matchLocationFromRankingConfigName(rankingConfigName) {
|
2627
|
-
return this.pathTemplates.rankingConfigPathTemplate.match(rankingConfigName)
|
2628
|
-
.location;
|
2610
|
+
return this.pathTemplates.rankingConfigPathTemplate.match(rankingConfigName).location;
|
2629
2611
|
}
|
2630
2612
|
/**
|
2631
2613
|
* Parse the ranking_config from RankingConfig resource.
|
@@ -2635,8 +2617,7 @@ class RankServiceClient {
|
|
2635
2617
|
* @returns {string} A string representing the ranking_config.
|
2636
2618
|
*/
|
2637
2619
|
matchRankingConfigFromRankingConfigName(rankingConfigName) {
|
2638
|
-
return this.pathTemplates.rankingConfigPathTemplate.match(rankingConfigName)
|
2639
|
-
.ranking_config;
|
2620
|
+
return this.pathTemplates.rankingConfigPathTemplate.match(rankingConfigName).ranking_config;
|
2640
2621
|
}
|
2641
2622
|
/**
|
2642
2623
|
* Return a fully-qualified sampleQuery resource name string.
|
@@ -2663,8 +2644,7 @@ class RankServiceClient {
|
|
2663
2644
|
* @returns {string} A string representing the project.
|
2664
2645
|
*/
|
2665
2646
|
matchProjectFromSampleQueryName(sampleQueryName) {
|
2666
|
-
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2667
|
-
.project;
|
2647
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).project;
|
2668
2648
|
}
|
2669
2649
|
/**
|
2670
2650
|
* Parse the location from SampleQuery resource.
|
@@ -2674,8 +2654,7 @@ class RankServiceClient {
|
|
2674
2654
|
* @returns {string} A string representing the location.
|
2675
2655
|
*/
|
2676
2656
|
matchLocationFromSampleQueryName(sampleQueryName) {
|
2677
|
-
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2678
|
-
.location;
|
2657
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).location;
|
2679
2658
|
}
|
2680
2659
|
/**
|
2681
2660
|
* Parse the sample_query_set from SampleQuery resource.
|
@@ -2685,8 +2664,7 @@ class RankServiceClient {
|
|
2685
2664
|
* @returns {string} A string representing the sample_query_set.
|
2686
2665
|
*/
|
2687
2666
|
matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
|
2688
|
-
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2689
|
-
.sample_query_set;
|
2667
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).sample_query_set;
|
2690
2668
|
}
|
2691
2669
|
/**
|
2692
2670
|
* Parse the sample_query from SampleQuery resource.
|
@@ -2696,8 +2674,7 @@ class RankServiceClient {
|
|
2696
2674
|
* @returns {string} A string representing the sample_query.
|
2697
2675
|
*/
|
2698
2676
|
matchSampleQueryFromSampleQueryName(sampleQueryName) {
|
2699
|
-
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
|
2700
|
-
.sample_query;
|
2677
|
+
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).sample_query;
|
2701
2678
|
}
|
2702
2679
|
/**
|
2703
2680
|
* Return a fully-qualified sampleQuerySet resource name string.
|
@@ -2756,7 +2733,7 @@ class RankServiceClient {
|
|
2756
2733
|
this._log.info('ending gRPC channel');
|
2757
2734
|
this._terminated = true;
|
2758
2735
|
stub.close();
|
2759
|
-
this.locationsClient.close();
|
2736
|
+
this.locationsClient.close().catch(err => { throw err; });
|
2760
2737
|
});
|
2761
2738
|
}
|
2762
2739
|
return Promise.resolve();
|
@@ -253,55 +253,55 @@ export declare class RecommendationServiceClient {
|
|
253
253
|
recommend(request: protos.google.cloud.discoveryengine.v1alpha.IRecommendRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IRecommendResponse, protos.google.cloud.discoveryengine.v1alpha.IRecommendRequest | null | undefined, {} | null | undefined>): void;
|
254
254
|
recommend(request: protos.google.cloud.discoveryengine.v1alpha.IRecommendRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IRecommendResponse, protos.google.cloud.discoveryengine.v1alpha.IRecommendRequest | null | undefined, {} | null | undefined>): void;
|
255
255
|
/**
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
|
269
|
-
|
270
|
-
|
271
|
-
|
272
|
-
|
256
|
+
* Gets information about a location.
|
257
|
+
*
|
258
|
+
* @param {Object} request
|
259
|
+
* The request object that will be sent.
|
260
|
+
* @param {string} request.name
|
261
|
+
* Resource name for the location.
|
262
|
+
* @param {object} [options]
|
263
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
|
264
|
+
* @returns {Promise} - The promise which resolves to an array.
|
265
|
+
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
|
266
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
267
|
+
* for more details and examples.
|
268
|
+
* @example
|
269
|
+
* ```
|
270
|
+
* const [response] = await client.getLocation(request);
|
271
|
+
* ```
|
272
|
+
*/
|
273
273
|
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>;
|
274
274
|
/**
|
275
|
-
|
276
|
-
|
277
|
-
|
278
|
-
|
279
|
-
|
280
|
-
|
281
|
-
|
282
|
-
|
283
|
-
|
284
|
-
|
285
|
-
|
286
|
-
|
287
|
-
|
288
|
-
|
289
|
-
|
290
|
-
|
291
|
-
|
292
|
-
|
293
|
-
|
294
|
-
|
295
|
-
|
296
|
-
|
297
|
-
|
298
|
-
|
299
|
-
|
300
|
-
|
301
|
-
|
302
|
-
|
303
|
-
|
304
|
-
|
275
|
+
* Lists information about the supported locations for this service. Returns an iterable object.
|
276
|
+
*
|
277
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
278
|
+
* @param {Object} request
|
279
|
+
* The request object that will be sent.
|
280
|
+
* @param {string} request.name
|
281
|
+
* The resource that owns the locations collection, if applicable.
|
282
|
+
* @param {string} request.filter
|
283
|
+
* The standard list filter.
|
284
|
+
* @param {number} request.pageSize
|
285
|
+
* The standard list page size.
|
286
|
+
* @param {string} request.pageToken
|
287
|
+
* The standard list page token.
|
288
|
+
* @param {object} [options]
|
289
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
290
|
+
* @returns {Object}
|
291
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
292
|
+
* When you iterate the returned iterable, each element will be an object representing
|
293
|
+
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
|
294
|
+
* so you can stop the iteration when you don't need more results.
|
295
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
296
|
+
* for more details and examples.
|
297
|
+
* @example
|
298
|
+
* ```
|
299
|
+
* const iterable = client.listLocationsAsync(request);
|
300
|
+
* for await (const response of iterable) {
|
301
|
+
* // process response
|
302
|
+
* }
|
303
|
+
* ```
|
304
|
+
*/
|
305
305
|
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
|
306
306
|
/**
|
307
307
|
* Return a fully-qualified aclConfig resource name string.
|