@google-cloud/discoveryengine 0.5.0 → 0.7.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 +24 -0
- package/README.md +38 -21
- package/build/protos/google/cloud/discoveryengine/v1/common.proto +100 -0
- package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +116 -0
- package/build/protos/google/cloud/discoveryengine/v1/document.proto +118 -0
- package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +313 -0
- package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +334 -0
- package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +86 -0
- package/build/protos/google/cloud/discoveryengine/v1/schema.proto +58 -0
- package/build/protos/google/cloud/discoveryengine/v1/schema_service.proto +256 -0
- package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +289 -0
- package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +458 -0
- package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +133 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +3 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +34 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +54 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +86 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +29 -4
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +17 -13
- package/build/protos/protos.d.ts +6937 -0
- package/build/protos/protos.js +55830 -1
- package/build/protos/protos.json +5770 -1
- package/build/src/index.d.ts +18 -19
- package/build/src/index.js +9 -9
- package/build/src/v1/completion_service_client.d.ts +455 -0
- package/build/src/v1/completion_service_client.js +659 -0
- package/build/src/v1/completion_service_client_config.json +43 -0
- package/build/src/v1/document_service_client.d.ts +995 -0
- package/build/src/v1/document_service_client.js +1191 -0
- package/build/src/v1/document_service_client_config.json +82 -0
- package/build/src/v1/index.d.ts +5 -0
- package/build/src/v1/index.js +31 -0
- package/build/src/v1/schema_service_client.d.ts +795 -0
- package/build/src/v1/schema_service_client.js +1129 -0
- package/build/src/v1/schema_service_client_config.json +63 -0
- package/build/src/v1/search_service_client.d.ts +857 -0
- package/build/src/v1/search_service_client.js +1073 -0
- package/build/src/v1/search_service_client_config.json +43 -0
- package/build/src/v1/user_event_service_client.d.ts +638 -0
- package/build/src/v1/user_event_service_client.js +933 -0
- package/build/src/v1/user_event_service_client_config.json +62 -0
- package/build/src/v1beta/document_service_client.d.ts +115 -0
- package/build/src/v1beta/document_service_client.js +49 -0
- package/build/src/v1beta/document_service_client_config.json +5 -0
- package/build/src/v1beta/schema_service_client.js +6 -0
- package/build/src/v1beta/search_service_client.d.ts +78 -12
- package/build/src/v1beta/search_service_client.js +52 -8
- package/build/src/v1beta/user_event_service_client.js +6 -0
- package/package.json +9 -7
@@ -0,0 +1,62 @@
|
|
1
|
+
{
|
2
|
+
"interfaces": {
|
3
|
+
"google.cloud.discoveryengine.v1.UserEventService": {
|
4
|
+
"retry_codes": {
|
5
|
+
"non_idempotent": [],
|
6
|
+
"idempotent": [
|
7
|
+
"DEADLINE_EXCEEDED",
|
8
|
+
"UNAVAILABLE"
|
9
|
+
],
|
10
|
+
"unavailable": [
|
11
|
+
"UNAVAILABLE"
|
12
|
+
]
|
13
|
+
},
|
14
|
+
"retry_params": {
|
15
|
+
"default": {
|
16
|
+
"initial_retry_delay_millis": 100,
|
17
|
+
"retry_delay_multiplier": 1.3,
|
18
|
+
"max_retry_delay_millis": 60000,
|
19
|
+
"initial_rpc_timeout_millis": 60000,
|
20
|
+
"rpc_timeout_multiplier": 1,
|
21
|
+
"max_rpc_timeout_millis": 60000,
|
22
|
+
"total_timeout_millis": 600000
|
23
|
+
},
|
24
|
+
"ce5b960a6ed052e690863808e4f0deff3dc7d49f": {
|
25
|
+
"initial_retry_delay_millis": 1000,
|
26
|
+
"retry_delay_multiplier": 1.3,
|
27
|
+
"max_retry_delay_millis": 10000,
|
28
|
+
"initial_rpc_timeout_millis": 60000,
|
29
|
+
"rpc_timeout_multiplier": 1,
|
30
|
+
"max_rpc_timeout_millis": 60000,
|
31
|
+
"total_timeout_millis": 600000
|
32
|
+
},
|
33
|
+
"e6a9f61a856ca7c2128ab9550ca4fb9e97c77876": {
|
34
|
+
"initial_retry_delay_millis": 1000,
|
35
|
+
"retry_delay_multiplier": 1.3,
|
36
|
+
"max_retry_delay_millis": 30000,
|
37
|
+
"initial_rpc_timeout_millis": 60000,
|
38
|
+
"rpc_timeout_multiplier": 1,
|
39
|
+
"max_rpc_timeout_millis": 60000,
|
40
|
+
"total_timeout_millis": 600000
|
41
|
+
}
|
42
|
+
},
|
43
|
+
"methods": {
|
44
|
+
"WriteUserEvent": {
|
45
|
+
"timeout_millis": 30000,
|
46
|
+
"retry_codes_name": "unavailable",
|
47
|
+
"retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
|
48
|
+
},
|
49
|
+
"CollectUserEvent": {
|
50
|
+
"timeout_millis": 30000,
|
51
|
+
"retry_codes_name": "unavailable",
|
52
|
+
"retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
|
53
|
+
},
|
54
|
+
"ImportUserEvents": {
|
55
|
+
"timeout_millis": 300000,
|
56
|
+
"retry_codes_name": "unavailable",
|
57
|
+
"retry_params_name": "e6a9f61a856ca7c2128ab9550ca4fb9e97c77876"
|
58
|
+
}
|
59
|
+
}
|
60
|
+
}
|
61
|
+
}
|
62
|
+
}
|
@@ -287,6 +287,58 @@ export declare class DocumentServiceClient {
|
|
287
287
|
* The mode of reconciliation between existing documents and the documents to
|
288
288
|
* be imported. Defaults to
|
289
289
|
* {@link google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL|ReconciliationMode.INCREMENTAL}.
|
290
|
+
* @param {boolean} request.autoGenerateIds
|
291
|
+
* Whether to automatically generate IDs for the documents if absent.
|
292
|
+
*
|
293
|
+
* If set to `true`,
|
294
|
+
* {@link google.cloud.discoveryengine.v1beta.Document.id|Document.id}s are
|
295
|
+
* automatically generated based on the hash of the payload, where IDs may not
|
296
|
+
* be consistent during multiple imports. In which case
|
297
|
+
* {@link google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.FULL|ReconciliationMode.FULL}
|
298
|
+
* is highly recommended to avoid duplicate contents. If unset or set to
|
299
|
+
* `false`, {@link google.cloud.discoveryengine.v1beta.Document.id|Document.id}s
|
300
|
+
* have to be specified using
|
301
|
+
* {@link google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.id_field|id_field},
|
302
|
+
* otherwises, documents without IDs will fail to be imported.
|
303
|
+
*
|
304
|
+
* Only set this field when using
|
305
|
+
* {@link google.cloud.discoveryengine.v1beta.GcsSource|GcsSource} or
|
306
|
+
* {@link google.cloud.discoveryengine.v1beta.BigQuerySource|BigQuerySource}, and
|
307
|
+
* when
|
308
|
+
* {@link google.cloud.discoveryengine.v1beta.GcsSource.data_schema|GcsSource.data_schema}
|
309
|
+
* or
|
310
|
+
* {@link google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema|BigQuerySource.data_schema}
|
311
|
+
* is `custom`. Otherwise, an INVALID_ARGUMENT error is thrown.
|
312
|
+
* @param {string} request.idField
|
313
|
+
* The field in the Cloud Storage and BigQuery sources that indicates the
|
314
|
+
* unique IDs of the documents.
|
315
|
+
*
|
316
|
+
* For {@link google.cloud.discoveryengine.v1beta.GcsSource|GcsSource} it is the
|
317
|
+
* key of the JSON field. For instance, `my_id` for JSON `{"my_id":
|
318
|
+
* "some_uuid"}`. For
|
319
|
+
* {@link google.cloud.discoveryengine.v1beta.BigQuerySource|BigQuerySource} it is
|
320
|
+
* the column name of the BigQuery table where the unique ids are stored.
|
321
|
+
*
|
322
|
+
* The values of the JSON field or the BigQuery column will be used as the
|
323
|
+
* {@link google.cloud.discoveryengine.v1beta.Document.id|Document.id}s. The JSON
|
324
|
+
* field or the BigQuery column must be of string type, and the values must be
|
325
|
+
* set as valid strings conform to
|
326
|
+
* [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters.
|
327
|
+
* Otherwise, documents without valid IDs will fail to be imported.
|
328
|
+
*
|
329
|
+
* Only set this field when using
|
330
|
+
* {@link google.cloud.discoveryengine.v1beta.GcsSource|GcsSource} or
|
331
|
+
* {@link google.cloud.discoveryengine.v1beta.BigQuerySource|BigQuerySource}, and
|
332
|
+
* when
|
333
|
+
* {@link google.cloud.discoveryengine.v1beta.GcsSource.data_schema|GcsSource.data_schema}
|
334
|
+
* or
|
335
|
+
* {@link google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema|BigQuerySource.data_schema}
|
336
|
+
* is `custom`. And only set this field when
|
337
|
+
* {@link google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.auto_generate_ids|auto_generate_ids}
|
338
|
+
* is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
|
339
|
+
*
|
340
|
+
* If it is unset, a default value `_id` is used when importing from the
|
341
|
+
* allowed data sources.
|
290
342
|
* @param {object} [options]
|
291
343
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
292
344
|
* @returns {Promise} - The promise which resolves to an array.
|
@@ -319,6 +371,69 @@ export declare class DocumentServiceClient {
|
|
319
371
|
* region_tag:discoveryengine_v1beta_generated_DocumentService_ImportDocuments_async
|
320
372
|
*/
|
321
373
|
checkImportDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.ImportDocumentsResponse, protos.google.cloud.discoveryengine.v1beta.ImportDocumentsMetadata>>;
|
374
|
+
/**
|
375
|
+
* Permanently deletes all selected
|
376
|
+
* {@link google.cloud.discoveryengine.v1beta.Document|Document}s in a branch.
|
377
|
+
*
|
378
|
+
* This process is asynchronous. Depending on the number of
|
379
|
+
* {@link google.cloud.discoveryengine.v1beta.Document|Document}s to be deleted,
|
380
|
+
* this operation can take hours to complete. Before the delete operation
|
381
|
+
* completes, some {@link google.cloud.discoveryengine.v1beta.Document|Document}s
|
382
|
+
* might still be returned by
|
383
|
+
* {@link google.cloud.discoveryengine.v1beta.DocumentService.GetDocument|DocumentService.GetDocument}
|
384
|
+
* or
|
385
|
+
* {@link google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}.
|
386
|
+
*
|
387
|
+
* To get a list of the
|
388
|
+
* {@link google.cloud.discoveryengine.v1beta.Document|Document}s to be deleted,
|
389
|
+
* set
|
390
|
+
* {@link google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.force|PurgeDocumentsRequest.force}
|
391
|
+
* to false.
|
392
|
+
*
|
393
|
+
* @param {Object} request
|
394
|
+
* The request object that will be sent.
|
395
|
+
* @param {string} request.parent
|
396
|
+
* Required. The parent resource name, such as
|
397
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
398
|
+
* @param {string} request.filter
|
399
|
+
* Required. Filter matching documents to purge. Only currently supported
|
400
|
+
* value is
|
401
|
+
* `*` (all items).
|
402
|
+
* @param {boolean} request.force
|
403
|
+
* Actually performs the purge. If `force` is set to false, return the
|
404
|
+
* expected purge count without deleting any documents.
|
405
|
+
* @param {object} [options]
|
406
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
407
|
+
* @returns {Promise} - The promise which resolves to an array.
|
408
|
+
* The first element of the array is an object representing
|
409
|
+
* a long running operation. Its `promise()` method returns a promise
|
410
|
+
* you can `await` for.
|
411
|
+
* Please see the
|
412
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
413
|
+
* for more details and examples.
|
414
|
+
* @example <caption>include:samples/generated/v1beta/document_service.purge_documents.js</caption>
|
415
|
+
* region_tag:discoveryengine_v1beta_generated_DocumentService_PurgeDocuments_async
|
416
|
+
*/
|
417
|
+
purgeDocuments(request?: protos.google.cloud.discoveryengine.v1beta.IPurgeDocumentsRequest, options?: CallOptions): Promise<[
|
418
|
+
LROperation<protos.google.cloud.discoveryengine.v1beta.IPurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1beta.IPurgeDocumentsMetadata>,
|
419
|
+
protos.google.longrunning.IOperation | undefined,
|
420
|
+
{} | undefined
|
421
|
+
]>;
|
422
|
+
purgeDocuments(request: protos.google.cloud.discoveryengine.v1beta.IPurgeDocumentsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IPurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1beta.IPurgeDocumentsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
423
|
+
purgeDocuments(request: protos.google.cloud.discoveryengine.v1beta.IPurgeDocumentsRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IPurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1beta.IPurgeDocumentsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
424
|
+
/**
|
425
|
+
* Check the status of the long running operation returned by `purgeDocuments()`.
|
426
|
+
* @param {String} name
|
427
|
+
* The operation name that will be passed.
|
428
|
+
* @returns {Promise} - The promise which resolves to an object.
|
429
|
+
* The decoded operation object has result and metadata field to get information from.
|
430
|
+
* Please see the
|
431
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
432
|
+
* for more details and examples.
|
433
|
+
* @example <caption>include:samples/generated/v1beta/document_service.purge_documents.js</caption>
|
434
|
+
* region_tag:discoveryengine_v1beta_generated_DocumentService_PurgeDocuments_async
|
435
|
+
*/
|
436
|
+
checkPurgeDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata>>;
|
322
437
|
/**
|
323
438
|
* Gets a list of {@link google.cloud.discoveryengine.v1beta.Document|Document}s.
|
324
439
|
*
|
@@ -174,6 +174,9 @@ class DocumentServiceClient {
|
|
174
174
|
{
|
175
175
|
get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/operations/*}',
|
176
176
|
},
|
177
|
+
{
|
178
|
+
get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*/operations/*}',
|
179
|
+
},
|
177
180
|
{
|
178
181
|
get: '/v1beta/{name=projects/*/locations/*/collections/*/operations/*}',
|
179
182
|
},
|
@@ -197,6 +200,9 @@ class DocumentServiceClient {
|
|
197
200
|
{
|
198
201
|
get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/models/*}/operations',
|
199
202
|
},
|
203
|
+
{
|
204
|
+
get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}/operations',
|
205
|
+
},
|
200
206
|
{
|
201
207
|
get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*}/operations',
|
202
208
|
},
|
@@ -223,8 +229,11 @@ class DocumentServiceClient {
|
|
223
229
|
.operationsClient(opts);
|
224
230
|
const importDocumentsResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1beta.ImportDocumentsResponse');
|
225
231
|
const importDocumentsMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1beta.ImportDocumentsMetadata');
|
232
|
+
const purgeDocumentsResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse');
|
233
|
+
const purgeDocumentsMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata');
|
226
234
|
this.descriptors.longrunning = {
|
227
235
|
importDocuments: new this._gaxModule.LongrunningDescriptor(this.operationsClient, importDocumentsResponse.decode.bind(importDocumentsResponse), importDocumentsMetadata.decode.bind(importDocumentsMetadata)),
|
236
|
+
purgeDocuments: new this._gaxModule.LongrunningDescriptor(this.operationsClient, purgeDocumentsResponse.decode.bind(purgeDocumentsResponse), purgeDocumentsMetadata.decode.bind(purgeDocumentsMetadata)),
|
228
237
|
};
|
229
238
|
// Put together the default options sent with requests.
|
230
239
|
this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1beta.DocumentService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
|
@@ -267,6 +276,7 @@ class DocumentServiceClient {
|
|
267
276
|
'updateDocument',
|
268
277
|
'deleteDocument',
|
269
278
|
'importDocuments',
|
279
|
+
'purgeDocuments',
|
270
280
|
];
|
271
281
|
for (const methodName of documentServiceStubMethods) {
|
272
282
|
const callPromise = this.documentServiceStub.then(stub => (...args) => {
|
@@ -450,6 +460,45 @@ class DocumentServiceClient {
|
|
450
460
|
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.importDocuments, this._gaxModule.createDefaultBackoffSettings());
|
451
461
|
return decodeOperation;
|
452
462
|
}
|
463
|
+
purgeDocuments(request, optionsOrCallback, callback) {
|
464
|
+
var _a;
|
465
|
+
request = request || {};
|
466
|
+
let options;
|
467
|
+
if (typeof optionsOrCallback === 'function' && callback === undefined) {
|
468
|
+
callback = optionsOrCallback;
|
469
|
+
options = {};
|
470
|
+
}
|
471
|
+
else {
|
472
|
+
options = optionsOrCallback;
|
473
|
+
}
|
474
|
+
options = options || {};
|
475
|
+
options.otherArgs = options.otherArgs || {};
|
476
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
477
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
478
|
+
this._gaxModule.routingHeader.fromParams({
|
479
|
+
parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
|
480
|
+
});
|
481
|
+
this.initialize();
|
482
|
+
return this.innerApiCalls.purgeDocuments(request, options, callback);
|
483
|
+
}
|
484
|
+
/**
|
485
|
+
* Check the status of the long running operation returned by `purgeDocuments()`.
|
486
|
+
* @param {String} name
|
487
|
+
* The operation name that will be passed.
|
488
|
+
* @returns {Promise} - The promise which resolves to an object.
|
489
|
+
* The decoded operation object has result and metadata field to get information from.
|
490
|
+
* Please see the
|
491
|
+
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
492
|
+
* for more details and examples.
|
493
|
+
* @example <caption>include:samples/generated/v1beta/document_service.purge_documents.js</caption>
|
494
|
+
* region_tag:discoveryengine_v1beta_generated_DocumentService_PurgeDocuments_async
|
495
|
+
*/
|
496
|
+
async checkPurgeDocumentsProgress(name) {
|
497
|
+
const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
|
498
|
+
const [operation] = await this.operationsClient.getOperation(request);
|
499
|
+
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.purgeDocuments, this._gaxModule.createDefaultBackoffSettings());
|
500
|
+
return decodeOperation;
|
501
|
+
}
|
453
502
|
listDocuments(request, optionsOrCallback, callback) {
|
454
503
|
var _a;
|
455
504
|
request = request || {};
|
@@ -70,6 +70,11 @@
|
|
70
70
|
"timeout_millis": 300000,
|
71
71
|
"retry_codes_name": "unavailable",
|
72
72
|
"retry_params_name": "e6a9f61a856ca7c2128ab9550ca4fb9e97c77876"
|
73
|
+
},
|
74
|
+
"PurgeDocuments": {
|
75
|
+
"timeout_millis": 30000,
|
76
|
+
"retry_codes_name": "unavailable",
|
77
|
+
"retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
|
73
78
|
}
|
74
79
|
}
|
75
80
|
}
|
@@ -172,6 +172,9 @@ class SchemaServiceClient {
|
|
172
172
|
{
|
173
173
|
get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/operations/*}',
|
174
174
|
},
|
175
|
+
{
|
176
|
+
get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*/operations/*}',
|
177
|
+
},
|
175
178
|
{
|
176
179
|
get: '/v1beta/{name=projects/*/locations/*/collections/*/operations/*}',
|
177
180
|
},
|
@@ -195,6 +198,9 @@ class SchemaServiceClient {
|
|
195
198
|
{
|
196
199
|
get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/models/*}/operations',
|
197
200
|
},
|
201
|
+
{
|
202
|
+
get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}/operations',
|
203
|
+
},
|
198
204
|
{
|
199
205
|
get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*}/operations',
|
200
206
|
},
|
@@ -162,6 +162,10 @@ export declare class SearchServiceClient {
|
|
162
162
|
* case-sensitive.
|
163
163
|
*
|
164
164
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
165
|
+
* @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
|
166
|
+
* Information about the end user.
|
167
|
+
* Highly recommended for analytics. The user_agent string in UserInfo will
|
168
|
+
* be used to deduce device_type for analytics.
|
165
169
|
* @param {number[]} request.facetSpecs
|
166
170
|
* Facet specifications for faceted search. If empty, no facets are returned.
|
167
171
|
*
|
@@ -172,16 +176,13 @@ export declare class SearchServiceClient {
|
|
172
176
|
* @param {number[]} request.params
|
173
177
|
* Additional search parameters.
|
174
178
|
*
|
175
|
-
* For
|
176
|
-
* {@link google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH|IndustryVertical.SITE_SEARCH}
|
177
|
-
* vertical, supported values are:
|
179
|
+
* For public website search only, supported values are:
|
178
180
|
*
|
179
181
|
* * `user_country_code`: string. Default empty. If set to non-empty, results
|
180
182
|
* are restricted or boosted based on the location provided.
|
181
183
|
* * `search_type`: double. Default empty. Enables non-webpage searching
|
182
184
|
* depending on the value. The only valid non-default value is 1,
|
183
185
|
* which enables image searching.
|
184
|
-
* This field is ignored for other verticals.
|
185
186
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
|
186
187
|
* The query expansion specification that specifies the conditions under which
|
187
188
|
* query expansion will occur.
|
@@ -206,6 +207,27 @@ export declare class SearchServiceClient {
|
|
206
207
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec} request.contentSearchSpec
|
207
208
|
* The content search spec that configs the desired behavior of content
|
208
209
|
* search.
|
210
|
+
* @param {boolean} request.safeSearch
|
211
|
+
* Whether to turn on safe search. This is only supported for
|
212
|
+
* {@link |ContentConfig.PUBLIC_WEBSITE}.
|
213
|
+
* @param {number[]} request.userLabels
|
214
|
+
* The user labels applied to a resource must meet the following requirements:
|
215
|
+
*
|
216
|
+
* * Each resource can have multiple labels, up to a maximum of 64.
|
217
|
+
* * Each label must be a key-value pair.
|
218
|
+
* * Keys have a minimum length of 1 character and a maximum length of 63
|
219
|
+
* characters and cannot be empty. Values can be empty and have a maximum
|
220
|
+
* length of 63 characters.
|
221
|
+
* * Keys and values can contain only lowercase letters, numeric characters,
|
222
|
+
* underscores, and dashes. All characters must use UTF-8 encoding, and
|
223
|
+
* international characters are allowed.
|
224
|
+
* * The key portion of a label must be unique. However, you can use the same
|
225
|
+
* key with multiple resources.
|
226
|
+
* * Keys must start with a lowercase letter or international character.
|
227
|
+
*
|
228
|
+
* See [Google Cloud
|
229
|
+
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
230
|
+
* for more details.
|
209
231
|
* @param {object} [options]
|
210
232
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
211
233
|
* @returns {Promise} - The promise which resolves to an array.
|
@@ -280,6 +302,10 @@ export declare class SearchServiceClient {
|
|
280
302
|
* case-sensitive.
|
281
303
|
*
|
282
304
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
305
|
+
* @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
|
306
|
+
* Information about the end user.
|
307
|
+
* Highly recommended for analytics. The user_agent string in UserInfo will
|
308
|
+
* be used to deduce device_type for analytics.
|
283
309
|
* @param {number[]} request.facetSpecs
|
284
310
|
* Facet specifications for faceted search. If empty, no facets are returned.
|
285
311
|
*
|
@@ -290,16 +316,13 @@ export declare class SearchServiceClient {
|
|
290
316
|
* @param {number[]} request.params
|
291
317
|
* Additional search parameters.
|
292
318
|
*
|
293
|
-
* For
|
294
|
-
* {@link google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH|IndustryVertical.SITE_SEARCH}
|
295
|
-
* vertical, supported values are:
|
319
|
+
* For public website search only, supported values are:
|
296
320
|
*
|
297
321
|
* * `user_country_code`: string. Default empty. If set to non-empty, results
|
298
322
|
* are restricted or boosted based on the location provided.
|
299
323
|
* * `search_type`: double. Default empty. Enables non-webpage searching
|
300
324
|
* depending on the value. The only valid non-default value is 1,
|
301
325
|
* which enables image searching.
|
302
|
-
* This field is ignored for other verticals.
|
303
326
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
|
304
327
|
* The query expansion specification that specifies the conditions under which
|
305
328
|
* query expansion will occur.
|
@@ -324,6 +347,27 @@ export declare class SearchServiceClient {
|
|
324
347
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec} request.contentSearchSpec
|
325
348
|
* The content search spec that configs the desired behavior of content
|
326
349
|
* search.
|
350
|
+
* @param {boolean} request.safeSearch
|
351
|
+
* Whether to turn on safe search. This is only supported for
|
352
|
+
* {@link |ContentConfig.PUBLIC_WEBSITE}.
|
353
|
+
* @param {number[]} request.userLabels
|
354
|
+
* The user labels applied to a resource must meet the following requirements:
|
355
|
+
*
|
356
|
+
* * Each resource can have multiple labels, up to a maximum of 64.
|
357
|
+
* * Each label must be a key-value pair.
|
358
|
+
* * Keys have a minimum length of 1 character and a maximum length of 63
|
359
|
+
* characters and cannot be empty. Values can be empty and have a maximum
|
360
|
+
* length of 63 characters.
|
361
|
+
* * Keys and values can contain only lowercase letters, numeric characters,
|
362
|
+
* underscores, and dashes. All characters must use UTF-8 encoding, and
|
363
|
+
* international characters are allowed.
|
364
|
+
* * The key portion of a label must be unique. However, you can use the same
|
365
|
+
* key with multiple resources.
|
366
|
+
* * Keys must start with a lowercase letter or international character.
|
367
|
+
*
|
368
|
+
* See [Google Cloud
|
369
|
+
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
370
|
+
* for more details.
|
327
371
|
* @param {object} [options]
|
328
372
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
329
373
|
* @returns {Stream}
|
@@ -393,6 +437,10 @@ export declare class SearchServiceClient {
|
|
393
437
|
* case-sensitive.
|
394
438
|
*
|
395
439
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
440
|
+
* @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
|
441
|
+
* Information about the end user.
|
442
|
+
* Highly recommended for analytics. The user_agent string in UserInfo will
|
443
|
+
* be used to deduce device_type for analytics.
|
396
444
|
* @param {number[]} request.facetSpecs
|
397
445
|
* Facet specifications for faceted search. If empty, no facets are returned.
|
398
446
|
*
|
@@ -403,16 +451,13 @@ export declare class SearchServiceClient {
|
|
403
451
|
* @param {number[]} request.params
|
404
452
|
* Additional search parameters.
|
405
453
|
*
|
406
|
-
* For
|
407
|
-
* {@link google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH|IndustryVertical.SITE_SEARCH}
|
408
|
-
* vertical, supported values are:
|
454
|
+
* For public website search only, supported values are:
|
409
455
|
*
|
410
456
|
* * `user_country_code`: string. Default empty. If set to non-empty, results
|
411
457
|
* are restricted or boosted based on the location provided.
|
412
458
|
* * `search_type`: double. Default empty. Enables non-webpage searching
|
413
459
|
* depending on the value. The only valid non-default value is 1,
|
414
460
|
* which enables image searching.
|
415
|
-
* This field is ignored for other verticals.
|
416
461
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
|
417
462
|
* The query expansion specification that specifies the conditions under which
|
418
463
|
* query expansion will occur.
|
@@ -437,6 +482,27 @@ export declare class SearchServiceClient {
|
|
437
482
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec} request.contentSearchSpec
|
438
483
|
* The content search spec that configs the desired behavior of content
|
439
484
|
* search.
|
485
|
+
* @param {boolean} request.safeSearch
|
486
|
+
* Whether to turn on safe search. This is only supported for
|
487
|
+
* {@link |ContentConfig.PUBLIC_WEBSITE}.
|
488
|
+
* @param {number[]} request.userLabels
|
489
|
+
* The user labels applied to a resource must meet the following requirements:
|
490
|
+
*
|
491
|
+
* * Each resource can have multiple labels, up to a maximum of 64.
|
492
|
+
* * Each label must be a key-value pair.
|
493
|
+
* * Keys have a minimum length of 1 character and a maximum length of 63
|
494
|
+
* characters and cannot be empty. Values can be empty and have a maximum
|
495
|
+
* length of 63 characters.
|
496
|
+
* * Keys and values can contain only lowercase letters, numeric characters,
|
497
|
+
* underscores, and dashes. All characters must use UTF-8 encoding, and
|
498
|
+
* international characters are allowed.
|
499
|
+
* * The key portion of a label must be unique. However, you can use the same
|
500
|
+
* key with multiple resources.
|
501
|
+
* * Keys must start with a lowercase letter or international character.
|
502
|
+
*
|
503
|
+
* See [Google Cloud
|
504
|
+
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
505
|
+
* for more details.
|
440
506
|
* @param {object} [options]
|
441
507
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
442
508
|
* @returns {Object}
|
@@ -320,6 +320,10 @@ class SearchServiceClient {
|
|
320
320
|
* case-sensitive.
|
321
321
|
*
|
322
322
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
323
|
+
* @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
|
324
|
+
* Information about the end user.
|
325
|
+
* Highly recommended for analytics. The user_agent string in UserInfo will
|
326
|
+
* be used to deduce device_type for analytics.
|
323
327
|
* @param {number[]} request.facetSpecs
|
324
328
|
* Facet specifications for faceted search. If empty, no facets are returned.
|
325
329
|
*
|
@@ -330,16 +334,13 @@ class SearchServiceClient {
|
|
330
334
|
* @param {number[]} request.params
|
331
335
|
* Additional search parameters.
|
332
336
|
*
|
333
|
-
* For
|
334
|
-
* {@link google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH|IndustryVertical.SITE_SEARCH}
|
335
|
-
* vertical, supported values are:
|
337
|
+
* For public website search only, supported values are:
|
336
338
|
*
|
337
339
|
* * `user_country_code`: string. Default empty. If set to non-empty, results
|
338
340
|
* are restricted or boosted based on the location provided.
|
339
341
|
* * `search_type`: double. Default empty. Enables non-webpage searching
|
340
342
|
* depending on the value. The only valid non-default value is 1,
|
341
343
|
* which enables image searching.
|
342
|
-
* This field is ignored for other verticals.
|
343
344
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
|
344
345
|
* The query expansion specification that specifies the conditions under which
|
345
346
|
* query expansion will occur.
|
@@ -364,6 +365,27 @@ class SearchServiceClient {
|
|
364
365
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec} request.contentSearchSpec
|
365
366
|
* The content search spec that configs the desired behavior of content
|
366
367
|
* search.
|
368
|
+
* @param {boolean} request.safeSearch
|
369
|
+
* Whether to turn on safe search. This is only supported for
|
370
|
+
* {@link |ContentConfig.PUBLIC_WEBSITE}.
|
371
|
+
* @param {number[]} request.userLabels
|
372
|
+
* The user labels applied to a resource must meet the following requirements:
|
373
|
+
*
|
374
|
+
* * Each resource can have multiple labels, up to a maximum of 64.
|
375
|
+
* * Each label must be a key-value pair.
|
376
|
+
* * Keys have a minimum length of 1 character and a maximum length of 63
|
377
|
+
* characters and cannot be empty. Values can be empty and have a maximum
|
378
|
+
* length of 63 characters.
|
379
|
+
* * Keys and values can contain only lowercase letters, numeric characters,
|
380
|
+
* underscores, and dashes. All characters must use UTF-8 encoding, and
|
381
|
+
* international characters are allowed.
|
382
|
+
* * The key portion of a label must be unique. However, you can use the same
|
383
|
+
* key with multiple resources.
|
384
|
+
* * Keys must start with a lowercase letter or international character.
|
385
|
+
*
|
386
|
+
* See [Google Cloud
|
387
|
+
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
388
|
+
* for more details.
|
367
389
|
* @param {object} [options]
|
368
390
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
369
391
|
* @returns {Stream}
|
@@ -447,6 +469,10 @@ class SearchServiceClient {
|
|
447
469
|
* case-sensitive.
|
448
470
|
*
|
449
471
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
472
|
+
* @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
|
473
|
+
* Information about the end user.
|
474
|
+
* Highly recommended for analytics. The user_agent string in UserInfo will
|
475
|
+
* be used to deduce device_type for analytics.
|
450
476
|
* @param {number[]} request.facetSpecs
|
451
477
|
* Facet specifications for faceted search. If empty, no facets are returned.
|
452
478
|
*
|
@@ -457,16 +483,13 @@ class SearchServiceClient {
|
|
457
483
|
* @param {number[]} request.params
|
458
484
|
* Additional search parameters.
|
459
485
|
*
|
460
|
-
* For
|
461
|
-
* {@link google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH|IndustryVertical.SITE_SEARCH}
|
462
|
-
* vertical, supported values are:
|
486
|
+
* For public website search only, supported values are:
|
463
487
|
*
|
464
488
|
* * `user_country_code`: string. Default empty. If set to non-empty, results
|
465
489
|
* are restricted or boosted based on the location provided.
|
466
490
|
* * `search_type`: double. Default empty. Enables non-webpage searching
|
467
491
|
* depending on the value. The only valid non-default value is 1,
|
468
492
|
* which enables image searching.
|
469
|
-
* This field is ignored for other verticals.
|
470
493
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
|
471
494
|
* The query expansion specification that specifies the conditions under which
|
472
495
|
* query expansion will occur.
|
@@ -491,6 +514,27 @@ class SearchServiceClient {
|
|
491
514
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec} request.contentSearchSpec
|
492
515
|
* The content search spec that configs the desired behavior of content
|
493
516
|
* search.
|
517
|
+
* @param {boolean} request.safeSearch
|
518
|
+
* Whether to turn on safe search. This is only supported for
|
519
|
+
* {@link |ContentConfig.PUBLIC_WEBSITE}.
|
520
|
+
* @param {number[]} request.userLabels
|
521
|
+
* The user labels applied to a resource must meet the following requirements:
|
522
|
+
*
|
523
|
+
* * Each resource can have multiple labels, up to a maximum of 64.
|
524
|
+
* * Each label must be a key-value pair.
|
525
|
+
* * Keys have a minimum length of 1 character and a maximum length of 63
|
526
|
+
* characters and cannot be empty. Values can be empty and have a maximum
|
527
|
+
* length of 63 characters.
|
528
|
+
* * Keys and values can contain only lowercase letters, numeric characters,
|
529
|
+
* underscores, and dashes. All characters must use UTF-8 encoding, and
|
530
|
+
* international characters are allowed.
|
531
|
+
* * The key portion of a label must be unique. However, you can use the same
|
532
|
+
* key with multiple resources.
|
533
|
+
* * Keys must start with a lowercase letter or international character.
|
534
|
+
*
|
535
|
+
* See [Google Cloud
|
536
|
+
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
537
|
+
* for more details.
|
494
538
|
* @param {object} [options]
|
495
539
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
496
540
|
* @returns {Object}
|
@@ -166,6 +166,9 @@ class UserEventServiceClient {
|
|
166
166
|
{
|
167
167
|
get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/operations/*}',
|
168
168
|
},
|
169
|
+
{
|
170
|
+
get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*/operations/*}',
|
171
|
+
},
|
169
172
|
{
|
170
173
|
get: '/v1beta/{name=projects/*/locations/*/collections/*/operations/*}',
|
171
174
|
},
|
@@ -189,6 +192,9 @@ class UserEventServiceClient {
|
|
189
192
|
{
|
190
193
|
get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/models/*}/operations',
|
191
194
|
},
|
195
|
+
{
|
196
|
+
get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}/operations',
|
197
|
+
},
|
192
198
|
{
|
193
199
|
get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*}/operations',
|
194
200
|
},
|
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "@google-cloud/discoveryengine",
|
3
|
-
"version": "0.
|
3
|
+
"version": "0.7.0",
|
4
4
|
"description": "Discovery Engine API client for Node.js",
|
5
5
|
"repository": {
|
6
6
|
"type": "git",
|
@@ -31,7 +31,7 @@
|
|
31
31
|
],
|
32
32
|
"scripts": {
|
33
33
|
"clean": "gts clean",
|
34
|
-
"compile": "tsc -p . && cp -r protos build/
|
34
|
+
"compile": "tsc -p . && cp -r protos build/",
|
35
35
|
"compile-protos": "compileProtos src",
|
36
36
|
"docs": "jsdoc -c .jsdoc.js",
|
37
37
|
"predocs-test": "npm run docs",
|
@@ -39,10 +39,11 @@
|
|
39
39
|
"fix": "gts fix",
|
40
40
|
"lint": "gts check",
|
41
41
|
"prepare": "npm run compile-protos && npm run compile",
|
42
|
-
"
|
43
|
-
"
|
44
|
-
"samples-test": "
|
45
|
-
"
|
42
|
+
"prelint": "cd samples; npm link ../; npm i",
|
43
|
+
"postpack": "minifyProtoJson",
|
44
|
+
"samples-test": "cd samples/ && npm link ../ && npm i && npm test",
|
45
|
+
"system-test": "c8 mocha build/system-test",
|
46
|
+
"test": "c8 mocha build/test"
|
46
47
|
},
|
47
48
|
"dependencies": {
|
48
49
|
"google-gax": "^3.5.8"
|
@@ -56,7 +57,8 @@
|
|
56
57
|
"jsdoc": "^4.0.0",
|
57
58
|
"jsdoc-fresh": "^2.0.0",
|
58
59
|
"jsdoc-region-tag": "^2.0.0",
|
59
|
-
"linkinator": "
|
60
|
+
"linkinator": "4.1.2",
|
61
|
+
"long": "^5.2.3",
|
60
62
|
"mocha": "^9.2.2",
|
61
63
|
"null-loader": "^4.0.1",
|
62
64
|
"pack-n-play": "^1.0.0-2",
|