@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.
Files changed (43) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/README.md +6 -0
  3. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +1 -2
  4. package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +15 -2
  5. package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +131 -0
  6. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +281 -0
  7. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +6 -5
  8. package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +2 -1
  9. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +26 -22
  10. package/build/protos/google/cloud/discoveryengine/v1beta/schema.proto +1 -1
  11. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +193 -47
  12. package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +41 -36
  13. package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +2 -2
  14. package/build/protos/protos.d.ts +6529 -4472
  15. package/build/protos/protos.js +16561 -11622
  16. package/build/protos/protos.json +1842 -1317
  17. package/build/src/v1/completion_service_client.d.ts +6 -7
  18. package/build/src/v1/document_service_client.d.ts +83 -94
  19. package/build/src/v1/document_service_client.js +18 -22
  20. package/build/src/v1/schema_service_client.d.ts +39 -49
  21. package/build/src/v1/schema_service_client.js +17 -22
  22. package/build/src/v1/search_service_client.d.ts +31 -34
  23. package/build/src/v1/search_service_client.js +21 -23
  24. package/build/src/v1/user_event_service_client.d.ts +6 -10
  25. package/build/src/v1/user_event_service_client.js +1 -2
  26. package/build/src/v1beta/completion_service_client.d.ts +106 -8
  27. package/build/src/v1beta/completion_service_client.js +128 -0
  28. package/build/src/v1beta/conversational_search_service_client.d.ts +876 -0
  29. package/build/src/v1beta/conversational_search_service_client.js +1149 -0
  30. package/build/src/v1beta/conversational_search_service_client_config.json +68 -0
  31. package/build/src/v1beta/document_service_client.d.ts +183 -98
  32. package/build/src/v1beta/document_service_client.js +166 -22
  33. package/build/src/v1beta/index.d.ts +1 -0
  34. package/build/src/v1beta/index.js +3 -1
  35. package/build/src/v1beta/recommendation_service_client.d.ts +103 -11
  36. package/build/src/v1beta/recommendation_service_client.js +128 -0
  37. package/build/src/v1beta/schema_service_client.d.ts +132 -49
  38. package/build/src/v1beta/schema_service_client.js +163 -22
  39. package/build/src/v1beta/search_service_client.d.ts +163 -67
  40. package/build/src/v1beta/search_service_client.js +175 -45
  41. package/build/src/v1beta/user_event_service_client.d.ts +104 -15
  42. package/build/src/v1beta/user_event_service_client.js +147 -2
  43. package/package.json +8 -11
@@ -28,7 +28,7 @@ const gapicConfig = require("./document_service_client_config.json");
28
28
  const version = require('../../../package.json').version;
