@google-cloud/discoveryengine 1.3.0 → 1.4.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.
Files changed (131) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +63 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/common.proto +54 -3
  4. package/build/protos/google/cloud/discoveryengine/v1/completion.proto +52 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +51 -4
  6. package/build/protos/google/cloud/discoveryengine/v1/conversation.proto +3 -0
  7. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +40 -1
  8. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +98 -0
  9. package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +304 -0
  10. package/build/protos/google/cloud/discoveryengine/v1/document.proto +1 -1
  11. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +215 -0
  12. package/build/protos/google/cloud/discoveryengine/v1/engine_service.proto +242 -0
  13. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +64 -0
  14. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +38 -0
  15. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +137 -4
  16. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +170 -0
  17. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto +691 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +3 -3
  19. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +0 -5
  20. package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +3 -0
  21. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +39 -0
  22. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +1 -1
  23. package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +1 -1
  24. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +97 -0
  25. package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +147 -0
  26. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +164 -0
  27. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +540 -0
  28. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +59 -8
  29. package/build/protos/google/cloud/discoveryengine/v1beta/completion.proto +52 -0
  30. package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +51 -4
  31. package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +3 -0
  32. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +40 -1
  33. package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +98 -0
  34. package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto +306 -0
  35. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +1 -1
  36. package/build/protos/google/cloud/discoveryengine/v1beta/engine.proto +220 -0
  37. package/build/protos/google/cloud/discoveryengine/v1beta/engine_service.proto +244 -0
  38. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +64 -0
  39. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +38 -0
  40. package/build/protos/google/cloud/discoveryengine/v1beta/recommendation_service.proto +26 -3
  41. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +150 -11
  42. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +264 -0
  43. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config_service.proto +147 -0
  44. package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine.proto +170 -0
  45. package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine_service.proto +695 -0
  46. package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -3
  47. package/build/protos/protos.d.ts +42822 -21397
  48. package/build/protos/protos.js +110509 -61572
  49. package/build/protos/protos.json +11779 -6752
  50. package/build/src/index.d.ts +10 -1
  51. package/build/src/index.js +11 -2
  52. package/build/src/v1/completion_service_client.d.ts +489 -7
  53. package/build/src/v1/completion_service_client.js +716 -12
  54. package/build/src/v1/completion_service_client_config.json +10 -0
  55. package/build/src/v1/conversational_search_service_client.d.ts +341 -3
  56. package/build/src/v1/conversational_search_service_client.js +467 -10
  57. package/build/src/v1/data_store_service_client.d.ts +1286 -0
  58. package/build/src/v1/data_store_service_client.js +1768 -0
  59. package/build/src/v1/data_store_service_client_config.json +46 -0
  60. package/build/src/v1/document_service_client.d.ts +347 -2
  61. package/build/src/v1/document_service_client.js +507 -10
  62. package/build/src/v1/engine_service_client.d.ts +1211 -0
  63. package/build/src/v1/engine_service_client.js +1731 -0
  64. package/build/src/v1/engine_service_client_config.json +46 -0
  65. package/build/src/v1/index.d.ts +3 -0
  66. package/build/src/v1/index.js +8 -2
  67. package/build/src/v1/schema_service_client.d.ts +272 -2
  68. package/build/src/v1/schema_service_client.js +403 -10
  69. package/build/src/v1/search_service_client.d.ts +515 -11
  70. package/build/src/v1/search_service_client.js +649 -16
  71. package/build/src/v1/site_search_engine_service_client.d.ts +1564 -0
  72. package/build/src/v1/site_search_engine_service_client.js +2075 -0
  73. package/build/src/v1/site_search_engine_service_client_config.json +74 -0
  74. package/build/src/v1/user_event_service_client.d.ts +272 -2
  75. package/build/src/v1/user_event_service_client.js +403 -10
  76. package/build/src/v1alpha/completion_service_client.d.ts +230 -2
  77. package/build/src/v1alpha/completion_service_client.js +339 -10
  78. package/build/src/v1alpha/conversational_search_service_client.d.ts +247 -2
  79. package/build/src/v1alpha/conversational_search_service_client.js +339 -10
  80. package/build/src/v1alpha/data_store_service_client.d.ts +230 -2
  81. package/build/src/v1alpha/data_store_service_client.js +347 -12
  82. package/build/src/v1alpha/document_service_client.d.ts +230 -2
  83. package/build/src/v1alpha/document_service_client.js +347 -12
  84. package/build/src/v1alpha/engine_service_client.d.ts +231 -3
  85. package/build/src/v1alpha/engine_service_client.js +347 -12
  86. package/build/src/v1alpha/index.d.ts +1 -0
  87. package/build/src/v1alpha/index.js +4 -2
  88. package/build/src/v1alpha/recommendation_service_client.d.ts +230 -2
  89. package/build/src/v1alpha/recommendation_service_client.js +339 -10
  90. package/build/src/v1alpha/schema_service_client.d.ts +230 -2
  91. package/build/src/v1alpha/schema_service_client.js +347 -12
  92. package/build/src/v1alpha/search_service_client.d.ts +269 -2
  93. package/build/src/v1alpha/search_service_client.js +365 -10
  94. package/build/src/v1alpha/search_tuning_service_client.d.ts +977 -0
  95. package/build/src/v1alpha/search_tuning_service_client.js +1479 -0
  96. package/build/src/v1alpha/search_tuning_service_client_config.json +30 -0
  97. package/build/src/v1alpha/site_search_engine_service_client.d.ts +750 -3
  98. package/build/src/v1alpha/site_search_engine_service_client.js +838 -14
  99. package/build/src/v1alpha/site_search_engine_service_client_config.json +44 -0
  100. package/build/src/v1alpha/user_event_service_client.d.ts +230 -2
  101. package/build/src/v1alpha/user_event_service_client.js +347 -12
  102. package/build/src/v1beta/completion_service_client.d.ts +633 -7
  103. package/build/src/v1beta/completion_service_client.js +912 -12
  104. package/build/src/v1beta/completion_service_client_config.json +10 -0
  105. package/build/src/v1beta/conversational_search_service_client.d.ts +341 -3
  106. package/build/src/v1beta/conversational_search_service_client.js +467 -10
  107. package/build/src/v1beta/data_store_service_client.d.ts +1433 -0
  108. package/build/src/v1beta/data_store_service_client.js +1966 -0
  109. package/build/src/v1beta/data_store_service_client_config.json +46 -0
  110. package/build/src/v1beta/document_service_client.d.ts +491 -2
  111. package/build/src/v1beta/document_service_client.js +707 -12
  112. package/build/src/v1beta/engine_service_client.d.ts +1357 -0
  113. package/build/src/v1beta/engine_service_client.js +1928 -0
  114. package/build/src/v1beta/engine_service_client_config.json +46 -0
  115. package/build/src/v1beta/index.d.ts +4 -0
  116. package/build/src/v1beta/index.js +10 -2
  117. package/build/src/v1beta/recommendation_service_client.d.ts +420 -5
  118. package/build/src/v1beta/recommendation_service_client.js +571 -10
  119. package/build/src/v1beta/schema_service_client.d.ts +416 -2
  120. package/build/src/v1beta/schema_service_client.js +603 -12
  121. package/build/src/v1beta/search_service_client.d.ts +539 -29
  122. package/build/src/v1beta/search_service_client.js +665 -28
  123. package/build/src/v1beta/serving_config_service_client.d.ts +1102 -0
  124. package/build/src/v1beta/serving_config_service_client.js +1563 -0
  125. package/build/src/v1beta/serving_config_service_client_config.json +38 -0
  126. package/build/src/v1beta/site_search_engine_service_client.d.ts +1712 -0
  127. package/build/src/v1beta/site_search_engine_service_client.js +2271 -0
  128. package/build/src/v1beta/site_search_engine_service_client_config.json +74 -0
  129. package/build/src/v1beta/user_event_service_client.d.ts +416 -2
  130. package/build/src/v1beta/user_event_service_client.js +603 -12
  131. package/package.json +3 -3
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
- // Copyright 2023 Google LLC
2
+ // Copyright 2024 Google LLC
3
3
  //
