@google-cloud/discoveryengine 1.12.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 (121) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +10 -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 +61 -2
  21. package/build/protos/google/cloud/discoveryengine/v1alpha/chunk.proto +1 -1
  22. package/build/protos/google/cloud/discoveryengine/v1alpha/completion.proto +31 -0
  23. package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +38 -0
  24. package/build/protos/google/cloud/discoveryengine/v1alpha/control.proto +1 -1
  25. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +28 -9
  26. package/build/protos/google/cloud/discoveryengine/v1alpha/custom_tuning_model.proto +10 -1
  27. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +71 -0
  28. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +11 -1
  29. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +24 -1
  30. package/build/protos/google/cloud/discoveryengine/v1alpha/document_processing_config.proto +6 -2
  31. package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +108 -1
  32. package/build/protos/google/cloud/discoveryengine/v1alpha/grounded_generation_service.proto +2 -1
  33. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +119 -5
  34. package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +58 -1
  35. package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +5 -0
  36. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +428 -12
  37. package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config.proto +14 -5
  38. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +126 -0
  39. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +4 -0
  40. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event_service.proto +3 -0
  41. package/build/protos/google/cloud/discoveryengine/v1beta/answer.proto +47 -2
  42. package/build/protos/google/cloud/discoveryengine/v1beta/control.proto +1 -1
  43. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +3 -0
  44. package/build/protos/google/cloud/discoveryengine/v1beta/custom_tuning_model.proto +3 -0
  45. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +20 -0
  46. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +2 -0
  47. package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +114 -0
  48. package/build/protos/google/cloud/discoveryengine/v1beta/grounded_generation_service.proto +2 -1
  49. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +13 -7
  50. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +44 -0
  51. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +101 -6
  52. package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -0
  53. package/build/protos/protos.d.ts +24137 -16126
  54. package/build/protos/protos.js +78286 -58223
  55. package/build/protos/protos.json +1954 -105
  56. package/build/src/index.d.ts +4 -1
  57. package/build/src/index.js +4 -1
  58. package/build/src/v1/completion_service_client.d.ts +93 -0
  59. package/build/src/v1/completion_service_client.js +134 -0
  60. package/build/src/v1/control_service_client.d.ts +93 -0
  61. package/build/src/v1/control_service_client.js +128 -0
  62. package/build/src/v1/conversational_search_service_client.d.ts +93 -0
  63. package/build/src/v1/conversational_search_service_client.js +128 -0
  64. package/build/src/v1/data_store_service_client.d.ts +102 -0
  65. package/build/src/v1/data_store_service_client.js +134 -0
  66. package/build/src/v1/document_service_client.d.ts +131 -0
  67. package/build/src/v1/document_service_client.js +156 -0
  68. package/build/src/v1/document_service_client_config.json +5 -0
  69. package/build/src/v1/engine_service_client.d.ts +93 -0
  70. package/build/src/v1/engine_service_client.js +134 -0
  71. package/build/src/v1/grounded_generation_service_client.d.ts +93 -0
  72. package/build/src/v1/grounded_generation_service_client.js +128 -0
  73. package/build/src/v1/index.d.ts +1 -0
  74. package/build/src/v1/index.js +3 -1
  75. package/build/src/v1/project_service_client.d.ts +93 -0
  76. package/build/src/v1/project_service_client.js +134 -0
  77. package/build/src/v1/rank_service_client.d.ts +93 -0
  78. package/build/src/v1/rank_service_client.js +128 -0
  79. package/build/src/v1/recommendation_service_client.d.ts +95 -1
  80. package/build/src/v1/recommendation_service_client.js +128 -0
  81. package/build/src/v1/schema_service_client.d.ts +93 -0
  82. package/build/src/v1/schema_service_client.js +134 -0
  83. package/build/src/v1/search_service_client.d.ts +111 -9
  84. package/build/src/v1/search_service_client.js +140 -6
  85. package/build/src/v1/search_tuning_service_client.d.ts +1776 -0
  86. package/build/src/v1/search_tuning_service_client.js +2589 -0
  87. package/build/src/v1/search_tuning_service_client_config.json +34 -0
  88. package/build/src/v1/site_search_engine_service_client.d.ts +93 -0
  89. package/build/src/v1/site_search_engine_service_client.js +134 -0
  90. package/build/src/v1/user_event_service_client.d.ts +168 -0
  91. package/build/src/v1/user_event_service_client.js +176 -0
  92. package/build/src/v1/user_event_service_client_config.json +5 -0
  93. package/build/src/v1alpha/acl_config_service_client.d.ts +1 -1
  94. package/build/src/v1alpha/completion_service_client.d.ts +91 -0
  95. package/build/src/v1alpha/completion_service_client.js +90 -0
  96. package/build/src/v1alpha/completion_service_client_config.json +10 -0
  97. package/build/src/v1alpha/conversational_search_service_client.d.ts +18 -0
  98. package/build/src/v1alpha/data_store_service_client.d.ts +12 -3
  99. package/build/src/v1alpha/data_store_service_client.js +8 -2
  100. package/build/src/v1alpha/document_service_client.d.ts +33 -0
  101. package/build/src/v1alpha/document_service_client.js +28 -0
  102. package/build/src/v1alpha/document_service_client_config.json +5 -0
  103. package/build/src/v1alpha/engine_service_client.js +6 -0
  104. package/build/src/v1alpha/estimate_billing_service_client.js +6 -0
  105. package/build/src/v1alpha/evaluation_service_client.js +6 -0
  106. package/build/src/v1alpha/project_service_client.js +6 -0
  107. package/build/src/v1alpha/sample_query_service_client.js +6 -0
  108. package/build/src/v1alpha/schema_service_client.js +6 -0
  109. package/build/src/v1alpha/search_service_client.d.ts +219 -21
  110. package/build/src/v1alpha/search_service_client.js +146 -14
  111. package/build/src/v1alpha/search_tuning_service_client.js +6 -0
  112. package/build/src/v1alpha/site_search_engine_service_client.d.ts +101 -0
  113. package/build/src/v1alpha/site_search_engine_service_client.js +70 -0
  114. package/build/src/v1alpha/site_search_engine_service_client_config.json +8 -0
  115. package/build/src/v1alpha/user_event_service_client.js +6 -0
  116. package/build/src/v1beta/document_service_client.d.ts +38 -0
  117. package/build/src/v1beta/document_service_client.js +22 -0
  118. package/build/src/v1beta/document_service_client_config.json +5 -0
  119. package/build/src/v1beta/search_service_client.d.ts +36 -9
  120. package/build/src/v1beta/search_service_client.js +24 -6
  121. package/package.json +2 -2