29
29
  /**
30
30
  * Service for ingesting
31
- * {@link google.cloud.discoveryengine.v1beta.Document|Document} information of the
31
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document} information of the
32
32
  * customer's website.
33
33
  * @class
34
34
  * @memberof v1beta
@@ -142,9 +142,11 @@ 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
+ projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
145
146
  projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
146
147
  projectLocationDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}'),
147
148
  projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
149
+ projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
148
150
  projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
149
151
  };
150
152
  // Some of the methods on this service return "paged" results,
@@ -177,6 +179,15 @@ class DocumentServiceClient {
177
179
  {
178
180
  get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*/operations/*}',
179
181
  },
182
+ {
183
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/operations/*}',
184
+ },
185
+ {
186
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites/operations/*}',
187
+ },
188
+ {
189
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/engines/*/operations/*}',
190
+ },
180
191
  {
181
192
  get: '/v1beta/{name=projects/*/locations/*/collections/*/operations/*}',
182
193
  },
@@ -203,9 +214,18 @@ class DocumentServiceClient {
203
214
  {
204
215
  get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}/operations',
205
216
  },
217
+ {
218
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites}/operations',
219
+ },
220
+ {
221
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/operations',
222
+ },
206
223
  {
207
224
  get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*}/operations',
208
225
  },
226
+ {
227
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/engines/*}/operations',
228
+ },
209
229
  {
210
230
  get: '/v1beta/{name=projects/*/locations/*/collections/*}/operations',
211
231
  },
@@ -448,8 +468,7 @@ class DocumentServiceClient {
448
468
  * The operation name that will be passed.
449
469
  * @returns {Promise} - The promise which resolves to an object.
450
470
  * The decoded operation object has result and metadata field to get information from.
451
- * Please see the
452
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
471
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
453
472
  * for more details and examples.
454
473
  * @example <caption>include:samples/generated/v1beta/document_service.import_documents.js</caption>
455
474
  * region_tag:discoveryengine_v1beta_generated_DocumentService_ImportDocuments_async
@@ -487,8 +506,7 @@ class DocumentServiceClient {
487
506
  * The operation name that will be passed.
488
507
  * @returns {Promise} - The promise which resolves to an object.
489
508
  * 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)
509
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
492
510
  * for more details and examples.
493
511
  * @example <caption>include:samples/generated/v1beta/document_service.purge_documents.js</caption>
494
512
  * region_tag:discoveryengine_v1beta_generated_DocumentService_PurgeDocuments_async
@@ -530,36 +548,36 @@ class DocumentServiceClient {
530
548
  * Use `default_branch` as the branch ID, to list documents under the default
531
549
  * branch.
532
550
  *
533
- * If the caller does not have permission to list {@link |Documents}s under this
551
+ * If the caller does not have permission to list
552
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s under this
534
553
  * branch, regardless of whether or not this branch exists, a
535
554
  * `PERMISSION_DENIED` error is returned.
536
555
  * @param {number} request.pageSize
537
- * Maximum number of {@link google.cloud.discoveryengine.v1beta.Document|Document}s
556
+ * Maximum number of {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s
538
557
  * to return. If unspecified, defaults to 100. The maximum allowed value is
539
558
  * 1000. Values above 1000 will be coerced to 1000.
540
559
  *
541
560
  * If this field is negative, an `INVALID_ARGUMENT` error is returned.
542
561
  * @param {string} request.pageToken
543
562
  * A page token
544
- * {@link google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
563
+ * {@link protos.google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
545
564
  * received from a previous
546
- * {@link google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
565
+ * {@link protos.google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
547
566
  * call. Provide this to retrieve the subsequent page.
548
567
  *
549
568
  * When paginating, all other parameters provided to
550
- * {@link google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
569
+ * {@link protos.google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
551
570
  * must match the call that provided the page token. Otherwise, an
552
571
  * `INVALID_ARGUMENT` error is returned.
553
572
  * @param {object} [options]
554
573
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
555
574
  * @returns {Stream}
556
- * An object stream which emits an object representing {@link google.cloud.discoveryengine.v1beta.Document | Document} on 'data' event.
575
+ * An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1beta.Document|Document} on 'data' event.
557
576
  * The client library will perform auto-pagination by default: it will call the API as many
558
577
  * times as needed. Note that it can affect your quota.
559
578
  * We recommend using `listDocumentsAsync()`
560
579
  * method described below for async iteration which you can stop as needed.
561
- * Please see the
562
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
580
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
563
581
  * for more details and examples.
564
582
  */