4
4
  // Licensed under the Apache License, Version 2.0 (the "License");
5
5
  // you may not use this file except in compliance with the License.
@@ -72,7 +72,7 @@ class ConversationalSearchServiceClient {
72
72
  * ```
73
73
  */
74
74
  constructor(opts, gaxInstance) {
75
- var _a, _b;
75
+ var _a, _b, _c, _d;
76
76
  this._terminated = false;
77
77
  this.descriptors = {
78
78
  page: {},
@@ -83,16 +83,24 @@ class ConversationalSearchServiceClient {
83
83
  // Ensure that options include all the required fields.
84
84
  const staticMembers = this
85
85
  .constructor;
86
- const servicePath = (opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint) || staticMembers.servicePath;
86
+ if ((opts === null || opts === void 0 ? void 0 : opts.universe_domain) &&
87
+ (opts === null || opts === void 0 ? void 0 : opts.universeDomain) &&
88
+ (opts === null || opts === void 0 ? void 0 : opts.universe_domain) !== (opts === null || opts === void 0 ? void 0 : opts.universeDomain)) {
89
+ throw new Error('Please set either universe_domain or universeDomain, but not both.');
90
+ }
91
+ this._universeDomain =
92
+ (_b = (_a = opts === null || opts === void 0 ? void 0 : opts.universeDomain) !== null && _a !== void 0 ? _a : opts === null || opts === void 0 ? void 0 : opts.universe_domain) !== null && _b !== void 0 ? _b : 'googleapis.com';
93
+ this._servicePath = 'discoveryengine.' + this._universeDomain;
94
+ const servicePath = (opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint) || this._servicePath;
87
95
  this._providedCustomServicePath = !!((opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint));
88
96
  const port = (opts === null || opts === void 0 ? void 0 : opts.port) || staticMembers.port;
89
- const clientConfig = (_a = opts === null || opts === void 0 ? void 0 : opts.clientConfig) !== null && _a !== void 0 ? _a : {};
90
- const fallback = (_b = opts === null || opts === void 0 ? void 0 : opts.fallback) !== null && _b !== void 0 ? _b : (typeof window !== 'undefined' && typeof (window === null || window === void 0 ? void 0 : window.fetch) === 'function');
97
+ const clientConfig = (_c = opts === null || opts === void 0 ? void 0 : opts.clientConfig) !== null && _c !== void 0 ? _c : {};
98
+ const fallback = (_d = opts === null || opts === void 0 ? void 0 : opts.fallback) !== null && _d !== void 0 ? _d : (typeof window !== 'undefined' && typeof (window === null || window === void 0 ? void 0 : window.fetch) === 'function');
91
99
  opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
92
100
  // Request numeric enum values if REST transport is used.
93
101
  opts.numericEnums = true;
94
102
  // If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
95
- if (servicePath !== staticMembers.servicePath && !('scopes' in opts)) {
103
+ if (servicePath !== this._servicePath && !('scopes' in opts)) {
96
104
  opts['scopes'] = staticMembers.scopes;
97
105
  }
98
106
  // Load google-gax module synchronously if needed
@@ -110,9 +118,9 @@ class ConversationalSearchServiceClient {
110
118
  // Set useJWTAccessWithScope on the auth object.
111
119
  this.auth.useJWTAccessWithScope = true;
112
120
  // Set defaultServicePath on the auth object.
113
- this.auth.defaultServicePath = staticMembers.servicePath;
121
+ this.auth.defaultServicePath = this._servicePath;
114
122
  // Set the default scopes in auth client if needed.
115
- if (servicePath === staticMembers.servicePath) {
123
+ if (servicePath === this._servicePath) {
116
124
  this.auth.defaultScopes = staticMembers.scopes;
117
125
  }
118
126
  this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
@@ -139,16 +147,23 @@ class ConversationalSearchServiceClient {
139
147
  // identifiers to uniquely identify resources within the API.
140
148
  // Create useful helper objects for these.
141
149
  this.pathTemplates = {
150
+ enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
142
151
  projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
143
152
  projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
144
153
  projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
145
154
  projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
146
155
  projectLocationCollectionDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}'),
156
+ projectLocationCollectionDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine'),
157
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
158
+ projectLocationCollectionEngineConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}'),
159
+ projectLocationCollectionEngineServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}'),
147
160
  projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
148
161
  projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
149
162
  projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
150
163
  projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
151
164
  projectLocationDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}'),
165
+ projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
166
+ projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
152
167
  };
153
168
  // Some of the methods on this service return "paged" results,
154
169
  // (e.g. 50 results at a time, with tokens to get subsequent
@@ -216,19 +231,38 @@ class ConversationalSearchServiceClient {
216
231
  }
217
232
  /**
218
233
  * The DNS address for this API service.
234
+ * @deprecated Use the apiEndpoint method of the client instance.
219
235
  * @returns {string} The DNS address for this service.
220
236
  */
221
237
  static get servicePath() {
238
+ if (typeof process !== undefined &&
239
+ typeof process.emitWarning === 'function') {
240
+ process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
241
+ }
222
242
  return 'discoveryengine.googleapis.com';
223
243
  }
224
244
  /**
225
- * The DNS address for this API service - same as servicePath(),
226
- * exists for compatibility reasons.
245
+ * The DNS address for this API service - same as servicePath.
246
+ * @deprecated Use the apiEndpoint method of the client instance.
227
247
  * @returns {string} The DNS address for this service.
228
248
  */
229
249
  static get apiEndpoint() {
250
+ if (typeof process !== undefined &&
251
+ typeof process.emitWarning === 'function') {
252
+ process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
253
+ }
230
254
  return 'discoveryengine.googleapis.com';
231
255
  }
256
+ /**
257
+ * The DNS address for this API service.
258
+ * @returns {string} The DNS address for this service.
259
+ */
260
+ get apiEndpoint() {
261
+ return this._servicePath;
262
+ }
263
+ get universeDomain() {
264
+ return this._universeDomain;
265
+ }
232
266
  /**
233
267
  * The port for this API service.
234
268
  * @returns {number} The default port for this service.
@@ -554,6 +588,63 @@ class ConversationalSearchServiceClient {
554
588
  // --------------------
555
589
  // -- Path templates --
556
590
  // --------------------
591
+ /**
592
+ * Return a fully-qualified engine resource name string.
593
+ *
594
+ * @param {string} project
595
+ * @param {string} location
596
+ * @param {string} collection
597
+ * @param {string} engine
598
+ * @returns {string} Resource name string.
599
+ */
600
+ enginePath(project, location, collection, engine) {
601
+ return this.pathTemplates.enginePathTemplate.render({
602
+ project: project,
603
+ location: location,
604
+ collection: collection,
605
+ engine: engine,
606
+ });
607
+ }
608
+ /**
609
+ * Parse the project from Engine resource.
610
+ *
611
+ * @param {string} engineName
612
+ * A fully-qualified path representing Engine resource.
613
+ * @returns {string} A string representing the project.
614
+ */
615
+ matchProjectFromEngineName(engineName) {
616
+ return this.pathTemplates.enginePathTemplate.match(engineName).project;
617
+ }
618
+ /**
619
+ * Parse the location from Engine resource.
620
+ *
621
+ * @param {string} engineName
622
+ * A fully-qualified path representing Engine resource.
623
+ * @returns {string} A string representing the location.
624
+ */
625
+ matchLocationFromEngineName(engineName) {
626
+ return this.pathTemplates.enginePathTemplate.match(engineName).location;
627
+ }
628
+ /**
629
+ * Parse the collection from Engine resource.
630
+ *
631
+ * @param {string} engineName
632
+ * A fully-qualified path representing Engine resource.
633
+ * @returns {string} A string representing the collection.
634
+ */
635
+ matchCollectionFromEngineName(engineName) {
636
+ return this.pathTemplates.enginePathTemplate.match(engineName).collection;
637
+ }
638
+ /**
639
+ * Parse the engine from Engine resource.
640
+ *
641
+ * @param {string} engineName
642
+ * A fully-qualified path representing Engine resource.
643
+ * @returns {string} A string representing the engine.
644
+ */
645
+ matchEngineFromEngineName(engineName) {
646
+ return this.pathTemplates.enginePathTemplate.match(engineName).engine;
647
+ }
557
648
  /**
558
649
  * Return a fully-qualified projectLocationCollectionDataStore resource name string.
559
650
  *
@@ -899,6 +990,270 @@ class ConversationalSearchServiceClient {
899
990
  matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
900
991
  return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).serving_config;
901
992
  }
993
+ /**
994
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
995
+ *
996
+ * @param {string} project
997
+ * @param {string} location
998
+ * @param {string} collection
999
+ * @param {string} data_store
1000
+ * @returns {string} Resource name string.
1001
+ */
1002
+ projectLocationCollectionDataStoreSiteSearchEnginePath(project, location, collection, dataStore) {
1003
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.render({
1004
+ project: project,
1005
+ location: location,
1006
+ collection: collection,
1007
+ data_store: dataStore,
1008
+ });
1009
+ }
1010
+ /**
1011
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1012
+ *
1013
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1014
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1015
+ * @returns {string} A string representing the project.
1016
+ */
1017
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1018
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).project;
1019
+ }
1020
+ /**
1021
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1022
+ *
1023
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1024
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1025
+ * @returns {string} A string representing the location.
1026
+ */
1027
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1028
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).location;
1029
+ }
1030
+ /**
1031
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1032
+ *
1033
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1034
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1035
+ * @returns {string} A string representing the collection.
1036
+ */
1037
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1038
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).collection;
1039
+ }
1040
+ /**
1041
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1042
+ *
1043
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1044
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1045
+ * @returns {string} A string representing the data_store.
1046
+ */
1047
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1048
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).data_store;
1049
+ }
1050
+ /**
1051
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
1052
+ *
1053
+ * @param {string} project
1054
+ * @param {string} location
1055
+ * @param {string} collection
1056
+ * @param {string} data_store
1057
+ * @param {string} target_site
1058
+ * @returns {string} Resource name string.
1059
+ */
1060
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project, location, collection, dataStore, targetSite) {
1061
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.render({
1062
+ project: project,
1063
+ location: location,
1064
+ collection: collection,
1065
+ data_store: dataStore,
1066
+ target_site: targetSite,
1067
+ });
1068
+ }
1069
+ /**
1070
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1071
+ *
1072
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1073
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1074
+ * @returns {string} A string representing the project.
1075
+ */
1076
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1077
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).project;
1078
+ }
1079
+ /**
1080
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1081
+ *
1082
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1083
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1084
+ * @returns {string} A string representing the location.
1085
+ */
1086
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1087
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).location;
1088
+ }
1089
+ /**
1090
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1091
+ *
1092
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1093
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1094
+ * @returns {string} A string representing the collection.
1095
+ */
1096
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1097
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).collection;
1098
+ }
1099
+ /**
1100
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1101
+ *
1102
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1103
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1104
+ * @returns {string} A string representing the data_store.
1105
+ */
1106
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1107
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).data_store;
1108
+ }
1109
+ /**
1110
+ * Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1111
+ *
1112
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1113
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1114
+ * @returns {string} A string representing the target_site.
1115
+ */
1116
+ matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1117
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).target_site;
1118
+ }
1119
+ /**
1120
+ * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
1121
+ *
1122
+ * @param {string} project
1123
+ * @param {string} location
1124
+ * @param {string} collection
1125
+ * @param {string} engine
1126
+ * @param {string} conversation
1127
+ * @returns {string} Resource name string.
1128
+ */
1129
+ projectLocationCollectionEngineConversationPath(project, location, collection, engine, conversation) {
1130
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.render({
1131
+ project: project,
1132
+ location: location,
1133
+ collection: collection,
1134
+ engine: engine,
1135
+ conversation: conversation,
1136
+ });
1137
+ }
1138
+ /**
1139
+ * Parse the project from ProjectLocationCollectionEngineConversation resource.
1140
+ *
1141
+ * @param {string} projectLocationCollectionEngineConversationName
1142
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1143
+ * @returns {string} A string representing the project.
1144
+ */
1145
+ matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1146
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).project;
1147
+ }
1148
+ /**
1149
+ * Parse the location from ProjectLocationCollectionEngineConversation resource.
1150
+ *
1151
+ * @param {string} projectLocationCollectionEngineConversationName
1152
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1153
+ * @returns {string} A string representing the location.
1154
+ */
1155
+ matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1156
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).location;
1157
+ }
1158
+ /**
1159
+ * Parse the collection from ProjectLocationCollectionEngineConversation resource.
1160
+ *
1161
+ * @param {string} projectLocationCollectionEngineConversationName
1162
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1163
+ * @returns {string} A string representing the collection.
1164
+ */
1165
+ matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1166
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).collection;
1167
+ }
1168
+ /**
1169
+ * Parse the engine from ProjectLocationCollectionEngineConversation resource.
1170
+ *
1171
+ * @param {string} projectLocationCollectionEngineConversationName
1172
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1173
+ * @returns {string} A string representing the engine.
1174
+ */
1175
+ matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1176
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).engine;
1177
+ }
1178
+ /**
1179
+ * Parse the conversation from ProjectLocationCollectionEngineConversation resource.
1180
+ *
1181
+ * @param {string} projectLocationCollectionEngineConversationName
1182
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1183
+ * @returns {string} A string representing the conversation.
1184
+ */
1185
+ matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1186
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).conversation;
1187
+ }
1188
+ /**
1189
+ * Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
1190
+ *
1191
+ * @param {string} project
1192
+ * @param {string} location
1193
+ * @param {string} collection
1194
+ * @param {string} engine
1195
+ * @param {string} serving_config
1196
+ * @returns {string} Resource name string.
1197
+ */
1198
+ projectLocationCollectionEngineServingConfigPath(project, location, collection, engine, servingConfig) {
1199
+ return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.render({
1200
+ project: project,
1201
+ location: location,
1202
+ collection: collection,
1203
+ engine: engine,
1204
+ serving_config: servingConfig,
1205
+ });
1206
+ }
1207
+ /**
1208
+ * Parse the project from ProjectLocationCollectionEngineServingConfig resource.
1209
+ *
1210
+ * @param {string} projectLocationCollectionEngineServingConfigName
1211
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1212
+ * @returns {string} A string representing the project.
1213
+ */
1214
+ matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
1215
+ return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).project;
1216
+ }
1217
+ /**
1218
+ * Parse the location from ProjectLocationCollectionEngineServingConfig resource.
1219
+ *
1220
+ * @param {string} projectLocationCollectionEngineServingConfigName
1221
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1222
+ * @returns {string} A string representing the location.
1223
+ */
1224
+ matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
1225
+ return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).location;
1226
+ }
1227
+ /**
1228
+ * Parse the collection from ProjectLocationCollectionEngineServingConfig resource.
1229
+ *
1230
+ * @param {string} projectLocationCollectionEngineServingConfigName
1231
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1232
+ * @returns {string} A string representing the collection.
1233
+ */
1234
+ matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
1235
+ return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).collection;
1236
+ }
1237
+ /**
1238
+ * Parse the engine from ProjectLocationCollectionEngineServingConfig resource.
1239
+ *
1240
+ * @param {string} projectLocationCollectionEngineServingConfigName
1241
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1242
+ * @returns {string} A string representing the engine.
1243
+ */
1244
+ matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
1245
+ return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).engine;
1246
+ }
1247
+ /**
1248
+ * Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.
1249
+ *
1250
+ * @param {string} projectLocationCollectionEngineServingConfigName
1251
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1252
+ * @returns {string} A string representing the serving_config.
1253
+ */
1254
+ matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
1255
+ return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).serving_config;
1256
+ }
902
1257
  /**
903
1258
  * Return a fully-qualified projectLocationDataStore resource name string.
904
1259
  *
@@ -1184,6 +1539,108 @@ class ConversationalSearchServiceClient {
1184
1539
  matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName) {
1185
1540
  return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.match(projectLocationDataStoreServingConfigName).serving_config;
1186
1541
  }
1542
+ /**
1543
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
1544
+ *
1545
+ * @param {string} project
1546
+ * @param {string} location
1547
+ * @param {string} data_store
1548
+ * @returns {string} Resource name string.
1549
+ */
1550
+ projectLocationDataStoreSiteSearchEnginePath(project, location, dataStore) {
1551
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.render({
1552
+ project: project,
1553
+ location: location,
1554
+ data_store: dataStore,
1555
+ });
1556
+ }
1557
+ /**
1558
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.
1559
+ *
1560
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1561
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1562
+ * @returns {string} A string representing the project.
1563
+ */
1564
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
1565
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).project;
1566
+ }
1567
+ /**
1568
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.
1569
+ *
1570
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1571
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1572
+ * @returns {string} A string representing the location.
1573
+ */
1574
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
1575
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).location;
1576
+ }
1577
+ /**
1578
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.
1579
+ *
1580
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1581
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1582
+ * @returns {string} A string representing the data_store.
1583
+ */
1584
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
1585
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).data_store;
1586
+ }
1587
+ /**
1588
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
1589
+ *
1590
+ * @param {string} project
1591
+ * @param {string} location
1592
+ * @param {string} data_store
1593
+ * @param {string} target_site
1594
+ * @returns {string} Resource name string.
1595
+ */
1596
+ projectLocationDataStoreSiteSearchEngineTargetSitePath(project, location, dataStore, targetSite) {
1597
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.render({
1598
+ project: project,
1599
+ location: location,
1600
+ data_store: dataStore,
1601
+ target_site: targetSite,
1602
+ });
1603
+ }
1604
+ /**
1605
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1606
+ *
1607
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1608
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1609
+ * @returns {string} A string representing the project.
1610
+ */
1611
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1612
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).project;
1613
+ }
1614
+ /**
1615
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1616
+ *
1617
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1618
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1619
+ * @returns {string} A string representing the location.
1620
+ */
1621
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1622
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).location;
1623
+ }
1624
+ /**
1625
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1626
+ *
1627
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1628
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1629
+ * @returns {string} A string representing the data_store.
1630
+ */
1631
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1632
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).data_store;
1633
+ }
1634
+ /**
1635
+ * Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1636
+ *
1637
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1638
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1639
+ * @returns {string} A string representing the target_site.
1640
+ */
1641
+ matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1642
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
1643
+ }
1187
1644
  /**
1188
1645
  * Terminate the gRPC channel and close the client.
1189
1646
  *