@google-cloud/discoveryengine 1.13.0 → 1.14.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 (92) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +6 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/answer.proto +49 -5
  4. package/build/protos/google/cloud/discoveryengine/v1/control.proto +6 -4
  5. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +9 -9
  6. package/build/protos/google/cloud/discoveryengine/v1/custom_tuning_model.proto +96 -0
  7. package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +10 -0
  8. package/build/protos/google/cloud/discoveryengine/v1/document.proto +20 -0
  9. package/build/protos/google/cloud/discoveryengine/v1/document_processing_config.proto +2 -0
  10. package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +110 -0
  11. package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +2 -1
  12. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +13 -7
  13. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +117 -0
  14. package/build/protos/google/cloud/discoveryengine/v1/recommendation_service.proto +2 -1
  15. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +40 -16
  16. package/build/protos/google/cloud/discoveryengine/v1/search_tuning_service.proto +196 -0
  17. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +4 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +21 -0
  19. package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config_service.proto +1 -1
  20. package/build/protos/google/cloud/discoveryengine/v1alpha/answer.proto +6 -0
  21. package/build/protos/google/cloud/discoveryengine/v1alpha/control.proto +1 -1
  22. package/build/protos/google/cloud/discoveryengine/v1alpha/custom_tuning_model.proto +3 -0
  23. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +48 -0
  24. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +20 -0
  25. package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +107 -0
  26. package/build/protos/google/cloud/discoveryengine/v1alpha/grounded_generation_service.proto +2 -1
  27. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +7 -7
  28. package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +1 -1
  29. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +21 -1
  30. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +4 -0
  31. package/build/protos/google/cloud/discoveryengine/v1beta/answer.proto +47 -2
  32. package/build/protos/google/cloud/discoveryengine/v1beta/control.proto +1 -1
  33. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +3 -0
  34. package/build/protos/google/cloud/discoveryengine/v1beta/custom_tuning_model.proto +3 -0
  35. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +20 -0
  36. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +2 -0
  37. package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +114 -0
  38. package/build/protos/google/cloud/discoveryengine/v1beta/grounded_generation_service.proto +2 -1
  39. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +13 -7
  40. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +44 -0
  41. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +101 -6
  42. package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -0
  43. package/build/protos/protos.d.ts +7369 -2842
  44. package/build/protos/protos.js +13311 -2062
  45. package/build/protos/protos.json +1096 -45
  46. package/build/src/index.d.ts +4 -1
  47. package/build/src/index.js +4 -1
  48. package/build/src/v1/completion_service_client.d.ts +93 -0
  49. package/build/src/v1/completion_service_client.js +134 -0
  50. package/build/src/v1/control_service_client.d.ts +93 -0
  51. package/build/src/v1/control_service_client.js +128 -0
  52. package/build/src/v1/conversational_search_service_client.d.ts +93 -0
  53. package/build/src/v1/conversational_search_service_client.js +128 -0
  54. package/build/src/v1/data_store_service_client.d.ts +102 -0
  55. package/build/src/v1/data_store_service_client.js +134 -0
  56. package/build/src/v1/document_service_client.d.ts +131 -0
  57. package/build/src/v1/document_service_client.js +156 -0
  58. package/build/src/v1/document_service_client_config.json +5 -0
  59. package/build/src/v1/engine_service_client.d.ts +93 -0
  60. package/build/src/v1/engine_service_client.js +134 -0
  61. package/build/src/v1/grounded_generation_service_client.d.ts +93 -0
  62. package/build/src/v1/grounded_generation_service_client.js +128 -0
  63. package/build/src/v1/index.d.ts +1 -0
  64. package/build/src/v1/index.js +3 -1
  65. package/build/src/v1/project_service_client.d.ts +93 -0
  66. package/build/src/v1/project_service_client.js +134 -0
  67. package/build/src/v1/rank_service_client.d.ts +93 -0
  68. package/build/src/v1/rank_service_client.js +128 -0
  69. package/build/src/v1/recommendation_service_client.d.ts +95 -1
  70. package/build/src/v1/recommendation_service_client.js +128 -0
  71. package/build/src/v1/schema_service_client.d.ts +93 -0
  72. package/build/src/v1/schema_service_client.js +134 -0
  73. package/build/src/v1/search_service_client.d.ts +111 -9
  74. package/build/src/v1/search_service_client.js +140 -6
  75. package/build/src/v1/search_tuning_service_client.d.ts +1776 -0
  76. package/build/src/v1/search_tuning_service_client.js +2589 -0
  77. package/build/src/v1/search_tuning_service_client_config.json +34 -0
  78. package/build/src/v1/site_search_engine_service_client.d.ts +93 -0
  79. package/build/src/v1/site_search_engine_service_client.js +134 -0
  80. package/build/src/v1/user_event_service_client.d.ts +168 -0
  81. package/build/src/v1/user_event_service_client.js +176 -0
  82. package/build/src/v1/user_event_service_client_config.json +5 -0
  83. package/build/src/v1alpha/acl_config_service_client.d.ts +1 -1
  84. package/build/src/v1alpha/document_service_client.d.ts +29 -0
  85. package/build/src/v1alpha/document_service_client.js +22 -0
  86. package/build/src/v1alpha/document_service_client_config.json +5 -0
  87. package/build/src/v1beta/document_service_client.d.ts +38 -0
  88. package/build/src/v1beta/document_service_client.js +22 -0
  89. package/build/src/v1beta/document_service_client_config.json +5 -0
  90. package/build/src/v1beta/search_service_client.d.ts +36 -9
  91. package/build/src/v1beta/search_service_client.js +24 -6
  92. package/package.json +1 -1