565
583
  listDocumentsStream(request, options) {
@@ -589,35 +607,35 @@ class DocumentServiceClient {
589
607
  * Use `default_branch` as the branch ID, to list documents under the default
590
608
  * branch.
591
609
  *
592
- * If the caller does not have permission to list {@link |Documents}s under this
610
+ * If the caller does not have permission to list
611
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s under this
593
612
  * branch, regardless of whether or not this branch exists, a
594
613
  * `PERMISSION_DENIED` error is returned.
595
614
  * @param {number} request.pageSize
596
- * Maximum number of {@link google.cloud.discoveryengine.v1beta.Document|Document}s
615
+ * Maximum number of {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s
597
616
  * to return. If unspecified, defaults to 100. The maximum allowed value is
598
617
  * 1000. Values above 1000 will be coerced to 1000.
599
618
  *
600
619
  * If this field is negative, an `INVALID_ARGUMENT` error is returned.
601
620
  * @param {string} request.pageToken
602
621
  * A page token
603
- * {@link google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
622
+ * {@link protos.google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
604
623
  * received from a previous
605
- * {@link google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
624
+ * {@link protos.google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
606
625
  * call. Provide this to retrieve the subsequent page.
607
626
  *
608
627
  * When paginating, all other parameters provided to
609
- * {@link google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
628
+ * {@link protos.google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
610
629
  * must match the call that provided the page token. Otherwise, an
611
630
  * `INVALID_ARGUMENT` error is returned.
612
631
  * @param {object} [options]
613
632
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
614
633
  * @returns {Object}
615
- * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
634
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
616
635
  * When you iterate the returned iterable, each element will be an object representing
617
- * {@link google.cloud.discoveryengine.v1beta.Document | Document}. The API will be called under the hood as needed, once per the page,
636
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}. The API will be called under the hood as needed, once per the page,
618
637
  * so you can stop the iteration when you don't need more results.
619
- * Please see the
620
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
638
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
621
639
  * for more details and examples.
622
640
  * @example <caption>include:samples/generated/v1beta/document_service.list_documents.js</caption>
623
641
  * region_tag:discoveryengine_v1beta_generated_DocumentService_ListDocuments_async
@@ -918,6 +936,75 @@ class DocumentServiceClient {
918
936
  matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
919
937
  return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).document;
920
938
  }
939
+ /**
940
+ * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
941
+ *
942
+ * @param {string} project
943
+ * @param {string} location
944
+ * @param {string} collection
945
+ * @param {string} data_store
946
+ * @param {string} conversation
947
+ * @returns {string} Resource name string.
948
+ */
949
+ projectLocationCollectionDataStoreConversationPath(project, location, collection, dataStore, conversation) {
950
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.render({
951
+ project: project,
952
+ location: location,
953
+ collection: collection,
954
+ data_store: dataStore,
955
+ conversation: conversation,
956
+ });
957
+ }
958
+ /**
959
+ * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
960
+ *
961
+ * @param {string} projectLocationCollectionDataStoreConversationName
962
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
963
+ * @returns {string} A string representing the project.
964
+ */
965
+ matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
966
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).project;
967
+ }
968
+ /**
969
+ * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
970
+ *
971
+ * @param {string} projectLocationCollectionDataStoreConversationName
972
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
973
+ * @returns {string} A string representing the location.
974
+ */
975
+ matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
976
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).location;
977
+ }
978
+ /**
979
+ * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
980
+ *
981
+ * @param {string} projectLocationCollectionDataStoreConversationName
982
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
983
+ * @returns {string} A string representing the collection.
984
+ */
985
+ matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
986
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).collection;
987
+ }
988
+ /**
989
+ * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
990
+ *
991
+ * @param {string} projectLocationCollectionDataStoreConversationName
992
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
993
+ * @returns {string} A string representing the data_store.
994
+ */
995
+ matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
996
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).data_store;
997
+ }
998
+ /**
999
+ * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
1000
+ *
1001
+ * @param {string} projectLocationCollectionDataStoreConversationName
1002
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
1003
+ * @returns {string} A string representing the conversation.
1004
+ */
1005
+ matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
1006
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).conversation;
1007
+ }
921
1008
  /**
922
1009
  * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
923
1010
  *
@@ -1113,6 +1200,63 @@ class DocumentServiceClient {
1113
1200
  matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
1114
1201
  return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).document;
1115
1202
  }
1203
+ /**
1204
+ * Return a fully-qualified projectLocationDataStoreConversation resource name string.
1205
+ *
1206
+ * @param {string} project
1207
+ * @param {string} location
1208
+ * @param {string} data_store
1209
+ * @param {string} conversation
1210
+ * @returns {string} Resource name string.
1211
+ */
1212
+ projectLocationDataStoreConversationPath(project, location, dataStore, conversation) {
1213
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.render({
1214
+ project: project,
1215
+ location: location,
1216
+ data_store: dataStore,
1217
+ conversation: conversation,
1218
+ });
1219
+ }
1220
+ /**
1221
+ * Parse the project from ProjectLocationDataStoreConversation resource.
1222
+ *
1223
+ * @param {string} projectLocationDataStoreConversationName
1224
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1225
+ * @returns {string} A string representing the project.
1226
+ */
1227
+ matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
1228
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).project;
1229
+ }
1230
+ /**
1231
+ * Parse the location from ProjectLocationDataStoreConversation resource.
1232
+ *
1233
+ * @param {string} projectLocationDataStoreConversationName
1234
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1235
+ * @returns {string} A string representing the location.
1236
+ */
1237
+ matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
1238
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).location;
1239
+ }
1240
+ /**
1241
+ * Parse the data_store from ProjectLocationDataStoreConversation resource.
1242
+ *
1243
+ * @param {string} projectLocationDataStoreConversationName
1244
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1245
+ * @returns {string} A string representing the data_store.
1246
+ */
1247
+ matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
1248
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).data_store;
1249
+ }
1250
+ /**
1251
+ * Parse the conversation from ProjectLocationDataStoreConversation resource.
1252
+ *
1253
+ * @param {string} projectLocationDataStoreConversationName
1254
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1255
+ * @returns {string} A string representing the conversation.
1256
+ */
1257
+ matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
1258
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).conversation;
1259
+ }
1116
1260
  /**
1117
1261
  * Return a fully-qualified projectLocationDataStoreSchema resource name string.
1118
1262
  *
@@ -1,4 +1,5 @@
1
1
  export { CompletionServiceClient } from './completion_service_client';
2
+ export { ConversationalSearchServiceClient } from './conversational_search_service_client';
2
3
  export { DocumentServiceClient } from './document_service_client';
3
4
  export { RecommendationServiceClient } from './recommendation_service_client';
4
5
  export { SchemaServiceClient } from './schema_service_client';
@@ -17,9 +17,11 @@
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.SearchServiceClient = exports.SchemaServiceClient = exports.RecommendationServiceClient = exports.DocumentServiceClient = exports.CompletionServiceClient = void 0;
20
+ exports.UserEventServiceClient = exports.SearchServiceClient = exports.SchemaServiceClient = exports.RecommendationServiceClient = exports.DocumentServiceClient = exports.ConversationalSearchServiceClient = exports.CompletionServiceClient = void 0;
21
21
  var completion_service_client_1 = require("./completion_service_client");
22
22
  Object.defineProperty(exports, "CompletionServiceClient", { enumerable: true, get: function () { return completion_service_client_1.CompletionServiceClient; } });
23
+ var conversational_search_service_client_1 = require("./conversational_search_service_client");
24
+ Object.defineProperty(exports, "ConversationalSearchServiceClient", { enumerable: true, get: function () { return conversational_search_service_client_1.ConversationalSearchServiceClient; } });
23
25
  var document_service_client_1 = require("./document_service_client");
24
26
  Object.defineProperty(exports, "DocumentServiceClient", { enumerable: true, get: function () { return document_service_client_1.DocumentServiceClient; } });
25
27
  var recommendation_service_client_1 = require("./recommendation_service_client");
@@ -123,15 +123,15 @@ export declare class RecommendationServiceClient {
123
123
  * write request is required for event logging.
124
124
  *
125
125
  * Don't set
126
- * {@link google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
126
+ * {@link protos.google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
127
127
  * or
128
- * {@link google.cloud.discoveryengine.v1beta.UserInfo.user_id|UserEvent.user_info.user_id}
128
+ * {@link protos.google.cloud.discoveryengine.v1beta.UserInfo.user_id|UserEvent.user_info.user_id}
129
129
  * to the same fixed ID for different users. If you are trying to receive
130
130
  * non-personalized recommendations (not recommended; this can negatively
131
131
  * impact model performance), instead set
132
- * {@link google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
132
+ * {@link protos.google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
133
133
  * to a random unique ID and leave
134
- * {@link google.cloud.discoveryengine.v1beta.UserInfo.user_id|UserEvent.user_info.user_id}
134
+ * {@link protos.google.cloud.discoveryengine.v1beta.UserInfo.user_id|UserEvent.user_info.user_id}
135
135
  * unset.
136
136
  * @param {number} request.pageSize
137
137
  * Maximum number of results to return. Set this property
@@ -152,11 +152,11 @@ export declare class RecommendationServiceClient {
152
152
  * If your filter blocks all results, the API will return generic
153
153
  * (unfiltered) popular Documents. If you only want results strictly matching
154
154
  * the filters, set `strictFiltering` to True in
155
- * {@link google.cloud.discoveryengine.v1beta.RecommendRequest.params|RecommendRequest.params}
155
+ * {@link protos.google.cloud.discoveryengine.v1beta.RecommendRequest.params|RecommendRequest.params}
156
156
  * to receive empty results instead.
157
157
  *
158
158
  * Note that the API will never return
159
- * {@link google.cloud.discoveryengine.v1beta.Document|Document}s with
159
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s with
160
160
  * `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
161
161
  * @param {boolean} request.validateOnly
162
162
  * Use validate only mode for this recommendation query. If set to true, a
@@ -170,10 +170,10 @@ export declare class RecommendationServiceClient {
170
170
  *
171
171
  * * `returnDocument`: Boolean. If set to true, the associated Document
172
172
  * object will be returned in
173
- * {@link google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document|RecommendResponse.RecommendationResult.document}.
173
+ * {@link protos.google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document|RecommendResponse.RecommendationResult.document}.
174
174
  * * `returnScore`: Boolean. If set to true, the recommendation 'score'
175
175
  * corresponding to each returned Document will be set in
176
- * {@link google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata|RecommendResponse.RecommendationResult.metadata}.
176
+ * {@link protos.google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata|RecommendResponse.RecommendationResult.metadata}.
177
177
  * The given 'score' indicates the probability of a Document conversion
178
178
  * given the user's context and history.
179
179
  * * `strictFiltering`: Boolean. True by default. If set to false, the service
@@ -209,9 +209,8 @@ export declare class RecommendationServiceClient {
209
209
  * @param {object} [options]
210
210
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
211
211
  * @returns {Promise} - The promise which resolves to an array.
212
- * The first element of the array is an object representing {@link google.cloud.discoveryengine.v1beta.RecommendResponse | RecommendResponse}.
213
- * Please see the
214
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
212
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1beta.RecommendResponse|RecommendResponse}.
213
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
215
214
  * for more details and examples.
216
215
  * @example <caption>include:samples/generated/v1beta/recommendation_service.recommend.js</caption>
217
216
  * region_tag:discoveryengine_v1beta_generated_RecommendationService_Recommend_async
@@ -283,6 +282,57 @@ export declare class RecommendationServiceClient {
283
282
  * @returns {string} A string representing the document.
284
283
  */
