@google-cloud/discoveryengine 1.3.0 → 1.3.1

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 (57) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +12 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +0 -5
  4. package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +3 -0
  5. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +39 -0
  6. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +1 -1
  7. package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +1 -1
  8. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +97 -0
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +147 -0
  10. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +164 -0
  11. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +540 -0
  12. package/build/protos/protos.d.ts +4473 -550
  13. package/build/protos/protos.js +27437 -19222
  14. package/build/protos/protos.json +1060 -358
  15. package/build/src/index.js +1 -1
  16. package/build/src/v1/completion_service_client.js +1 -1
  17. package/build/src/v1/conversational_search_service_client.js +1 -1
  18. package/build/src/v1/document_service_client.js +1 -1
  19. package/build/src/v1/index.js +1 -1
  20. package/build/src/v1/schema_service_client.js +1 -1
  21. package/build/src/v1/search_service_client.js +1 -1
  22. package/build/src/v1/user_event_service_client.js +1 -1
  23. package/build/src/v1alpha/completion_service_client.d.ts +219 -0
  24. package/build/src/v1alpha/completion_service_client.js +302 -0
  25. package/build/src/v1alpha/conversational_search_service_client.d.ts +236 -0
  26. package/build/src/v1alpha/conversational_search_service_client.js +302 -0
  27. package/build/src/v1alpha/data_store_service_client.d.ts +219 -0
  28. package/build/src/v1alpha/data_store_service_client.js +310 -2
  29. package/build/src/v1alpha/document_service_client.d.ts +219 -0
  30. package/build/src/v1alpha/document_service_client.js +310 -2
  31. package/build/src/v1alpha/engine_service_client.d.ts +220 -1
  32. package/build/src/v1alpha/engine_service_client.js +310 -2
  33. package/build/src/v1alpha/index.d.ts +1 -0
  34. package/build/src/v1alpha/index.js +3 -1
  35. package/build/src/v1alpha/recommendation_service_client.d.ts +219 -0
  36. package/build/src/v1alpha/recommendation_service_client.js +302 -0
  37. package/build/src/v1alpha/schema_service_client.d.ts +219 -0
  38. package/build/src/v1alpha/schema_service_client.js +310 -2
  39. package/build/src/v1alpha/search_service_client.d.ts +258 -0
  40. package/build/src/v1alpha/search_service_client.js +328 -0
  41. package/build/src/v1alpha/search_tuning_service_client.d.ts +968 -0
  42. package/build/src/v1alpha/search_tuning_service_client.js +1452 -0
  43. package/build/src/v1alpha/search_tuning_service_client_config.json +30 -0
  44. package/build/src/v1alpha/site_search_engine_service_client.d.ts +739 -1
  45. package/build/src/v1alpha/site_search_engine_service_client.js +801 -4
  46. package/build/src/v1alpha/site_search_engine_service_client_config.json +44 -0
  47. package/build/src/v1alpha/user_event_service_client.d.ts +219 -0
  48. package/build/src/v1alpha/user_event_service_client.js +310 -2
  49. package/build/src/v1beta/completion_service_client.js +1 -1
  50. package/build/src/v1beta/conversational_search_service_client.js +1 -1
  51. package/build/src/v1beta/document_service_client.js +1 -1
  52. package/build/src/v1beta/index.js +1 -1
  53. package/build/src/v1beta/recommendation_service_client.js +1 -1
  54. package/build/src/v1beta/schema_service_client.js +1 -1
  55. package/build/src/v1beta/search_service_client.js +1 -1
  56. package/build/src/v1beta/user_event_service_client.js +1 -1
  57. package/package.json +2 -2