@@ -157,6 +157,7 @@ class SearchServiceClient {
157
157
  projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
158
158
  projectLocationCollectionDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/controls/{control}'),
159
159
  projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
160
+ projectLocationCollectionDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
160
161
  projectLocationCollectionDataStoreDocumentProcessingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig'),
161
162
  projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
162
163
  projectLocationCollectionDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}'),
@@ -175,6 +176,7 @@ class SearchServiceClient {
175
176
  projectLocationDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
176
177
  projectLocationDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/controls/{control}'),
177
178
  projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
179
+ projectLocationDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
178
180
  projectLocationDataStoreDocumentProcessingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/documentProcessingConfig'),
179
181
  projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
180
182
  projectLocationDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}'),
@@ -409,9 +411,12 @@ class SearchServiceClient {
409
411
  * Leave it unset if ordered by relevance. `order_by` expression is
410
412
  * case-sensitive.
411
413
  *
412
- * For more information on ordering for retail search, see
413
- * [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
414
- *
414
+ * For more information on ordering the website search results, see
415
+ * [Order web search
416
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
417
+ * For more information on ordering the healthcare search results, see
418
+ * [Order healthcare search
419
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
415
420
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
416
421
  * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
417
422
  * Information about the end user.
@@ -645,9 +650,12 @@ class SearchServiceClient {
645
650
  * Leave it unset if ordered by relevance. `order_by` expression is
646
651
  * case-sensitive.
647
652
  *
648
- * For more information on ordering for retail search, see
649
- * [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
650
- *
653
+ * For more information on ordering the website search results, see
654
+ * [Order web search
655
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
656
+ * For more information on ordering the healthcare search results, see
657
+ * [Order healthcare search
658
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
651
659
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
652
660
  * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
653
661
  * Information about the end user.
@@ -1365,6 +1373,75 @@ class SearchServiceClient {
1365
1373
  matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
1366
1374
  return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).conversation;
1367
1375
  }
1376
+ /**
1377
+ * Return a fully-qualified projectLocationCollectionDataStoreCustomTuningModel resource name string.
1378
+ *
1379
+ * @param {string} project
1380
+ * @param {string} location
1381
+ * @param {string} collection
1382
+ * @param {string} data_store
1383
+ * @param {string} custom_tuning_model
1384
+ * @returns {string} Resource name string.
1385
+ */
1386
+ projectLocationCollectionDataStoreCustomTuningModelPath(project, location, collection, dataStore, customTuningModel) {
1387
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.render({
1388
+ project: project,
1389
+ location: location,
1390
+ collection: collection,
1391
+ data_store: dataStore,
1392
+ custom_tuning_model: customTuningModel,
1393
+ });
1394
+ }
1395
+ /**
1396
+ * Parse the project from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1397
+ *
1398
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1399
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1400
+ * @returns {string} A string representing the project.
1401
+ */
1402
+ matchProjectFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1403
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).project;
1404
+ }
1405
+ /**
1406
+ * Parse the location from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1407
+ *
1408
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1409
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1410
+ * @returns {string} A string representing the location.
1411
+ */
1412
+ matchLocationFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1413
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).location;
1414
+ }
1415
+ /**
1416
+ * Parse the collection from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1417
+ *
1418
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1419
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1420
+ * @returns {string} A string representing the collection.
1421
+ */
1422
+ matchCollectionFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1423
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).collection;
1424
+ }
1425
+ /**
1426
+ * Parse the data_store from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1427
+ *
1428
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1429
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1430
+ * @returns {string} A string representing the data_store.
1431
+ */
1432
+ matchDataStoreFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1433
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).data_store;
1434
+ }
1435
+ /**
1436
+ * Parse the custom_tuning_model from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1437
+ *
1438
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1439
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1440
+ * @returns {string} A string representing the custom_tuning_model.
1441
+ */
1442
+ matchCustomTuningModelFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1443
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).custom_tuning_model;
1444
+ }
1368
1445
  /**
1369
1446
  * Return a fully-qualified projectLocationCollectionDataStoreDocumentProcessingConfig resource name string.
1370
1447
  *
@@ -2559,6 +2636,63 @@ class SearchServiceClient {
2559
2636
  matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
2560
2637
  return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).conversation;
2561
2638
  }
2639
+ /**
2640
+ * Return a fully-qualified projectLocationDataStoreCustomTuningModel resource name string.
2641
+ *
2642
+ * @param {string} project
2643
+ * @param {string} location
2644
+ * @param {string} data_store
2645
+ * @param {string} custom_tuning_model
2646
+ * @returns {string} Resource name string.
2647
+ */
2648
+ projectLocationDataStoreCustomTuningModelPath(project, location, dataStore, customTuningModel) {
2649
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.render({
2650
+ project: project,
2651
+ location: location,
2652
+ data_store: dataStore,
2653
+ custom_tuning_model: customTuningModel,
2654
+ });
2655
+ }
2656
+ /**
2657
+ * Parse the project from ProjectLocationDataStoreCustomTuningModel resource.
2658
+ *
2659
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2660
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2661
+ * @returns {string} A string representing the project.
2662
+ */
2663
+ matchProjectFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName) {
2664
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).project;
2665
+ }
2666
+ /**
2667
+ * Parse the location from ProjectLocationDataStoreCustomTuningModel resource.
2668
+ *
2669
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2670
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2671
+ * @returns {string} A string representing the location.
2672
+ */
2673
+ matchLocationFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName) {
2674
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).location;
2675
+ }
2676
+ /**
2677
+ * Parse the data_store from ProjectLocationDataStoreCustomTuningModel resource.
2678
+ *
2679
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2680
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2681
+ * @returns {string} A string representing the data_store.
2682
+ */
2683
+ matchDataStoreFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName) {
2684
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).data_store;
2685
+ }
2686
+ /**
2687
+ * Parse the custom_tuning_model from ProjectLocationDataStoreCustomTuningModel resource.
2688
+ *
2689
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2690
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2691
+ * @returns {string} A string representing the custom_tuning_model.
2692
+ */
2693
+ matchCustomTuningModelFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName) {
2694
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).custom_tuning_model;
2695
+ }
2562
2696
  /**
2563
2697
  * Return a fully-qualified projectLocationDataStoreDocumentProcessingConfig resource name string.
2564
2698
  *