285
284
  matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
285
+ /**
286
+ * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
287
+ *
288
+ * @param {string} project
289
+ * @param {string} location
290
+ * @param {string} collection
291
+ * @param {string} data_store
292
+ * @param {string} conversation
293
+ * @returns {string} Resource name string.
294
+ */
295
+ projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
296
+ /**
297
+ * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
298
+ *
299
+ * @param {string} projectLocationCollectionDataStoreConversationName
300
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
301
+ * @returns {string} A string representing the project.
302
+ */
303
+ matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
304
+ /**
305
+ * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
306
+ *
307
+ * @param {string} projectLocationCollectionDataStoreConversationName
308
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
309
+ * @returns {string} A string representing the location.
310
+ */
311
+ matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
312
+ /**
313
+ * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
314
+ *
315
+ * @param {string} projectLocationCollectionDataStoreConversationName
316
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
317
+ * @returns {string} A string representing the collection.
318
+ */
319
+ matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
320
+ /**
321
+ * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
322
+ *
323
+ * @param {string} projectLocationCollectionDataStoreConversationName
324
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
325
+ * @returns {string} A string representing the data_store.
326
+ */
327
+ matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
328
+ /**
329
+ * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
330
+ *
331
+ * @param {string} projectLocationCollectionDataStoreConversationName
332
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
333
+ * @returns {string} A string representing the conversation.
334
+ */
335
+ matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
286
336
  /**
287
337
  * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
288
338
  *
@@ -436,6 +486,48 @@ export declare class RecommendationServiceClient {
436
486
  * @returns {string} A string representing the document.
437
487
  */
