@google-cloud/discoveryengine 0.7.0 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- package/CHANGELOG.md +24 -0
- package/README.md +6 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +1 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +15 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +131 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +281 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +6 -5
- package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +26 -22
- package/build/protos/google/cloud/discoveryengine/v1beta/schema.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +193 -47
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +41 -36
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +2 -2
- package/build/protos/protos.d.ts +6529 -4472
- package/build/protos/protos.js +16561 -11622
- package/build/protos/protos.json +1842 -1317
- package/build/src/v1/completion_service_client.d.ts +6 -7
- package/build/src/v1/document_service_client.d.ts +83 -94
- package/build/src/v1/document_service_client.js +18 -22
- package/build/src/v1/schema_service_client.d.ts +39 -49
- package/build/src/v1/schema_service_client.js +17 -22
- package/build/src/v1/search_service_client.d.ts +31 -34
- package/build/src/v1/search_service_client.js +21 -23
- package/build/src/v1/user_event_service_client.d.ts +6 -10
- package/build/src/v1/user_event_service_client.js +1 -2
- package/build/src/v1beta/completion_service_client.d.ts +106 -8
- package/build/src/v1beta/completion_service_client.js +128 -0
- package/build/src/v1beta/conversational_search_service_client.d.ts +876 -0
- package/build/src/v1beta/conversational_search_service_client.js +1149 -0
- package/build/src/v1beta/conversational_search_service_client_config.json +68 -0
- package/build/src/v1beta/document_service_client.d.ts +183 -98
- package/build/src/v1beta/document_service_client.js +166 -22
- package/build/src/v1beta/index.d.ts +1 -0
- package/build/src/v1beta/index.js +3 -1
- package/build/src/v1beta/recommendation_service_client.d.ts +103 -11
- package/build/src/v1beta/recommendation_service_client.js +128 -0
- package/build/src/v1beta/schema_service_client.d.ts +132 -49
- package/build/src/v1beta/schema_service_client.js +163 -22
- package/build/src/v1beta/search_service_client.d.ts +163 -67
- package/build/src/v1beta/search_service_client.js +175 -45
- package/build/src/v1beta/user_event_service_client.d.ts +104 -15
- package/build/src/v1beta/user_event_service_client.js +147 -2
- package/package.json +8 -11
@@ -283,26 +283,26 @@ class SearchServiceClient {
|
|
283
283
|
* @param {string} request.query
|
284
284
|
* Raw search query.
|
285
285
|
* @param {number} request.pageSize
|
286
|
-
* Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
|
286
|
+
* Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
|
287
287
|
* return. If unspecified, defaults to a reasonable value. The maximum allowed
|
288
288
|
* value is 100. Values above 100 will be coerced to 100.
|
289
289
|
*
|
290
290
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
291
291
|
* @param {string} request.pageToken
|
292
292
|
* A page token received from a previous
|
293
|
-
* {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
293
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
294
294
|
* call. Provide this to retrieve the subsequent page.
|
295
295
|
*
|
296
296
|
* When paginating, all other parameters provided to
|
297
|
-
* {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
297
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
298
298
|
* must match the call that provided the page token. Otherwise, an
|
299
299
|
* `INVALID_ARGUMENT` error is returned.
|
300
300
|
* @param {number} request.offset
|
301
301
|
* A 0-indexed integer that specifies the current offset (that is, starting
|
302
302
|
* result location, amongst the
|
303
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
|
303
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
|
304
304
|
* relevant) in search results. This field is only considered if
|
305
|
-
* {@link google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
|
305
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
|
306
306
|
* unset.
|
307
307
|
*
|
308
308
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
@@ -335,9 +335,9 @@ class SearchServiceClient {
|
|
335
335
|
* This field should NOT have a fixed value such as `unknown_visitor`.
|
336
336
|
*
|
337
337
|
* This should be the same identifier as
|
338
|
-
* {@link google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
338
|
+
* {@link protos.google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
339
339
|
* and
|
340
|
-
* {@link google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
340
|
+
* {@link protos.google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
341
341
|
*
|
342
342
|
* The field must be a UTF-8 encoded string with a length limit of 128
|
343
343
|
* characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
@@ -346,7 +346,7 @@ class SearchServiceClient {
|
|
346
346
|
* search.
|
347
347
|
* @param {boolean} request.safeSearch
|
348
348
|
* Whether to turn on safe search. This is only supported for
|
349
|
-
* {@link
|
349
|
+
* {@link protos.|ContentConfig.PUBLIC_WEBSITE}.
|
350
350
|
* @param {number[]} request.userLabels
|
351
351
|
* The user labels applied to a resource must meet the following requirements:
|
352
352
|
*
|
@@ -368,13 +368,12 @@ class SearchServiceClient {
|
|
368
368
|
* @param {object} [options]
|
369
369
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
370
370
|
* @returns {Stream}
|
371
|
-
* An object stream which emits an object representing {@link google.cloud.discoveryengine.v1.SearchResponse.SearchResult
|
371
|
+
* An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1.SearchResponse.SearchResult|SearchResult} on 'data' event.
|
372
372
|
* The client library will perform auto-pagination by default: it will call the API as many
|
373
373
|
* times as needed. Note that it can affect your quota.
|
374
374
|
* We recommend using `searchAsync()`
|
375
375
|
* method described below for async iteration which you can stop as needed.
|
376
|
-
* Please see the
|
377
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
376
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
378
377
|
* for more details and examples.
|
379
378
|
*/
|
380
379
|
searchStream(request, options) {
|
@@ -412,26 +411,26 @@ class SearchServiceClient {
|
|
412
411
|
* @param {string} request.query
|
413
412
|
* Raw search query.
|
414
413
|
* @param {number} request.pageSize
|
415
|
-
* Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
|
414
|
+
* Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
|
416
415
|
* return. If unspecified, defaults to a reasonable value. The maximum allowed
|
417
416
|
* value is 100. Values above 100 will be coerced to 100.
|
418
417
|
*
|
419
418
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
420
419
|
* @param {string} request.pageToken
|
421
420
|
* A page token received from a previous
|
422
|
-
* {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
421
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
423
422
|
* call. Provide this to retrieve the subsequent page.
|
424
423
|
*
|
425
424
|
* When paginating, all other parameters provided to
|
426
|
-
* {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
425
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
427
426
|
* must match the call that provided the page token. Otherwise, an
|
428
427
|
* `INVALID_ARGUMENT` error is returned.
|
429
428
|
* @param {number} request.offset
|
430
429
|
* A 0-indexed integer that specifies the current offset (that is, starting
|
431
430
|
* result location, amongst the
|
432
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
|
431
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
|
433
432
|
* relevant) in search results. This field is only considered if
|
434
|
-
* {@link google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
|
433
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
|
435
434
|
* unset.
|
436
435
|
*
|
437
436
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
@@ -464,9 +463,9 @@ class SearchServiceClient {
|
|
464
463
|
* This field should NOT have a fixed value such as `unknown_visitor`.
|
465
464
|
*
|
466
465
|
* This should be the same identifier as
|
467
|
-
* {@link google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
466
|
+
* {@link protos.google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
468
467
|
* and
|
469
|
-
* {@link google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
468
|
+
* {@link protos.google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
470
469
|
*
|
471
470
|
* The field must be a UTF-8 encoded string with a length limit of 128
|
472
471
|
* characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
@@ -475,7 +474,7 @@ class SearchServiceClient {
|
|
475
474
|
* search.
|
476
475
|
* @param {boolean} request.safeSearch
|
477
476
|
* Whether to turn on safe search. This is only supported for
|
478
|
-
* {@link
|
477
|
+
* {@link protos.|ContentConfig.PUBLIC_WEBSITE}.
|
479
478
|
* @param {number[]} request.userLabels
|
480
479
|
* The user labels applied to a resource must meet the following requirements:
|
481
480
|
*
|
@@ -497,12 +496,11 @@ class SearchServiceClient {
|
|
497
496
|
* @param {object} [options]
|
498
497
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
499
498
|
* @returns {Object}
|
500
|
-
* An iterable Object that allows
|
499
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
501
500
|
* When you iterate the returned iterable, each element will be an object representing
|
502
|
-
* {@link google.cloud.discoveryengine.v1.SearchResponse.SearchResult
|
501
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchResponse.SearchResult|SearchResult}. The API will be called under the hood as needed, once per the page,
|
503
502
|
* so you can stop the iteration when you don't need more results.
|
504
|
-
* Please see the
|
505
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
503
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
506
504
|
* for more details and examples.
|
507
505
|
* @example <caption>include:samples/generated/v1/search_service.search.js</caption>
|
508
506
|
* region_tag:discoveryengine_v1_generated_SearchService_Search_async
|
@@ -119,9 +119,8 @@ export declare class UserEventServiceClient {
|
|
119
119
|
* @param {object} [options]
|
120
120
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
121
121
|
* @returns {Promise} - The promise which resolves to an array.
|
122
|
-
* The first element of the array is an object representing {@link google.cloud.discoveryengine.v1.UserEvent
|
123
|
-
* Please see the
|
124
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
122
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1.UserEvent|UserEvent}.
|
123
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
125
124
|
* for more details and examples.
|
126
125
|
* @example <caption>include:samples/generated/v1/user_event_service.write_user_event.js</caption>
|
127
126
|
* region_tag:discoveryengine_v1_generated_UserEventService_WriteUserEvent_async
|
@@ -160,9 +159,8 @@ export declare class UserEventServiceClient {
|
|
160
159
|
* @param {object} [options]
|
161
160
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
162
161
|
* @returns {Promise} - The promise which resolves to an array.
|
163
|
-
* The first element of the array is an object representing {@link google.api.HttpBody
|
164
|
-
* Please see the
|
165
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
162
|
+
* The first element of the array is an object representing {@link protos.google.api.HttpBody|HttpBody}.
|
163
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
166
164
|
* for more details and examples.
|
167
165
|
* @example <caption>include:samples/generated/v1/user_event_service.collect_user_event.js</caption>
|
168
166
|
* region_tag:discoveryengine_v1_generated_UserEventService_CollectUserEvent_async
|
@@ -203,8 +201,7 @@ export declare class UserEventServiceClient {
|
|
203
201
|
* The first element of the array is an object representing
|
204
202
|
* a long running operation. Its `promise()` method returns a promise
|
205
203
|
* you can `await` for.
|
206
|
-
* Please see the
|
207
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
204
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
208
205
|
* for more details and examples.
|
209
206
|
* @example <caption>include:samples/generated/v1/user_event_service.import_user_events.js</caption>
|
210
207
|
* region_tag:discoveryengine_v1_generated_UserEventService_ImportUserEvents_async
|
@@ -222,8 +219,7 @@ export declare class UserEventServiceClient {
|
|
222
219
|
* The operation name that will be passed.
|
223
220
|
* @returns {Promise} - The promise which resolves to an object.
|
224
221
|
* The decoded operation object has result and metadata field to get information from.
|
225
|
-
* Please see the
|
226
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
222
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
227
223
|
* for more details and examples.
|
228
224
|
* @example <caption>include:samples/generated/v1/user_event_service.import_user_events.js</caption>
|
229
225
|
* region_tag:discoveryengine_v1_generated_UserEventService_ImportUserEvents_async
|
@@ -391,8 +391,7 @@ class UserEventServiceClient {
|
|
391
391
|
* The operation name that will be passed.
|
392
392
|
* @returns {Promise} - The promise which resolves to an object.
|
393
393
|
* The decoded operation object has result and metadata field to get information from.
|
394
|
-
* Please see the
|
395
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
394
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
396
395
|
* for more details and examples.
|
397
396
|
* @example <caption>include:samples/generated/v1/user_event_service.import_user_events.js</caption>
|
398
397
|
* region_tag:discoveryengine_v1_generated_UserEventService_ImportUserEvents_async
|
@@ -123,17 +123,18 @@ export declare class CompletionServiceClient {
|
|
123
123
|
*
|
124
124
|
* * `document` - Using suggestions generated from user-imported documents.
|
125
125
|
* * `search-history` - Using suggestions generated from the past history of
|
126
|
-
* {@link google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
126
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
127
127
|
* API calls. Do not use it when there is no traffic for Search API.
|
128
128
|
* * `user-event` - Using suggestions generated from user-imported search
|
129
129
|
* events.
|
130
|
+
* * `document-completable` - Using suggestions taken directly from
|
131
|
+
* user-imported document fields marked as completable.
|
130
132
|
*
|
131
133
|
* Default values:
|
132
134
|
*
|
133
135
|
* * `document` is the default model for regular dataStores.
|
134
136
|
* * `search-history` is the default model for
|
135
|
-
* {@link
|
136
|
-
* dataStores.
|
137
|
+
* {@link protos.|IndustryVertical.SITE_SEARCH} dataStores.
|
137
138
|
* @param {string} request.userPseudoId
|
138
139
|
* A unique identifier for tracking visitors. For example, this could be
|
139
140
|
* implemented with an HTTP cookie, which should be able to uniquely identify
|
@@ -143,18 +144,22 @@ export declare class CompletionServiceClient {
|
|
143
144
|
* This field should NOT have a fixed value such as `unknown_visitor`.
|
144
145
|
*
|
145
146
|
* This should be the same identifier as
|
146
|
-
* {@link google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
147
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
147
148
|
* and
|
148
|
-
* {@link google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id|SearchRequest.user_pseudo_id}.
|
149
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id|SearchRequest.user_pseudo_id}.
|
149
150
|
*
|
150
151
|
* The field must be a UTF-8 encoded string with a length limit of 128
|
151
152
|
* characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
153
|
+
* @param {boolean} request.includeTailSuggestions
|
154
|
+
* Indicates if tail suggestions should be returned if there are no
|
155
|
+
* suggestions that match the full query. Even if set to true, if there are
|
156
|
+
* suggestions that match the full query, those are returned and no
|
157
|
+
* tail suggestions are returned.
|
152
158
|
* @param {object} [options]
|
153
159
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
154
160
|
* @returns {Promise} - The promise which resolves to an array.
|
155
|
-
* The first element of the array is an object representing {@link google.cloud.discoveryengine.v1beta.CompleteQueryResponse
|
156
|
-
* Please see the
|
157
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
161
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1beta.CompleteQueryResponse|CompleteQueryResponse}.
|
162
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
158
163
|
* for more details and examples.
|
159
164
|
* @example <caption>include:samples/generated/v1beta/completion_service.complete_query.js</caption>
|
160
165
|
* region_tag:discoveryengine_v1beta_generated_CompletionService_CompleteQuery_async
|
@@ -268,6 +273,57 @@ export declare class CompletionServiceClient {
|
|
268
273
|
* @returns {string} A string representing the document.
|
269
274
|
*/
|
270
275
|
matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
276
|
+
/**
|
277
|
+
* Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
|
278
|
+
*
|
279
|
+
* @param {string} project
|
280
|
+
* @param {string} location
|
281
|
+
* @param {string} collection
|
282
|
+
* @param {string} data_store
|
283
|
+
* @param {string} conversation
|
284
|
+
* @returns {string} Resource name string.
|
285
|
+
*/
|
286
|
+
projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
|
287
|
+
/**
|
288
|
+
* Parse the project from ProjectLocationCollectionDataStoreConversation resource.
|
289
|
+
*
|
290
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
291
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
292
|
+
* @returns {string} A string representing the project.
|
293
|
+
*/
|
294
|
+
matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
295
|
+
/**
|
296
|
+
* Parse the location from ProjectLocationCollectionDataStoreConversation resource.
|
297
|
+
*
|
298
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
299
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
300
|
+
* @returns {string} A string representing the location.
|
301
|
+
*/
|
302
|
+
matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
303
|
+
/**
|
304
|
+
* Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
|
305
|
+
*
|
306
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
307
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
308
|
+
* @returns {string} A string representing the collection.
|
309
|
+
*/
|
310
|
+
matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
311
|
+
/**
|
312
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
|
313
|
+
*
|
314
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
315
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
316
|
+
* @returns {string} A string representing the data_store.
|
317
|
+
*/
|
318
|
+
matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
319
|
+
/**
|
320
|
+
* Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
|
321
|
+
*
|
322
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
323
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
324
|
+
* @returns {string} A string representing the conversation.
|
325
|
+
*/
|
326
|
+
matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
271
327
|
/**
|
272
328
|
* Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
|
273
329
|
*
|
@@ -403,6 +459,48 @@ export declare class CompletionServiceClient {
|
|
403
459
|
* @returns {string} A string representing the document.
|
404
460
|
*/
|
405
461
|
matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
462
|
+
/**
|
463
|
+
* Return a fully-qualified projectLocationDataStoreConversation resource name string.
|
464
|
+
*
|
465
|
+
* @param {string} project
|
466
|
+
* @param {string} location
|
467
|
+
* @param {string} data_store
|
468
|
+
* @param {string} conversation
|
469
|
+
* @returns {string} Resource name string.
|
470
|
+
*/
|
471
|
+
projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
|
472
|
+
/**
|
473
|
+
* Parse the project from ProjectLocationDataStoreConversation resource.
|
474
|
+
*
|
475
|
+
* @param {string} projectLocationDataStoreConversationName
|
476
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
477
|
+
* @returns {string} A string representing the project.
|
478
|
+
*/
|
479
|
+
matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
480
|
+
/**
|
481
|
+
* Parse the location from ProjectLocationDataStoreConversation resource.
|
482
|
+
*
|
483
|
+
* @param {string} projectLocationDataStoreConversationName
|
484
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
485
|
+
* @returns {string} A string representing the location.
|
486
|
+
*/
|
487
|
+
matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
488
|
+
/**
|
489
|
+
* Parse the data_store from ProjectLocationDataStoreConversation resource.
|
490
|
+
*
|
491
|
+
* @param {string} projectLocationDataStoreConversationName
|
492
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
493
|
+
* @returns {string} A string representing the data_store.
|
494
|
+
*/
|
495
|
+
matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
496
|
+
/**
|
497
|
+
* Parse the conversation from ProjectLocationDataStoreConversation resource.
|
498
|
+
*
|
499
|
+
* @param {string} projectLocationDataStoreConversationName
|
500
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
501
|
+
* @returns {string} A string representing the conversation.
|
502
|
+
*/
|
503
|
+
matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
406
504
|
/**
|
407
505
|
* Return a fully-qualified projectLocationDataStoreSchema resource name string.
|
408
506
|
*
|
@@ -140,9 +140,11 @@ class CompletionServiceClient {
|
|
140
140
|
this.pathTemplates = {
|
141
141
|
projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
|
142
142
|
projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
|
143
|
+
projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
|
143
144
|
projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
|
144
145
|
projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
|
145
146
|
projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
|
147
|
+
projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
|
146
148
|
projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
|
147
149
|
};
|
148
150
|
// Put together the default options sent with requests.
|
@@ -399,6 +401,75 @@ class CompletionServiceClient {
|
|
399
401
|
matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
|
400
402
|
return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).document;
|
401
403
|
}
|
404
|
+
/**
|
405
|
+
* Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
|
406
|
+
*
|
407
|
+
* @param {string} project
|
408
|
+
* @param {string} location
|
409
|
+
* @param {string} collection
|
410
|
+
* @param {string} data_store
|
411
|
+
* @param {string} conversation
|
412
|
+
* @returns {string} Resource name string.
|
413
|
+
*/
|
414
|
+
projectLocationCollectionDataStoreConversationPath(project, location, collection, dataStore, conversation) {
|
415
|
+
return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.render({
|
416
|
+
project: project,
|
417
|
+
location: location,
|
418
|
+
collection: collection,
|
419
|
+
data_store: dataStore,
|
420
|
+
conversation: conversation,
|
421
|
+
});
|
422
|
+
}
|
423
|
+
/**
|
424
|
+
* Parse the project from ProjectLocationCollectionDataStoreConversation resource.
|
425
|
+
*
|
426
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
427
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
428
|
+
* @returns {string} A string representing the project.
|
429
|
+
*/
|
430
|
+
matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
|
431
|
+
return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).project;
|
432
|
+
}
|
433
|
+
/**
|
434
|
+
* Parse the location from ProjectLocationCollectionDataStoreConversation resource.
|
435
|
+
*
|
436
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
437
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
438
|
+
* @returns {string} A string representing the location.
|
439
|
+
*/
|
440
|
+
matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
|
441
|
+
return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).location;
|
442
|
+
}
|
443
|
+
/**
|
444
|
+
* Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
|
445
|
+
*
|
446
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
447
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
448
|
+
* @returns {string} A string representing the collection.
|
449
|
+
*/
|
450
|
+
matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
|
451
|
+
return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).collection;
|
452
|
+
}
|
453
|
+
/**
|
454
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
|
455
|
+
*
|
456
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
457
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
458
|
+
* @returns {string} A string representing the data_store.
|
459
|
+
*/
|
460
|
+
matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
|
461
|
+
return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).data_store;
|
462
|
+
}
|
463
|
+
/**
|
464
|
+
* Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
|
465
|
+
*
|
466
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
467
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
468
|
+
* @returns {string} A string representing the conversation.
|
469
|
+
*/
|
470
|
+
matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
|
471
|
+
return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).conversation;
|
472
|
+
}
|
402
473
|
/**
|
403
474
|
* Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
|
404
475
|
*
|
@@ -582,6 +653,63 @@ class CompletionServiceClient {
|
|
582
653
|
matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
|
583
654
|
return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).document;
|
584
655
|
}
|
656
|
+
/**
|
657
|
+
* Return a fully-qualified projectLocationDataStoreConversation resource name string.
|
658
|
+
*
|
659
|
+
* @param {string} project
|
660
|
+
* @param {string} location
|
661
|
+
* @param {string} data_store
|
662
|
+
* @param {string} conversation
|
663
|
+
* @returns {string} Resource name string.
|
664
|
+
*/
|
665
|
+
projectLocationDataStoreConversationPath(project, location, dataStore, conversation) {
|
666
|
+
return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.render({
|
667
|
+
project: project,
|
668
|
+
location: location,
|
669
|
+
data_store: dataStore,
|
670
|
+
conversation: conversation,
|
671
|
+
});
|
672
|
+
}
|
673
|
+
/**
|
674
|
+
* Parse the project from ProjectLocationDataStoreConversation resource.
|
675
|
+
*
|
676
|
+
* @param {string} projectLocationDataStoreConversationName
|
677
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
678
|
+
* @returns {string} A string representing the project.
|
679
|
+
*/
|
680
|
+
matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
|
681
|
+
return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).project;
|
682
|
+
}
|
683
|
+
/**
|
684
|
+
* Parse the location from ProjectLocationDataStoreConversation resource.
|
685
|
+
*
|
686
|
+
* @param {string} projectLocationDataStoreConversationName
|
687
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
688
|
+
* @returns {string} A string representing the location.
|
689
|
+
*/
|
690
|
+
matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
|
691
|
+
return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).location;
|
692
|
+
}
|
693
|
+
/**
|
694
|
+
* Parse the data_store from ProjectLocationDataStoreConversation resource.
|
695
|
+
*
|
696
|
+
* @param {string} projectLocationDataStoreConversationName
|
697
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
698
|
+
* @returns {string} A string representing the data_store.
|
699
|
+
*/
|
700
|
+
matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
|
701
|
+
return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).data_store;
|
702
|
+
}
|
703
|
+
/**
|
704
|
+
* Parse the conversation from ProjectLocationDataStoreConversation resource.
|
705
|
+
*
|
706
|
+
* @param {string} projectLocationDataStoreConversationName
|
707
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
708
|
+
* @returns {string} A string representing the conversation.
|
709
|
+
*/
|
710
|
+
matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
|
711
|
+
return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).conversation;
|
712
|
+
}
|
585
713
|
/**
|
586
714
|
* Return a fully-qualified projectLocationDataStoreSchema resource name string.
|
587
715
|
*
|