@@ -170,6 +170,19 @@ export declare class SearchServiceClient {
170
170
  * For more information about filtering including syntax and filter
171
171
  * operators, see
172
172
  * [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
173
+ * @param {string} request.canonicalFilter
174
+ * The default filter that is applied when a user performs a search without
175
+ * checking any filters on the search page.
176
+ *
177
+ * The filter applied to every search request when quality improvement such as
178
+ * query expansion is needed. In the case a query does not have a sufficient
179
+ * amount of results this filter will be used to determine whether or not to
180
+ * enable the query expansion flow. The original filter will still be used for
181
+ * the query expanded search.
182
+ * This field is strongly recommended to achieve high search quality.
183
+ *
184
+ * For more information about filter syntax, see
185
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.filter|SearchRequest.filter}.
173
186
  * @param {string} request.orderBy
174
187
  * The order in which documents are returned. Documents can be ordered by
175
188
  * a field in an {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}
@@ -365,6 +378,19 @@ export declare class SearchServiceClient {
365
378
  * For more information about filtering including syntax and filter
366
379
  * operators, see
367
380
  * [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
381
+ * @param {string} request.canonicalFilter
382
+ * The default filter that is applied when a user performs a search without
383
+ * checking any filters on the search page.
384
+ *
385
+ * The filter applied to every search request when quality improvement such as
386
+ * query expansion is needed. In the case a query does not have a sufficient
387
+ * amount of results this filter will be used to determine whether or not to
388
+ * enable the query expansion flow. The original filter will still be used for
389
+ * the query expanded search.
390
+ * This field is strongly recommended to achieve high search quality.
391
+ *
392
+ * For more information about filter syntax, see
393
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.filter|SearchRequest.filter}.
368
394
  * @param {string} request.orderBy
369
395
  * The order in which documents are returned. Documents can be ordered by
370
396
  * a field in an {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}
@@ -555,6 +581,19 @@ export declare class SearchServiceClient {
555
581
  * For more information about filtering including syntax and filter
556
582
  * operators, see
557
583
  * [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
584
+ * @param {string} request.canonicalFilter
585
+ * The default filter that is applied when a user performs a search without
586
+ * checking any filters on the search page.
587
+ *
588
+ * The filter applied to every search request when quality improvement such as
589
+ * query expansion is needed. In the case a query does not have a sufficient
590
+ * amount of results this filter will be used to determine whether or not to
591
+ * enable the query expansion flow. The original filter will still be used for
592
+ * the query expanded search.
593
+ * This field is strongly recommended to achieve high search quality.
594
+ *
595
+ * For more information about filter syntax, see
596
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.filter|SearchRequest.filter}.
558
597
  * @param {string} request.orderBy
559
598
  * The order in which documents are returned. Documents can be ordered by
560
599
  * a field in an {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}
@@ -1081,6 +1120,150 @@ export declare class SearchServiceClient {
1081
1120
  * @returns {string} A string representing the serving_config.
1082
1121
  */
1083
1122
  matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1123
+ /**
1124
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
1125
+ *
1126
+ * @param {string} project
1127
+ * @param {string} location
1128
+ * @param {string} collection
1129
+ * @param {string} data_store
1130
+ * @returns {string} Resource name string.
1131
+ */
1132
+ projectLocationCollectionDataStoreSiteSearchEnginePath(project: string, location: string, collection: string, dataStore: string): string;
1133
+ /**
1134
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1135
+ *
1136
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1137
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1138
+ * @returns {string} A string representing the project.
1139
+ */
1140
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
1141
+ /**
1142
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1143
+ *
1144
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1145
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1146
+ * @returns {string} A string representing the location.
1147
+ */
1148
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
1149
+ /**
1150
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1151
+ *
1152
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1153
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1154
+ * @returns {string} A string representing the collection.
1155
+ */
1156
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
1157
+ /**
1158
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1159
+ *
1160
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1161
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1162
+ * @returns {string} A string representing the data_store.
1163
+ */
1164
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
1165
+ /**
1166
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
1167
+ *
1168
+ * @param {string} project
1169
+ * @param {string} location
1170
+ * @param {string} collection
1171
+ * @param {string} data_store
1172
+ * @param {string} target_site
1173
+ * @returns {string} Resource name string.
1174
+ */
1175
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, collection: string, dataStore: string, targetSite: string): string;
1176
+ /**
1177
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1178
+ *
1179
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1180
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1181
+ * @returns {string} A string representing the project.
1182
+ */
1183
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1184
+ /**
1185
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1186
+ *
1187
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1188
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1189
+ * @returns {string} A string representing the location.
1190
+ */
1191
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1192
+ /**
1193
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1194
+ *
1195
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1196
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1197
+ * @returns {string} A string representing the collection.
1198
+ */
1199
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1200
+ /**
1201
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1202
+ *
1203
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1204
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1205
+ * @returns {string} A string representing the data_store.
1206
+ */
1207
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1208
+ /**
1209
+ * Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1210
+ *
1211
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1212
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1213
+ * @returns {string} A string representing the target_site.
1214
+ */
1215
+ matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1216
+ /**
1217
+ * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
1218
+ *
1219
+ * @param {string} project
1220
+ * @param {string} location
1221
+ * @param {string} collection
1222
+ * @param {string} engine
1223
+ * @param {string} conversation
1224
+ * @returns {string} Resource name string.
1225
+ */
1226
+ projectLocationCollectionEngineConversationPath(project: string, location: string, collection: string, engine: string, conversation: string): string;
1227
+ /**
1228
+ * Parse the project from ProjectLocationCollectionEngineConversation resource.
1229
+ *
1230
+ * @param {string} projectLocationCollectionEngineConversationName
1231
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1232
+ * @returns {string} A string representing the project.
1233
+ */
1234
+ matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1235
+ /**
1236
+ * Parse the location from ProjectLocationCollectionEngineConversation resource.
1237
+ *
1238
+ * @param {string} projectLocationCollectionEngineConversationName
1239
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1240
+ * @returns {string} A string representing the location.
1241
+ */
1242
+ matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1243
+ /**
1244
+ * Parse the collection from ProjectLocationCollectionEngineConversation resource.
1245
+ *
1246
+ * @param {string} projectLocationCollectionEngineConversationName
1247
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1248
+ * @returns {string} A string representing the collection.
1249
+ */
1250
+ matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1251
+ /**
1252
+ * Parse the engine from ProjectLocationCollectionEngineConversation resource.
1253
+ *
1254
+ * @param {string} projectLocationCollectionEngineConversationName
1255
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1256
+ * @returns {string} A string representing the engine.
1257
+ */
1258
+ matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1259
+ /**
1260
+ * Parse the conversation from ProjectLocationCollectionEngineConversation resource.
1261
+ *
1262
+ * @param {string} projectLocationCollectionEngineConversationName
1263
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1264
+ * @returns {string} A string representing the conversation.
1265
+ */
1266
+ matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1084
1267
  /**
1085
1268
  * Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
1086
1269
  *
@@ -1384,6 +1567,81 @@ export declare class SearchServiceClient {
1384
1567
  * @returns {string} A string representing the serving_config.
1385
1568
  */
1386
1569
  matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1570
+ /**
1571
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
1572
+ *
1573
+ * @param {string} project
1574
+ * @param {string} location
1575
+ * @param {string} data_store
1576
+ * @returns {string} Resource name string.
1577
+ */
1578
+ projectLocationDataStoreSiteSearchEnginePath(project: string, location: string, dataStore: string): string;
1579
+ /**
1580
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.
1581
+ *
1582
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1583
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1584
+ * @returns {string} A string representing the project.
1585
+ */
1586
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1587
+ /**
1588
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.
1589
+ *
1590
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1591
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1592
+ * @returns {string} A string representing the location.
1593
+ */
1594
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1595
+ /**
1596
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.
1597
+ *
1598
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1599
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1600
+ * @returns {string} A string representing the data_store.
1601
+ */
1602
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1603
+ /**
1604
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
1605
+ *
1606
+ * @param {string} project
1607
+ * @param {string} location
1608
+ * @param {string} data_store
1609
+ * @param {string} target_site
1610
+ * @returns {string} Resource name string.
1611
+ */
1612
+ projectLocationDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, dataStore: string, targetSite: string): string;
1613
+ /**
1614
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1615
+ *
1616
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1617
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1618
+ * @returns {string} A string representing the project.
1619
+ */
1620
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1621
+ /**
1622
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1623
+ *
1624
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1625
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1626
+ * @returns {string} A string representing the location.
1627
+ */
1628
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1629
+ /**
1630
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1631
+ *
1632
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1633
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1634
+ * @returns {string} A string representing the data_store.
1635
+ */
1636
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1637
+ /**
1638
+ * Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1639
+ *
1640
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1641
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1642
+ * @returns {string} A string representing the target_site.
1643
+ */
1644
+ matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1387
1645
  /**
1388
1646
  * Terminate the gRPC channel and close the client.
1389
1647
  *
@@ -145,6 +145,9 @@ class SearchServiceClient {
145
145
  projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
146
146
  projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
147
147
  projectLocationCollectionDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}'),
148
+ projectLocationCollectionDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine'),
149
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
150
+ projectLocationCollectionEngineConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}'),
148
151
  projectLocationCollectionEngineServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}'),
149
152
  projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
150
153
  projectLocationDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}'),
@@ -152,6 +155,8 @@ class SearchServiceClient {
152
155
  projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
153
156
  projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
154
157
  projectLocationDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}'),
158
+ projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
159
+ projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
155
160
  };
156
161
  // Some of the methods on this service return "paged" results,
157
162
  // (e.g. 50 results at a time, with tokens to get subsequent
@@ -334,6 +339,19 @@ class SearchServiceClient {
334
339
  * For more information about filtering including syntax and filter
335
340
  * operators, see
336
341
  * [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
342
+ * @param {string} request.canonicalFilter
343
+ * The default filter that is applied when a user performs a search without
344
+ * checking any filters on the search page.
345
+ *
346
+ * The filter applied to every search request when quality improvement such as
347
+ * query expansion is needed. In the case a query does not have a sufficient
348
+ * amount of results this filter will be used to determine whether or not to
349
+ * enable the query expansion flow. The original filter will still be used for
350
+ * the query expanded search.
351
+ * This field is strongly recommended to achieve high search quality.
352
+ *
353
+ * For more information about filter syntax, see
354
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.filter|SearchRequest.filter}.
337
355
  * @param {string} request.orderBy
338
356
  * The order in which documents are returned. Documents can be ordered by
339
357
  * a field in an {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}
@@ -538,6 +556,19 @@ class SearchServiceClient {
538
556
  * For more information about filtering including syntax and filter
539
557
  * operators, see
540
558
  * [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
559
+ * @param {string} request.canonicalFilter
560
+ * The default filter that is applied when a user performs a search without
561
+ * checking any filters on the search page.
562
+ *
563
+ * The filter applied to every search request when quality improvement such as
564
+ * query expansion is needed. In the case a query does not have a sufficient
565
+ * amount of results this filter will be used to determine whether or not to
566
+ * enable the query expansion flow. The original filter will still be used for
567
+ * the query expanded search.
568
+ * This field is strongly recommended to achieve high search quality.
569
+ *
570
+ * For more information about filter syntax, see
571
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.filter|SearchRequest.filter}.
541
572
  * @param {string} request.orderBy
542
573
  * The order in which documents are returned. Documents can be ordered by
543
574
  * a field in an {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}
@@ -1208,6 +1239,201 @@ class SearchServiceClient {
1208
1239
  matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
1209
1240
  return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).serving_config;
1210
1241
  }
1242
+ /**
1243
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
1244
+ *
1245
+ * @param {string} project
1246
+ * @param {string} location
1247
+ * @param {string} collection
1248
+ * @param {string} data_store
1249
+ * @returns {string} Resource name string.
1250
+ */
1251
+ projectLocationCollectionDataStoreSiteSearchEnginePath(project, location, collection, dataStore) {
1252
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.render({
1253
+ project: project,
1254
+ location: location,
1255
+ collection: collection,
1256
+ data_store: dataStore,
1257
+ });
1258
+ }
1259
+ /**
1260
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1261
+ *
1262
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1263
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1264
+ * @returns {string} A string representing the project.
1265
+ */
1266
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1267
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).project;
1268
+ }
1269
+ /**
1270
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1271
+ *
1272
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1273
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1274
+ * @returns {string} A string representing the location.
1275
+ */
1276
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1277
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).location;
1278
+ }
1279
+ /**
1280
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1281
+ *
1282
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1283
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1284
+ * @returns {string} A string representing the collection.
1285
+ */
1286
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1287
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).collection;
1288
+ }
1289
+ /**
1290
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1291
+ *
1292
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1293
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1294
+ * @returns {string} A string representing the data_store.
1295
+ */
1296
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1297
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).data_store;
1298
+ }
1299
+ /**
1300
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
1301
+ *
1302
+ * @param {string} project
1303
+ * @param {string} location
1304
+ * @param {string} collection
1305
+ * @param {string} data_store
1306
+ * @param {string} target_site
1307
+ * @returns {string} Resource name string.
1308
+ */
1309
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project, location, collection, dataStore, targetSite) {
1310
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.render({
1311
+ project: project,
1312
+ location: location,
1313
+ collection: collection,
1314
+ data_store: dataStore,
1315
+ target_site: targetSite,
1316
+ });
1317
+ }
1318
+ /**
1319
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1320
+ *
1321
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1322
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1323
+ * @returns {string} A string representing the project.
1324
+ */
1325
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1326
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).project;
1327
+ }
1328
+ /**
1329
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1330
+ *
1331
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1332
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1333
+ * @returns {string} A string representing the location.
1334
+ */
1335
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1336
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).location;
1337
+ }
1338
+ /**
1339
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1340
+ *
1341
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1342
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1343
+ * @returns {string} A string representing the collection.
1344
+ */
1345
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1346
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).collection;
1347
+ }
1348
+ /**
1349
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1350
+ *
1351
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1352
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1353
+ * @returns {string} A string representing the data_store.
1354
+ */
1355
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1356
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).data_store;
1357
+ }
1358
+ /**
1359
+ * Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1360
+ *
1361
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1362
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1363
+ * @returns {string} A string representing the target_site.
1364
+ */
1365
+ matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1366
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).target_site;
1367
+ }
1368
+ /**
1369
+ * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
1370
+ *
1371
+ * @param {string} project
1372
+ * @param {string} location
1373
+ * @param {string} collection
1374
+ * @param {string} engine
1375
+ * @param {string} conversation
1376
+ * @returns {string} Resource name string.
1377
+ */
1378
+ projectLocationCollectionEngineConversationPath(project, location, collection, engine, conversation) {
1379
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.render({
1380
+ project: project,
1381
+ location: location,
1382
+ collection: collection,
1383
+ engine: engine,
1384
+ conversation: conversation,
1385
+ });
1386
+ }
1387
+ /**
1388
+ * Parse the project from ProjectLocationCollectionEngineConversation resource.
1389
+ *
1390
+ * @param {string} projectLocationCollectionEngineConversationName
1391
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1392
+ * @returns {string} A string representing the project.
1393
+ */
1394
+ matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1395
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).project;
1396
+ }
1397
+ /**
1398
+ * Parse the location from ProjectLocationCollectionEngineConversation resource.
1399
+ *
1400
+ * @param {string} projectLocationCollectionEngineConversationName
1401
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1402
+ * @returns {string} A string representing the location.
1403
+ */
1404
+ matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1405
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).location;
1406
+ }
1407
+ /**
1408
+ * Parse the collection from ProjectLocationCollectionEngineConversation resource.
1409
+ *
1410
+ * @param {string} projectLocationCollectionEngineConversationName
1411
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1412
+ * @returns {string} A string representing the collection.
1413
+ */
1414
+ matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1415
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).collection;
1416
+ }
1417
+ /**
1418
+ * Parse the engine from ProjectLocationCollectionEngineConversation resource.
1419
+ *
1420
+ * @param {string} projectLocationCollectionEngineConversationName
1421
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1422
+ * @returns {string} A string representing the engine.
1423
+ */
1424
+ matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1425
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).engine;
1426
+ }
1427
+ /**
1428
+ * Parse the conversation from ProjectLocationCollectionEngineConversation resource.
1429
+ *
1430
+ * @param {string} projectLocationCollectionEngineConversationName
1431
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1432
+ * @returns {string} A string representing the conversation.
1433
+ */
1434
+ matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1435
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).conversation;
1436
+ }
1211
1437
  /**
1212
1438
  * Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
1213
1439
  *
@@ -1619,6 +1845,108 @@ class SearchServiceClient {
1619
1845
  matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName) {
1620
1846
  return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.match(projectLocationDataStoreServingConfigName).serving_config;
1621
1847
  }
1848
+ /**
1849
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
1850
+ *
1851
+ * @param {string} project
1852
+ * @param {string} location
1853
+ * @param {string} data_store
1854
+ * @returns {string} Resource name string.
1855
+ */
1856
+ projectLocationDataStoreSiteSearchEnginePath(project, location, dataStore) {
1857
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.render({
1858
+ project: project,
1859
+ location: location,
1860
+ data_store: dataStore,
1861
+ });
1862
+ }
1863
+ /**
1864
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.
1865
+ *
1866
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1867
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1868
+ * @returns {string} A string representing the project.
1869
+ */
1870
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
1871
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).project;
1872
+ }
1873
+ /**
1874
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.
1875
+ *
1876
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1877
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1878
+ * @returns {string} A string representing the location.
1879
+ */
1880
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
1881
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).location;
1882
+ }
1883
+ /**
1884
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.
1885
+ *
1886
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1887
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1888
+ * @returns {string} A string representing the data_store.
1889
+ */
1890
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
1891
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).data_store;
1892
+ }
1893
+ /**
1894
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
1895
+ *
1896
+ * @param {string} project
1897
+ * @param {string} location
1898
+ * @param {string} data_store
1899
+ * @param {string} target_site
1900
+ * @returns {string} Resource name string.
1901
+ */
1902
+ projectLocationDataStoreSiteSearchEngineTargetSitePath(project, location, dataStore, targetSite) {
1903
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.render({
1904
+ project: project,
1905
+ location: location,
1906
+ data_store: dataStore,
1907
+ target_site: targetSite,
1908
+ });
1909
+ }
1910
+ /**
1911
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1912
+ *
1913
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1914
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1915
+ * @returns {string} A string representing the project.
1916
+ */
1917
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1918
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).project;
1919
+ }
1920
+ /**
1921
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1922
+ *
1923
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1924
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1925
+ * @returns {string} A string representing the location.
1926
+ */
1927
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1928
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).location;
1929
+ }
1930
+ /**
1931
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1932
+ *
1933
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1934
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1935
+ * @returns {string} A string representing the data_store.
1936
+ */
1937
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1938
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).data_store;
1939
+ }
1940
+ /**
1941
+ * Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1942
+ *
1943
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1944
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1945
+ * @returns {string} A string representing the target_site.
1946
+ */
1947
+ matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1948
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
1949
+ }
1622
1950
  /**
1623
1951
  * Terminate the gRPC channel and close the client.
1624
1952
  *