438
488
  matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
489
+ /**
490
+ * Return a fully-qualified projectLocationDataStoreConversation resource name string.
491
+ *
492
+ * @param {string} project
493
+ * @param {string} location
494
+ * @param {string} data_store
495
+ * @param {string} conversation
496
+ * @returns {string} Resource name string.
497
+ */
498
+ projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
499
+ /**
500
+ * Parse the project from ProjectLocationDataStoreConversation resource.
501
+ *
502
+ * @param {string} projectLocationDataStoreConversationName
503
+ * A fully-qualified path representing project_location_data_store_conversation resource.
504
+ * @returns {string} A string representing the project.
505
+ */
506
+ matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
507
+ /**
508
+ * Parse the location from ProjectLocationDataStoreConversation resource.
509
+ *
510
+ * @param {string} projectLocationDataStoreConversationName
511
+ * A fully-qualified path representing project_location_data_store_conversation resource.
512
+ * @returns {string} A string representing the location.
513
+ */
514
+ matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
515
+ /**
516
+ * Parse the data_store from ProjectLocationDataStoreConversation resource.
517
+ *
518
+ * @param {string} projectLocationDataStoreConversationName
519
+ * A fully-qualified path representing project_location_data_store_conversation resource.
520
+ * @returns {string} A string representing the data_store.
521
+ */
522
+ matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
523
+ /**
524
+ * Parse the conversation from ProjectLocationDataStoreConversation resource.
525
+ *
526
+ * @param {string} projectLocationDataStoreConversationName
527
+ * A fully-qualified path representing project_location_data_store_conversation resource.
528
+ * @returns {string} A string representing the conversation.
529
+ */
530
+ matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
439
531
  /**
440
532
  * Return a fully-qualified projectLocationDataStoreSchema resource name string.
441
533
  *
@@ -140,9 +140,11 @@ class RecommendationServiceClient {
140
140
  // Create useful helper objects for these.
141
141
  this.pathTemplates = {
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
  projectLocationCollectionDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}'),
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
  projectLocationDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}'),
148
150
  };
@@ -343,6 +345,75 @@ class RecommendationServiceClient {
343
345
  matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
344
346
  return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).document;
345
347
  }
348
+ /**
349
+ * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
350
+ *
351
+ * @param {string} project
352
+ * @param {string} location
353
+ * @param {string} collection
354
+ * @param {string} data_store
355
+ * @param {string} conversation
356
+ * @returns {string} Resource name string.
357
+ */
358
+ projectLocationCollectionDataStoreConversationPath(project, location, collection, dataStore, conversation) {
359
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.render({
360
+ project: project,
361
+ location: location,
362
+ collection: collection,
363
+ data_store: dataStore,
364
+ conversation: conversation,
365
+ });
366
+ }
367
+ /**
368
+ * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
369
+ *
370
+ * @param {string} projectLocationCollectionDataStoreConversationName
371
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
372
+ * @returns {string} A string representing the project.
373
+ */
374
+ matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
375
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).project;
376
+ }
377
+ /**
378
+ * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
379
+ *
380
+ * @param {string} projectLocationCollectionDataStoreConversationName
381
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
382
+ * @returns {string} A string representing the location.
383
+ */
384
+ matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
385
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).location;
386
+ }
387
+ /**
388
+ * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
389
+ *
390
+ * @param {string} projectLocationCollectionDataStoreConversationName
391
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
392
+ * @returns {string} A string representing the collection.
393
+ */
394
+ matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
395
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).collection;
396
+ }
397
+ /**
398
+ * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
399
+ *
400
+ * @param {string} projectLocationCollectionDataStoreConversationName
401
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
402
+ * @returns {string} A string representing the data_store.
403
+ */
404
+ matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
405
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).data_store;
406
+ }
407
+ /**
408
+ * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
409
+ *
410
+ * @param {string} projectLocationCollectionDataStoreConversationName
411
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
412
+ * @returns {string} A string representing the conversation.
413
+ */
414
+ matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
415
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).conversation;
416
+ }
346
417
  /**
347
418
  * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
348
419
  *
@@ -550,6 +621,63 @@ class RecommendationServiceClient {
550
621
  matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
551
622
  return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).document;
552
623
  }
624
+ /**
625
+ * Return a fully-qualified projectLocationDataStoreConversation resource name string.
626
+ *
627
+ * @param {string} project
628
+ * @param {string} location
629
+ * @param {string} data_store
630
+ * @param {string} conversation
631
+ * @returns {string} Resource name string.
632
+ */
633
+ projectLocationDataStoreConversationPath(project, location, dataStore, conversation) {
634
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.render({
635
+ project: project,
636
+ location: location,
637
+ data_store: dataStore,
638
+ conversation: conversation,
639
+ });
640
+ }
641
+ /**
642
+ * Parse the project from ProjectLocationDataStoreConversation resource.
643
+ *
644
+ * @param {string} projectLocationDataStoreConversationName
645
+ * A fully-qualified path representing project_location_data_store_conversation resource.
646
+ * @returns {string} A string representing the project.
647
+ */
648
+ matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
649
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).project;
650
+ }
651
+ /**
652
+ * Parse the location from ProjectLocationDataStoreConversation resource.
653
+ *
654
+ * @param {string} projectLocationDataStoreConversationName
655
+ * A fully-qualified path representing project_location_data_store_conversation resource.
656
+ * @returns {string} A string representing the location.
657
+ */
658
+ matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
659
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).location;
660
+ }
661
+ /**
662
+ * Parse the data_store from ProjectLocationDataStoreConversation resource.
663
+ *
664
+ * @param {string} projectLocationDataStoreConversationName
665
+ * A fully-qualified path representing project_location_data_store_conversation resource.
666
+ * @returns {string} A string representing the data_store.
667
+ */
668
+ matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
669
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).data_store;
670
+ }
671
+ /**
672
+ * Parse the conversation from ProjectLocationDataStoreConversation resource.
673
+ *
674
+ * @param {string} projectLocationDataStoreConversationName
675
+ * A fully-qualified path representing project_location_data_store_conversation resource.
676
+ * @returns {string} A string representing the conversation.
677
+ */
678
+ matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
679
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).conversation;
680
+ }
553
681
  /**
554
682
  * Return a fully-qualified projectLocationDataStoreSchema resource name string.
555
683
  *