@google-cloud/discoveryengine 1.12.0 → 1.14.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 +10 -0
- package/build/protos/google/cloud/discoveryengine/v1/answer.proto +49 -5
- package/build/protos/google/cloud/discoveryengine/v1/control.proto +6 -4
- package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +9 -9
- package/build/protos/google/cloud/discoveryengine/v1/custom_tuning_model.proto +96 -0
- package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +10 -0
- package/build/protos/google/cloud/discoveryengine/v1/document.proto +20 -0
- package/build/protos/google/cloud/discoveryengine/v1/document_processing_config.proto +2 -0
- package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +110 -0
- package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +13 -7
- package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +117 -0
- package/build/protos/google/cloud/discoveryengine/v1/recommendation_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +40 -16
- package/build/protos/google/cloud/discoveryengine/v1/search_tuning_service.proto +196 -0
- package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +4 -0
- package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +21 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config_service.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/answer.proto +61 -2
- package/build/protos/google/cloud/discoveryengine/v1alpha/chunk.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/completion.proto +31 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +38 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/control.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +28 -9
- package/build/protos/google/cloud/discoveryengine/v1alpha/custom_tuning_model.proto +10 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +71 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +11 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +24 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_processing_config.proto +6 -2
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +108 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/grounded_generation_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +119 -5
- package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +58 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +5 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +428 -12
- package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config.proto +14 -5
- package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +126 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +4 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event_service.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/answer.proto +47 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/control.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/custom_tuning_model.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +20 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +2 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +114 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/grounded_generation_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +13 -7
- package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +44 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +101 -6
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -0
- package/build/protos/protos.d.ts +24137 -16126
- package/build/protos/protos.js +78286 -58223
- package/build/protos/protos.json +1954 -105
- package/build/src/index.d.ts +4 -1
- package/build/src/index.js +4 -1
- package/build/src/v1/completion_service_client.d.ts +93 -0
- package/build/src/v1/completion_service_client.js +134 -0
- package/build/src/v1/control_service_client.d.ts +93 -0
- package/build/src/v1/control_service_client.js +128 -0
- package/build/src/v1/conversational_search_service_client.d.ts +93 -0
- package/build/src/v1/conversational_search_service_client.js +128 -0
- package/build/src/v1/data_store_service_client.d.ts +102 -0
- package/build/src/v1/data_store_service_client.js +134 -0
- package/build/src/v1/document_service_client.d.ts +131 -0
- package/build/src/v1/document_service_client.js +156 -0
- package/build/src/v1/document_service_client_config.json +5 -0
- package/build/src/v1/engine_service_client.d.ts +93 -0
- package/build/src/v1/engine_service_client.js +134 -0
- package/build/src/v1/grounded_generation_service_client.d.ts +93 -0
- package/build/src/v1/grounded_generation_service_client.js +128 -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 +93 -0
- package/build/src/v1/project_service_client.js +134 -0
- package/build/src/v1/rank_service_client.d.ts +93 -0
- package/build/src/v1/rank_service_client.js +128 -0
- package/build/src/v1/recommendation_service_client.d.ts +95 -1
- package/build/src/v1/recommendation_service_client.js +128 -0
- package/build/src/v1/schema_service_client.d.ts +93 -0
- package/build/src/v1/schema_service_client.js +134 -0
- package/build/src/v1/search_service_client.d.ts +111 -9
- package/build/src/v1/search_service_client.js +140 -6
- package/build/src/v1/search_tuning_service_client.d.ts +1776 -0
- package/build/src/v1/search_tuning_service_client.js +2589 -0
- package/build/src/v1/search_tuning_service_client_config.json +34 -0
- package/build/src/v1/site_search_engine_service_client.d.ts +93 -0
- package/build/src/v1/site_search_engine_service_client.js +134 -0
- package/build/src/v1/user_event_service_client.d.ts +168 -0
- package/build/src/v1/user_event_service_client.js +176 -0
- package/build/src/v1/user_event_service_client_config.json +5 -0
- package/build/src/v1alpha/acl_config_service_client.d.ts +1 -1
- package/build/src/v1alpha/completion_service_client.d.ts +91 -0
- package/build/src/v1alpha/completion_service_client.js +90 -0
- package/build/src/v1alpha/completion_service_client_config.json +10 -0
- package/build/src/v1alpha/conversational_search_service_client.d.ts +18 -0
- package/build/src/v1alpha/data_store_service_client.d.ts +12 -3
- package/build/src/v1alpha/data_store_service_client.js +8 -2
- package/build/src/v1alpha/document_service_client.d.ts +33 -0
- package/build/src/v1alpha/document_service_client.js +28 -0
- package/build/src/v1alpha/document_service_client_config.json +5 -0
- package/build/src/v1alpha/engine_service_client.js +6 -0
- package/build/src/v1alpha/estimate_billing_service_client.js +6 -0
- package/build/src/v1alpha/evaluation_service_client.js +6 -0
- package/build/src/v1alpha/project_service_client.js +6 -0
- package/build/src/v1alpha/sample_query_service_client.js +6 -0
- package/build/src/v1alpha/schema_service_client.js +6 -0
- package/build/src/v1alpha/search_service_client.d.ts +219 -21
- package/build/src/v1alpha/search_service_client.js +146 -14
- package/build/src/v1alpha/search_tuning_service_client.js +6 -0
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +101 -0
- package/build/src/v1alpha/site_search_engine_service_client.js +70 -0
- package/build/src/v1alpha/site_search_engine_service_client_config.json +8 -0
- package/build/src/v1alpha/user_event_service_client.js +6 -0
- package/build/src/v1beta/document_service_client.d.ts +38 -0
- package/build/src/v1beta/document_service_client.js +22 -0
- package/build/src/v1beta/document_service_client_config.json +5 -0
- package/build/src/v1beta/search_service_client.d.ts +36 -9
- package/build/src/v1beta/search_service_client.js +24 -6
- package/package.json +2 -2
@@ -304,6 +304,35 @@ export declare class DocumentServiceClient {
|
|
304
304
|
]>;
|
305
305
|
getProcessedDocument(request: protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IProcessedDocument, protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest | null | undefined, {} | null | undefined>): void;
|
306
306
|
getProcessedDocument(request: protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IProcessedDocument, protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest | null | undefined, {} | null | undefined>): void;
|
307
|
+
/**
|
308
|
+
* Gets index freshness metadata for
|
309
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s. Supported for
|
310
|
+
* website search only.
|
311
|
+
*
|
312
|
+
* @param {Object} request
|
313
|
+
* The request object that will be sent.
|
314
|
+
* @param {string} request.parent
|
315
|
+
* Required. The parent branch resource name, such as
|
316
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
317
|
+
* @param {google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataRequest.Matcher} request.matcher
|
318
|
+
* Required. Matcher for the
|
319
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s.
|
320
|
+
* @param {object} [options]
|
321
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
322
|
+
* @returns {Promise} - The promise which resolves to an array.
|
323
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.BatchGetDocumentsMetadataResponse|BatchGetDocumentsMetadataResponse}.
|
324
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
325
|
+
* for more details and examples.
|
326
|
+
* @example <caption>include:samples/generated/v1alpha/document_service.batch_get_documents_metadata.js</caption>
|
327
|
+
* region_tag:discoveryengine_v1alpha_generated_DocumentService_BatchGetDocumentsMetadata_async
|
328
|
+
*/
|
329
|
+
batchGetDocumentsMetadata(request?: protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataRequest, options?: CallOptions): Promise<[
|
330
|
+
protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataResponse,
|
331
|
+
(protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataRequest | undefined),
|
332
|
+
{} | undefined
|
333
|
+
]>;
|
334
|
+
batchGetDocumentsMetadata(request: protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataResponse, protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataRequest | null | undefined, {} | null | undefined>): void;
|
335
|
+
batchGetDocumentsMetadata(request: protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataResponse, protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataRequest | null | undefined, {} | null | undefined>): void;
|
307
336
|
/**
|
308
337
|
* Bulk import of multiple
|
309
338
|
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s. Request
|
@@ -329,6 +358,8 @@ export declare class DocumentServiceClient {
|
|
329
358
|
* Cloud SQL input source.
|
330
359
|
* @param {google.cloud.discoveryengine.v1alpha.FirestoreSource} request.firestoreSource
|
331
360
|
* Firestore input source.
|
361
|
+
* @param {google.cloud.discoveryengine.v1alpha.AlloyDbSource} request.alloyDbSource
|
362
|
+
* AlloyDB input source.
|
332
363
|
* @param {google.cloud.discoveryengine.v1alpha.BigtableSource} request.bigtableSource
|
333
364
|
* Cloud Bigtable input source.
|
334
365
|
* @param {string} request.parent
|
@@ -461,6 +492,8 @@ export declare class DocumentServiceClient {
|
|
461
492
|
* Supported `data_schema`:
|
462
493
|
* * `document_id`: One valid
|
463
494
|
* {@link protos.google.cloud.discoveryengine.v1alpha.Document.id|Document.id} per line.
|
495
|
+
* @param {google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.InlineSource} request.inlineSource
|
496
|
+
* Inline source for the input content for purge.
|
464
497
|
* @param {string} request.parent
|
465
498
|
* Required. The parent resource name, such as
|
466
499
|
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
@@ -259,6 +259,9 @@ class DocumentServiceClient {
|
|
259
259
|
{
|
260
260
|
get: '/v1alpha/{name=projects/*/locations/*/evaluations/*/operations/*}',
|
261
261
|
},
|
262
|
+
{
|
263
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}',
|
264
|
+
},
|
262
265
|
{ get: '/v1alpha/{name=projects/*/locations/*/operations/*}' },
|
263
266
|
{
|
264
267
|
get: '/v1alpha/{name=projects/*/locations/*/sampleQuerySets/*/operations/*}',
|
@@ -303,6 +306,9 @@ class DocumentServiceClient {
|
|
303
306
|
{
|
304
307
|
get: '/v1alpha/{name=projects/*/locations/*/dataStores/*}/operations',
|
305
308
|
},
|
309
|
+
{
|
310
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*}/operations',
|
311
|
+
},
|
306
312
|
{ get: '/v1alpha/{name=projects/*/locations/*}/operations' },
|
307
313
|
{ get: '/v1alpha/{name=projects/*}/operations' },
|
308
314
|
],
|
@@ -363,6 +369,7 @@ class DocumentServiceClient {
|
|
363
369
|
'importDocuments',
|
364
370
|
'purgeDocuments',
|
365
371
|
'getProcessedDocument',
|
372
|
+
'batchGetDocumentsMetadata',
|
366
373
|
];
|
367
374
|
for (const methodName of documentServiceStubMethods) {
|
368
375
|
const callPromise = this.documentServiceStub.then(stub => (...args) => {
|
@@ -547,6 +554,27 @@ class DocumentServiceClient {
|
|
547
554
|
this.initialize();
|
548
555
|
return this.innerApiCalls.getProcessedDocument(request, options, callback);
|
549
556
|
}
|
557
|
+
batchGetDocumentsMetadata(request, optionsOrCallback, callback) {
|
558
|
+
var _a;
|
559
|
+
request = request || {};
|
560
|
+
let options;
|
561
|
+
if (typeof optionsOrCallback === 'function' && callback === undefined) {
|
562
|
+
callback = optionsOrCallback;
|
563
|
+
options = {};
|
564
|
+
}
|
565
|
+
else {
|
566
|
+
options = optionsOrCallback;
|
567
|
+
}
|
568
|
+
options = options || {};
|
569
|
+
options.otherArgs = options.otherArgs || {};
|
570
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
571
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
572
|
+
this._gaxModule.routingHeader.fromParams({
|
573
|
+
parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
|
574
|
+
});
|
575
|
+
this.initialize();
|
576
|
+
return this.innerApiCalls.batchGetDocumentsMetadata(request, options, callback);
|
577
|
+
}
|
550
578
|
importDocuments(request, optionsOrCallback, callback) {
|
551
579
|
var _a;
|
552
580
|
request = request || {};
|
@@ -80,6 +80,11 @@
|
|
80
80
|
"timeout_millis": 30000,
|
81
81
|
"retry_codes_name": "unavailable",
|
82
82
|
"retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
|
83
|
+
},
|
84
|
+
"BatchGetDocumentsMetadata": {
|
85
|
+
"timeout_millis": 30000,
|
86
|
+
"retry_codes_name": "unavailable",
|
87
|
+
"retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
|
83
88
|
}
|
84
89
|
}
|
85
90
|
}
|
@@ -257,6 +257,9 @@ class EngineServiceClient {
|
|
257
257
|
{
|
258
258
|
get: '/v1alpha/{name=projects/*/locations/*/evaluations/*/operations/*}',
|
259
259
|
},
|
260
|
+
{
|
261
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}',
|
262
|
+
},
|
260
263
|
{ get: '/v1alpha/{name=projects/*/locations/*/operations/*}' },
|
261
264
|
{
|
262
265
|
get: '/v1alpha/{name=projects/*/locations/*/sampleQuerySets/*/operations/*}',
|
@@ -301,6 +304,9 @@ class EngineServiceClient {
|
|
301
304
|
{
|
302
305
|
get: '/v1alpha/{name=projects/*/locations/*/dataStores/*}/operations',
|
303
306
|
},
|
307
|
+
{
|
308
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*}/operations',
|
309
|
+
},
|
304
310
|
{ get: '/v1alpha/{name=projects/*/locations/*}/operations' },
|
305
311
|
{ get: '/v1alpha/{name=projects/*}/operations' },
|
306
312
|
],
|
@@ -251,6 +251,9 @@ class EstimateBillingServiceClient {
|
|
251
251
|
{
|
252
252
|
get: '/v1alpha/{name=projects/*/locations/*/evaluations/*/operations/*}',
|
253
253
|
},
|
254
|
+
{
|
255
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}',
|
256
|
+
},
|
254
257
|
{ get: '/v1alpha/{name=projects/*/locations/*/operations/*}' },
|
255
258
|
{
|
256
259
|
get: '/v1alpha/{name=projects/*/locations/*/sampleQuerySets/*/operations/*}',
|
@@ -295,6 +298,9 @@ class EstimateBillingServiceClient {
|
|
295
298
|
{
|
296
299
|
get: '/v1alpha/{name=projects/*/locations/*/dataStores/*}/operations',
|
297
300
|
},
|
301
|
+
{
|
302
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*}/operations',
|
303
|
+
},
|
298
304
|
{ get: '/v1alpha/{name=projects/*/locations/*}/operations' },
|
299
305
|
{ get: '/v1alpha/{name=projects/*}/operations' },
|
300
306
|
],
|
@@ -258,6 +258,9 @@ class EvaluationServiceClient {
|
|
258
258
|
{
|
259
259
|
get: '/v1alpha/{name=projects/*/locations/*/evaluations/*/operations/*}',
|
260
260
|
},
|
261
|
+
{
|
262
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}',
|
263
|
+
},
|
261
264
|
{ get: '/v1alpha/{name=projects/*/locations/*/operations/*}' },
|
262
265
|
{
|
263
266
|
get: '/v1alpha/{name=projects/*/locations/*/sampleQuerySets/*/operations/*}',
|
@@ -302,6 +305,9 @@ class EvaluationServiceClient {
|
|
302
305
|
{
|
303
306
|
get: '/v1alpha/{name=projects/*/locations/*/dataStores/*}/operations',
|
304
307
|
},
|
308
|
+
{
|
309
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*}/operations',
|
310
|
+
},
|
305
311
|
{ get: '/v1alpha/{name=projects/*/locations/*}/operations' },
|
306
312
|
{ get: '/v1alpha/{name=projects/*}/operations' },
|
307
313
|
],
|
@@ -250,6 +250,9 @@ class ProjectServiceClient {
|
|
250
250
|
{
|
251
251
|
get: '/v1alpha/{name=projects/*/locations/*/evaluations/*/operations/*}',
|
252
252
|
},
|
253
|
+
{
|
254
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}',
|
255
|
+
},
|
253
256
|
{ get: '/v1alpha/{name=projects/*/locations/*/operations/*}' },
|
254
257
|
{
|
255
258
|
get: '/v1alpha/{name=projects/*/locations/*/sampleQuerySets/*/operations/*}',
|
@@ -294,6 +297,9 @@ class ProjectServiceClient {
|
|
294
297
|
{
|
295
298
|
get: '/v1alpha/{name=projects/*/locations/*/dataStores/*}/operations',
|
296
299
|
},
|
300
|
+
{
|
301
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*}/operations',
|
302
|
+
},
|
297
303
|
{ get: '/v1alpha/{name=projects/*/locations/*}/operations' },
|
298
304
|
{ get: '/v1alpha/{name=projects/*}/operations' },
|
299
305
|
],
|
@@ -256,6 +256,9 @@ class SampleQueryServiceClient {
|
|
256
256
|
{
|
257
257
|
get: '/v1alpha/{name=projects/*/locations/*/evaluations/*/operations/*}',
|
258
258
|
},
|
259
|
+
{
|
260
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}',
|
261
|
+
},
|
259
262
|
{ get: '/v1alpha/{name=projects/*/locations/*/operations/*}' },
|
260
263
|
{
|
261
264
|
get: '/v1alpha/{name=projects/*/locations/*/sampleQuerySets/*/operations/*}',
|
@@ -300,6 +303,9 @@ class SampleQueryServiceClient {
|
|
300
303
|
{
|
301
304
|
get: '/v1alpha/{name=projects/*/locations/*/dataStores/*}/operations',
|
302
305
|
},
|
306
|
+
{
|
307
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*}/operations',
|
308
|
+
},
|
303
309
|
{ get: '/v1alpha/{name=projects/*/locations/*}/operations' },
|
304
310
|
{ get: '/v1alpha/{name=projects/*}/operations' },
|
305
311
|
],
|
@@ -255,6 +255,9 @@ class SchemaServiceClient {
|
|
255
255
|
{
|
256
256
|
get: '/v1alpha/{name=projects/*/locations/*/evaluations/*/operations/*}',
|
257
257
|
},
|
258
|
+
{
|
259
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}',
|
260
|
+
},
|
258
261
|
{ get: '/v1alpha/{name=projects/*/locations/*/operations/*}' },
|
259
262
|
{
|
260
263
|
get: '/v1alpha/{name=projects/*/locations/*/sampleQuerySets/*/operations/*}',
|
@@ -299,6 +302,9 @@ class SchemaServiceClient {
|
|
299
302
|
{
|
300
303
|
get: '/v1alpha/{name=projects/*/locations/*/dataStores/*}/operations',
|
301
304
|
},
|
305
|
+
{
|
306
|
+
get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*}/operations',
|
307
|
+
},
|
302
308
|
{ get: '/v1alpha/{name=projects/*/locations/*}/operations' },
|
303
309
|
{ get: '/v1alpha/{name=projects/*}/operations' },
|
304
310
|
],
|
@@ -206,15 +206,29 @@ export declare class SearchServiceClient {
|
|
206
206
|
* object. Leave it unset if ordered by relevance. `order_by` expression is
|
207
207
|
* case-sensitive.
|
208
208
|
*
|
209
|
-
* For more information on ordering
|
210
|
-
* [
|
211
|
-
*
|
209
|
+
* For more information on ordering the website search results, see
|
210
|
+
* [Order web search
|
211
|
+
* results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
|
212
|
+
* For more information on ordering the healthcare search results, see
|
213
|
+
* [Order healthcare search
|
214
|
+
* results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
|
212
215
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
213
216
|
* @param {google.cloud.discoveryengine.v1alpha.UserInfo} request.userInfo
|
214
217
|
* Information about the end user.
|
215
218
|
* Highly recommended for analytics.
|
216
219
|
* {@link protos.google.cloud.discoveryengine.v1alpha.UserInfo.user_agent|UserInfo.user_agent}
|
217
220
|
* is used to deduce `device_type` for analytics.
|
221
|
+
* @param {string} request.languageCode
|
222
|
+
* The BCP-47 language code, such as "en-US" or "sr-Latn". For more
|
223
|
+
* information, see [Standard
|
224
|
+
* fields](https://cloud.google.com/apis/design/standard_fields). This field
|
225
|
+
* helps to better interpret the query. If a value isn't specified, the query
|
226
|
+
* language code is automatically detected, which may not be accurate.
|
227
|
+
* @param {string} request.regionCode
|
228
|
+
* The Unicode country/region code (CLDR) of a location, such as "US" and
|
229
|
+
* "419". For more information, see [Standard
|
230
|
+
* fields](https://cloud.google.com/apis/design/standard_fields). If set,
|
231
|
+
* then results will be boosted based on the region_code provided.
|
218
232
|
* @param {number[]} request.facetSpecs
|
219
233
|
* Facet specifications for faceted search. If empty, no facets are returned.
|
220
234
|
*
|
@@ -279,20 +293,26 @@ export declare class SearchServiceClient {
|
|
279
293
|
* documents. This overrides
|
280
294
|
* {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
281
295
|
* The ranking expression is a single function or multiple functions that are
|
282
|
-
*
|
296
|
+
* joined by "+".
|
297
|
+
*
|
283
298
|
* * ranking_expression = function, { " + ", function };
|
299
|
+
*
|
284
300
|
* Supported functions:
|
301
|
+
*
|
285
302
|
* * double * relevance_score
|
286
303
|
* * double * dotProduct(embedding_field_path)
|
304
|
+
*
|
287
305
|
* Function variables:
|
288
|
-
*
|
306
|
+
*
|
307
|
+
* * `relevance_score`: pre-defined keywords, used for measure relevance
|
289
308
|
* between query and document.
|
290
|
-
* `embedding_field_path`: the document embedding field
|
309
|
+
* * `embedding_field_path`: the document embedding field
|
291
310
|
* used with query embedding vector.
|
292
|
-
* `dotProduct`: embedding function between embedding_field_path and query
|
311
|
+
* * `dotProduct`: embedding function between embedding_field_path and query
|
293
312
|
* embedding vector.
|
294
313
|
*
|
295
314
|
* Example ranking expression:
|
315
|
+
*
|
296
316
|
* If document has an embedding field doc_embedding, the ranking expression
|
297
317
|
* could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
298
318
|
* @param {boolean} request.safeSearch
|
@@ -316,8 +336,54 @@ export declare class SearchServiceClient {
|
|
316
336
|
* See [Google Cloud
|
317
337
|
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
318
338
|
* for more details.
|
339
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.NaturalLanguageQueryUnderstandingSpec} request.naturalLanguageQueryUnderstandingSpec
|
340
|
+
* If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
|
341
|
+
* natural language query understanding will be done.
|
342
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
|
343
|
+
* Search as you type configuration. Only supported for the
|
344
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
|
345
|
+
* vertical.
|
319
346
|
* @param {google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec} request.customFineTuningSpec
|
320
347
|
* Custom fine tuning configs.
|
348
|
+
* If set, it has higher priority than the configs set in
|
349
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.custom_fine_tuning_spec|ServingConfig.custom_fine_tuning_spec}.
|
350
|
+
* @param {string} request.session
|
351
|
+
* The session resource name. Optional.
|
352
|
+
*
|
353
|
+
* Session allows users to do multi-turn /search API calls or coordination
|
354
|
+
* between /search API calls and /answer API calls.
|
355
|
+
*
|
356
|
+
* Example #1 (multi-turn /search API calls):
|
357
|
+
* 1. Call /search API with the auto-session mode (see below).
|
358
|
+
* 2. Call /search API with the session ID generated in the first call.
|
359
|
+
* Here, the previous search query gets considered in query
|
360
|
+
* standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
361
|
+
* and the current query is "How about 2023?", the current query will
|
362
|
+
* be interpreted as "How did Alphabet do in 2023?".
|
363
|
+
*
|
364
|
+
* Example #2 (coordination between /search API calls and /answer API calls):
|
365
|
+
* 1. Call /search API with the auto-session mode (see below).
|
366
|
+
* 2. Call /answer API with the session ID generated in the first call.
|
367
|
+
* Here, the answer generation happens in the context of the search
|
368
|
+
* results from the first search call.
|
369
|
+
*
|
370
|
+
* Auto-session mode: when `projects/.../sessions/-` is used, a new session
|
371
|
+
* gets automatically created. Otherwise, users can use the create-session API
|
372
|
+
* to create a session manually.
|
373
|
+
*
|
374
|
+
* Multi-turn Search feature is currently at private GA stage. Please use
|
375
|
+
* v1alpha or v1beta version instead before we launch this feature to public
|
376
|
+
* GA. Or ask for allowlisting through Google Support team.
|
377
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.SessionSpec} request.sessionSpec
|
378
|
+
* Session specification.
|
379
|
+
*
|
380
|
+
* Can be used only when `session` is set.
|
381
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.RelevanceThreshold} request.relevanceThreshold
|
382
|
+
* The relevance threshold of the search results.
|
383
|
+
*
|
384
|
+
* Default to Google defined threshold, leveraging a balance of
|
385
|
+
* precision and recall to deliver both highly accurate results and
|
386
|
+
* comprehensive coverage of relevant information.
|
321
387
|
* @param {object} [options]
|
322
388
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
323
389
|
* @returns {Promise} - The promise which resolves to an array.
|
@@ -427,15 +493,29 @@ export declare class SearchServiceClient {
|
|
427
493
|
* object. Leave it unset if ordered by relevance. `order_by` expression is
|
428
494
|
* case-sensitive.
|
429
495
|
*
|
430
|
-
* For more information on ordering
|
431
|
-
* [
|
432
|
-
*
|
496
|
+
* For more information on ordering the website search results, see
|
497
|
+
* [Order web search
|
498
|
+
* results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
|
499
|
+
* For more information on ordering the healthcare search results, see
|
500
|
+
* [Order healthcare search
|
501
|
+
* results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
|
433
502
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
434
503
|
* @param {google.cloud.discoveryengine.v1alpha.UserInfo} request.userInfo
|
435
504
|
* Information about the end user.
|
436
505
|
* Highly recommended for analytics.
|
437
506
|
* {@link protos.google.cloud.discoveryengine.v1alpha.UserInfo.user_agent|UserInfo.user_agent}
|
438
507
|
* is used to deduce `device_type` for analytics.
|
508
|
+
* @param {string} request.languageCode
|
509
|
+
* The BCP-47 language code, such as "en-US" or "sr-Latn". For more
|
510
|
+
* information, see [Standard
|
511
|
+
* fields](https://cloud.google.com/apis/design/standard_fields). This field
|
512
|
+
* helps to better interpret the query. If a value isn't specified, the query
|
513
|
+
* language code is automatically detected, which may not be accurate.
|
514
|
+
* @param {string} request.regionCode
|
515
|
+
* The Unicode country/region code (CLDR) of a location, such as "US" and
|
516
|
+
* "419". For more information, see [Standard
|
517
|
+
* fields](https://cloud.google.com/apis/design/standard_fields). If set,
|
518
|
+
* then results will be boosted based on the region_code provided.
|
439
519
|
* @param {number[]} request.facetSpecs
|
440
520
|
* Facet specifications for faceted search. If empty, no facets are returned.
|
441
521
|
*
|
@@ -500,20 +580,26 @@ export declare class SearchServiceClient {
|
|
500
580
|
* documents. This overrides
|
501
581
|
* {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
502
582
|
* The ranking expression is a single function or multiple functions that are
|
503
|
-
*
|
583
|
+
* joined by "+".
|
584
|
+
*
|
504
585
|
* * ranking_expression = function, { " + ", function };
|
586
|
+
*
|
505
587
|
* Supported functions:
|
588
|
+
*
|
506
589
|
* * double * relevance_score
|
507
590
|
* * double * dotProduct(embedding_field_path)
|
591
|
+
*
|
508
592
|
* Function variables:
|
509
|
-
*
|
593
|
+
*
|
594
|
+
* * `relevance_score`: pre-defined keywords, used for measure relevance
|
510
595
|
* between query and document.
|
511
|
-
* `embedding_field_path`: the document embedding field
|
596
|
+
* * `embedding_field_path`: the document embedding field
|
512
597
|
* used with query embedding vector.
|
513
|
-
* `dotProduct`: embedding function between embedding_field_path and query
|
598
|
+
* * `dotProduct`: embedding function between embedding_field_path and query
|
514
599
|
* embedding vector.
|
515
600
|
*
|
516
601
|
* Example ranking expression:
|
602
|
+
*
|
517
603
|
* If document has an embedding field doc_embedding, the ranking expression
|
518
604
|
* could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
519
605
|
* @param {boolean} request.safeSearch
|
@@ -537,8 +623,54 @@ export declare class SearchServiceClient {
|
|
537
623
|
* See [Google Cloud
|
538
624
|
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
539
625
|
* for more details.
|
626
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.NaturalLanguageQueryUnderstandingSpec} request.naturalLanguageQueryUnderstandingSpec
|
627
|
+
* If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
|
628
|
+
* natural language query understanding will be done.
|
629
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
|
630
|
+
* Search as you type configuration. Only supported for the
|
631
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
|
632
|
+
* vertical.
|
540
633
|
* @param {google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec} request.customFineTuningSpec
|
541
634
|
* Custom fine tuning configs.
|
635
|
+
* If set, it has higher priority than the configs set in
|
636
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.custom_fine_tuning_spec|ServingConfig.custom_fine_tuning_spec}.
|
637
|
+
* @param {string} request.session
|
638
|
+
* The session resource name. Optional.
|
639
|
+
*
|
640
|
+
* Session allows users to do multi-turn /search API calls or coordination
|
641
|
+
* between /search API calls and /answer API calls.
|
642
|
+
*
|
643
|
+
* Example #1 (multi-turn /search API calls):
|
644
|
+
* 1. Call /search API with the auto-session mode (see below).
|
645
|
+
* 2. Call /search API with the session ID generated in the first call.
|
646
|
+
* Here, the previous search query gets considered in query
|
647
|
+
* standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
648
|
+
* and the current query is "How about 2023?", the current query will
|
649
|
+
* be interpreted as "How did Alphabet do in 2023?".
|
650
|
+
*
|
651
|
+
* Example #2 (coordination between /search API calls and /answer API calls):
|
652
|
+
* 1. Call /search API with the auto-session mode (see below).
|
653
|
+
* 2. Call /answer API with the session ID generated in the first call.
|
654
|
+
* Here, the answer generation happens in the context of the search
|
655
|
+
* results from the first search call.
|
656
|
+
*
|
657
|
+
* Auto-session mode: when `projects/.../sessions/-` is used, a new session
|
658
|
+
* gets automatically created. Otherwise, users can use the create-session API
|
659
|
+
* to create a session manually.
|
660
|
+
*
|
661
|
+
* Multi-turn Search feature is currently at private GA stage. Please use
|
662
|
+
* v1alpha or v1beta version instead before we launch this feature to public
|
663
|
+
* GA. Or ask for allowlisting through Google Support team.
|
664
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.SessionSpec} request.sessionSpec
|
665
|
+
* Session specification.
|
666
|
+
*
|
667
|
+
* Can be used only when `session` is set.
|
668
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.RelevanceThreshold} request.relevanceThreshold
|
669
|
+
* The relevance threshold of the search results.
|
670
|
+
*
|
671
|
+
* Default to Google defined threshold, leveraging a balance of
|
672
|
+
* precision and recall to deliver both highly accurate results and
|
673
|
+
* comprehensive coverage of relevant information.
|
542
674
|
* @param {object} [options]
|
543
675
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
544
676
|
* @returns {Stream}
|
@@ -643,15 +775,29 @@ export declare class SearchServiceClient {
|
|
643
775
|
* object. Leave it unset if ordered by relevance. `order_by` expression is
|
644
776
|
* case-sensitive.
|
645
777
|
*
|
646
|
-
* For more information on ordering
|
647
|
-
* [
|
648
|
-
*
|
778
|
+
* For more information on ordering the website search results, see
|
779
|
+
* [Order web search
|
780
|
+
* results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
|
781
|
+
* For more information on ordering the healthcare search results, see
|
782
|
+
* [Order healthcare search
|
783
|
+
* results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
|
649
784
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
650
785
|
* @param {google.cloud.discoveryengine.v1alpha.UserInfo} request.userInfo
|
651
786
|
* Information about the end user.
|
652
787
|
* Highly recommended for analytics.
|
653
788
|
* {@link protos.google.cloud.discoveryengine.v1alpha.UserInfo.user_agent|UserInfo.user_agent}
|
654
789
|
* is used to deduce `device_type` for analytics.
|
790
|
+
* @param {string} request.languageCode
|
791
|
+
* The BCP-47 language code, such as "en-US" or "sr-Latn". For more
|
792
|
+
* information, see [Standard
|
793
|
+
* fields](https://cloud.google.com/apis/design/standard_fields). This field
|
794
|
+
* helps to better interpret the query. If a value isn't specified, the query
|
795
|
+
* language code is automatically detected, which may not be accurate.
|
796
|
+
* @param {string} request.regionCode
|
797
|
+
* The Unicode country/region code (CLDR) of a location, such as "US" and
|
798
|
+
* "419". For more information, see [Standard
|
799
|
+
* fields](https://cloud.google.com/apis/design/standard_fields). If set,
|
800
|
+
* then results will be boosted based on the region_code provided.
|
655
801
|
* @param {number[]} request.facetSpecs
|
656
802
|
* Facet specifications for faceted search. If empty, no facets are returned.
|
657
803
|
*
|
@@ -716,20 +862,26 @@ export declare class SearchServiceClient {
|
|
716
862
|
* documents. This overrides
|
717
863
|
* {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
718
864
|
* The ranking expression is a single function or multiple functions that are
|
719
|
-
*
|
865
|
+
* joined by "+".
|
866
|
+
*
|
720
867
|
* * ranking_expression = function, { " + ", function };
|
868
|
+
*
|
721
869
|
* Supported functions:
|
870
|
+
*
|
722
871
|
* * double * relevance_score
|
723
872
|
* * double * dotProduct(embedding_field_path)
|
873
|
+
*
|
724
874
|
* Function variables:
|
725
|
-
*
|
875
|
+
*
|
876
|
+
* * `relevance_score`: pre-defined keywords, used for measure relevance
|
726
877
|
* between query and document.
|
727
|
-
* `embedding_field_path`: the document embedding field
|
878
|
+
* * `embedding_field_path`: the document embedding field
|
728
879
|
* used with query embedding vector.
|
729
|
-
* `dotProduct`: embedding function between embedding_field_path and query
|
880
|
+
* * `dotProduct`: embedding function between embedding_field_path and query
|
730
881
|
* embedding vector.
|
731
882
|
*
|
732
883
|
* Example ranking expression:
|
884
|
+
*
|
733
885
|
* If document has an embedding field doc_embedding, the ranking expression
|
734
886
|
* could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
735
887
|
* @param {boolean} request.safeSearch
|
@@ -753,8 +905,54 @@ export declare class SearchServiceClient {
|
|
753
905
|
* See [Google Cloud
|
754
906
|
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
755
907
|
* for more details.
|
908
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.NaturalLanguageQueryUnderstandingSpec} request.naturalLanguageQueryUnderstandingSpec
|
909
|
+
* If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
|
910
|
+
* natural language query understanding will be done.
|
911
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
|
912
|
+
* Search as you type configuration. Only supported for the
|
913
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
|
914
|
+
* vertical.
|
756
915
|
* @param {google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec} request.customFineTuningSpec
|
757
916
|
* Custom fine tuning configs.
|
917
|
+
* If set, it has higher priority than the configs set in
|
918
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.custom_fine_tuning_spec|ServingConfig.custom_fine_tuning_spec}.
|
919
|
+
* @param {string} request.session
|
920
|
+
* The session resource name. Optional.
|
921
|
+
*
|
922
|
+
* Session allows users to do multi-turn /search API calls or coordination
|
923
|
+
* between /search API calls and /answer API calls.
|
924
|
+
*
|
925
|
+
* Example #1 (multi-turn /search API calls):
|
926
|
+
* 1. Call /search API with the auto-session mode (see below).
|
927
|
+
* 2. Call /search API with the session ID generated in the first call.
|
928
|
+
* Here, the previous search query gets considered in query
|
929
|
+
* standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
930
|
+
* and the current query is "How about 2023?", the current query will
|
931
|
+
* be interpreted as "How did Alphabet do in 2023?".
|
932
|
+
*
|
933
|
+
* Example #2 (coordination between /search API calls and /answer API calls):
|
934
|
+
* 1. Call /search API with the auto-session mode (see below).
|
935
|
+
* 2. Call /answer API with the session ID generated in the first call.
|
936
|
+
* Here, the answer generation happens in the context of the search
|
937
|
+
* results from the first search call.
|
938
|
+
*
|
939
|
+
* Auto-session mode: when `projects/.../sessions/-` is used, a new session
|
940
|
+
* gets automatically created. Otherwise, users can use the create-session API
|
941
|
+
* to create a session manually.
|
942
|
+
*
|
943
|
+
* Multi-turn Search feature is currently at private GA stage. Please use
|
944
|
+
* v1alpha or v1beta version instead before we launch this feature to public
|
945
|
+
* GA. Or ask for allowlisting through Google Support team.
|
946
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.SessionSpec} request.sessionSpec
|
947
|
+
* Session specification.
|
948
|
+
*
|
949
|
+
* Can be used only when `session` is set.
|
950
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.RelevanceThreshold} request.relevanceThreshold
|
951
|
+
* The relevance threshold of the search results.
|
952
|
+
*
|
953
|
+
* Default to Google defined threshold, leveraging a balance of
|
954
|
+
* precision and recall to deliver both highly accurate results and
|
955
|
+
* comprehensive coverage of relevant information.
|
758
956
|
* @param {object} [options]
|
759
957
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
760
958
|
* @returns {Object}
|