@google-cloud/discoveryengine 2.1.0 → 2.3.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/README.md +13 -0
- package/build/protos/google/cloud/discoveryengine/v1/answer.proto +17 -0
- package/build/protos/google/cloud/discoveryengine/v1/chunk.proto +52 -0
- package/build/protos/google/cloud/discoveryengine/v1/cmek_config_service.proto +300 -0
- package/build/protos/google/cloud/discoveryengine/v1/common.proto +67 -0
- package/build/protos/google/cloud/discoveryengine/v1/control.proto +1 -3
- package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +54 -2
- package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +14 -0
- package/build/protos/google/cloud/discoveryengine/v1/document.proto +95 -4
- package/build/protos/google/cloud/discoveryengine/v1/document_processing_config.proto +28 -1
- package/build/protos/google/cloud/discoveryengine/v1/engine.proto +131 -6
- package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +8 -0
- package/build/protos/google/cloud/discoveryengine/v1/grounding.proto +9 -0
- package/build/protos/google/cloud/discoveryengine/v1/identity_mapping_store.proto +84 -0
- package/build/protos/google/cloud/discoveryengine/v1/identity_mapping_store_service.proto +375 -0
- package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +6 -0
- package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +6 -0
- package/build/protos/google/cloud/discoveryengine/v1/user_license.proto +98 -0
- package/build/protos/google/cloud/discoveryengine/v1/user_license_service.proto +191 -0
- package/build/protos/protos.d.ts +5415 -578
- package/build/protos/protos.js +77830 -63391
- package/build/protos/protos.json +1537 -92
- package/build/src/index.d.ts +10 -1
- package/build/src/index.js +8 -22
- package/build/src/v1/cmek_config_service_client.d.ts +2287 -0
- package/build/src/v1/cmek_config_service_client.js +3274 -0
- package/build/src/v1/cmek_config_service_client_config.json +42 -0
- package/build/src/v1/cmek_config_service_proto_list.json +44 -0
- package/build/src/v1/completion_service_client.d.ts +166 -76
- package/build/src/v1/completion_service_client.js +258 -263
- package/build/src/v1/completion_service_proto_list.json +6 -1
- package/build/src/v1/control_service_client.d.ts +171 -81
- package/build/src/v1/control_service_client.js +246 -132
- package/build/src/v1/control_service_proto_list.json +6 -1
- package/build/src/v1/conversational_search_service_client.d.ts +233 -143
- package/build/src/v1/conversational_search_service_client.js +330 -226
- package/build/src/v1/conversational_search_service_proto_list.json +6 -1
- package/build/src/v1/data_store_service_client.d.ts +218 -122
- package/build/src/v1/data_store_service_client.js +273 -281
- package/build/src/v1/data_store_service_proto_list.json +6 -1
- package/build/src/v1/document_service_client.d.ts +210 -120
- package/build/src/v1/document_service_client.js +300 -301
- package/build/src/v1/document_service_proto_list.json +6 -1
- package/build/src/v1/engine_service_client.d.ts +193 -103
- package/build/src/v1/engine_service_client.js +273 -280
- package/build/src/v1/engine_service_proto_list.json +6 -1
- package/build/src/v1/gapic_metadata.json +184 -0
- package/build/src/v1/grounded_generation_service_client.d.ts +138 -48
- package/build/src/v1/grounded_generation_service_client.js +217 -100
- package/build/src/v1/grounded_generation_service_proto_list.json +6 -1
- package/build/src/v1/identity_mapping_store_service_client.d.ts +2470 -0
- package/build/src/v1/identity_mapping_store_service_client.js +3449 -0
- package/build/src/v1/identity_mapping_store_service_client_config.json +54 -0
- package/build/src/v1/identity_mapping_store_service_proto_list.json +44 -0
- package/build/src/v1/index.d.ts +3 -0
- package/build/src/v1/index.js +7 -1
- package/build/src/v1/project_service_client.d.ts +166 -76
- package/build/src/v1/project_service_client.js +235 -223
- package/build/src/v1/project_service_proto_list.json +6 -1
- package/build/src/v1/rank_service_client.d.ts +137 -47
- package/build/src/v1/rank_service_client.js +204 -85
- package/build/src/v1/rank_service_proto_list.json +6 -1
- package/build/src/v1/recommendation_service_client.d.ts +137 -47
- package/build/src/v1/recommendation_service_client.js +202 -82
- package/build/src/v1/recommendation_service_proto_list.json +6 -1
- package/build/src/v1/schema_service_client.d.ts +201 -111
- package/build/src/v1/schema_service_client.js +264 -274
- package/build/src/v1/schema_service_proto_list.json +6 -1
- package/build/src/v1/search_service_client.d.ts +661 -571
- package/build/src/v1/search_service_client.js +216 -113
- package/build/src/v1/search_service_proto_list.json +6 -1
- package/build/src/v1/search_tuning_service_client.d.ts +167 -77
- package/build/src/v1/search_tuning_service_client.js +246 -236
- package/build/src/v1/search_tuning_service_proto_list.json +6 -1
- package/build/src/v1/serving_config_service_client.d.ts +138 -48
- package/build/src/v1/serving_config_service_client.js +201 -80
- package/build/src/v1/serving_config_service_proto_list.json +6 -1
- package/build/src/v1/site_search_engine_service_client.d.ts +238 -148
- package/build/src/v1/site_search_engine_service_client.js +324 -379
- package/build/src/v1/site_search_engine_service_proto_list.json +6 -1
- package/build/src/v1/user_event_service_client.d.ts +167 -77
- package/build/src/v1/user_event_service_client.js +260 -254
- package/build/src/v1/user_event_service_proto_list.json +6 -1
- package/build/src/v1/user_license_service_client.d.ts +2256 -0
- package/build/src/v1/user_license_service_client.js +3194 -0
- package/build/src/v1/user_license_service_client_config.json +34 -0
- package/build/src/v1/user_license_service_proto_list.json +44 -0
- package/build/src/v1alpha/acl_config_service_client.d.ts +49 -49
- package/build/src/v1alpha/acl_config_service_client.js +94 -106
- package/build/src/v1alpha/chunk_service_client.d.ts +88 -88
- package/build/src/v1alpha/chunk_service_client.js +98 -120
- package/build/src/v1alpha/completion_service_client.d.ts +77 -77
- package/build/src/v1alpha/completion_service_client.js +141 -281
- package/build/src/v1alpha/control_service_client.d.ts +85 -85
- package/build/src/v1alpha/control_service_client.js +129 -151
- package/build/src/v1alpha/conversational_search_service_client.d.ts +143 -143
- package/build/src/v1alpha/conversational_search_service_client.js +211 -237
- package/build/src/v1alpha/data_store_service_client.d.ts +126 -126
- package/build/src/v1alpha/data_store_service_client.js +176 -317
- package/build/src/v1alpha/document_service_client.d.ts +126 -126
- package/build/src/v1alpha/document_service_client.js +193 -329
- package/build/src/v1alpha/engine_service_client.d.ts +106 -106
- package/build/src/v1alpha/engine_service_client.js +180 -326
- package/build/src/v1alpha/estimate_billing_service_client.d.ts +76 -76
- package/build/src/v1alpha/estimate_billing_service_client.js +119 -244
- package/build/src/v1alpha/evaluation_service_client.d.ts +161 -161
- package/build/src/v1alpha/evaluation_service_client.js +150 -296
- package/build/src/v1alpha/grounded_generation_service_client.d.ts +48 -48
- package/build/src/v1alpha/grounded_generation_service_client.js +85 -100
- package/build/src/v1alpha/project_service_client.d.ts +78 -78
- package/build/src/v1alpha/project_service_client.js +139 -263
- package/build/src/v1alpha/rank_service_client.d.ts +47 -47
- package/build/src/v1alpha/rank_service_client.js +87 -104
- package/build/src/v1alpha/recommendation_service_client.d.ts +47 -47
- package/build/src/v1alpha/recommendation_service_client.js +85 -100
- package/build/src/v1alpha/sample_query_service_client.d.ts +123 -123
- package/build/src/v1alpha/sample_query_service_client.js +169 -302
- package/build/src/v1alpha/sample_query_set_service_client.d.ts +94 -94
- package/build/src/v1alpha/sample_query_set_service_client.js +130 -153
- package/build/src/v1alpha/schema_service_client.d.ts +112 -112
- package/build/src/v1alpha/schema_service_client.js +147 -293
- 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 +129 -254
- package/build/src/v1alpha/serving_config_service_client.d.ts +75 -75
- package/build/src/v1alpha/serving_config_service_client.js +109 -133
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +151 -151
- package/build/src/v1alpha/site_search_engine_service_client.js +203 -388
- package/build/src/v1alpha/user_event_service_client.d.ts +78 -78
- package/build/src/v1alpha/user_event_service_client.js +143 -272
- package/build/src/v1beta/completion_service_client.d.ts +78 -78
- package/build/src/v1beta/completion_service_client.js +149 -280
- package/build/src/v1beta/control_service_client.d.ts +84 -84
- package/build/src/v1beta/control_service_client.js +127 -147
- package/build/src/v1beta/conversational_search_service_client.d.ts +142 -142
- package/build/src/v1beta/conversational_search_service_client.js +209 -233
- package/build/src/v1beta/data_store_service_client.d.ts +124 -124
- package/build/src/v1beta/data_store_service_client.js +154 -289
- package/build/src/v1beta/document_service_client.d.ts +124 -124
- package/build/src/v1beta/document_service_client.js +181 -310
- package/build/src/v1beta/engine_service_client.d.ts +106 -106
- package/build/src/v1beta/engine_service_client.js +178 -316
- package/build/src/v1beta/evaluation_service_client.d.ts +161 -161
- package/build/src/v1beta/evaluation_service_client.js +148 -286
- package/build/src/v1beta/grounded_generation_service_client.d.ts +49 -49
- package/build/src/v1beta/grounded_generation_service_client.js +98 -114
- package/build/src/v1beta/project_service_client.d.ts +76 -76
- package/build/src/v1beta/project_service_client.js +116 -232
- package/build/src/v1beta/rank_service_client.d.ts +47 -47
- package/build/src/v1beta/rank_service_client.js +85 -99
- package/build/src/v1beta/recommendation_service_client.d.ts +47 -47
- package/build/src/v1beta/recommendation_service_client.js +83 -96
- package/build/src/v1beta/sample_query_service_client.d.ts +123 -123
- package/build/src/v1beta/sample_query_service_client.js +167 -292
- package/build/src/v1beta/sample_query_set_service_client.d.ts +94 -94
- package/build/src/v1beta/sample_query_set_service_client.js +128 -149
- package/build/src/v1beta/schema_service_client.d.ts +111 -111
- package/build/src/v1beta/schema_service_client.js +145 -283
- 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 +127 -244
- package/build/src/v1beta/serving_config_service_client.d.ts +75 -75
- package/build/src/v1beta/serving_config_service_client.js +107 -129
- package/build/src/v1beta/site_search_engine_service_client.d.ts +151 -151
- package/build/src/v1beta/site_search_engine_service_client.js +205 -387
- package/build/src/v1beta/user_event_service_client.d.ts +78 -78
- package/build/src/v1beta/user_event_service_client.js +141 -262
- package/package.json +7 -7
- package/CHANGELOG.md +0 -267
@@ -253,55 +253,55 @@ export declare class RecommendationServiceClient {
|
|
253
253
|
recommend(request: protos.google.cloud.discoveryengine.v1.IRecommendRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IRecommendResponse, protos.google.cloud.discoveryengine.v1.IRecommendRequest | null | undefined, {} | null | undefined>): void;
|
254
254
|
recommend(request: protos.google.cloud.discoveryengine.v1.IRecommendRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.IRecommendResponse, protos.google.cloud.discoveryengine.v1.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 engine resource name string.
|
@@ -345,6 +345,39 @@ export declare class RecommendationServiceClient {
|
|
345
345
|
* @returns {string} A string representing the engine.
|
346
346
|
*/
|
347
347
|
matchEngineFromEngineName(engineName: string): string | number;
|
348
|
+
/**
|
349
|
+
* Return a fully-qualified identityMappingStore resource name string.
|
350
|
+
*
|
351
|
+
* @param {string} project
|
352
|
+
* @param {string} location
|
353
|
+
* @param {string} identity_mapping_store
|
354
|
+
* @returns {string} Resource name string.
|
355
|
+
*/
|
356
|
+
identityMappingStorePath(project: string, location: string, identityMappingStore: string): string;
|
357
|
+
/**
|
358
|
+
* Parse the project from IdentityMappingStore resource.
|
359
|
+
*
|
360
|
+
* @param {string} identityMappingStoreName
|
361
|
+
* A fully-qualified path representing IdentityMappingStore resource.
|
362
|
+
* @returns {string} A string representing the project.
|
363
|
+
*/
|
364
|
+
matchProjectFromIdentityMappingStoreName(identityMappingStoreName: string): string | number;
|
365
|
+
/**
|
366
|
+
* Parse the location from IdentityMappingStore resource.
|
367
|
+
*
|
368
|
+
* @param {string} identityMappingStoreName
|
369
|
+
* A fully-qualified path representing IdentityMappingStore resource.
|
370
|
+
* @returns {string} A string representing the location.
|
371
|
+
*/
|
372
|
+
matchLocationFromIdentityMappingStoreName(identityMappingStoreName: string): string | number;
|
373
|
+
/**
|
374
|
+
* Parse the identity_mapping_store from IdentityMappingStore resource.
|
375
|
+
*
|
376
|
+
* @param {string} identityMappingStoreName
|
377
|
+
* A fully-qualified path representing IdentityMappingStore resource.
|
378
|
+
* @returns {string} A string representing the identity_mapping_store.
|
379
|
+
*/
|
380
|
+
matchIdentityMappingStoreFromIdentityMappingStoreName(identityMappingStoreName: string): string | number;
|
348
381
|
/**
|
349
382
|
* Return a fully-qualified project resource name string.
|
350
383
|
*
|
@@ -360,6 +393,63 @@ export declare class RecommendationServiceClient {
|
|
360
393
|
* @returns {string} A string representing the project.
|
361
394
|
*/
|
362
395
|
matchProjectFromProjectName(projectName: string): string | number;
|
396
|
+
/**
|
397
|
+
* Return a fully-qualified projectLocationCmekConfig resource name string.
|
398
|
+
*
|
399
|
+
* @param {string} project
|
400
|
+
* @param {string} location
|
401
|
+
* @returns {string} Resource name string.
|
402
|
+
*/
|
403
|
+
projectLocationCmekConfigPath(project: string, location: string): string;
|
404
|
+
/**
|
405
|
+
* Parse the project from ProjectLocationCmekConfig resource.
|
406
|
+
*
|
407
|
+
* @param {string} projectLocationCmekConfigName
|
408
|
+
* A fully-qualified path representing project_location_cmekConfig resource.
|
409
|
+
* @returns {string} A string representing the project.
|
410
|
+
*/
|
411
|
+
matchProjectFromProjectLocationCmekConfigName(projectLocationCmekConfigName: string): string | number;
|
412
|
+
/**
|
413
|
+
* Parse the location from ProjectLocationCmekConfig resource.
|
414
|
+
*
|
415
|
+
* @param {string} projectLocationCmekConfigName
|
416
|
+
* A fully-qualified path representing project_location_cmekConfig resource.
|
417
|
+
* @returns {string} A string representing the location.
|
418
|
+
*/
|
419
|
+
matchLocationFromProjectLocationCmekConfigName(projectLocationCmekConfigName: string): string | number;
|
420
|
+
/**
|
421
|
+
* Return a fully-qualified projectLocationCmekConfigs resource name string.
|
422
|
+
*
|
423
|
+
* @param {string} project
|
424
|
+
* @param {string} location
|
425
|
+
* @param {string} cmek_config
|
426
|
+
* @returns {string} Resource name string.
|
427
|
+
*/
|
428
|
+
projectLocationCmekConfigsPath(project: string, location: string, cmekConfig: string): string;
|
429
|
+
/**
|
430
|
+
* Parse the project from ProjectLocationCmekConfigs resource.
|
431
|
+
*
|
432
|
+
* @param {string} projectLocationCmekConfigsName
|
433
|
+
* A fully-qualified path representing project_location_cmekConfigs resource.
|
434
|
+
* @returns {string} A string representing the project.
|
435
|
+
*/
|
436
|
+
matchProjectFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName: string): string | number;
|
437
|
+
/**
|
438
|
+
* Parse the location from ProjectLocationCmekConfigs resource.
|
439
|
+
*
|
440
|
+
* @param {string} projectLocationCmekConfigsName
|
441
|
+
* A fully-qualified path representing project_location_cmekConfigs resource.
|
442
|
+
* @returns {string} A string representing the location.
|
443
|
+
*/
|
444
|
+
matchLocationFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName: string): string | number;
|
445
|
+
/**
|
446
|
+
* Parse the cmek_config from ProjectLocationCmekConfigs resource.
|
447
|
+
*
|
448
|
+
* @param {string} projectLocationCmekConfigsName
|
449
|
+
* A fully-qualified path representing project_location_cmekConfigs resource.
|
450
|
+
* @returns {string} A string representing the cmek_config.
|
451
|
+
*/
|
452
|
+
matchCmekConfigFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName: string): string | number;
|
363
453
|
/**
|
364
454
|
* Return a fully-qualified projectLocationCollectionDataStore resource name string.
|
365
455
|
*
|
@@ -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
|
}
|
@@ -170,7 +163,10 @@ class RecommendationServiceClient {
|
|
170
163
|
// Create useful helper objects for these.
|
171
164
|
this.pathTemplates = {
|
172
165
|
enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
|
166
|
+
identityMappingStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}'),
|
173
167
|
projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
|
168
|
+
projectLocationCmekConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/cmekConfig'),
|
169
|
+
projectLocationCmekConfigsPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/cmekConfigs/{cmek_config}'),
|
174
170
|
projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
|
175
171
|
projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
|
176
172
|
projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
|
@@ -232,11 +228,10 @@ class RecommendationServiceClient {
|
|
232
228
|
}
|
233
229
|
// Put together the "service stub" for
|
234
230
|
// google.cloud.discoveryengine.v1.RecommendationService.
|
235
|
-
this.recommendationServiceStub = this._gaxGrpc.createStub(this._opts.fallback
|
236
|
-
|
237
|
-
|
238
|
-
|
239
|
-
.RecommendationService, this._opts, this._providedCustomServicePath);
|
231
|
+
this.recommendationServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
|
232
|
+
this._protos.lookupService('google.cloud.discoveryengine.v1.RecommendationService') :
|
233
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
234
|
+
this._protos.google.cloud.discoveryengine.v1.RecommendationService, this._opts, this._providedCustomServicePath);
|
240
235
|
// Iterate over each of the methods that the service provides
|
241
236
|
// and create an API call method for each.
|
242
237
|
const recommendationServiceStubMethods = ['recommend'];
|
@@ -262,8 +257,7 @@ class RecommendationServiceClient {
|
|
262
257
|
* @returns {string} The DNS address for this service.
|
263
258
|
*/
|
264
259
|
static get servicePath() {
|
265
|
-
if (typeof process === 'object' &&
|
266
|
-
typeof process.emitWarning === 'function') {
|
260
|
+
if (typeof process === 'object' && typeof process.emitWarning === 'function') {
|
267
261
|
process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
|
268
262
|
}
|
269
263
|
return 'discoveryengine.googleapis.com';
|
@@ -274,8 +268,7 @@ class RecommendationServiceClient {
|
|
274
268
|
* @returns {string} The DNS address for this service.
|
275
269
|
*/
|
276
270
|
static get apiEndpoint() {
|
277
|
-
if (typeof process === 'object' &&
|
278
|
-
typeof process.emitWarning === 'function') {
|
271
|
+
if (typeof process === 'object' && typeof process.emitWarning === 'function') {
|
279
272
|
process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
|
280
273
|
}
|
281
274
|
return 'discoveryengine.googleapis.com';
|
@@ -303,7 +296,9 @@ class RecommendationServiceClient {
|
|
303
296
|
* @returns {string[]} List of default scopes.
|
304
297
|
*/
|
305
298
|
static get scopes() {
|
306
|
-
return [
|
299
|
+
return [
|
300
|
+
'https://www.googleapis.com/auth/cloud-platform'
|
301
|
+
];
|
307
302
|
}
|
308
303
|
/**
|
309
304
|
* Return the project ID used by this class.
|
@@ -329,13 +324,10 @@ class RecommendationServiceClient {
|
|
329
324
|
options = options || {};
|
330
325
|
options.otherArgs = options.otherArgs || {};
|
331
326
|
options.otherArgs.headers = options.otherArgs.headers || {};
|
332
|
-
options.otherArgs.headers['x-goog-request-params'] =
|
333
|
-
|
334
|
-
serving_config: request.servingConfig ?? '',
|
335
|
-
});
|
336
|
-
this.initialize().catch(err => {
|
337
|
-
throw err;
|
327
|
+
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
|
328
|
+
'serving_config': request.servingConfig ?? '',
|
338
329
|
});
|
330
|
+
this.initialize().catch(err => { throw err; });
|
339
331
|
this._log.info('recommend request %j', request);
|
340
332
|
const wrappedCallback = callback
|
341
333
|
? (error, response, options, rawResponse) => {
|
@@ -343,65 +335,70 @@ class RecommendationServiceClient {
|
|
343
335
|
callback(error, response, options, rawResponse); // We verified callback above.
|
344
336
|
}
|
345
337
|
: undefined;
|
346
|
-
return this.innerApiCalls
|
347
|
-
.recommend(request, options, wrappedCallback)
|
338
|
+
return this.innerApiCalls.recommend(request, options, wrappedCallback)
|
348
339
|
?.then(([response, options, rawResponse]) => {
|
349
340
|
this._log.info('recommend response %j', response);
|
350
341
|
return [response, options, rawResponse];
|
342
|
+
}).catch((error) => {
|
343
|
+
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
|
344
|
+
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
|
345
|
+
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
|
346
|
+
}
|
347
|
+
throw error;
|
351
348
|
});
|
352
349
|
}
|
353
350
|
/**
|
354
|
-
|
355
|
-
|
356
|
-
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
369
|
-
|
370
|
-
|
351
|
+
* Gets information about a location.
|
352
|
+
*
|
353
|
+
* @param {Object} request
|
354
|
+
* The request object that will be sent.
|
355
|
+
* @param {string} request.name
|
356
|
+
* Resource name for the location.
|
357
|
+
* @param {object} [options]
|
358
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
|
359
|
+
* @returns {Promise} - The promise which resolves to an array.
|
360
|
+
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
|
361
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
362
|
+
* for more details and examples.
|
363
|
+
* @example
|
364
|
+
* ```
|
365
|
+
* const [response] = await client.getLocation(request);
|
366
|
+
* ```
|
367
|
+
*/
|
371
368
|
getLocation(request, options, callback) {
|
372
369
|
return this.locationsClient.getLocation(request, options, callback);
|
373
370
|
}
|
374
371
|
/**
|
375
|
-
|
376
|
-
|
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
|
-
|
372
|
+
* Lists information about the supported locations for this service. Returns an iterable object.
|
373
|
+
*
|
374
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
375
|
+
* @param {Object} request
|
376
|
+
* The request object that will be sent.
|
377
|
+
* @param {string} request.name
|
378
|
+
* The resource that owns the locations collection, if applicable.
|
379
|
+
* @param {string} request.filter
|
380
|
+
* The standard list filter.
|
381
|
+
* @param {number} request.pageSize
|
382
|
+
* The standard list page size.
|
383
|
+
* @param {string} request.pageToken
|
384
|
+
* The standard list page token.
|
385
|
+
* @param {object} [options]
|
386
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
387
|
+
* @returns {Object}
|
388
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
389
|
+
* When you iterate the returned iterable, each element will be an object representing
|
390
|
+
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
|
391
|
+
* so you can stop the iteration when you don't need more results.
|
392
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
393
|
+
* for more details and examples.
|
394
|
+
* @example
|
395
|
+
* ```
|
396
|
+
* const iterable = client.listLocationsAsync(request);
|
397
|
+
* for await (const response of iterable) {
|
398
|
+
* // process response
|
399
|
+
* }
|
400
|
+
* ```
|
401
|
+
*/
|
405
402
|
listLocationsAsync(request, options) {
|
406
403
|
return this.locationsClient.listLocationsAsync(request, options);
|
407
404
|
}
|
@@ -465,6 +462,51 @@ class RecommendationServiceClient {
|
|
465
462
|
matchEngineFromEngineName(engineName) {
|
466
463
|
return this.pathTemplates.enginePathTemplate.match(engineName).engine;
|
467
464
|
}
|
465
|
+
/**
|
466
|
+
* Return a fully-qualified identityMappingStore resource name string.
|
467
|
+
*
|
468
|
+
* @param {string} project
|
469
|
+
* @param {string} location
|
470
|
+
* @param {string} identity_mapping_store
|
471
|
+
* @returns {string} Resource name string.
|
472
|
+
*/
|
473
|
+
identityMappingStorePath(project, location, identityMappingStore) {
|
474
|
+
return this.pathTemplates.identityMappingStorePathTemplate.render({
|
475
|
+
project: project,
|
476
|
+
location: location,
|
477
|
+
identity_mapping_store: identityMappingStore,
|
478
|
+
});
|
479
|
+
}
|
480
|
+
/**
|
481
|
+
* Parse the project from IdentityMappingStore resource.
|
482
|
+
*
|
483
|
+
* @param {string} identityMappingStoreName
|
484
|
+
* A fully-qualified path representing IdentityMappingStore resource.
|
485
|
+
* @returns {string} A string representing the project.
|
486
|
+
*/
|
487
|
+
matchProjectFromIdentityMappingStoreName(identityMappingStoreName) {
|
488
|
+
return this.pathTemplates.identityMappingStorePathTemplate.match(identityMappingStoreName).project;
|
489
|
+
}
|
490
|
+
/**
|
491
|
+
* Parse the location from IdentityMappingStore resource.
|
492
|
+
*
|
493
|
+
* @param {string} identityMappingStoreName
|
494
|
+
* A fully-qualified path representing IdentityMappingStore resource.
|
495
|
+
* @returns {string} A string representing the location.
|
496
|
+
*/
|
497
|
+
matchLocationFromIdentityMappingStoreName(identityMappingStoreName) {
|
498
|
+
return this.pathTemplates.identityMappingStorePathTemplate.match(identityMappingStoreName).location;
|
499
|
+
}
|
500
|
+
/**
|
501
|
+
* Parse the identity_mapping_store from IdentityMappingStore resource.
|
502
|
+
*
|
503
|
+
* @param {string} identityMappingStoreName
|
504
|
+
* A fully-qualified path representing IdentityMappingStore resource.
|
505
|
+
* @returns {string} A string representing the identity_mapping_store.
|
506
|
+
*/
|
507
|
+
matchIdentityMappingStoreFromIdentityMappingStoreName(identityMappingStoreName) {
|
508
|
+
return this.pathTemplates.identityMappingStorePathTemplate.match(identityMappingStoreName).identity_mapping_store;
|
509
|
+
}
|
468
510
|
/**
|
469
511
|
* Return a fully-qualified project resource name string.
|
470
512
|
*
|
@@ -486,6 +528,84 @@ class RecommendationServiceClient {
|
|
486
528
|
matchProjectFromProjectName(projectName) {
|
487
529
|
return this.pathTemplates.projectPathTemplate.match(projectName).project;
|
488
530
|
}
|
531
|
+
/**
|
532
|
+
* Return a fully-qualified projectLocationCmekConfig resource name string.
|
533
|
+
*
|
534
|
+
* @param {string} project
|
535
|
+
* @param {string} location
|
536
|
+
* @returns {string} Resource name string.
|
537
|
+
*/
|
538
|
+
projectLocationCmekConfigPath(project, location) {
|
539
|
+
return this.pathTemplates.projectLocationCmekConfigPathTemplate.render({
|
540
|
+
project: project,
|
541
|
+
location: location,
|
542
|
+
});
|
543
|
+
}
|
544
|
+
/**
|
545
|
+
* Parse the project from ProjectLocationCmekConfig resource.
|
546
|
+
*
|
547
|
+
* @param {string} projectLocationCmekConfigName
|
548
|
+
* A fully-qualified path representing project_location_cmekConfig resource.
|
549
|
+
* @returns {string} A string representing the project.
|
550
|
+
*/
|
551
|
+
matchProjectFromProjectLocationCmekConfigName(projectLocationCmekConfigName) {
|
552
|
+
return this.pathTemplates.projectLocationCmekConfigPathTemplate.match(projectLocationCmekConfigName).project;
|
553
|
+
}
|
554
|
+
/**
|
555
|
+
* Parse the location from ProjectLocationCmekConfig resource.
|
556
|
+
*
|
557
|
+
* @param {string} projectLocationCmekConfigName
|
558
|
+
* A fully-qualified path representing project_location_cmekConfig resource.
|
559
|
+
* @returns {string} A string representing the location.
|
560
|
+
*/
|
561
|
+
matchLocationFromProjectLocationCmekConfigName(projectLocationCmekConfigName) {
|
562
|
+
return this.pathTemplates.projectLocationCmekConfigPathTemplate.match(projectLocationCmekConfigName).location;
|
563
|
+
}
|
564
|
+
/**
|
565
|
+
* Return a fully-qualified projectLocationCmekConfigs resource name string.
|
566
|
+
*
|
567
|
+
* @param {string} project
|
568
|
+
* @param {string} location
|
569
|
+
* @param {string} cmek_config
|
570
|
+
* @returns {string} Resource name string.
|
571
|
+
*/
|
572
|
+
projectLocationCmekConfigsPath(project, location, cmekConfig) {
|
573
|
+
return this.pathTemplates.projectLocationCmekConfigsPathTemplate.render({
|
574
|
+
project: project,
|
575
|
+
location: location,
|
576
|
+
cmek_config: cmekConfig,
|
577
|
+
});
|
578
|
+
}
|
579
|
+
/**
|
580
|
+
* Parse the project from ProjectLocationCmekConfigs resource.
|
581
|
+
*
|
582
|
+
* @param {string} projectLocationCmekConfigsName
|
583
|
+
* A fully-qualified path representing project_location_cmekConfigs resource.
|
584
|
+
* @returns {string} A string representing the project.
|
585
|
+
*/
|
586
|
+
matchProjectFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName) {
|
587
|
+
return this.pathTemplates.projectLocationCmekConfigsPathTemplate.match(projectLocationCmekConfigsName).project;
|
588
|
+
}
|
589
|
+
/**
|
590
|
+
* Parse the location from ProjectLocationCmekConfigs resource.
|
591
|
+
*
|
592
|
+
* @param {string} projectLocationCmekConfigsName
|
593
|
+
* A fully-qualified path representing project_location_cmekConfigs resource.
|
594
|
+
* @returns {string} A string representing the location.
|
595
|
+
*/
|
596
|
+
matchLocationFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName) {
|
597
|
+
return this.pathTemplates.projectLocationCmekConfigsPathTemplate.match(projectLocationCmekConfigsName).location;
|
598
|
+
}
|
599
|
+
/**
|
600
|
+
* Parse the cmek_config from ProjectLocationCmekConfigs resource.
|
601
|
+
*
|
602
|
+
* @param {string} projectLocationCmekConfigsName
|
603
|
+
* A fully-qualified path representing project_location_cmekConfigs resource.
|
604
|
+
* @returns {string} A string representing the cmek_config.
|
605
|
+
*/
|
606
|
+
matchCmekConfigFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName) {
|
607
|
+
return this.pathTemplates.projectLocationCmekConfigsPathTemplate.match(projectLocationCmekConfigsName).cmek_config;
|
608
|
+
}
|
489
609
|
/**
|
490
610
|
* Return a fully-qualified projectLocationCollectionDataStore resource name string.
|
491
611
|
*
|
@@ -2643,7 +2763,7 @@ class RecommendationServiceClient {
|
|
2643
2763
|
this._log.info('ending gRPC channel');
|
2644
2764
|
this._terminated = true;
|
2645
2765
|
stub.close();
|
2646
|
-
this.locationsClient.close();
|
2766
|
+
this.locationsClient.close().catch(err => { throw err; });
|
2647
2767
|
});
|
2648
2768
|
}
|
2649
2769
|
return Promise.resolve();
|
@@ -1,6 +1,7 @@
|
|
1
1
|
[
|
2
2
|
"../../protos/google/cloud/discoveryengine/v1/answer.proto",
|
3
3
|
"../../protos/google/cloud/discoveryengine/v1/chunk.proto",
|
4
|
+
"../../protos/google/cloud/discoveryengine/v1/cmek_config_service.proto",
|
4
5
|
"../../protos/google/cloud/discoveryengine/v1/common.proto",
|
5
6
|
"../../protos/google/cloud/discoveryengine/v1/completion.proto",
|
6
7
|
"../../protos/google/cloud/discoveryengine/v1/completion_service.proto",
|
@@ -18,6 +19,8 @@
|
|
18
19
|
"../../protos/google/cloud/discoveryengine/v1/engine_service.proto",
|
19
20
|
"../../protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto",
|
20
21
|
"../../protos/google/cloud/discoveryengine/v1/grounding.proto",
|
22
|
+
"../../protos/google/cloud/discoveryengine/v1/identity_mapping_store.proto",
|
23
|
+
"../../protos/google/cloud/discoveryengine/v1/identity_mapping_store_service.proto",
|
21
24
|
"../../protos/google/cloud/discoveryengine/v1/import_config.proto",
|
22
25
|
"../../protos/google/cloud/discoveryengine/v1/project.proto",
|
23
26
|
"../../protos/google/cloud/discoveryengine/v1/project_service.proto",
|
@@ -35,5 +38,7 @@
|
|
35
38
|
"../../protos/google/cloud/discoveryengine/v1/site_search_engine.proto",
|
36
39
|
"../../protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto",
|
37
40
|
"../../protos/google/cloud/discoveryengine/v1/user_event.proto",
|
38
|
-
"../../protos/google/cloud/discoveryengine/v1/user_event_service.proto"
|
41
|
+
"../../protos/google/cloud/discoveryengine/v1/user_event_service.proto",
|
42
|
+
"../../protos/google/cloud/discoveryengine/v1/user_license.proto",
|
43
|
+
"../../protos/google/cloud/discoveryengine/v1/user_license_service.proto"
|
39
44
|
]
|