@google-cloud/discoveryengine 2.0.0 → 2.1.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 (149) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +7 -2
  3. package/build/protos/google/cloud/discoveryengine/v1/answer.proto +54 -2
  4. package/build/protos/google/cloud/discoveryengine/v1/chunk.proto +2 -1
  5. package/build/protos/google/cloud/discoveryengine/v1/common.proto +35 -6
  6. package/build/protos/google/cloud/discoveryengine/v1/control.proto +113 -2
  7. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +168 -2
  8. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +23 -4
  9. package/build/protos/google/cloud/discoveryengine/v1/document.proto +7 -2
  10. package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +1 -1
  11. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +16 -3
  12. package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +70 -9
  13. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +20 -1
  14. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +9 -5
  15. package/build/protos/google/cloud/discoveryengine/v1/rank_service.proto +3 -1
  16. package/build/protos/google/cloud/discoveryengine/v1/recommendation_service.proto +2 -2
  17. package/build/protos/google/cloud/discoveryengine/v1/safety.proto +107 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +96 -8
  19. package/build/protos/google/cloud/discoveryengine/v1/serving_config.proto +271 -0
  20. package/build/protos/google/cloud/discoveryengine/v1/serving_config_service.proto +75 -0
  21. package/build/protos/google/cloud/discoveryengine/v1/session.proto +19 -0
  22. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +27 -3
  23. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto +184 -5
  24. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +34 -0
  25. package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +16 -4
  26. package/build/protos/protos.d.ts +5356 -981
  27. package/build/protos/protos.js +32266 -20956
  28. package/build/protos/protos.json +1391 -74
  29. package/build/src/index.d.ts +4 -1
  30. package/build/src/index.js +4 -1
  31. package/build/src/v1/completion_service_client.d.ts +238 -1
  32. package/build/src/v1/completion_service_client.js +341 -5
  33. package/build/src/v1/completion_service_proto_list.json +3 -0
  34. package/build/src/v1/control_service_client.d.ts +237 -0
  35. package/build/src/v1/control_service_client.js +347 -7
  36. package/build/src/v1/control_service_proto_list.json +3 -0
  37. package/build/src/v1/conversational_search_service_client.d.ts +213 -6
  38. package/build/src/v1/conversational_search_service_client.js +316 -22
  39. package/build/src/v1/conversational_search_service_client_config.json +5 -0
  40. package/build/src/v1/conversational_search_service_proto_list.json +3 -0
  41. package/build/src/v1/data_store_service_client.d.ts +238 -1
  42. package/build/src/v1/data_store_service_client.js +347 -7
  43. package/build/src/v1/data_store_service_proto_list.json +3 -0
  44. package/build/src/v1/document_service_client.d.ts +245 -2
  45. package/build/src/v1/document_service_client.js +356 -10
  46. package/build/src/v1/document_service_proto_list.json +3 -0
  47. package/build/src/v1/engine_service_client.d.ts +238 -1
  48. package/build/src/v1/engine_service_client.js +347 -7
  49. package/build/src/v1/engine_service_proto_list.json +3 -0
  50. package/build/src/v1/gapic_metadata.json +59 -0
  51. package/build/src/v1/grounded_generation_service_client.d.ts +238 -3
  52. package/build/src/v1/grounded_generation_service_client.js +335 -3
  53. package/build/src/v1/grounded_generation_service_proto_list.json +3 -0
  54. package/build/src/v1/index.d.ts +1 -0
  55. package/build/src/v1/index.js +3 -1
  56. package/build/src/v1/project_service_client.d.ts +238 -1
  57. package/build/src/v1/project_service_client.js +329 -1
  58. package/build/src/v1/project_service_proto_list.json +3 -0
  59. package/build/src/v1/rank_service_client.d.ts +238 -1
  60. package/build/src/v1/rank_service_client.js +329 -1
  61. package/build/src/v1/rank_service_proto_list.json +3 -0
  62. package/build/src/v1/recommendation_service_client.d.ts +95 -2
  63. package/build/src/v1/recommendation_service_client.js +131 -1
  64. package/build/src/v1/recommendation_service_proto_list.json +3 -0
  65. package/build/src/v1/schema_service_client.d.ts +238 -1
  66. package/build/src/v1/schema_service_client.js +347 -7
  67. package/build/src/v1/schema_service_proto_list.json +3 -0
  68. package/build/src/v1/search_service_client.d.ts +219 -30
  69. package/build/src/v1/search_service_client.js +230 -26
  70. package/build/src/v1/search_service_proto_list.json +3 -0
  71. package/build/src/v1/search_tuning_service_client.d.ts +238 -1
  72. package/build/src/v1/search_tuning_service_client.js +332 -2
  73. package/build/src/v1/search_tuning_service_proto_list.json +3 -0
  74. package/build/src/v1/serving_config_service_client.d.ts +1851 -0
  75. package/build/src/v1/serving_config_service_client.js +2653 -0
  76. package/build/src/v1/serving_config_service_client_config.json +30 -0
  77. package/build/src/v1/serving_config_service_proto_list.json +39 -0
  78. package/build/src/v1/site_search_engine_service_client.d.ts +357 -4
  79. package/build/src/v1/site_search_engine_service_client.js +521 -16
  80. package/build/src/v1/site_search_engine_service_client_config.json +12 -0
  81. package/build/src/v1/site_search_engine_service_proto_list.json +3 -0
  82. package/build/src/v1/user_event_service_client.d.ts +259 -10
  83. package/build/src/v1/user_event_service_client.js +338 -4
  84. package/build/src/v1/user_event_service_proto_list.json +3 -0
  85. package/build/src/v1alpha/acl_config_service_client.js +6 -2
  86. package/build/src/v1alpha/chunk_service_client.js +12 -4
  87. package/build/src/v1alpha/completion_service_client.d.ts +1 -1
  88. package/build/src/v1alpha/completion_service_client.js +15 -5
  89. package/build/src/v1alpha/control_service_client.js +21 -7
  90. package/build/src/v1alpha/conversational_search_service_client.js +51 -17
  91. package/build/src/v1alpha/data_store_service_client.d.ts +1 -1
  92. package/build/src/v1alpha/data_store_service_client.js +27 -9
  93. package/build/src/v1alpha/document_service_client.d.ts +1 -1
  94. package/build/src/v1alpha/document_service_client.js +33 -11
  95. package/build/src/v1alpha/engine_service_client.d.ts +1 -1
  96. package/build/src/v1alpha/engine_service_client.js +30 -10
  97. package/build/src/v1alpha/estimate_billing_service_client.d.ts +1 -1
  98. package/build/src/v1alpha/estimate_billing_service_client.js +3 -1
  99. package/build/src/v1alpha/evaluation_service_client.d.ts +1 -1
  100. package/build/src/v1alpha/evaluation_service_client.js +24 -8
  101. package/build/src/v1alpha/grounded_generation_service_client.js +3 -1
  102. package/build/src/v1alpha/project_service_client.d.ts +1 -1
  103. package/build/src/v1alpha/project_service_client.js +9 -3
  104. package/build/src/v1alpha/rank_service_client.js +3 -1
  105. package/build/src/v1alpha/recommendation_service_client.js +3 -1
  106. package/build/src/v1alpha/sample_query_service_client.d.ts +1 -1
  107. package/build/src/v1alpha/sample_query_service_client.js +24 -8
  108. package/build/src/v1alpha/sample_query_set_service_client.js +21 -7
  109. package/build/src/v1alpha/schema_service_client.d.ts +1 -1
  110. package/build/src/v1alpha/schema_service_client.js +21 -7
  111. package/build/src/v1alpha/search_service_client.js +9 -3
  112. package/build/src/v1alpha/search_tuning_service_client.d.ts +1 -1
  113. package/build/src/v1alpha/search_tuning_service_client.js +6 -2
  114. package/build/src/v1alpha/serving_config_service_client.js +15 -5
  115. package/build/src/v1alpha/site_search_engine_service_client.d.ts +1 -1
  116. package/build/src/v1alpha/site_search_engine_service_client.js +54 -18
  117. package/build/src/v1alpha/user_event_service_client.d.ts +1 -1
  118. package/build/src/v1alpha/user_event_service_client.js +12 -4
  119. package/build/src/v1beta/completion_service_client.d.ts +1 -1
  120. package/build/src/v1beta/completion_service_client.js +18 -6
  121. package/build/src/v1beta/control_service_client.js +21 -7
  122. package/build/src/v1beta/conversational_search_service_client.js +51 -17
  123. package/build/src/v1beta/data_store_service_client.d.ts +1 -1
  124. package/build/src/v1beta/data_store_service_client.js +21 -7
  125. package/build/src/v1beta/document_service_client.d.ts +1 -1
  126. package/build/src/v1beta/document_service_client.js +30 -10
  127. package/build/src/v1beta/engine_service_client.d.ts +1 -1
  128. package/build/src/v1beta/engine_service_client.js +30 -10
  129. package/build/src/v1beta/evaluation_service_client.d.ts +1 -1
  130. package/build/src/v1beta/evaluation_service_client.js +24 -8
  131. package/build/src/v1beta/grounded_generation_service_client.js +9 -3
  132. package/build/src/v1beta/project_service_client.d.ts +1 -1
  133. package/build/src/v1beta/project_service_client.js +3 -1
  134. package/build/src/v1beta/rank_service_client.js +3 -1
  135. package/build/src/v1beta/recommendation_service_client.js +3 -1
  136. package/build/src/v1beta/sample_query_service_client.d.ts +1 -1
  137. package/build/src/v1beta/sample_query_service_client.js +24 -8
  138. package/build/src/v1beta/sample_query_set_service_client.js +21 -7
  139. package/build/src/v1beta/schema_service_client.d.ts +1 -1
  140. package/build/src/v1beta/schema_service_client.js +21 -7
  141. package/build/src/v1beta/search_service_client.js +18 -6
  142. package/build/src/v1beta/search_tuning_service_client.d.ts +1 -1
  143. package/build/src/v1beta/search_tuning_service_client.js +6 -2
  144. package/build/src/v1beta/serving_config_service_client.js +15 -5
  145. package/build/src/v1beta/site_search_engine_service_client.d.ts +1 -1
  146. package/build/src/v1beta/site_search_engine_service_client.js +57 -19
  147. package/build/src/v1beta/user_event_service_client.d.ts +1 -1
  148. package/build/src/v1beta/user_event_service_client.js +12 -4
  149. package/package.json +5 -5
