@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 SearchServiceClient {
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: {},
@@ -82,16 +82,24 @@ class SearchServiceClient {
82
82
  };
83
83
  // Ensure that options include all the required fields.
84
84
  const staticMembers = this.constructor;
85
- const servicePath = (opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint) || staticMembers.servicePath;
85
+ if ((opts === null || opts === void 0 ? void 0 : opts.universe_domain) &&
86
+ (opts === null || opts === void 0 ? void 0 : opts.universeDomain) &&
87
+ (opts === null || opts === void 0 ? void 0 : opts.universe_domain) !== (opts === null || opts === void 0 ? void 0 : opts.universeDomain)) {
88
+ throw new Error('Please set either universe_domain or universeDomain, but not both.');
89
+ }
90
+ this._universeDomain =
91
+ (_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';
92
+ this._servicePath = 'discoveryengine.' + this._universeDomain;
93
+ const servicePath = (opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint) || this._servicePath;
86
94
  this._providedCustomServicePath = !!((opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint));
87
95
  const port = (opts === null || opts === void 0 ? void 0 : opts.port) || staticMembers.port;
88
- const clientConfig = (_a = opts === null || opts === void 0 ? void 0 : opts.clientConfig) !== null && _a !== void 0 ? _a : {};
89
- 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');
96
+ const clientConfig = (_c = opts === null || opts === void 0 ? void 0 : opts.clientConfig) !== null && _c !== void 0 ? _c : {};
97
+ 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');
90
98
  opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
91
99
  // Request numeric enum values if REST transport is used.
92
100
  opts.numericEnums = true;
93
101
  // If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
94
- if (servicePath !== staticMembers.servicePath && !('scopes' in opts)) {
102
+ if (servicePath !== this._servicePath && !('scopes' in opts)) {
95
103
  opts['scopes'] = staticMembers.scopes;
96
104
  }
97
105
  // Load google-gax module synchronously if needed
@@ -109,9 +117,9 @@ class SearchServiceClient {
109
117
  // Set useJWTAccessWithScope on the auth object.
110
118
  this.auth.useJWTAccessWithScope = true;
111
119
  // Set defaultServicePath on the auth object.
112
- this.auth.defaultServicePath = staticMembers.servicePath;
120
+ this.auth.defaultServicePath = this._servicePath;
113
121
  // Set the default scopes in auth client if needed.
114
- if (servicePath === staticMembers.servicePath) {
122
+ if (servicePath === this._servicePath) {
115
123
  this.auth.defaultScopes = staticMembers.scopes;
116
124
  }
117
125
  this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
@@ -145,6 +153,9 @@ class SearchServiceClient {
145
153
  projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
146
154
  projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
147
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}'),
148
159
  projectLocationCollectionEngineServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}'),
149
160
  projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
150
161
  projectLocationDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}'),
@@ -152,6 +163,8 @@ class SearchServiceClient {
152
163
  projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
153
164
  projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
154
165
  projectLocationDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}'),
166
+ projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
167
+ projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
155
168
  };
156
169
  // Some of the methods on this service return "paged" results,
157
170
  // (e.g. 50 results at a time, with tokens to get subsequent
@@ -212,19 +225,38 @@ class SearchServiceClient {
212
225
  }
213
226
  /**
214
227
  * The DNS address for this API service.
228
+ * @deprecated Use the apiEndpoint method of the client instance.
215
229
  * @returns {string} The DNS address for this service.
216
230
  */
217
231
  static get servicePath() {
232
+ if (typeof process !== undefined &&
233
+ typeof process.emitWarning === 'function') {
234
+ process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
235
+ }
218
236
  return 'discoveryengine.googleapis.com';
219
237
  }
220
238
  /**
221
- * The DNS address for this API service - same as servicePath(),
222
- * exists for compatibility reasons.
239
+ * The DNS address for this API service - same as servicePath.
240
+ * @deprecated Use the apiEndpoint method of the client instance.
223
241
  * @returns {string} The DNS address for this service.
224
242
  */
225
243
  static get apiEndpoint() {
244
+ if (typeof process !== undefined &&
245
+ typeof process.emitWarning === 'function') {
246
+ process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
247
+ }
226
248
  return 'discoveryengine.googleapis.com';
227
249
  }
250
+ /**
251
+ * The DNS address for this API service.
252
+ * @returns {string} The DNS address for this service.
253
+ */
254
+ get apiEndpoint() {
255
+ return this._servicePath;
256
+ }
257
+ get universeDomain() {
258
+ return this._universeDomain;
259
+ }
228
260
  /**
229
261
  * The port for this API service.
230
262
  * @returns {number} The default port for this service.
@@ -334,6 +366,19 @@ class SearchServiceClient {
334
366
  * For more information about filtering including syntax and filter
335
367
  * operators, see
336
368
  * [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
369
+ * @param {string} request.canonicalFilter
370
+ * The default filter that is applied when a user performs a search without
371
+ * checking any filters on the search page.
372
+ *
373
+ * The filter applied to every search request when quality improvement such as
374
+ * query expansion is needed. In the case a query does not have a sufficient
375
+ * amount of results this filter will be used to determine whether or not to
376
+ * enable the query expansion flow. The original filter will still be used for
377
+ * the query expanded search.
378
+ * This field is strongly recommended to achieve high search quality.
379
+ *
380
+ * For more information about filter syntax, see
381
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.filter|SearchRequest.filter}.
337
382
  * @param {string} request.orderBy
338
383
  * The order in which documents are returned. Documents can be ordered by
339
384
  * a field in an {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}
@@ -538,6 +583,19 @@ class SearchServiceClient {
538
583
  * For more information about filtering including syntax and filter
539
584
  * operators, see
540
585
  * [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
586
+ * @param {string} request.canonicalFilter
587
+ * The default filter that is applied when a user performs a search without
588
+ * checking any filters on the search page.
589
+ *
590
+ * The filter applied to every search request when quality improvement such as
591
+ * query expansion is needed. In the case a query does not have a sufficient
592
+ * amount of results this filter will be used to determine whether or not to
593
+ * enable the query expansion flow. The original filter will still be used for
594
+ * the query expanded search.
595
+ * This field is strongly recommended to achieve high search quality.
596
+ *
597
+ * For more information about filter syntax, see
598
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.filter|SearchRequest.filter}.
541
599
  * @param {string} request.orderBy
542
600
  * The order in which documents are returned. Documents can be ordered by
543
601
  * a field in an {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}
@@ -1208,6 +1266,201 @@ class SearchServiceClient {
1208
1266
  matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
1209
1267
  return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).serving_config;
1210
1268
  }
1269
+ /**
1270
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
1271
+ *
1272
+ * @param {string} project
1273
+ * @param {string} location
1274
+ * @param {string} collection
1275
+ * @param {string} data_store
1276
+ * @returns {string} Resource name string.
1277
+ */
1278
+ projectLocationCollectionDataStoreSiteSearchEnginePath(project, location, collection, dataStore) {
1279
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.render({
1280
+ project: project,
1281
+ location: location,
1282
+ collection: collection,
1283
+ data_store: dataStore,
1284
+ });
1285
+ }
1286
+ /**
1287
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1288
+ *
1289
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1290
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1291
+ * @returns {string} A string representing the project.
1292
+ */
1293
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1294
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).project;
1295
+ }
1296
+ /**
1297
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1298
+ *
1299
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1300
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1301
+ * @returns {string} A string representing the location.
1302
+ */
1303
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1304
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).location;
1305
+ }
1306
+ /**
1307
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1308
+ *
1309
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1310
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1311
+ * @returns {string} A string representing the collection.
1312
+ */
1313
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1314
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).collection;
1315
+ }
1316
+ /**
1317
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1318
+ *
1319
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1320
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1321
+ * @returns {string} A string representing the data_store.
1322
+ */
1323
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1324
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).data_store;
1325
+ }
1326
+ /**
1327
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
1328
+ *
1329
+ * @param {string} project
1330
+ * @param {string} location
1331
+ * @param {string} collection
1332
+ * @param {string} data_store
1333
+ * @param {string} target_site
1334
+ * @returns {string} Resource name string.
1335
+ */
1336
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project, location, collection, dataStore, targetSite) {
1337
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.render({
1338
+ project: project,
1339
+ location: location,
1340
+ collection: collection,
1341
+ data_store: dataStore,
1342
+ target_site: targetSite,
1343
+ });
1344
+ }
1345
+ /**
1346
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1347
+ *
1348
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1349
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1350
+ * @returns {string} A string representing the project.
1351
+ */
1352
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1353
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).project;
1354
+ }
1355
+ /**
1356
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1357
+ *
1358
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1359
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1360
+ * @returns {string} A string representing the location.
1361
+ */
1362
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1363
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).location;
1364
+ }
1365
+ /**
1366
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1367
+ *
1368
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1369
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1370
+ * @returns {string} A string representing the collection.
1371
+ */
1372
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1373
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).collection;
1374
+ }
1375
+ /**
1376
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1377
+ *
1378
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1379
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1380
+ * @returns {string} A string representing the data_store.
1381
+ */
1382
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1383
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).data_store;
1384
+ }
1385
+ /**
1386
+ * Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1387
+ *
1388
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1389
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1390
+ * @returns {string} A string representing the target_site.
1391
+ */
1392
+ matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1393
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).target_site;
1394
+ }
1395
+ /**
1396
+ * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
1397
+ *
1398
+ * @param {string} project
1399
+ * @param {string} location
1400
+ * @param {string} collection
1401
+ * @param {string} engine
1402
+ * @param {string} conversation
1403
+ * @returns {string} Resource name string.
1404
+ */
1405
+ projectLocationCollectionEngineConversationPath(project, location, collection, engine, conversation) {
1406
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.render({
1407
+ project: project,
1408
+ location: location,
1409
+ collection: collection,
1410
+ engine: engine,
1411
+ conversation: conversation,
1412
+ });
1413
+ }
1414
+ /**
1415
+ * Parse the project from ProjectLocationCollectionEngineConversation resource.
1416
+ *
1417
+ * @param {string} projectLocationCollectionEngineConversationName
1418
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1419
+ * @returns {string} A string representing the project.
1420
+ */
1421
+ matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1422
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).project;
1423
+ }
1424
+ /**
1425
+ * Parse the location from ProjectLocationCollectionEngineConversation resource.
1426
+ *
1427
+ * @param {string} projectLocationCollectionEngineConversationName
1428
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1429
+ * @returns {string} A string representing the location.
1430
+ */
1431
+ matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1432
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).location;
1433
+ }
1434
+ /**
1435
+ * Parse the collection from ProjectLocationCollectionEngineConversation resource.
1436
+ *
1437
+ * @param {string} projectLocationCollectionEngineConversationName
1438
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1439
+ * @returns {string} A string representing the collection.
1440
+ */
1441
+ matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1442
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).collection;
1443
+ }
1444
+ /**
1445
+ * Parse the engine from ProjectLocationCollectionEngineConversation resource.
1446
+ *
1447
+ * @param {string} projectLocationCollectionEngineConversationName
1448
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1449
+ * @returns {string} A string representing the engine.
1450
+ */
1451
+ matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1452
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).engine;
1453
+ }
1454
+ /**
1455
+ * Parse the conversation from ProjectLocationCollectionEngineConversation resource.
1456
+ *
1457
+ * @param {string} projectLocationCollectionEngineConversationName
1458
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1459
+ * @returns {string} A string representing the conversation.
1460
+ */
1461
+ matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1462
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).conversation;
1463
+ }
1211
1464
  /**
1212
1465
  * Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
1213
1466
  *
@@ -1619,6 +1872,108 @@ class SearchServiceClient {
1619
1872
  matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName) {
1620
1873
  return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.match(projectLocationDataStoreServingConfigName).serving_config;
1621
1874
  }
1875
+ /**
1876
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
1877
+ *
1878
+ * @param {string} project
1879
+ * @param {string} location
1880
+ * @param {string} data_store
1881
+ * @returns {string} Resource name string.
1882
+ */
1883
+ projectLocationDataStoreSiteSearchEnginePath(project, location, dataStore) {
1884
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.render({
1885
+ project: project,
1886
+ location: location,
1887
+ data_store: dataStore,
1888
+ });
1889
+ }
1890
+ /**
1891
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.
1892
+ *
1893
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1894
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1895
+ * @returns {string} A string representing the project.
1896
+ */
1897
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
1898
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).project;
1899
+ }
1900
+ /**
1901
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.
1902
+ *
1903
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1904
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1905
+ * @returns {string} A string representing the location.
1906
+ */
1907
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
1908
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).location;
1909
+ }
1910
+ /**
1911
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.
1912
+ *
1913
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1914
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1915
+ * @returns {string} A string representing the data_store.
1916
+ */
1917
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
1918
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).data_store;
1919
+ }
1920
+ /**
1921
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
1922
+ *
1923
+ * @param {string} project
1924
+ * @param {string} location
1925
+ * @param {string} data_store
1926
+ * @param {string} target_site
1927
+ * @returns {string} Resource name string.
1928
+ */
1929
+ projectLocationDataStoreSiteSearchEngineTargetSitePath(project, location, dataStore, targetSite) {
1930
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.render({
1931
+ project: project,
1932
+ location: location,
1933
+ data_store: dataStore,
1934
+ target_site: targetSite,
1935
+ });
1936
+ }
1937
+ /**
1938
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1939
+ *
1940
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1941
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1942
+ * @returns {string} A string representing the project.
1943
+ */
1944
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1945
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).project;
1946
+ }
1947
+ /**
1948
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1949
+ *
1950
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1951
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1952
+ * @returns {string} A string representing the location.
1953
+ */
1954
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1955
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).location;
1956
+ }
1957
+ /**
1958
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1959
+ *
1960
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1961
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1962
+ * @returns {string} A string representing the data_store.
1963
+ */
1964
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1965
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).data_store;
1966
+ }
1967
+ /**
1968
+ * Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1969
+ *
1970
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1971
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1972
+ * @returns {string} A string representing the target_site.
1973
+ */
1974
+ matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1975
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
1976
+ }
1622
1977
  /**
1623
1978
  * Terminate the gRPC channel and close the client.
1624
1979
  *