@google-cloud/discoveryengine 0.4.0 → 0.5.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 +15 -0
- package/README.md +7 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +40 -9
- package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +116 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +45 -3
- package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +12 -12
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +26 -8
- package/build/protos/google/cloud/discoveryengine/v1beta/recommendation_service.proto +15 -14
- package/build/protos/google/cloud/discoveryengine/v1beta/schema.proto +58 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/schema_service.proto +259 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +546 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +14 -12
- package/build/protos/protos.d.ts +5625 -1874
- package/build/protos/protos.js +1 -30029
- package/build/protos/protos.json +1 -3028
- package/build/src/index.d.ts +10 -1
- package/build/src/index.js +10 -1
- package/build/src/v1beta/completion_service_client.d.ts +455 -0
- package/build/src/v1beta/completion_service_client.js +659 -0
- package/build/src/v1beta/completion_service_client_config.json +43 -0
- package/build/src/v1beta/document_service_client.d.ts +111 -18
- package/build/src/v1beta/document_service_client.js +134 -6
- package/build/src/v1beta/index.d.ts +3 -0
- package/build/src/v1beta/index.js +7 -1
- package/build/src/v1beta/recommendation_service_client.d.ts +108 -14
- package/build/src/v1beta/recommendation_service_client.js +128 -0
- package/build/src/v1beta/schema_service_client.d.ts +798 -0
- package/build/src/v1beta/schema_service_client.js +1122 -0
- package/build/src/v1beta/schema_service_client_config.json +63 -0
- package/build/src/v1beta/search_service_client.d.ts +851 -0
- package/build/src/v1beta/search_service_client.js +1070 -0
- package/build/src/v1beta/search_service_client_config.json +43 -0
- package/build/src/v1beta/user_event_service_client.d.ts +93 -0
- package/build/src/v1beta/user_event_service_client.js +128 -0
- package/package.json +5 -4
- package/build/src/index.js.map +0 -1
- package/build/src/v1beta/document_service_client.js.map +0 -1
- package/build/src/v1beta/index.js.map +0 -1
- package/build/src/v1beta/recommendation_service_client.js.map +0 -1
- package/build/src/v1beta/user_event_service_client.js.map +0 -1
@@ -0,0 +1,43 @@
|
|
1
|
+
{
|
2
|
+
"interfaces": {
|
3
|
+
"google.cloud.discoveryengine.v1beta.CompletionService": {
|
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
|
+
"319f27672a8be83550d842a373549dd84649a57e": {
|
25
|
+
"initial_retry_delay_millis": 100,
|
26
|
+
"retry_delay_multiplier": 1.3,
|
27
|
+
"max_retry_delay_millis": 5000,
|
28
|
+
"initial_rpc_timeout_millis": 60000,
|
29
|
+
"rpc_timeout_multiplier": 1,
|
30
|
+
"max_rpc_timeout_millis": 60000,
|
31
|
+
"total_timeout_millis": 600000
|
32
|
+
}
|
33
|
+
},
|
34
|
+
"methods": {
|
35
|
+
"CompleteQuery": {
|
36
|
+
"timeout_millis": 5000,
|
37
|
+
"retry_codes_name": "unavailable",
|
38
|
+
"retry_params_name": "319f27672a8be83550d842a373549dd84649a57e"
|
39
|
+
}
|
40
|
+
}
|
41
|
+
}
|
42
|
+
}
|
43
|
+
}
|
@@ -122,10 +122,10 @@ export declare class DocumentServiceClient {
|
|
122
122
|
*
|
123
123
|
* If the caller does not have permission to access the
|
124
124
|
* {@link google.cloud.discoveryengine.v1beta.Document|Document}, regardless of
|
125
|
-
* whether or not it exists, a PERMISSION_DENIED error is returned.
|
125
|
+
* whether or not it exists, a `PERMISSION_DENIED` error is returned.
|
126
126
|
*
|
127
127
|
* If the requested {@link google.cloud.discoveryengine.v1beta.Document|Document}
|
128
|
-
* does not exist, a NOT_FOUND error is returned.
|
128
|
+
* does not exist, a `NOT_FOUND` error is returned.
|
129
129
|
* @param {object} [options]
|
130
130
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
131
131
|
* @returns {Promise} - The promise which resolves to an array.
|
@@ -162,16 +162,16 @@ export declare class DocumentServiceClient {
|
|
162
162
|
*
|
163
163
|
* If the caller does not have permission to create the
|
164
164
|
* {@link google.cloud.discoveryengine.v1beta.Document|Document}, regardless of
|
165
|
-
* whether or not it exists, a PERMISSION_DENIED error is returned.
|
165
|
+
* whether or not it exists, a `PERMISSION_DENIED` error is returned.
|
166
166
|
*
|
167
167
|
* This field must be unique among all
|
168
168
|
* {@link google.cloud.discoveryengine.v1beta.Document|Document}s with the same
|
169
169
|
* {@link google.cloud.discoveryengine.v1beta.CreateDocumentRequest.parent|parent}.
|
170
|
-
* Otherwise, an ALREADY_EXISTS error is returned.
|
170
|
+
* Otherwise, an `ALREADY_EXISTS` error is returned.
|
171
171
|
*
|
172
172
|
* This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
|
173
173
|
* standard with a length limit of 63 characters. Otherwise, an
|
174
|
-
* INVALID_ARGUMENT error is returned.
|
174
|
+
* `INVALID_ARGUMENT` error is returned.
|
175
175
|
* @param {object} [options]
|
176
176
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
177
177
|
* @returns {Promise} - The promise which resolves to an array.
|
@@ -199,12 +199,12 @@ export declare class DocumentServiceClient {
|
|
199
199
|
*
|
200
200
|
* If the caller does not have permission to update the
|
201
201
|
* {@link google.cloud.discoveryengine.v1beta.Document|Document}, regardless of
|
202
|
-
* whether or not it exists, a PERMISSION_DENIED error is returned.
|
202
|
+
* whether or not it exists, a `PERMISSION_DENIED` error is returned.
|
203
203
|
*
|
204
204
|
* If the {@link google.cloud.discoveryengine.v1beta.Document|Document} to update
|
205
205
|
* does not exist and
|
206
206
|
* {@link google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing|allow_missing}
|
207
|
-
* is not set, a NOT_FOUND error is returned.
|
207
|
+
* is not set, a `NOT_FOUND` error is returned.
|
208
208
|
* @param {boolean} request.allowMissing
|
209
209
|
* If set to true, and the
|
210
210
|
* {@link google.cloud.discoveryengine.v1beta.Document|Document} is not found, a
|
@@ -239,10 +239,10 @@ export declare class DocumentServiceClient {
|
|
239
239
|
*
|
240
240
|
* If the caller does not have permission to delete the
|
241
241
|
* {@link google.cloud.discoveryengine.v1beta.Document|Document}, regardless of
|
242
|
-
* whether or not it exists, a PERMISSION_DENIED error is returned.
|
242
|
+
* whether or not it exists, a `PERMISSION_DENIED` error is returned.
|
243
243
|
*
|
244
244
|
* If the {@link google.cloud.discoveryengine.v1beta.Document|Document} to delete
|
245
|
-
* does not exist, a NOT_FOUND error is returned.
|
245
|
+
* does not exist, a `NOT_FOUND` error is returned.
|
246
246
|
* @param {object} [options]
|
247
247
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
248
248
|
* @returns {Promise} - The promise which resolves to an array.
|
@@ -332,13 +332,13 @@ export declare class DocumentServiceClient {
|
|
332
332
|
*
|
333
333
|
* If the caller does not have permission to list {@link |Documents}s under this
|
334
334
|
* branch, regardless of whether or not this branch exists, a
|
335
|
-
* PERMISSION_DENIED error is returned.
|
335
|
+
* `PERMISSION_DENIED` error is returned.
|
336
336
|
* @param {number} request.pageSize
|
337
337
|
* Maximum number of {@link google.cloud.discoveryengine.v1beta.Document|Document}s
|
338
338
|
* to return. If unspecified, defaults to 100. The maximum allowed value is
|
339
339
|
* 1000. Values above 1000 will be coerced to 1000.
|
340
340
|
*
|
341
|
-
* If this field is negative, an INVALID_ARGUMENT error is returned.
|
341
|
+
* If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
342
342
|
* @param {string} request.pageToken
|
343
343
|
* A page token
|
344
344
|
* {@link google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
|
@@ -349,7 +349,7 @@ export declare class DocumentServiceClient {
|
|
349
349
|
* When paginating, all other parameters provided to
|
350
350
|
* {@link google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
351
351
|
* must match the call that provided the page token. Otherwise, an
|
352
|
-
* INVALID_ARGUMENT error is returned.
|
352
|
+
* `INVALID_ARGUMENT` error is returned.
|
353
353
|
* @param {object} [options]
|
354
354
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
355
355
|
* @returns {Promise} - The promise which resolves to an array.
|
@@ -382,13 +382,13 @@ export declare class DocumentServiceClient {
|
|
382
382
|
*
|
383
383
|
* If the caller does not have permission to list {@link |Documents}s under this
|
384
384
|
* branch, regardless of whether or not this branch exists, a
|
385
|
-
* PERMISSION_DENIED error is returned.
|
385
|
+
* `PERMISSION_DENIED` error is returned.
|
386
386
|
* @param {number} request.pageSize
|
387
387
|
* Maximum number of {@link google.cloud.discoveryengine.v1beta.Document|Document}s
|
388
388
|
* to return. If unspecified, defaults to 100. The maximum allowed value is
|
389
389
|
* 1000. Values above 1000 will be coerced to 1000.
|
390
390
|
*
|
391
|
-
* If this field is negative, an INVALID_ARGUMENT error is returned.
|
391
|
+
* If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
392
392
|
* @param {string} request.pageToken
|
393
393
|
* A page token
|
394
394
|
* {@link google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
|
@@ -399,7 +399,7 @@ export declare class DocumentServiceClient {
|
|
399
399
|
* When paginating, all other parameters provided to
|
400
400
|
* {@link google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
401
401
|
* must match the call that provided the page token. Otherwise, an
|
402
|
-
* INVALID_ARGUMENT error is returned.
|
402
|
+
* `INVALID_ARGUMENT` error is returned.
|
403
403
|
* @param {object} [options]
|
404
404
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
405
405
|
* @returns {Stream}
|
@@ -427,13 +427,13 @@ export declare class DocumentServiceClient {
|
|
427
427
|
*
|
428
428
|
* If the caller does not have permission to list {@link |Documents}s under this
|
429
429
|
* branch, regardless of whether or not this branch exists, a
|
430
|
-
* PERMISSION_DENIED error is returned.
|
430
|
+
* `PERMISSION_DENIED` error is returned.
|
431
431
|
* @param {number} request.pageSize
|
432
432
|
* Maximum number of {@link google.cloud.discoveryengine.v1beta.Document|Document}s
|
433
433
|
* to return. If unspecified, defaults to 100. The maximum allowed value is
|
434
434
|
* 1000. Values above 1000 will be coerced to 1000.
|
435
435
|
*
|
436
|
-
* If this field is negative, an INVALID_ARGUMENT error is returned.
|
436
|
+
* If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
437
437
|
* @param {string} request.pageToken
|
438
438
|
* A page token
|
439
439
|
* {@link google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
|
@@ -444,7 +444,7 @@ export declare class DocumentServiceClient {
|
|
444
444
|
* When paginating, all other parameters provided to
|
445
445
|
* {@link google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
446
446
|
* must match the call that provided the page token. Otherwise, an
|
447
|
-
* INVALID_ARGUMENT error is returned.
|
447
|
+
* `INVALID_ARGUMENT` error is returned.
|
448
448
|
* @param {object} [options]
|
449
449
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
450
450
|
* @returns {Object}
|
@@ -690,6 +690,57 @@ export declare class DocumentServiceClient {
|
|
690
690
|
* @returns {string} A string representing the document.
|
691
691
|
*/
|
692
692
|
matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
693
|
+
/**
|
694
|
+
* Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
|
695
|
+
*
|
696
|
+
* @param {string} project
|
697
|
+
* @param {string} location
|
698
|
+
* @param {string} collection
|
699
|
+
* @param {string} data_store
|
700
|
+
* @param {string} schema
|
701
|
+
* @returns {string} Resource name string.
|
702
|
+
*/
|
703
|
+
projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
|
704
|
+
/**
|
705
|
+
* Parse the project from ProjectLocationCollectionDataStoreSchema resource.
|
706
|
+
*
|
707
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
708
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
709
|
+
* @returns {string} A string representing the project.
|
710
|
+
*/
|
711
|
+
matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
712
|
+
/**
|
713
|
+
* Parse the location from ProjectLocationCollectionDataStoreSchema resource.
|
714
|
+
*
|
715
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
716
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
717
|
+
* @returns {string} A string representing the location.
|
718
|
+
*/
|
719
|
+
matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
720
|
+
/**
|
721
|
+
* Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
|
722
|
+
*
|
723
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
724
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
725
|
+
* @returns {string} A string representing the collection.
|
726
|
+
*/
|
727
|
+
matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
728
|
+
/**
|
729
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
|
730
|
+
*
|
731
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
732
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
733
|
+
* @returns {string} A string representing the data_store.
|
734
|
+
*/
|
735
|
+
matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
736
|
+
/**
|
737
|
+
* Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
|
738
|
+
*
|
739
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
740
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
741
|
+
* @returns {string} A string representing the schema.
|
742
|
+
*/
|
743
|
+
matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
693
744
|
/**
|
694
745
|
* Return a fully-qualified projectLocationDataStoreBranch resource name string.
|
695
746
|
*
|
@@ -783,6 +834,48 @@ export declare class DocumentServiceClient {
|
|
783
834
|
* @returns {string} A string representing the document.
|
784
835
|
*/
|
785
836
|
matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
837
|
+
/**
|
838
|
+
* Return a fully-qualified projectLocationDataStoreSchema resource name string.
|
839
|
+
*
|
840
|
+
* @param {string} project
|
841
|
+
* @param {string} location
|
842
|
+
* @param {string} data_store
|
843
|
+
* @param {string} schema
|
844
|
+
* @returns {string} Resource name string.
|
845
|
+
*/
|
846
|
+
projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
|
847
|
+
/**
|
848
|
+
* Parse the project from ProjectLocationDataStoreSchema resource.
|
849
|
+
*
|
850
|
+
* @param {string} projectLocationDataStoreSchemaName
|
851
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
852
|
+
* @returns {string} A string representing the project.
|
853
|
+
*/
|
854
|
+
matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
855
|
+
/**
|
856
|
+
* Parse the location from ProjectLocationDataStoreSchema resource.
|
857
|
+
*
|
858
|
+
* @param {string} projectLocationDataStoreSchemaName
|
859
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
860
|
+
* @returns {string} A string representing the location.
|
861
|
+
*/
|
862
|
+
matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
863
|
+
/**
|
864
|
+
* Parse the data_store from ProjectLocationDataStoreSchema resource.
|
865
|
+
*
|
866
|
+
* @param {string} projectLocationDataStoreSchemaName
|
867
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
868
|
+
* @returns {string} A string representing the data_store.
|
869
|
+
*/
|
870
|
+
matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
871
|
+
/**
|
872
|
+
* Parse the schema from ProjectLocationDataStoreSchema resource.
|
873
|
+
*
|
874
|
+
* @param {string} projectLocationDataStoreSchemaName
|
875
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
876
|
+
* @returns {string} A string representing the schema.
|
877
|
+
*/
|
878
|
+
matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
786
879
|
/**
|
787
880
|
* Terminate the gRPC channel and close the client.
|
788
881
|
*
|
@@ -142,8 +142,10 @@ class DocumentServiceClient {
|
|
142
142
|
this.pathTemplates = {
|
143
143
|
projectLocationCollectionDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}'),
|
144
144
|
projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
|
145
|
+
projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
|
145
146
|
projectLocationDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}'),
|
146
147
|
projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
|
148
|
+
projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
|
147
149
|
};
|
148
150
|
// Some of the methods on this service return "paged" results,
|
149
151
|
// (e.g. 50 results at a time, with tokens to get subsequent
|
@@ -481,13 +483,13 @@ class DocumentServiceClient {
|
|
481
483
|
*
|
482
484
|
* If the caller does not have permission to list {@link |Documents}s under this
|
483
485
|
* branch, regardless of whether or not this branch exists, a
|
484
|
-
* PERMISSION_DENIED error is returned.
|
486
|
+
* `PERMISSION_DENIED` error is returned.
|
485
487
|
* @param {number} request.pageSize
|
486
488
|
* Maximum number of {@link google.cloud.discoveryengine.v1beta.Document|Document}s
|
487
489
|
* to return. If unspecified, defaults to 100. The maximum allowed value is
|
488
490
|
* 1000. Values above 1000 will be coerced to 1000.
|
489
491
|
*
|
490
|
-
* If this field is negative, an INVALID_ARGUMENT error is returned.
|
492
|
+
* If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
491
493
|
* @param {string} request.pageToken
|
492
494
|
* A page token
|
493
495
|
* {@link google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
|
@@ -498,7 +500,7 @@ class DocumentServiceClient {
|
|
498
500
|
* When paginating, all other parameters provided to
|
499
501
|
* {@link google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
500
502
|
* must match the call that provided the page token. Otherwise, an
|
501
|
-
* INVALID_ARGUMENT error is returned.
|
503
|
+
* `INVALID_ARGUMENT` error is returned.
|
502
504
|
* @param {object} [options]
|
503
505
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
504
506
|
* @returns {Stream}
|
@@ -540,13 +542,13 @@ class DocumentServiceClient {
|
|
540
542
|
*
|
541
543
|
* If the caller does not have permission to list {@link |Documents}s under this
|
542
544
|
* branch, regardless of whether or not this branch exists, a
|
543
|
-
* PERMISSION_DENIED error is returned.
|
545
|
+
* `PERMISSION_DENIED` error is returned.
|
544
546
|
* @param {number} request.pageSize
|
545
547
|
* Maximum number of {@link google.cloud.discoveryengine.v1beta.Document|Document}s
|
546
548
|
* to return. If unspecified, defaults to 100. The maximum allowed value is
|
547
549
|
* 1000. Values above 1000 will be coerced to 1000.
|
548
550
|
*
|
549
|
-
* If this field is negative, an INVALID_ARGUMENT error is returned.
|
551
|
+
* If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
550
552
|
* @param {string} request.pageToken
|
551
553
|
* A page token
|
552
554
|
* {@link google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
|
@@ -557,7 +559,7 @@ class DocumentServiceClient {
|
|
557
559
|
* When paginating, all other parameters provided to
|
558
560
|
* {@link google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
559
561
|
* must match the call that provided the page token. Otherwise, an
|
560
|
-
* INVALID_ARGUMENT error is returned.
|
562
|
+
* `INVALID_ARGUMENT` error is returned.
|
561
563
|
* @param {object} [options]
|
562
564
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
563
565
|
* @returns {Object}
|
@@ -867,6 +869,75 @@ class DocumentServiceClient {
|
|
867
869
|
matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
|
868
870
|
return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).document;
|
869
871
|
}
|
872
|
+
/**
|
873
|
+
* Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
|
874
|
+
*
|
875
|
+
* @param {string} project
|
876
|
+
* @param {string} location
|
877
|
+
* @param {string} collection
|
878
|
+
* @param {string} data_store
|
879
|
+
* @param {string} schema
|
880
|
+
* @returns {string} Resource name string.
|
881
|
+
*/
|
882
|
+
projectLocationCollectionDataStoreSchemaPath(project, location, collection, dataStore, schema) {
|
883
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.render({
|
884
|
+
project: project,
|
885
|
+
location: location,
|
886
|
+
collection: collection,
|
887
|
+
data_store: dataStore,
|
888
|
+
schema: schema,
|
889
|
+
});
|
890
|
+
}
|
891
|
+
/**
|
892
|
+
* Parse the project from ProjectLocationCollectionDataStoreSchema resource.
|
893
|
+
*
|
894
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
895
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
896
|
+
* @returns {string} A string representing the project.
|
897
|
+
*/
|
898
|
+
matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
|
899
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).project;
|
900
|
+
}
|
901
|
+
/**
|
902
|
+
* Parse the location from ProjectLocationCollectionDataStoreSchema resource.
|
903
|
+
*
|
904
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
905
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
906
|
+
* @returns {string} A string representing the location.
|
907
|
+
*/
|
908
|
+
matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
|
909
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).location;
|
910
|
+
}
|
911
|
+
/**
|
912
|
+
* Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
|
913
|
+
*
|
914
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
915
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
916
|
+
* @returns {string} A string representing the collection.
|
917
|
+
*/
|
918
|
+
matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
|
919
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).collection;
|
920
|
+
}
|
921
|
+
/**
|
922
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
|
923
|
+
*
|
924
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
925
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
926
|
+
* @returns {string} A string representing the data_store.
|
927
|
+
*/
|
928
|
+
matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
|
929
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).data_store;
|
930
|
+
}
|
931
|
+
/**
|
932
|
+
* Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
|
933
|
+
*
|
934
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
935
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
936
|
+
* @returns {string} A string representing the schema.
|
937
|
+
*/
|
938
|
+
matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
|
939
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).schema;
|
940
|
+
}
|
870
941
|
/**
|
871
942
|
* Return a fully-qualified projectLocationDataStoreBranch resource name string.
|
872
943
|
*
|
@@ -993,6 +1064,63 @@ class DocumentServiceClient {
|
|
993
1064
|
matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
|
994
1065
|
return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).document;
|
995
1066
|
}
|
1067
|
+
/**
|
1068
|
+
* Return a fully-qualified projectLocationDataStoreSchema resource name string.
|
1069
|
+
*
|
1070
|
+
* @param {string} project
|
1071
|
+
* @param {string} location
|
1072
|
+
* @param {string} data_store
|
1073
|
+
* @param {string} schema
|
1074
|
+
* @returns {string} Resource name string.
|
1075
|
+
*/
|
1076
|
+
projectLocationDataStoreSchemaPath(project, location, dataStore, schema) {
|
1077
|
+
return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.render({
|
1078
|
+
project: project,
|
1079
|
+
location: location,
|
1080
|
+
data_store: dataStore,
|
1081
|
+
schema: schema,
|
1082
|
+
});
|
1083
|
+
}
|
1084
|
+
/**
|
1085
|
+
* Parse the project from ProjectLocationDataStoreSchema resource.
|
1086
|
+
*
|
1087
|
+
* @param {string} projectLocationDataStoreSchemaName
|
1088
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
1089
|
+
* @returns {string} A string representing the project.
|
1090
|
+
*/
|
1091
|
+
matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
|
1092
|
+
return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).project;
|
1093
|
+
}
|
1094
|
+
/**
|
1095
|
+
* Parse the location from ProjectLocationDataStoreSchema resource.
|
1096
|
+
*
|
1097
|
+
* @param {string} projectLocationDataStoreSchemaName
|
1098
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
1099
|
+
* @returns {string} A string representing the location.
|
1100
|
+
*/
|
1101
|
+
matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
|
1102
|
+
return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).location;
|
1103
|
+
}
|
1104
|
+
/**
|
1105
|
+
* Parse the data_store from ProjectLocationDataStoreSchema resource.
|
1106
|
+
*
|
1107
|
+
* @param {string} projectLocationDataStoreSchemaName
|
1108
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
1109
|
+
* @returns {string} A string representing the data_store.
|
1110
|
+
*/
|
1111
|
+
matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
|
1112
|
+
return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).data_store;
|
1113
|
+
}
|
1114
|
+
/**
|
1115
|
+
* Parse the schema from ProjectLocationDataStoreSchema resource.
|
1116
|
+
*
|
1117
|
+
* @param {string} projectLocationDataStoreSchemaName
|
1118
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
1119
|
+
* @returns {string} A string representing the schema.
|
1120
|
+
*/
|
1121
|
+
matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
|
1122
|
+
return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).schema;
|
1123
|
+
}
|
996
1124
|
/**
|
997
1125
|
* Terminate the gRPC channel and close the client.
|
998
1126
|
*
|
@@ -1,3 +1,6 @@
|
|
1
|
+
export { CompletionServiceClient } from './completion_service_client';
|
1
2
|
export { DocumentServiceClient } from './document_service_client';
|
2
3
|
export { RecommendationServiceClient } from './recommendation_service_client';
|
4
|
+
export { SchemaServiceClient } from './schema_service_client';
|
5
|
+
export { SearchServiceClient } from './search_service_client';
|
3
6
|
export { UserEventServiceClient } from './user_event_service_client';
|
@@ -17,11 +17,17 @@
|
|
17
17
|
// ** https://github.com/googleapis/gapic-generator-typescript **
|
18
18
|
// ** All changes to this file may be overwritten. **
|
19
19
|
Object.defineProperty(exports, "__esModule", { value: true });
|
20
|
-
exports.UserEventServiceClient = exports.RecommendationServiceClient = exports.DocumentServiceClient = void 0;
|
20
|
+
exports.UserEventServiceClient = exports.SearchServiceClient = exports.SchemaServiceClient = exports.RecommendationServiceClient = exports.DocumentServiceClient = exports.CompletionServiceClient = void 0;
|
21
|
+
var completion_service_client_1 = require("./completion_service_client");
|
22
|
+
Object.defineProperty(exports, "CompletionServiceClient", { enumerable: true, get: function () { return completion_service_client_1.CompletionServiceClient; } });
|
21
23
|
var document_service_client_1 = require("./document_service_client");
|
22
24
|
Object.defineProperty(exports, "DocumentServiceClient", { enumerable: true, get: function () { return document_service_client_1.DocumentServiceClient; } });
|
23
25
|
var recommendation_service_client_1 = require("./recommendation_service_client");
|
24
26
|
Object.defineProperty(exports, "RecommendationServiceClient", { enumerable: true, get: function () { return recommendation_service_client_1.RecommendationServiceClient; } });
|
27
|
+
var schema_service_client_1 = require("./schema_service_client");
|
28
|
+
Object.defineProperty(exports, "SchemaServiceClient", { enumerable: true, get: function () { return schema_service_client_1.SchemaServiceClient; } });
|
29
|
+
var search_service_client_1 = require("./search_service_client");
|
30
|
+
Object.defineProperty(exports, "SearchServiceClient", { enumerable: true, get: function () { return search_service_client_1.SearchServiceClient; } });
|
25
31
|
var user_event_service_client_1 = require("./user_event_service_client");
|
26
32
|
Object.defineProperty(exports, "UserEventServiceClient", { enumerable: true, get: function () { return user_event_service_client_1.UserEventServiceClient; } });
|
27
33
|
//# sourceMappingURL=index.js.map
|