@@ -171,10 +171,13 @@ export declare class SearchServiceClient {
171
171
  * This applies to each OneBox type individually.
172
172
  * Default number is 10.
173
173
  * @param {number[]} request.dataStoreSpecs
174
- * Specs defining dataStores to filter on in a search call and configurations
175
- * for those dataStores. This is only considered for engines with multiple
176
- * dataStores use case. For single dataStore within an engine, they should
177
- * use the specs at the top level.
174
+ * Specifications that define the specific
175
+ * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
176
+ * along with configurations for those data stores. This is only considered
177
+ * for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
178
+ * stores. For engines with a single data store, the specs directly under
179
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
180
+ * used.
178
181
  * @param {string} request.filter
179
182
  * The filter syntax consists of an expression language for constructing a
180
183
  * predicate from one or more fields of the documents being filtered. Filter
@@ -219,7 +222,7 @@ export declare class SearchServiceClient {
219
222
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
220
223
  * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
221
224
  * Information about the end user.
222
- * Highly recommended for analytics.
225
+ * Highly recommended for analytics and personalization.
223
226
  * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
224
227
  * is used to deduce `device_type` for analytics.
225
228
  * @param {string} request.languageCode
@@ -301,6 +304,9 @@ export declare class SearchServiceClient {
301
304
  * Search as you type configuration. Only supported for the
302
305
  * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
303
306
  * vertical.
307
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
308
+ * Optional. Config for display feature, like match highlighting on search
309
+ * results.
304
310
  * @param {string} request.session
305
311
  * The session resource name. Optional.
306
312
  *
@@ -332,6 +338,16 @@ export declare class SearchServiceClient {
332
338
  * Session specification.
333
339
  *
334
340
  * Can be used only when `session` is set.
341
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
342
+ * The relevance threshold of the search results.
343
+ *
344
+ * Default to Google defined threshold, leveraging a balance of
345
+ * precision and recall to deliver both highly accurate results and
346
+ * comprehensive coverage of relevant information.
347
+ *
348
+ * This feature is not supported for healthcare search.
349
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
350
+ * Optional. The specification for returning the relevance score.
335
351
  * @param {object} [options]
336
352
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
337
353
  * @returns {Promise} - The promise which resolves to an array.
@@ -405,10 +421,13 @@ export declare class SearchServiceClient {
405
421
  * This applies to each OneBox type individually.
406
422
  * Default number is 10.
407
423
  * @param {number[]} request.dataStoreSpecs
408
- * Specs defining dataStores to filter on in a search call and configurations
409
- * for those dataStores. This is only considered for engines with multiple
410
- * dataStores use case. For single dataStore within an engine, they should
411
- * use the specs at the top level.
424
+ * Specifications that define the specific
425
+ * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
426
+ * along with configurations for those data stores. This is only considered
427
+ * for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
428
+ * stores. For engines with a single data store, the specs directly under
429
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
430
+ * used.
412
431
  * @param {string} request.filter
413
432
  * The filter syntax consists of an expression language for constructing a
414
433
  * predicate from one or more fields of the documents being filtered. Filter
@@ -453,7 +472,7 @@ export declare class SearchServiceClient {
453
472
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
454
473
  * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
455
474
  * Information about the end user.
456
- * Highly recommended for analytics.
475
+ * Highly recommended for analytics and personalization.
457
476
  * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
458
477
  * is used to deduce `device_type` for analytics.
459
478
  * @param {string} request.languageCode
@@ -535,6 +554,9 @@ export declare class SearchServiceClient {
535
554
  * Search as you type configuration. Only supported for the
536
555
  * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
537
556
  * vertical.
557
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
558
+ * Optional. Config for display feature, like match highlighting on search
559
+ * results.
538
560
  * @param {string} request.session
539
561
  * The session resource name. Optional.
540
562
  *
@@ -566,6 +588,16 @@ export declare class SearchServiceClient {
566
588
  * Session specification.
567
589
  *
568
590
  * Can be used only when `session` is set.
591
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
592
+ * The relevance threshold of the search results.
593
+ *
594
+ * Default to Google defined threshold, leveraging a balance of
595
+ * precision and recall to deliver both highly accurate results and
596
+ * comprehensive coverage of relevant information.
597
+ *
598
+ * This feature is not supported for healthcare search.
599
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
600
+ * Optional. The specification for returning the relevance score.
569
601
  * @param {object} [options]
570
602
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
571
603
  * @returns {Stream}
@@ -634,10 +666,13 @@ export declare class SearchServiceClient {
634
666
  * This applies to each OneBox type individually.
635
667
  * Default number is 10.
636
668
  * @param {number[]} request.dataStoreSpecs
637
- * Specs defining dataStores to filter on in a search call and configurations
638
- * for those dataStores. This is only considered for engines with multiple
639
- * dataStores use case. For single dataStore within an engine, they should
640
- * use the specs at the top level.
669
+ * Specifications that define the specific
670
+ * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
671
+ * along with configurations for those data stores. This is only considered
672
+ * for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
673
+ * stores. For engines with a single data store, the specs directly under
674
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
675
+ * used.
641
676
  * @param {string} request.filter
642
677
  * The filter syntax consists of an expression language for constructing a
643
678
  * predicate from one or more fields of the documents being filtered. Filter
@@ -682,7 +717,7 @@ export declare class SearchServiceClient {
682
717
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
683
718
  * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
684
719
  * Information about the end user.
685
- * Highly recommended for analytics.
720
+ * Highly recommended for analytics and personalization.
686
721
  * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
687
722
  * is used to deduce `device_type` for analytics.
688
723
  * @param {string} request.languageCode
@@ -764,6 +799,9 @@ export declare class SearchServiceClient {
764
799
  * Search as you type configuration. Only supported for the
765
800
  * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
766
801
  * vertical.
802
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
803
+ * Optional. Config for display feature, like match highlighting on search
804
+ * results.
767
805
  * @param {string} request.session
768
806
  * The session resource name. Optional.
769
807
  *
@@ -795,6 +833,16 @@ export declare class SearchServiceClient {
795
833
  * Session specification.
796
834
  *
797
835
  * Can be used only when `session` is set.
836
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
837
+ * The relevance threshold of the search results.
838
+ *
839
+ * Default to Google defined threshold, leveraging a balance of
840
+ * precision and recall to deliver both highly accurate results and
841
+ * comprehensive coverage of relevant information.
842
+ *
843
+ * This feature is not supported for healthcare search.
844
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
845
+ * Optional. The specification for returning the relevance score.
798
846
  * @param {object} [options]
799
847
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
800
848
  * @returns {Object}
@@ -875,10 +923,13 @@ export declare class SearchServiceClient {
875
923
  * This applies to each OneBox type individually.
876
924
  * Default number is 10.
877
925
  * @param {number[]} request.dataStoreSpecs
878
- * Specs defining dataStores to filter on in a search call and configurations
879
- * for those dataStores. This is only considered for engines with multiple
880
- * dataStores use case. For single dataStore within an engine, they should
881
- * use the specs at the top level.
926
+ * Specifications that define the specific
927
+ * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
928
+ * along with configurations for those data stores. This is only considered
929
+ * for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
930
+ * stores. For engines with a single data store, the specs directly under
931
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
932
+ * used.
882
933
  * @param {string} request.filter
883
934
  * The filter syntax consists of an expression language for constructing a
884
935
  * predicate from one or more fields of the documents being filtered. Filter
@@ -923,7 +974,7 @@ export declare class SearchServiceClient {
923
974
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
924
975
  * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
925
976
  * Information about the end user.
926
- * Highly recommended for analytics.
977
+ * Highly recommended for analytics and personalization.
927
978
  * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
928
979
  * is used to deduce `device_type` for analytics.
929
980
  * @param {string} request.languageCode
@@ -1005,6 +1056,9 @@ export declare class SearchServiceClient {
1005
1056
  * Search as you type configuration. Only supported for the
1006
1057
  * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
1007
1058
  * vertical.
1059
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
1060
+ * Optional. Config for display feature, like match highlighting on search
1061
+ * results.
1008
1062
  * @param {string} request.session
1009
1063
  * The session resource name. Optional.
1010
1064
  *
@@ -1036,6 +1090,16 @@ export declare class SearchServiceClient {
1036
1090
  * Session specification.
1037
1091
  *
1038
1092
  * Can be used only when `session` is set.
1093
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
1094
+ * The relevance threshold of the search results.
1095
+ *
1096
+ * Default to Google defined threshold, leveraging a balance of
1097
+ * precision and recall to deliver both highly accurate results and
1098
+ * comprehensive coverage of relevant information.
1099
+ *
1100
+ * This feature is not supported for healthcare search.
1101
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
1102
+ * Optional. The specification for returning the relevance score.
1039
1103
  * @param {object} [options]
1040
1104
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1041
1105
  * @returns {Promise} - The promise which resolves to an array.
@@ -1109,10 +1173,13 @@ export declare class SearchServiceClient {
1109
1173
  * This applies to each OneBox type individually.
1110
1174
  * Default number is 10.
1111
1175
  * @param {number[]} request.dataStoreSpecs
1112
- * Specs defining dataStores to filter on in a search call and configurations
1113
- * for those dataStores. This is only considered for engines with multiple
1114
- * dataStores use case. For single dataStore within an engine, they should
1115
- * use the specs at the top level.
1176
+ * Specifications that define the specific
1177
+ * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
1178
+ * along with configurations for those data stores. This is only considered
1179
+ * for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
1180
+ * stores. For engines with a single data store, the specs directly under
1181
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
1182
+ * used.
1116
1183
  * @param {string} request.filter
1117
1184
  * The filter syntax consists of an expression language for constructing a
1118
1185
  * predicate from one or more fields of the documents being filtered. Filter
@@ -1157,7 +1224,7 @@ export declare class SearchServiceClient {
1157
1224
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
1158
1225
  * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
1159
1226
  * Information about the end user.
1160
- * Highly recommended for analytics.
1227
+ * Highly recommended for analytics and personalization.
1161
1228
  * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
1162
1229
  * is used to deduce `device_type` for analytics.
1163
1230
  * @param {string} request.languageCode
@@ -1239,6 +1306,9 @@ export declare class SearchServiceClient {
1239
1306
  * Search as you type configuration. Only supported for the
1240
1307
  * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
1241
1308
  * vertical.
1309
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
1310
+ * Optional. Config for display feature, like match highlighting on search
1311
+ * results.
1242
1312
  * @param {string} request.session
1243
1313
  * The session resource name. Optional.
1244
1314
  *
@@ -1270,6 +1340,16 @@ export declare class SearchServiceClient {
1270
1340
  * Session specification.
1271
1341
  *
1272
1342
  * Can be used only when `session` is set.
1343
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
1344
+ * The relevance threshold of the search results.
1345
+ *
1346
+ * Default to Google defined threshold, leveraging a balance of
1347
+ * precision and recall to deliver both highly accurate results and
1348
+ * comprehensive coverage of relevant information.
1349
+ *
1350
+ * This feature is not supported for healthcare search.
1351
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
1352
+ * Optional. The specification for returning the relevance score.
1273
1353
  * @param {object} [options]
1274
1354
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1275
1355
  * @returns {Stream}
@@ -1338,10 +1418,13 @@ export declare class SearchServiceClient {
1338
1418
  * This applies to each OneBox type individually.
1339
1419
  * Default number is 10.
1340
1420
  * @param {number[]} request.dataStoreSpecs
1341
- * Specs defining dataStores to filter on in a search call and configurations
1342
- * for those dataStores. This is only considered for engines with multiple
1343
- * dataStores use case. For single dataStore within an engine, they should
1344
- * use the specs at the top level.
1421
+ * Specifications that define the specific
1422
+ * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
1423
+ * along with configurations for those data stores. This is only considered
1424
+ * for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
1425
+ * stores. For engines with a single data store, the specs directly under
1426
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
1427
+ * used.
1345
1428
  * @param {string} request.filter
1346
1429
  * The filter syntax consists of an expression language for constructing a
1347
1430
  * predicate from one or more fields of the documents being filtered. Filter
@@ -1386,7 +1469,7 @@ export declare class SearchServiceClient {
1386
1469
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
1387
1470
  * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
1388
1471
  * Information about the end user.
1389
- * Highly recommended for analytics.
1472
+ * Highly recommended for analytics and personalization.
1390
1473
  * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
1391
1474
  * is used to deduce `device_type` for analytics.
1392
1475
  * @param {string} request.languageCode
@@ -1468,6 +1551,9 @@ export declare class SearchServiceClient {
1468
1551
  * Search as you type configuration. Only supported for the
1469
1552
  * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
1470
1553
  * vertical.
1554
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
1555
+ * Optional. Config for display feature, like match highlighting on search
1556
+ * results.
1471
1557
  * @param {string} request.session
1472
1558
  * The session resource name. Optional.
1473
1559
  *
@@ -1499,6 +1585,16 @@ export declare class SearchServiceClient {
1499
1585
  * Session specification.
1500
1586
  *
1501
1587
  * Can be used only when `session` is set.
1588
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
1589
+ * The relevance threshold of the search results.
1590
+ *
1591
+ * Default to Google defined threshold, leveraging a balance of
1592
+ * precision and recall to deliver both highly accurate results and
1593
+ * comprehensive coverage of relevant information.
1594
+ *
1595
+ * This feature is not supported for healthcare search.
1596
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
1597
+ * Optional. The specification for returning the relevance score.
1502
1598
  * @param {object} [options]
1503
1599
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1504
1600
  * @returns {Object}
@@ -2292,6 +2388,57 @@ export declare class SearchServiceClient {
2292
2388
  * @returns {string} A string representing the data_store.
2293
2389
  */
2294
2390
  matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
2391
+ /**
2392
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineSitemap resource name string.
2393
+ *
2394
+ * @param {string} project
2395
+ * @param {string} location
2396
+ * @param {string} collection
2397
+ * @param {string} data_store
2398
+ * @param {string} sitemap
2399
+ * @returns {string} Resource name string.
2400
+ */
2401
+ projectLocationCollectionDataStoreSiteSearchEngineSitemapPath(project: string, location: string, collection: string, dataStore: string, sitemap: string): string;
2402
+ /**
2403
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2404
+ *
2405
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2406
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2407
+ * @returns {string} A string representing the project.
2408
+ */
2409
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
2410
+ /**
2411
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2412
+ *
2413
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2414
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2415
+ * @returns {string} A string representing the location.
2416
+ */
2417
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
2418
+ /**
2419
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2420
+ *
2421
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2422
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2423
+ * @returns {string} A string representing the collection.
2424
+ */
2425
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
2426
+ /**
2427
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2428
+ *
2429
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2430
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2431
+ * @returns {string} A string representing the data_store.
2432
+ */
2433
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
2434
+ /**
2435
+ * Parse the sitemap from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2436
+ *
2437
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2438
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2439
+ * @returns {string} A string representing the sitemap.
2440
+ */
2441
+ matchSitemapFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
2295
2442
  /**
2296
2443
  * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
2297
2444
  *
@@ -3162,6 +3309,48 @@ export declare class SearchServiceClient {
3162
3309
  * @returns {string} A string representing the data_store.
3163
3310
  */
3164
3311
  matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
3312
+ /**
3313
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineSitemap resource name string.
3314
+ *
3315
+ * @param {string} project
3316
+ * @param {string} location
3317
+ * @param {string} data_store
3318
+ * @param {string} sitemap
3319
+ * @returns {string} Resource name string.
3320
+ */
3321
+ projectLocationDataStoreSiteSearchEngineSitemapPath(project: string, location: string, dataStore: string, sitemap: string): string;
3322
+ /**
3323
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
3324
+ *
3325
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
3326
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
3327
+ * @returns {string} A string representing the project.
3328
+ */
3329
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
3330
+ /**
3331
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
3332
+ *
3333
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
3334
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
3335
+ * @returns {string} A string representing the location.
3336
+ */
3337
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
3338
+ /**
3339
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
3340
+ *
3341
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
3342
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
3343
+ * @returns {string} A string representing the data_store.
3344
+ */
3345
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
3346
+ /**
3347
+ * Parse the sitemap from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
3348
+ *
3349
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
3350
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
3351
+ * @returns {string} A string representing the sitemap.
3352
+ */
3353
+ matchSitemapFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
3165
3354
  /**
3166
3355
  * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
3167
3356
  *