@@ -205,9 +205,12 @@ export declare class SearchServiceClient {
205
205
  * object. Leave it unset if ordered by relevance. `order_by` expression is
206
206
  * case-sensitive.
207
207
  *
208
- * For more information on ordering for retail search, see
209
- * [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
210
- *
208
+ * For more information on ordering the website search results, see
209
+ * [Order web search
210
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
211
+ * For more information on ordering the healthcare search results, see
212
+ * [Order healthcare search
213
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
211
214
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
212
215
  * @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
213
216
  * Information about the end user.
@@ -370,6 +373,12 @@ export declare class SearchServiceClient {
370
373
  * Session specification.
371
374
  *
372
375
  * Can be used only when `session` is set.
376
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold} request.relevanceThreshold
377
+ * The relevance threshold of the search results.
378
+ *
379
+ * Default to Google defined threshold, leveraging a balance of
380
+ * precision and recall to deliver both highly accurate results and
381
+ * comprehensive coverage of relevant information.
373
382
  * @param {object} [options]
374
383
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
375
384
  * @returns {Promise} - The promise which resolves to an array.
@@ -478,9 +487,12 @@ export declare class SearchServiceClient {
478
487
  * object. Leave it unset if ordered by relevance. `order_by` expression is
479
488
  * case-sensitive.
480
489
  *
481
- * For more information on ordering for retail search, see
482
- * [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
483
- *
490
+ * For more information on ordering the website search results, see
491
+ * [Order web search
492
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
493
+ * For more information on ordering the healthcare search results, see
494
+ * [Order healthcare search
495
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
484
496
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
485
497
  * @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
486
498
  * Information about the end user.
@@ -643,6 +655,12 @@ export declare class SearchServiceClient {
643
655
  * Session specification.
644
656
  *
645
657
  * Can be used only when `session` is set.
658
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold} request.relevanceThreshold
659
+ * The relevance threshold of the search results.
660
+ *
661
+ * Default to Google defined threshold, leveraging a balance of
662
+ * precision and recall to deliver both highly accurate results and
663
+ * comprehensive coverage of relevant information.
646
664
  * @param {object} [options]
647
665
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
648
666
  * @returns {Stream}
@@ -746,9 +764,12 @@ export declare class SearchServiceClient {
746
764
  * object. Leave it unset if ordered by relevance. `order_by` expression is
747
765
  * case-sensitive.
748
766
  *
749
- * For more information on ordering for retail search, see
750
- * [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
751
- *
767
+ * For more information on ordering the website search results, see
768
+ * [Order web search
769
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
770
+ * For more information on ordering the healthcare search results, see
771
+ * [Order healthcare search
772
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
752
773
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
753
774
  * @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
754
775
  * Information about the end user.
@@ -911,6 +932,12 @@ export declare class SearchServiceClient {
911
932
  * Session specification.
912
933
  *
913
934
  * Can be used only when `session` is set.
935
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold} request.relevanceThreshold
936
+ * The relevance threshold of the search results.
937
+ *
938
+ * Default to Google defined threshold, leveraging a balance of
939
+ * precision and recall to deliver both highly accurate results and
940
+ * comprehensive coverage of relevant information.
914
941
  * @param {object} [options]
915
942
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
916
943
  * @returns {Object}
@@ -415,9 +415,12 @@ class SearchServiceClient {
415
415
  * object. Leave it unset if ordered by relevance. `order_by` expression is
416
416
  * case-sensitive.
417
417
  *
418
- * For more information on ordering for retail search, see
419
- * [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
420
- *
418
+ * For more information on ordering the website search results, see
419
+ * [Order web search
420
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
421
+ * For more information on ordering the healthcare search results, see
422
+ * [Order healthcare search
423
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
421
424
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
422
425
  * @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
423
426
  * Information about the end user.
@@ -580,6 +583,12 @@ class SearchServiceClient {
580
583
  * Session specification.
581
584
  *
582
585
  * Can be used only when `session` is set.
586
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold} request.relevanceThreshold
587
+ * The relevance threshold of the search results.
588
+ *
589
+ * Default to Google defined threshold, leveraging a balance of
590
+ * precision and recall to deliver both highly accurate results and
591
+ * comprehensive coverage of relevant information.
583
592
  * @param {object} [options]
584
593
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
585
594
  * @returns {Stream}
@@ -697,9 +706,12 @@ class SearchServiceClient {
697
706
  * object. Leave it unset if ordered by relevance. `order_by` expression is
698
707
  * case-sensitive.
699
708
  *
700
- * For more information on ordering for retail search, see
701
- * [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
702
- *
709
+ * For more information on ordering the website search results, see
710
+ * [Order web search
711
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
712
+ * For more information on ordering the healthcare search results, see
713
+ * [Order healthcare search
714
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
703
715
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
704
716
  * @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
705
717
  * Information about the end user.
@@ -862,6 +874,12 @@ class SearchServiceClient {
862
874
  * Session specification.
863
875
  *
864
876
  * Can be used only when `session` is set.
877
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold} request.relevanceThreshold
878
+ * The relevance threshold of the search results.
879
+ *
880
+ * Default to Google defined threshold, leveraging a balance of
881
+ * precision and recall to deliver both highly accurate results and
882
+ * comprehensive coverage of relevant information.
865
883
  * @param {object} [options]
866
884
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
867
885
  * @returns {Object}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@google-cloud/discoveryengine",
3
- "version": "1.12.0",
3
+ "version": "1.14.0",
4
4
  "description": "Discovery Engine API client for Node.js",
5
5
  "repository": {
6
6
  "type": "git",
@@ -43,7 +43,7 @@
43
43
  "postpack": "minifyProtoJson",
44
44
  "samples-test": "cd samples/ && npm link ../ && npm i && npm test",
45
45
  "system-test": "c8 mocha build/system-test",
46
- "test": "c8 mocha build/test"
46
+ "test": "NODE_OPTIONS=--max-old-space-size=8192 c8 mocha build/test"
47
47
  },
48
48
  "dependencies": {
49
49
  "google-gax": "^4.0.3"