@google-cloud/discoveryengine 2.5.2 → 2.6.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 (75) hide show
  1. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +30 -1
  2. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +459 -134
  3. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +7 -0
  4. package/build/protos/protos.d.ts +1551 -248
  5. package/build/protos/protos.js +3506 -77
  6. package/build/protos/protos.json +338 -35
  7. package/build/src/v1/assistant_service_client.js +1 -1
  8. package/build/src/v1/cmek_config_service_client.js +1 -1
  9. package/build/src/v1/completion_service_client.js +1 -1
  10. package/build/src/v1/control_service_client.js +1 -1
  11. package/build/src/v1/conversational_search_service_client.js +1 -1
  12. package/build/src/v1/data_store_service_client.js +1 -1
  13. package/build/src/v1/document_service_client.js +1 -1
  14. package/build/src/v1/engine_service_client.js +1 -1
  15. package/build/src/v1/grounded_generation_service_client.js +1 -1
  16. package/build/src/v1/identity_mapping_store_service_client.js +1 -1
  17. package/build/src/v1/index.js +1 -1
  18. package/build/src/v1/project_service_client.js +1 -1
  19. package/build/src/v1/rank_service_client.js +1 -1
  20. package/build/src/v1/recommendation_service_client.js +1 -1
  21. package/build/src/v1/schema_service_client.js +1 -1
  22. package/build/src/v1/search_service_client.d.ts +672 -432
  23. package/build/src/v1/search_service_client.js +449 -289
  24. package/build/src/v1/search_tuning_service_client.js +1 -1
  25. package/build/src/v1/serving_config_service_client.js +1 -1
  26. package/build/src/v1/session_service_client.js +1 -1
  27. package/build/src/v1/site_search_engine_service_client.js +1 -1
  28. package/build/src/v1/user_event_service_client.js +1 -1
  29. package/build/src/v1/user_license_service_client.js +1 -1
  30. package/build/src/v1alpha/acl_config_service_client.js +1 -1
  31. package/build/src/v1alpha/chunk_service_client.js +1 -1
  32. package/build/src/v1alpha/completion_service_client.js +1 -1
  33. package/build/src/v1alpha/control_service_client.js +1 -1
  34. package/build/src/v1alpha/conversational_search_service_client.js +1 -1
  35. package/build/src/v1alpha/data_store_service_client.js +1 -1
  36. package/build/src/v1alpha/document_service_client.js +1 -1
  37. package/build/src/v1alpha/engine_service_client.js +1 -1
  38. package/build/src/v1alpha/estimate_billing_service_client.js +1 -1
  39. package/build/src/v1alpha/evaluation_service_client.js +1 -1
  40. package/build/src/v1alpha/grounded_generation_service_client.js +1 -1
  41. package/build/src/v1alpha/index.js +1 -1
  42. package/build/src/v1alpha/project_service_client.js +1 -1
  43. package/build/src/v1alpha/rank_service_client.js +1 -1
  44. package/build/src/v1alpha/recommendation_service_client.js +1 -1
  45. package/build/src/v1alpha/sample_query_service_client.js +1 -1
  46. package/build/src/v1alpha/sample_query_set_service_client.js +1 -1
  47. package/build/src/v1alpha/schema_service_client.js +1 -1
  48. package/build/src/v1alpha/search_service_client.js +1 -1
  49. package/build/src/v1alpha/search_tuning_service_client.js +1 -1
  50. package/build/src/v1alpha/serving_config_service_client.js +1 -1
  51. package/build/src/v1alpha/session_service_client.js +1 -1
  52. package/build/src/v1alpha/site_search_engine_service_client.js +1 -1
  53. package/build/src/v1alpha/user_event_service_client.js +1 -1
  54. package/build/src/v1beta/completion_service_client.js +1 -1
  55. package/build/src/v1beta/control_service_client.js +1 -1
  56. package/build/src/v1beta/conversational_search_service_client.js +1 -1
  57. package/build/src/v1beta/data_store_service_client.js +1 -1
  58. package/build/src/v1beta/document_service_client.js +1 -1
  59. package/build/src/v1beta/engine_service_client.js +1 -1
  60. package/build/src/v1beta/evaluation_service_client.js +1 -1
  61. package/build/src/v1beta/grounded_generation_service_client.js +1 -1
  62. package/build/src/v1beta/index.js +1 -1
  63. package/build/src/v1beta/project_service_client.js +1 -1
  64. package/build/src/v1beta/rank_service_client.js +1 -1
  65. package/build/src/v1beta/recommendation_service_client.js +1 -1
  66. package/build/src/v1beta/sample_query_service_client.js +1 -1
  67. package/build/src/v1beta/sample_query_set_service_client.js +1 -1
  68. package/build/src/v1beta/schema_service_client.js +1 -1
  69. package/build/src/v1beta/search_service_client.js +1 -1
  70. package/build/src/v1beta/search_tuning_service_client.js +1 -1
  71. package/build/src/v1beta/serving_config_service_client.js +1 -1
  72. package/build/src/v1beta/session_service_client.js +1 -1
  73. package/build/src/v1beta/site_search_engine_service_client.js +1 -1
  74. package/build/src/v1beta/user_event_service_client.js +1 -1
  75. package/package.json +2 -2
@@ -136,6 +136,24 @@ export declare class SearchServiceClient {
136
136
  * documents under the default branch.
137
137
  * @param {string} request.query
138
138
  * Raw search query.
139
+ * @param {string[]} [request.pageCategories]
140
+ * Optional. The categories associated with a category page. Must be set for
141
+ * category navigation queries to achieve good search quality. The format
142
+ * should be the same as
143
+ * {@link protos.google.cloud.discoveryengine.v1.PageInfo.page_category|PageInfo.page_category}.
144
+ * This field is the equivalent of the query for browse (navigation) queries.
145
+ * It's used by the browse model when the query is empty.
146
+ *
147
+ * If the field is empty, it will not be used by the browse model.
148
+ * If the field contains more than one element, only the first element will
149
+ * be used.
150
+ *
151
+ * To represent full path of a category, use '>' character to separate
152
+ * different hierarchies. If '>' is part of the category name, replace it with
153
+ * other character(s).
154
+ * For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
155
+ * 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
156
+ * > Founders Edition`
139
157
  * @param {google.cloud.discoveryengine.v1.SearchRequest.ImageQuery} request.imageQuery
140
158
  * Raw image query.
141
159
  * @param {number} request.pageSize
@@ -166,6 +184,8 @@ export declare class SearchServiceClient {
166
184
  * unset.
167
185
  *
168
186
  * If this field is negative, an `INVALID_ARGUMENT` is returned.
187
+ *
188
+ * A large offset may be capped to a reasonable threshold.
169
189
  * @param {number} request.oneBoxPageSize
170
190
  * The maximum number of results to return for OneBox.
171
191
  * This applies to each OneBox type individually.
@@ -262,11 +282,11 @@ export declare class SearchServiceClient {
262
282
  * @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
263
283
  * The spell correction specification that specifies the mode under
264
284
  * which spell correction takes effect.
265
- * @param {string} request.userPseudoId
266
- * A unique identifier for tracking visitors. For example, this could be
267
- * implemented with an HTTP cookie, which should be able to uniquely identify
268
- * a visitor on a single device. This unique identifier should not change if
269
- * the visitor logs in or out of the website.
285
+ * @param {string} [request.userPseudoId]
286
+ * Optional. A unique identifier for tracking visitors. For example, this
287
+ * could be implemented with an HTTP cookie, which should be able to uniquely
288
+ * identify a visitor on a single device. This unique identifier should not
289
+ * change if the visitor logs in or out of the website.
270
290
  *
271
291
  * This field should NOT have a fixed value such as `unknown_visitor`.
272
292
  *
@@ -279,72 +299,9 @@ export declare class SearchServiceClient {
279
299
  * characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
280
300
  * @param {google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
281
301
  * A specification for configuring the behavior of content search.
282
- * @param {boolean} request.safeSearch
283
- * Whether to turn on safe search. This is only supported for
284
- * website search.
285
- * @param {number[]} request.userLabels
286
- * The user labels applied to a resource must meet the following requirements:
287
- *
288
- * * Each resource can have multiple labels, up to a maximum of 64.
289
- * * Each label must be a key-value pair.
290
- * * Keys have a minimum length of 1 character and a maximum length of 63
291
- * characters and cannot be empty. Values can be empty and have a maximum
292
- * length of 63 characters.
293
- * * Keys and values can contain only lowercase letters, numeric characters,
294
- * underscores, and dashes. All characters must use UTF-8 encoding, and
295
- * international characters are allowed.
296
- * * The key portion of a label must be unique. However, you can use the same
297
- * key with multiple resources.
298
- * * Keys must start with a lowercase letter or international character.
299
- *
300
- * See [Google Cloud
301
- * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
302
- * for more details.
303
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
304
- * Search as you type configuration. Only supported for the
305
- * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
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.
310
- * @param {string} request.session
311
- * The session resource name. Optional.
312
- *
313
- * Session allows users to do multi-turn /search API calls or coordination
314
- * between /search API calls and /answer API calls.
315
- *
316
- * Example #1 (multi-turn /search API calls):
317
- * Call /search API with the session ID generated in the first call.
318
- * Here, the previous search query gets considered in query
319
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
320
- * and the current query is "How about 2023?", the current query will
321
- * be interpreted as "How did Alphabet do in 2023?".
322
- *
323
- * Example #2 (coordination between /search API calls and /answer API calls):
324
- * Call /answer API with the session ID generated in the first call.
325
- * Here, the answer generation happens in the context of the search
326
- * results from the first search call.
327
- *
328
- * Multi-turn Search feature is currently at private GA stage. Please use
329
- * v1alpha or v1beta version instead before we launch this feature to public
330
- * GA. Or ask for allowlisting through Google Support team.
331
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
332
- * Session specification.
333
- *
334
- * Can be used only when `session` is set.
335
- * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
336
- * The relevance threshold of the search results.
337
- *
338
- * Default to Google defined threshold, leveraging a balance of
339
- * precision and recall to deliver both highly accurate results and
340
- * comprehensive coverage of relevant information.
341
- *
342
- * This feature is not supported for healthcare search.
343
- * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
344
- * Optional. The specification for returning the relevance score.
345
- * @param {string} request.rankingExpression
346
- * The ranking expression controls the customized ranking on retrieval
347
- * documents. This overrides
302
+ * @param {string} [request.rankingExpression]
303
+ * Optional. The ranking expression controls the customized ranking on
304
+ * retrieval documents. This overrides
348
305
  * {@link protos.google.cloud.discoveryengine.v1.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
349
306
  * The syntax and supported features depend on the
350
307
  * `ranking_expression_backend` value. If `ranking_expression_backend` is not
@@ -434,7 +391,90 @@ export declare class SearchServiceClient {
434
391
  * the document.
435
392
  * * `base_rank`: the default rank of the result
436
393
  * @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
437
- * The backend to use for the ranking expression evaluation.
394
+ * Optional. The backend to use for the ranking expression evaluation.
395
+ * @param {boolean} request.safeSearch
396
+ * Whether to turn on safe search. This is only supported for
397
+ * website search.
398
+ * @param {number[]} request.userLabels
399
+ * The user labels applied to a resource must meet the following requirements:
400
+ *
401
+ * * Each resource can have multiple labels, up to a maximum of 64.
402
+ * * Each label must be a key-value pair.
403
+ * * Keys have a minimum length of 1 character and a maximum length of 63
404
+ * characters and cannot be empty. Values can be empty and have a maximum
405
+ * length of 63 characters.
406
+ * * Keys and values can contain only lowercase letters, numeric characters,
407
+ * underscores, and dashes. All characters must use UTF-8 encoding, and
408
+ * international characters are allowed.
409
+ * * The key portion of a label must be unique. However, you can use the same
410
+ * key with multiple resources.
411
+ * * Keys must start with a lowercase letter or international character.
412
+ *
413
+ * See [Google Cloud
414
+ * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
415
+ * for more details.
416
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec} [request.naturalLanguageQueryUnderstandingSpec]
417
+ * Optional. Config for natural language query understanding capabilities,
418
+ * such as extracting structured field filters from the query. Refer to [this
419
+ * documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
420
+ * for more information.
421
+ * If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
422
+ * natural language query understanding will be done.
423
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
424
+ * Search as you type configuration. Only supported for the
425
+ * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
426
+ * vertical.
427
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
428
+ * Optional. Config for display feature, like match highlighting on search
429
+ * results.
430
+ * @param {number[]} [request.crowdingSpecs]
431
+ * Optional. Crowding specifications for improving result diversity.
432
+ * If multiple CrowdingSpecs are specified, crowding will be evaluated on
433
+ * each unique combination of the `field` values, and max_count will be the
434
+ * maximum value of `max_count` across all CrowdingSpecs.
435
+ * For example, if the first CrowdingSpec has `field` = "color" and
436
+ * `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
437
+ * `max_count` = 2, then after 3 documents that share the same color AND size
438
+ * have been returned, subsequent ones should be
439
+ * removed or demoted.
440
+ * @param {string} request.session
441
+ * The session resource name. Optional.
442
+ *
443
+ * Session allows users to do multi-turn /search API calls or coordination
444
+ * between /search API calls and /answer API calls.
445
+ *
446
+ * Example #1 (multi-turn /search API calls):
447
+ * Call /search API with the session ID generated in the first call.
448
+ * Here, the previous search query gets considered in query
449
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
450
+ * and the current query is "How about 2023?", the current query will
451
+ * be interpreted as "How did Alphabet do in 2023?".
452
+ *
453
+ * Example #2 (coordination between /search API calls and /answer API calls):
454
+ * Call /answer API with the session ID generated in the first call.
455
+ * Here, the answer generation happens in the context of the search
456
+ * results from the first search call.
457
+ *
458
+ * Multi-turn Search feature is currently at private GA stage. Please use
459
+ * v1alpha or v1beta version instead before we launch this feature to public
460
+ * GA. Or ask for allowlisting through Google Support team.
461
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
462
+ * Session specification.
463
+ *
464
+ * Can be used only when `session` is set.
465
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
466
+ * The global relevance threshold of the search results.
467
+ *
468
+ * Defaults to Google defined threshold, leveraging a balance of
469
+ * precision and recall to deliver both highly accurate results and
470
+ * comprehensive coverage of relevant information.
471
+ *
472
+ * If more granular relevance filtering is required, use the
473
+ * `relevance_filter_spec` instead.
474
+ *
475
+ * This feature is not supported for healthcare search.
476
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
477
+ * Optional. The specification for returning the relevance score.
438
478
  * @param {object} [options]
439
479
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
440
480
  * @returns {Promise} - The promise which resolves to an array.
@@ -473,6 +513,24 @@ export declare class SearchServiceClient {
473
513
  * documents under the default branch.
474
514
  * @param {string} request.query
475
515
  * Raw search query.
516
+ * @param {string[]} [request.pageCategories]
517
+ * Optional. The categories associated with a category page. Must be set for
518
+ * category navigation queries to achieve good search quality. The format
519
+ * should be the same as
520
+ * {@link protos.google.cloud.discoveryengine.v1.PageInfo.page_category|PageInfo.page_category}.
521
+ * This field is the equivalent of the query for browse (navigation) queries.
522
+ * It's used by the browse model when the query is empty.
523
+ *
524
+ * If the field is empty, it will not be used by the browse model.
525
+ * If the field contains more than one element, only the first element will
526
+ * be used.
527
+ *
528
+ * To represent full path of a category, use '>' character to separate
529
+ * different hierarchies. If '>' is part of the category name, replace it with
530
+ * other character(s).
531
+ * For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
532
+ * 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
533
+ * > Founders Edition`
476
534
  * @param {google.cloud.discoveryengine.v1.SearchRequest.ImageQuery} request.imageQuery
477
535
  * Raw image query.
478
536
  * @param {number} request.pageSize
@@ -503,6 +561,8 @@ export declare class SearchServiceClient {
503
561
  * unset.
504
562
  *
505
563
  * If this field is negative, an `INVALID_ARGUMENT` is returned.
564
+ *
565
+ * A large offset may be capped to a reasonable threshold.
506
566
  * @param {number} request.oneBoxPageSize
507
567
  * The maximum number of results to return for OneBox.
508
568
  * This applies to each OneBox type individually.
@@ -599,11 +659,11 @@ export declare class SearchServiceClient {
599
659
  * @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
600
660
  * The spell correction specification that specifies the mode under
601
661
  * which spell correction takes effect.
602
- * @param {string} request.userPseudoId
603
- * A unique identifier for tracking visitors. For example, this could be
604
- * implemented with an HTTP cookie, which should be able to uniquely identify
605
- * a visitor on a single device. This unique identifier should not change if
606
- * the visitor logs in or out of the website.
662
+ * @param {string} [request.userPseudoId]
663
+ * Optional. A unique identifier for tracking visitors. For example, this
664
+ * could be implemented with an HTTP cookie, which should be able to uniquely
665
+ * identify a visitor on a single device. This unique identifier should not
666
+ * change if the visitor logs in or out of the website.
607
667
  *
608
668
  * This field should NOT have a fixed value such as `unknown_visitor`.
609
669
  *
@@ -616,72 +676,9 @@ export declare class SearchServiceClient {
616
676
  * characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
617
677
  * @param {google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
618
678
  * A specification for configuring the behavior of content search.
619
- * @param {boolean} request.safeSearch
620
- * Whether to turn on safe search. This is only supported for
621
- * website search.
622
- * @param {number[]} request.userLabels
623
- * The user labels applied to a resource must meet the following requirements:
624
- *
625
- * * Each resource can have multiple labels, up to a maximum of 64.
626
- * * Each label must be a key-value pair.
627
- * * Keys have a minimum length of 1 character and a maximum length of 63
628
- * characters and cannot be empty. Values can be empty and have a maximum
629
- * length of 63 characters.
630
- * * Keys and values can contain only lowercase letters, numeric characters,
631
- * underscores, and dashes. All characters must use UTF-8 encoding, and
632
- * international characters are allowed.
633
- * * The key portion of a label must be unique. However, you can use the same
634
- * key with multiple resources.
635
- * * Keys must start with a lowercase letter or international character.
636
- *
637
- * See [Google Cloud
638
- * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
639
- * for more details.
640
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
641
- * Search as you type configuration. Only supported for the
642
- * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
643
- * vertical.
644
- * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
645
- * Optional. Config for display feature, like match highlighting on search
646
- * results.
647
- * @param {string} request.session
648
- * The session resource name. Optional.
649
- *
650
- * Session allows users to do multi-turn /search API calls or coordination
651
- * between /search API calls and /answer API calls.
652
- *
653
- * Example #1 (multi-turn /search API calls):
654
- * Call /search API with the session ID generated in the first call.
655
- * Here, the previous search query gets considered in query
656
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
657
- * and the current query is "How about 2023?", the current query will
658
- * be interpreted as "How did Alphabet do in 2023?".
659
- *
660
- * Example #2 (coordination between /search API calls and /answer API calls):
661
- * Call /answer API with the session ID generated in the first call.
662
- * Here, the answer generation happens in the context of the search
663
- * results from the first search call.
664
- *
665
- * Multi-turn Search feature is currently at private GA stage. Please use
666
- * v1alpha or v1beta version instead before we launch this feature to public
667
- * GA. Or ask for allowlisting through Google Support team.
668
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
669
- * Session specification.
670
- *
671
- * Can be used only when `session` is set.
672
- * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
673
- * The relevance threshold of the search results.
674
- *
675
- * Default to Google defined threshold, leveraging a balance of
676
- * precision and recall to deliver both highly accurate results and
677
- * comprehensive coverage of relevant information.
678
- *
679
- * This feature is not supported for healthcare search.
680
- * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
681
- * Optional. The specification for returning the relevance score.
682
- * @param {string} request.rankingExpression
683
- * The ranking expression controls the customized ranking on retrieval
684
- * documents. This overrides
679
+ * @param {string} [request.rankingExpression]
680
+ * Optional. The ranking expression controls the customized ranking on
681
+ * retrieval documents. This overrides
685
682
  * {@link protos.google.cloud.discoveryengine.v1.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
686
683
  * The syntax and supported features depend on the
687
684
  * `ranking_expression_backend` value. If `ranking_expression_backend` is not
@@ -771,7 +768,90 @@ export declare class SearchServiceClient {
771
768
  * the document.
772
769
  * * `base_rank`: the default rank of the result
773
770
  * @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
774
- * The backend to use for the ranking expression evaluation.
771
+ * Optional. The backend to use for the ranking expression evaluation.
772
+ * @param {boolean} request.safeSearch
773
+ * Whether to turn on safe search. This is only supported for
774
+ * website search.
775
+ * @param {number[]} request.userLabels
776
+ * The user labels applied to a resource must meet the following requirements:
777
+ *
778
+ * * Each resource can have multiple labels, up to a maximum of 64.
779
+ * * Each label must be a key-value pair.
780
+ * * Keys have a minimum length of 1 character and a maximum length of 63
781
+ * characters and cannot be empty. Values can be empty and have a maximum
782
+ * length of 63 characters.
783
+ * * Keys and values can contain only lowercase letters, numeric characters,
784
+ * underscores, and dashes. All characters must use UTF-8 encoding, and
785
+ * international characters are allowed.
786
+ * * The key portion of a label must be unique. However, you can use the same
787
+ * key with multiple resources.
788
+ * * Keys must start with a lowercase letter or international character.
789
+ *
790
+ * See [Google Cloud
791
+ * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
792
+ * for more details.
793
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec} [request.naturalLanguageQueryUnderstandingSpec]
794
+ * Optional. Config for natural language query understanding capabilities,
795
+ * such as extracting structured field filters from the query. Refer to [this
796
+ * documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
797
+ * for more information.
798
+ * If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
799
+ * natural language query understanding will be done.
800
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
801
+ * Search as you type configuration. Only supported for the
802
+ * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
803
+ * vertical.
804
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
805
+ * Optional. Config for display feature, like match highlighting on search
806
+ * results.
807
+ * @param {number[]} [request.crowdingSpecs]
808
+ * Optional. Crowding specifications for improving result diversity.
809
+ * If multiple CrowdingSpecs are specified, crowding will be evaluated on
810
+ * each unique combination of the `field` values, and max_count will be the
811
+ * maximum value of `max_count` across all CrowdingSpecs.
812
+ * For example, if the first CrowdingSpec has `field` = "color" and
813
+ * `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
814
+ * `max_count` = 2, then after 3 documents that share the same color AND size
815
+ * have been returned, subsequent ones should be
816
+ * removed or demoted.
817
+ * @param {string} request.session
818
+ * The session resource name. Optional.
819
+ *
820
+ * Session allows users to do multi-turn /search API calls or coordination
821
+ * between /search API calls and /answer API calls.
822
+ *
823
+ * Example #1 (multi-turn /search API calls):
824
+ * Call /search API with the session ID generated in the first call.
825
+ * Here, the previous search query gets considered in query
826
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
827
+ * and the current query is "How about 2023?", the current query will
828
+ * be interpreted as "How did Alphabet do in 2023?".
829
+ *
830
+ * Example #2 (coordination between /search API calls and /answer API calls):
831
+ * Call /answer API with the session ID generated in the first call.
832
+ * Here, the answer generation happens in the context of the search
833
+ * results from the first search call.
834
+ *
835
+ * Multi-turn Search feature is currently at private GA stage. Please use
836
+ * v1alpha or v1beta version instead before we launch this feature to public
837
+ * GA. Or ask for allowlisting through Google Support team.
838
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
839
+ * Session specification.
840
+ *
841
+ * Can be used only when `session` is set.
842
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
843
+ * The global relevance threshold of the search results.
844
+ *
845
+ * Defaults to Google defined threshold, leveraging a balance of
846
+ * precision and recall to deliver both highly accurate results and
847
+ * comprehensive coverage of relevant information.
848
+ *
849
+ * If more granular relevance filtering is required, use the
850
+ * `relevance_filter_spec` instead.
851
+ *
852
+ * This feature is not supported for healthcare search.
853
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
854
+ * Optional. The specification for returning the relevance score.
775
855
  * @param {object} [options]
776
856
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
777
857
  * @returns {Stream}
@@ -805,6 +885,24 @@ export declare class SearchServiceClient {
805
885
  * documents under the default branch.
806
886
  * @param {string} request.query
807
887
  * Raw search query.
888
+ * @param {string[]} [request.pageCategories]
889
+ * Optional. The categories associated with a category page. Must be set for
890
+ * category navigation queries to achieve good search quality. The format
891
+ * should be the same as
892
+ * {@link protos.google.cloud.discoveryengine.v1.PageInfo.page_category|PageInfo.page_category}.
893
+ * This field is the equivalent of the query for browse (navigation) queries.
894
+ * It's used by the browse model when the query is empty.
895
+ *
896
+ * If the field is empty, it will not be used by the browse model.
897
+ * If the field contains more than one element, only the first element will
898
+ * be used.
899
+ *
900
+ * To represent full path of a category, use '>' character to separate
901
+ * different hierarchies. If '>' is part of the category name, replace it with
902
+ * other character(s).
903
+ * For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
904
+ * 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
905
+ * > Founders Edition`
808
906
  * @param {google.cloud.discoveryengine.v1.SearchRequest.ImageQuery} request.imageQuery
809
907
  * Raw image query.
810
908
  * @param {number} request.pageSize
@@ -835,6 +933,8 @@ export declare class SearchServiceClient {
835
933
  * unset.
836
934
  *
837
935
  * If this field is negative, an `INVALID_ARGUMENT` is returned.
936
+ *
937
+ * A large offset may be capped to a reasonable threshold.
838
938
  * @param {number} request.oneBoxPageSize
839
939
  * The maximum number of results to return for OneBox.
840
940
  * This applies to each OneBox type individually.
@@ -931,11 +1031,11 @@ export declare class SearchServiceClient {
931
1031
  * @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
932
1032
  * The spell correction specification that specifies the mode under
933
1033
  * which spell correction takes effect.
934
- * @param {string} request.userPseudoId
935
- * A unique identifier for tracking visitors. For example, this could be
936
- * implemented with an HTTP cookie, which should be able to uniquely identify
937
- * a visitor on a single device. This unique identifier should not change if
938
- * the visitor logs in or out of the website.
1034
+ * @param {string} [request.userPseudoId]
1035
+ * Optional. A unique identifier for tracking visitors. For example, this
1036
+ * could be implemented with an HTTP cookie, which should be able to uniquely
1037
+ * identify a visitor on a single device. This unique identifier should not
1038
+ * change if the visitor logs in or out of the website.
939
1039
  *
940
1040
  * This field should NOT have a fixed value such as `unknown_visitor`.
941
1041
  *
@@ -948,72 +1048,9 @@ export declare class SearchServiceClient {
948
1048
  * characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
949
1049
  * @param {google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
950
1050
  * A specification for configuring the behavior of content search.
951
- * @param {boolean} request.safeSearch
952
- * Whether to turn on safe search. This is only supported for
953
- * website search.
954
- * @param {number[]} request.userLabels
955
- * The user labels applied to a resource must meet the following requirements:
956
- *
957
- * * Each resource can have multiple labels, up to a maximum of 64.
958
- * * Each label must be a key-value pair.
959
- * * Keys have a minimum length of 1 character and a maximum length of 63
960
- * characters and cannot be empty. Values can be empty and have a maximum
961
- * length of 63 characters.
962
- * * Keys and values can contain only lowercase letters, numeric characters,
963
- * underscores, and dashes. All characters must use UTF-8 encoding, and
964
- * international characters are allowed.
965
- * * The key portion of a label must be unique. However, you can use the same
966
- * key with multiple resources.
967
- * * Keys must start with a lowercase letter or international character.
968
- *
969
- * See [Google Cloud
970
- * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
971
- * for more details.
972
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
973
- * Search as you type configuration. Only supported for the
974
- * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
975
- * vertical.
976
- * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
977
- * Optional. Config for display feature, like match highlighting on search
978
- * results.
979
- * @param {string} request.session
980
- * The session resource name. Optional.
981
- *
982
- * Session allows users to do multi-turn /search API calls or coordination
983
- * between /search API calls and /answer API calls.
984
- *
985
- * Example #1 (multi-turn /search API calls):
986
- * Call /search API with the session ID generated in the first call.
987
- * Here, the previous search query gets considered in query
988
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
989
- * and the current query is "How about 2023?", the current query will
990
- * be interpreted as "How did Alphabet do in 2023?".
991
- *
992
- * Example #2 (coordination between /search API calls and /answer API calls):
993
- * Call /answer API with the session ID generated in the first call.
994
- * Here, the answer generation happens in the context of the search
995
- * results from the first search call.
996
- *
997
- * Multi-turn Search feature is currently at private GA stage. Please use
998
- * v1alpha or v1beta version instead before we launch this feature to public
999
- * GA. Or ask for allowlisting through Google Support team.
1000
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
1001
- * Session specification.
1002
- *
1003
- * Can be used only when `session` is set.
1004
- * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
1005
- * The relevance threshold of the search results.
1006
- *
1007
- * Default to Google defined threshold, leveraging a balance of
1008
- * precision and recall to deliver both highly accurate results and
1009
- * comprehensive coverage of relevant information.
1010
- *
1011
- * This feature is not supported for healthcare search.
1012
- * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
1013
- * Optional. The specification for returning the relevance score.
1014
- * @param {string} request.rankingExpression
1015
- * The ranking expression controls the customized ranking on retrieval
1016
- * documents. This overrides
1051
+ * @param {string} [request.rankingExpression]
1052
+ * Optional. The ranking expression controls the customized ranking on
1053
+ * retrieval documents. This overrides
1017
1054
  * {@link protos.google.cloud.discoveryengine.v1.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
1018
1055
  * The syntax and supported features depend on the
1019
1056
  * `ranking_expression_backend` value. If `ranking_expression_backend` is not
@@ -1103,7 +1140,90 @@ export declare class SearchServiceClient {
1103
1140
  * the document.
1104
1141
  * * `base_rank`: the default rank of the result
1105
1142
  * @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
1106
- * The backend to use for the ranking expression evaluation.
1143
+ * Optional. The backend to use for the ranking expression evaluation.
1144
+ * @param {boolean} request.safeSearch
1145
+ * Whether to turn on safe search. This is only supported for
1146
+ * website search.
1147
+ * @param {number[]} request.userLabels
1148
+ * The user labels applied to a resource must meet the following requirements:
1149
+ *
1150
+ * * Each resource can have multiple labels, up to a maximum of 64.
1151
+ * * Each label must be a key-value pair.
1152
+ * * Keys have a minimum length of 1 character and a maximum length of 63
1153
+ * characters and cannot be empty. Values can be empty and have a maximum
1154
+ * length of 63 characters.
1155
+ * * Keys and values can contain only lowercase letters, numeric characters,
1156
+ * underscores, and dashes. All characters must use UTF-8 encoding, and
1157
+ * international characters are allowed.
1158
+ * * The key portion of a label must be unique. However, you can use the same
1159
+ * key with multiple resources.
1160
+ * * Keys must start with a lowercase letter or international character.
1161
+ *
1162
+ * See [Google Cloud
1163
+ * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
1164
+ * for more details.
1165
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec} [request.naturalLanguageQueryUnderstandingSpec]
1166
+ * Optional. Config for natural language query understanding capabilities,
1167
+ * such as extracting structured field filters from the query. Refer to [this
1168
+ * documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
1169
+ * for more information.
1170
+ * If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
1171
+ * natural language query understanding will be done.
1172
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
1173
+ * Search as you type configuration. Only supported for the
1174
+ * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
1175
+ * vertical.
1176
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
1177
+ * Optional. Config for display feature, like match highlighting on search
1178
+ * results.
1179
+ * @param {number[]} [request.crowdingSpecs]
1180
+ * Optional. Crowding specifications for improving result diversity.
1181
+ * If multiple CrowdingSpecs are specified, crowding will be evaluated on
1182
+ * each unique combination of the `field` values, and max_count will be the
1183
+ * maximum value of `max_count` across all CrowdingSpecs.
1184
+ * For example, if the first CrowdingSpec has `field` = "color" and
1185
+ * `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
1186
+ * `max_count` = 2, then after 3 documents that share the same color AND size
1187
+ * have been returned, subsequent ones should be
1188
+ * removed or demoted.
1189
+ * @param {string} request.session
1190
+ * The session resource name. Optional.
1191
+ *
1192
+ * Session allows users to do multi-turn /search API calls or coordination
1193
+ * between /search API calls and /answer API calls.
1194
+ *
1195
+ * Example #1 (multi-turn /search API calls):
1196
+ * Call /search API with the session ID generated in the first call.
1197
+ * Here, the previous search query gets considered in query
1198
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
1199
+ * and the current query is "How about 2023?", the current query will
1200
+ * be interpreted as "How did Alphabet do in 2023?".
1201
+ *
1202
+ * Example #2 (coordination between /search API calls and /answer API calls):
1203
+ * Call /answer API with the session ID generated in the first call.
1204
+ * Here, the answer generation happens in the context of the search
1205
+ * results from the first search call.
1206
+ *
1207
+ * Multi-turn Search feature is currently at private GA stage. Please use
1208
+ * v1alpha or v1beta version instead before we launch this feature to public
1209
+ * GA. Or ask for allowlisting through Google Support team.
1210
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
1211
+ * Session specification.
1212
+ *
1213
+ * Can be used only when `session` is set.
1214
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
1215
+ * The global relevance threshold of the search results.
1216
+ *
1217
+ * Defaults to Google defined threshold, leveraging a balance of
1218
+ * precision and recall to deliver both highly accurate results and
1219
+ * comprehensive coverage of relevant information.
1220
+ *
1221
+ * If more granular relevance filtering is required, use the
1222
+ * `relevance_filter_spec` instead.
1223
+ *
1224
+ * This feature is not supported for healthcare search.
1225
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
1226
+ * Optional. The specification for returning the relevance score.
1107
1227
  * @param {object} [options]
1108
1228
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1109
1229
  * @returns {Object}
@@ -1149,6 +1269,24 @@ export declare class SearchServiceClient {
1149
1269
  * documents under the default branch.
1150
1270
  * @param {string} request.query
1151
1271
  * Raw search query.
1272
+ * @param {string[]} [request.pageCategories]
1273
+ * Optional. The categories associated with a category page. Must be set for
1274
+ * category navigation queries to achieve good search quality. The format
1275
+ * should be the same as
1276
+ * {@link protos.google.cloud.discoveryengine.v1.PageInfo.page_category|PageInfo.page_category}.
1277
+ * This field is the equivalent of the query for browse (navigation) queries.
1278
+ * It's used by the browse model when the query is empty.
1279
+ *
1280
+ * If the field is empty, it will not be used by the browse model.
1281
+ * If the field contains more than one element, only the first element will
1282
+ * be used.
1283
+ *
1284
+ * To represent full path of a category, use '>' character to separate
1285
+ * different hierarchies. If '>' is part of the category name, replace it with
1286
+ * other character(s).
1287
+ * For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
1288
+ * 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
1289
+ * > Founders Edition`
1152
1290
  * @param {google.cloud.discoveryengine.v1.SearchRequest.ImageQuery} request.imageQuery
1153
1291
  * Raw image query.
1154
1292
  * @param {number} request.pageSize
@@ -1179,6 +1317,8 @@ export declare class SearchServiceClient {
1179
1317
  * unset.
1180
1318
  *
1181
1319
  * If this field is negative, an `INVALID_ARGUMENT` is returned.
1320
+ *
1321
+ * A large offset may be capped to a reasonable threshold.
1182
1322
  * @param {number} request.oneBoxPageSize
1183
1323
  * The maximum number of results to return for OneBox.
1184
1324
  * This applies to each OneBox type individually.
@@ -1275,11 +1415,11 @@ export declare class SearchServiceClient {
1275
1415
  * @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
1276
1416
  * The spell correction specification that specifies the mode under
1277
1417
  * which spell correction takes effect.
1278
- * @param {string} request.userPseudoId
1279
- * A unique identifier for tracking visitors. For example, this could be
1280
- * implemented with an HTTP cookie, which should be able to uniquely identify
1281
- * a visitor on a single device. This unique identifier should not change if
1282
- * the visitor logs in or out of the website.
1418
+ * @param {string} [request.userPseudoId]
1419
+ * Optional. A unique identifier for tracking visitors. For example, this
1420
+ * could be implemented with an HTTP cookie, which should be able to uniquely
1421
+ * identify a visitor on a single device. This unique identifier should not
1422
+ * change if the visitor logs in or out of the website.
1283
1423
  *
1284
1424
  * This field should NOT have a fixed value such as `unknown_visitor`.
1285
1425
  *
@@ -1292,72 +1432,9 @@ export declare class SearchServiceClient {
1292
1432
  * characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
1293
1433
  * @param {google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
1294
1434
  * A specification for configuring the behavior of content search.
1295
- * @param {boolean} request.safeSearch
1296
- * Whether to turn on safe search. This is only supported for
1297
- * website search.
1298
- * @param {number[]} request.userLabels
1299
- * The user labels applied to a resource must meet the following requirements:
1300
- *
1301
- * * Each resource can have multiple labels, up to a maximum of 64.
1302
- * * Each label must be a key-value pair.
1303
- * * Keys have a minimum length of 1 character and a maximum length of 63
1304
- * characters and cannot be empty. Values can be empty and have a maximum
1305
- * length of 63 characters.
1306
- * * Keys and values can contain only lowercase letters, numeric characters,
1307
- * underscores, and dashes. All characters must use UTF-8 encoding, and
1308
- * international characters are allowed.
1309
- * * The key portion of a label must be unique. However, you can use the same
1310
- * key with multiple resources.
1311
- * * Keys must start with a lowercase letter or international character.
1312
- *
1313
- * See [Google Cloud
1314
- * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
1315
- * for more details.
1316
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
1317
- * Search as you type configuration. Only supported for the
1318
- * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
1319
- * vertical.
1320
- * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
1321
- * Optional. Config for display feature, like match highlighting on search
1322
- * results.
1323
- * @param {string} request.session
1324
- * The session resource name. Optional.
1325
- *
1326
- * Session allows users to do multi-turn /search API calls or coordination
1327
- * between /search API calls and /answer API calls.
1328
- *
1329
- * Example #1 (multi-turn /search API calls):
1330
- * Call /search API with the session ID generated in the first call.
1331
- * Here, the previous search query gets considered in query
1332
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
1333
- * and the current query is "How about 2023?", the current query will
1334
- * be interpreted as "How did Alphabet do in 2023?".
1335
- *
1336
- * Example #2 (coordination between /search API calls and /answer API calls):
1337
- * Call /answer API with the session ID generated in the first call.
1338
- * Here, the answer generation happens in the context of the search
1339
- * results from the first search call.
1340
- *
1341
- * Multi-turn Search feature is currently at private GA stage. Please use
1342
- * v1alpha or v1beta version instead before we launch this feature to public
1343
- * GA. Or ask for allowlisting through Google Support team.
1344
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
1345
- * Session specification.
1346
- *
1347
- * Can be used only when `session` is set.
1348
- * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
1349
- * The relevance threshold of the search results.
1350
- *
1351
- * Default to Google defined threshold, leveraging a balance of
1352
- * precision and recall to deliver both highly accurate results and
1353
- * comprehensive coverage of relevant information.
1354
- *
1355
- * This feature is not supported for healthcare search.
1356
- * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
1357
- * Optional. The specification for returning the relevance score.
1358
- * @param {string} request.rankingExpression
1359
- * The ranking expression controls the customized ranking on retrieval
1360
- * documents. This overrides
1435
+ * @param {string} [request.rankingExpression]
1436
+ * Optional. The ranking expression controls the customized ranking on
1437
+ * retrieval documents. This overrides
1361
1438
  * {@link protos.google.cloud.discoveryengine.v1.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
1362
1439
  * The syntax and supported features depend on the
1363
1440
  * `ranking_expression_backend` value. If `ranking_expression_backend` is not
@@ -1447,7 +1524,90 @@ export declare class SearchServiceClient {
1447
1524
  * the document.
1448
1525
  * * `base_rank`: the default rank of the result
1449
1526
  * @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
1450
- * The backend to use for the ranking expression evaluation.
1527
+ * Optional. The backend to use for the ranking expression evaluation.
1528
+ * @param {boolean} request.safeSearch
1529
+ * Whether to turn on safe search. This is only supported for
1530
+ * website search.
1531
+ * @param {number[]} request.userLabels
1532
+ * The user labels applied to a resource must meet the following requirements:
1533
+ *
1534
+ * * Each resource can have multiple labels, up to a maximum of 64.
1535
+ * * Each label must be a key-value pair.
1536
+ * * Keys have a minimum length of 1 character and a maximum length of 63
1537
+ * characters and cannot be empty. Values can be empty and have a maximum
1538
+ * length of 63 characters.
1539
+ * * Keys and values can contain only lowercase letters, numeric characters,
1540
+ * underscores, and dashes. All characters must use UTF-8 encoding, and
1541
+ * international characters are allowed.
1542
+ * * The key portion of a label must be unique. However, you can use the same
1543
+ * key with multiple resources.
1544
+ * * Keys must start with a lowercase letter or international character.
1545
+ *
1546
+ * See [Google Cloud
1547
+ * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
1548
+ * for more details.
1549
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec} [request.naturalLanguageQueryUnderstandingSpec]
1550
+ * Optional. Config for natural language query understanding capabilities,
1551
+ * such as extracting structured field filters from the query. Refer to [this
1552
+ * documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
1553
+ * for more information.
1554
+ * If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
1555
+ * natural language query understanding will be done.
1556
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
1557
+ * Search as you type configuration. Only supported for the
1558
+ * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
1559
+ * vertical.
1560
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
1561
+ * Optional. Config for display feature, like match highlighting on search
1562
+ * results.
1563
+ * @param {number[]} [request.crowdingSpecs]
1564
+ * Optional. Crowding specifications for improving result diversity.
1565
+ * If multiple CrowdingSpecs are specified, crowding will be evaluated on
1566
+ * each unique combination of the `field` values, and max_count will be the
1567
+ * maximum value of `max_count` across all CrowdingSpecs.
1568
+ * For example, if the first CrowdingSpec has `field` = "color" and
1569
+ * `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
1570
+ * `max_count` = 2, then after 3 documents that share the same color AND size
1571
+ * have been returned, subsequent ones should be
1572
+ * removed or demoted.
1573
+ * @param {string} request.session
1574
+ * The session resource name. Optional.
1575
+ *
1576
+ * Session allows users to do multi-turn /search API calls or coordination
1577
+ * between /search API calls and /answer API calls.
1578
+ *
1579
+ * Example #1 (multi-turn /search API calls):
1580
+ * Call /search API with the session ID generated in the first call.
1581
+ * Here, the previous search query gets considered in query
1582
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
1583
+ * and the current query is "How about 2023?", the current query will
1584
+ * be interpreted as "How did Alphabet do in 2023?".
1585
+ *
1586
+ * Example #2 (coordination between /search API calls and /answer API calls):
1587
+ * Call /answer API with the session ID generated in the first call.
1588
+ * Here, the answer generation happens in the context of the search
1589
+ * results from the first search call.
1590
+ *
1591
+ * Multi-turn Search feature is currently at private GA stage. Please use
1592
+ * v1alpha or v1beta version instead before we launch this feature to public
1593
+ * GA. Or ask for allowlisting through Google Support team.
1594
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
1595
+ * Session specification.
1596
+ *
1597
+ * Can be used only when `session` is set.
1598
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
1599
+ * The global relevance threshold of the search results.
1600
+ *
1601
+ * Defaults to Google defined threshold, leveraging a balance of
1602
+ * precision and recall to deliver both highly accurate results and
1603
+ * comprehensive coverage of relevant information.
1604
+ *
1605
+ * If more granular relevance filtering is required, use the
1606
+ * `relevance_filter_spec` instead.
1607
+ *
1608
+ * This feature is not supported for healthcare search.
1609
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
1610
+ * Optional. The specification for returning the relevance score.
1451
1611
  * @param {object} [options]
1452
1612
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1453
1613
  * @returns {Promise} - The promise which resolves to an array.
@@ -1486,6 +1646,24 @@ export declare class SearchServiceClient {
1486
1646
  * documents under the default branch.
1487
1647
  * @param {string} request.query
1488
1648
  * Raw search query.
1649
+ * @param {string[]} [request.pageCategories]
1650
+ * Optional. The categories associated with a category page. Must be set for
1651
+ * category navigation queries to achieve good search quality. The format
1652
+ * should be the same as
1653
+ * {@link protos.google.cloud.discoveryengine.v1.PageInfo.page_category|PageInfo.page_category}.
1654
+ * This field is the equivalent of the query for browse (navigation) queries.
1655
+ * It's used by the browse model when the query is empty.
1656
+ *
1657
+ * If the field is empty, it will not be used by the browse model.
1658
+ * If the field contains more than one element, only the first element will
1659
+ * be used.
1660
+ *
1661
+ * To represent full path of a category, use '>' character to separate
1662
+ * different hierarchies. If '>' is part of the category name, replace it with
1663
+ * other character(s).
1664
+ * For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
1665
+ * 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
1666
+ * > Founders Edition`
1489
1667
  * @param {google.cloud.discoveryengine.v1.SearchRequest.ImageQuery} request.imageQuery
1490
1668
  * Raw image query.
1491
1669
  * @param {number} request.pageSize
@@ -1516,6 +1694,8 @@ export declare class SearchServiceClient {
1516
1694
  * unset.
1517
1695
  *
1518
1696
  * If this field is negative, an `INVALID_ARGUMENT` is returned.
1697
+ *
1698
+ * A large offset may be capped to a reasonable threshold.
1519
1699
  * @param {number} request.oneBoxPageSize
1520
1700
  * The maximum number of results to return for OneBox.
1521
1701
  * This applies to each OneBox type individually.
@@ -1612,11 +1792,11 @@ export declare class SearchServiceClient {
1612
1792
  * @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
1613
1793
  * The spell correction specification that specifies the mode under
1614
1794
  * which spell correction takes effect.
1615
- * @param {string} request.userPseudoId
1616
- * A unique identifier for tracking visitors. For example, this could be
1617
- * implemented with an HTTP cookie, which should be able to uniquely identify
1618
- * a visitor on a single device. This unique identifier should not change if
1619
- * the visitor logs in or out of the website.
1795
+ * @param {string} [request.userPseudoId]
1796
+ * Optional. A unique identifier for tracking visitors. For example, this
1797
+ * could be implemented with an HTTP cookie, which should be able to uniquely
1798
+ * identify a visitor on a single device. This unique identifier should not
1799
+ * change if the visitor logs in or out of the website.
1620
1800
  *
1621
1801
  * This field should NOT have a fixed value such as `unknown_visitor`.
1622
1802
  *
@@ -1629,72 +1809,9 @@ export declare class SearchServiceClient {
1629
1809
  * characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
1630
1810
  * @param {google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
1631
1811
  * A specification for configuring the behavior of content search.
1632
- * @param {boolean} request.safeSearch
1633
- * Whether to turn on safe search. This is only supported for
1634
- * website search.
1635
- * @param {number[]} request.userLabels
1636
- * The user labels applied to a resource must meet the following requirements:
1637
- *
1638
- * * Each resource can have multiple labels, up to a maximum of 64.
1639
- * * Each label must be a key-value pair.
1640
- * * Keys have a minimum length of 1 character and a maximum length of 63
1641
- * characters and cannot be empty. Values can be empty and have a maximum
1642
- * length of 63 characters.
1643
- * * Keys and values can contain only lowercase letters, numeric characters,
1644
- * underscores, and dashes. All characters must use UTF-8 encoding, and
1645
- * international characters are allowed.
1646
- * * The key portion of a label must be unique. However, you can use the same
1647
- * key with multiple resources.
1648
- * * Keys must start with a lowercase letter or international character.
1649
- *
1650
- * See [Google Cloud
1651
- * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
1652
- * for more details.
1653
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
1654
- * Search as you type configuration. Only supported for the
1655
- * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
1656
- * vertical.
1657
- * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
1658
- * Optional. Config for display feature, like match highlighting on search
1659
- * results.
1660
- * @param {string} request.session
1661
- * The session resource name. Optional.
1662
- *
1663
- * Session allows users to do multi-turn /search API calls or coordination
1664
- * between /search API calls and /answer API calls.
1665
- *
1666
- * Example #1 (multi-turn /search API calls):
1667
- * Call /search API with the session ID generated in the first call.
1668
- * Here, the previous search query gets considered in query
1669
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
1670
- * and the current query is "How about 2023?", the current query will
1671
- * be interpreted as "How did Alphabet do in 2023?".
1672
- *
1673
- * Example #2 (coordination between /search API calls and /answer API calls):
1674
- * Call /answer API with the session ID generated in the first call.
1675
- * Here, the answer generation happens in the context of the search
1676
- * results from the first search call.
1677
- *
1678
- * Multi-turn Search feature is currently at private GA stage. Please use
1679
- * v1alpha or v1beta version instead before we launch this feature to public
1680
- * GA. Or ask for allowlisting through Google Support team.
1681
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
1682
- * Session specification.
1683
- *
1684
- * Can be used only when `session` is set.
1685
- * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
1686
- * The relevance threshold of the search results.
1687
- *
1688
- * Default to Google defined threshold, leveraging a balance of
1689
- * precision and recall to deliver both highly accurate results and
1690
- * comprehensive coverage of relevant information.
1691
- *
1692
- * This feature is not supported for healthcare search.
1693
- * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
1694
- * Optional. The specification for returning the relevance score.
1695
- * @param {string} request.rankingExpression
1696
- * The ranking expression controls the customized ranking on retrieval
1697
- * documents. This overrides
1812
+ * @param {string} [request.rankingExpression]
1813
+ * Optional. The ranking expression controls the customized ranking on
1814
+ * retrieval documents. This overrides
1698
1815
  * {@link protos.google.cloud.discoveryengine.v1.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
1699
1816
  * The syntax and supported features depend on the
1700
1817
  * `ranking_expression_backend` value. If `ranking_expression_backend` is not
@@ -1784,7 +1901,90 @@ export declare class SearchServiceClient {
1784
1901
  * the document.
1785
1902
  * * `base_rank`: the default rank of the result
1786
1903
  * @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
1787
- * The backend to use for the ranking expression evaluation.
1904
+ * Optional. The backend to use for the ranking expression evaluation.
1905
+ * @param {boolean} request.safeSearch
1906
+ * Whether to turn on safe search. This is only supported for
1907
+ * website search.
1908
+ * @param {number[]} request.userLabels
1909
+ * The user labels applied to a resource must meet the following requirements:
1910
+ *
1911
+ * * Each resource can have multiple labels, up to a maximum of 64.
1912
+ * * Each label must be a key-value pair.
1913
+ * * Keys have a minimum length of 1 character and a maximum length of 63
1914
+ * characters and cannot be empty. Values can be empty and have a maximum
1915
+ * length of 63 characters.
1916
+ * * Keys and values can contain only lowercase letters, numeric characters,
1917
+ * underscores, and dashes. All characters must use UTF-8 encoding, and
1918
+ * international characters are allowed.
1919
+ * * The key portion of a label must be unique. However, you can use the same
1920
+ * key with multiple resources.
1921
+ * * Keys must start with a lowercase letter or international character.
1922
+ *
1923
+ * See [Google Cloud
1924
+ * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
1925
+ * for more details.
1926
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec} [request.naturalLanguageQueryUnderstandingSpec]
1927
+ * Optional. Config for natural language query understanding capabilities,
1928
+ * such as extracting structured field filters from the query. Refer to [this
1929
+ * documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
1930
+ * for more information.
1931
+ * If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
1932
+ * natural language query understanding will be done.
1933
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
1934
+ * Search as you type configuration. Only supported for the
1935
+ * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
1936
+ * vertical.
1937
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
1938
+ * Optional. Config for display feature, like match highlighting on search
1939
+ * results.
1940
+ * @param {number[]} [request.crowdingSpecs]
1941
+ * Optional. Crowding specifications for improving result diversity.
1942
+ * If multiple CrowdingSpecs are specified, crowding will be evaluated on
1943
+ * each unique combination of the `field` values, and max_count will be the
1944
+ * maximum value of `max_count` across all CrowdingSpecs.
1945
+ * For example, if the first CrowdingSpec has `field` = "color" and
1946
+ * `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
1947
+ * `max_count` = 2, then after 3 documents that share the same color AND size
1948
+ * have been returned, subsequent ones should be
1949
+ * removed or demoted.
1950
+ * @param {string} request.session
1951
+ * The session resource name. Optional.
1952
+ *
1953
+ * Session allows users to do multi-turn /search API calls or coordination
1954
+ * between /search API calls and /answer API calls.
1955
+ *
1956
+ * Example #1 (multi-turn /search API calls):
1957
+ * Call /search API with the session ID generated in the first call.
1958
+ * Here, the previous search query gets considered in query
1959
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
1960
+ * and the current query is "How about 2023?", the current query will
1961
+ * be interpreted as "How did Alphabet do in 2023?".
1962
+ *
1963
+ * Example #2 (coordination between /search API calls and /answer API calls):
1964
+ * Call /answer API with the session ID generated in the first call.
1965
+ * Here, the answer generation happens in the context of the search
1966
+ * results from the first search call.
1967
+ *
1968
+ * Multi-turn Search feature is currently at private GA stage. Please use
1969
+ * v1alpha or v1beta version instead before we launch this feature to public
1970
+ * GA. Or ask for allowlisting through Google Support team.
1971
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
1972
+ * Session specification.
1973
+ *
1974
+ * Can be used only when `session` is set.
1975
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
1976
+ * The global relevance threshold of the search results.
1977
+ *
1978
+ * Defaults to Google defined threshold, leveraging a balance of
1979
+ * precision and recall to deliver both highly accurate results and
1980
+ * comprehensive coverage of relevant information.
1981
+ *
1982
+ * If more granular relevance filtering is required, use the
1983
+ * `relevance_filter_spec` instead.
1984
+ *
1985
+ * This feature is not supported for healthcare search.
1986
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
1987
+ * Optional. The specification for returning the relevance score.
1788
1988
  * @param {object} [options]
1789
1989
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1790
1990
  * @returns {Stream}
@@ -1818,6 +2018,24 @@ export declare class SearchServiceClient {
1818
2018
  * documents under the default branch.
1819
2019
  * @param {string} request.query
1820
2020
  * Raw search query.
2021
+ * @param {string[]} [request.pageCategories]
2022
+ * Optional. The categories associated with a category page. Must be set for
2023
+ * category navigation queries to achieve good search quality. The format
2024
+ * should be the same as
2025
+ * {@link protos.google.cloud.discoveryengine.v1.PageInfo.page_category|PageInfo.page_category}.
2026
+ * This field is the equivalent of the query for browse (navigation) queries.
2027
+ * It's used by the browse model when the query is empty.
2028
+ *
2029
+ * If the field is empty, it will not be used by the browse model.
2030
+ * If the field contains more than one element, only the first element will
2031
+ * be used.
2032
+ *
2033
+ * To represent full path of a category, use '>' character to separate
2034
+ * different hierarchies. If '>' is part of the category name, replace it with
2035
+ * other character(s).
2036
+ * For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
2037
+ * 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
2038
+ * > Founders Edition`
1821
2039
  * @param {google.cloud.discoveryengine.v1.SearchRequest.ImageQuery} request.imageQuery
1822
2040
  * Raw image query.
1823
2041
  * @param {number} request.pageSize
@@ -1848,6 +2066,8 @@ export declare class SearchServiceClient {
1848
2066
  * unset.
1849
2067
  *
1850
2068
  * If this field is negative, an `INVALID_ARGUMENT` is returned.
2069
+ *
2070
+ * A large offset may be capped to a reasonable threshold.
1851
2071
  * @param {number} request.oneBoxPageSize
1852
2072
  * The maximum number of results to return for OneBox.
1853
2073
  * This applies to each OneBox type individually.
@@ -1944,11 +2164,11 @@ export declare class SearchServiceClient {
1944
2164
  * @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
1945
2165
  * The spell correction specification that specifies the mode under
1946
2166
  * which spell correction takes effect.
1947
- * @param {string} request.userPseudoId
1948
- * A unique identifier for tracking visitors. For example, this could be
1949
- * implemented with an HTTP cookie, which should be able to uniquely identify
1950
- * a visitor on a single device. This unique identifier should not change if
1951
- * the visitor logs in or out of the website.
2167
+ * @param {string} [request.userPseudoId]
2168
+ * Optional. A unique identifier for tracking visitors. For example, this
2169
+ * could be implemented with an HTTP cookie, which should be able to uniquely
2170
+ * identify a visitor on a single device. This unique identifier should not
2171
+ * change if the visitor logs in or out of the website.
1952
2172
  *
1953
2173
  * This field should NOT have a fixed value such as `unknown_visitor`.
1954
2174
  *
@@ -1961,72 +2181,9 @@ export declare class SearchServiceClient {
1961
2181
  * characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
1962
2182
  * @param {google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
1963
2183
  * A specification for configuring the behavior of content search.
1964
- * @param {boolean} request.safeSearch
1965
- * Whether to turn on safe search. This is only supported for
1966
- * website search.
1967
- * @param {number[]} request.userLabels
1968
- * The user labels applied to a resource must meet the following requirements:
1969
- *
1970
- * * Each resource can have multiple labels, up to a maximum of 64.
1971
- * * Each label must be a key-value pair.
1972
- * * Keys have a minimum length of 1 character and a maximum length of 63
1973
- * characters and cannot be empty. Values can be empty and have a maximum
1974
- * length of 63 characters.
1975
- * * Keys and values can contain only lowercase letters, numeric characters,
1976
- * underscores, and dashes. All characters must use UTF-8 encoding, and
1977
- * international characters are allowed.
1978
- * * The key portion of a label must be unique. However, you can use the same
1979
- * key with multiple resources.
1980
- * * Keys must start with a lowercase letter or international character.
1981
- *
1982
- * See [Google Cloud
1983
- * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
1984
- * for more details.
1985
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
1986
- * Search as you type configuration. Only supported for the
1987
- * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
1988
- * vertical.
1989
- * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
1990
- * Optional. Config for display feature, like match highlighting on search
1991
- * results.
1992
- * @param {string} request.session
1993
- * The session resource name. Optional.
1994
- *
1995
- * Session allows users to do multi-turn /search API calls or coordination
1996
- * between /search API calls and /answer API calls.
1997
- *
1998
- * Example #1 (multi-turn /search API calls):
1999
- * Call /search API with the session ID generated in the first call.
2000
- * Here, the previous search query gets considered in query
2001
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
2002
- * and the current query is "How about 2023?", the current query will
2003
- * be interpreted as "How did Alphabet do in 2023?".
2004
- *
2005
- * Example #2 (coordination between /search API calls and /answer API calls):
2006
- * Call /answer API with the session ID generated in the first call.
2007
- * Here, the answer generation happens in the context of the search
2008
- * results from the first search call.
2009
- *
2010
- * Multi-turn Search feature is currently at private GA stage. Please use
2011
- * v1alpha or v1beta version instead before we launch this feature to public
2012
- * GA. Or ask for allowlisting through Google Support team.
2013
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
2014
- * Session specification.
2015
- *
2016
- * Can be used only when `session` is set.
2017
- * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
2018
- * The relevance threshold of the search results.
2019
- *
2020
- * Default to Google defined threshold, leveraging a balance of
2021
- * precision and recall to deliver both highly accurate results and
2022
- * comprehensive coverage of relevant information.
2023
- *
2024
- * This feature is not supported for healthcare search.
2025
- * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
2026
- * Optional. The specification for returning the relevance score.
2027
- * @param {string} request.rankingExpression
2028
- * The ranking expression controls the customized ranking on retrieval
2029
- * documents. This overrides
2184
+ * @param {string} [request.rankingExpression]
2185
+ * Optional. The ranking expression controls the customized ranking on
2186
+ * retrieval documents. This overrides
2030
2187
  * {@link protos.google.cloud.discoveryengine.v1.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
2031
2188
  * The syntax and supported features depend on the
2032
2189
  * `ranking_expression_backend` value. If `ranking_expression_backend` is not
@@ -2116,7 +2273,90 @@ export declare class SearchServiceClient {
2116
2273
  * the document.
2117
2274
  * * `base_rank`: the default rank of the result
2118
2275
  * @param {google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
2119
- * The backend to use for the ranking expression evaluation.
2276
+ * Optional. The backend to use for the ranking expression evaluation.
2277
+ * @param {boolean} request.safeSearch
2278
+ * Whether to turn on safe search. This is only supported for
2279
+ * website search.
2280
+ * @param {number[]} request.userLabels
2281
+ * The user labels applied to a resource must meet the following requirements:
2282
+ *
2283
+ * * Each resource can have multiple labels, up to a maximum of 64.
2284
+ * * Each label must be a key-value pair.
2285
+ * * Keys have a minimum length of 1 character and a maximum length of 63
2286
+ * characters and cannot be empty. Values can be empty and have a maximum
2287
+ * length of 63 characters.
2288
+ * * Keys and values can contain only lowercase letters, numeric characters,
2289
+ * underscores, and dashes. All characters must use UTF-8 encoding, and
2290
+ * international characters are allowed.
2291
+ * * The key portion of a label must be unique. However, you can use the same
2292
+ * key with multiple resources.
2293
+ * * Keys must start with a lowercase letter or international character.
2294
+ *
2295
+ * See [Google Cloud
2296
+ * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
2297
+ * for more details.
2298
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec} [request.naturalLanguageQueryUnderstandingSpec]
2299
+ * Optional. Config for natural language query understanding capabilities,
2300
+ * such as extracting structured field filters from the query. Refer to [this
2301
+ * documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
2302
+ * for more information.
2303
+ * If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
2304
+ * natural language query understanding will be done.
2305
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
2306
+ * Search as you type configuration. Only supported for the
2307
+ * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
2308
+ * vertical.
2309
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
2310
+ * Optional. Config for display feature, like match highlighting on search
2311
+ * results.
2312
+ * @param {number[]} [request.crowdingSpecs]
2313
+ * Optional. Crowding specifications for improving result diversity.
2314
+ * If multiple CrowdingSpecs are specified, crowding will be evaluated on
2315
+ * each unique combination of the `field` values, and max_count will be the
2316
+ * maximum value of `max_count` across all CrowdingSpecs.
2317
+ * For example, if the first CrowdingSpec has `field` = "color" and
2318
+ * `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
2319
+ * `max_count` = 2, then after 3 documents that share the same color AND size
2320
+ * have been returned, subsequent ones should be
2321
+ * removed or demoted.
2322
+ * @param {string} request.session
2323
+ * The session resource name. Optional.
2324
+ *
2325
+ * Session allows users to do multi-turn /search API calls or coordination
2326
+ * between /search API calls and /answer API calls.
2327
+ *
2328
+ * Example #1 (multi-turn /search API calls):
2329
+ * Call /search API with the session ID generated in the first call.
2330
+ * Here, the previous search query gets considered in query
2331
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
2332
+ * and the current query is "How about 2023?", the current query will
2333
+ * be interpreted as "How did Alphabet do in 2023?".
2334
+ *
2335
+ * Example #2 (coordination between /search API calls and /answer API calls):
2336
+ * Call /answer API with the session ID generated in the first call.
2337
+ * Here, the answer generation happens in the context of the search
2338
+ * results from the first search call.
2339
+ *
2340
+ * Multi-turn Search feature is currently at private GA stage. Please use
2341
+ * v1alpha or v1beta version instead before we launch this feature to public
2342
+ * GA. Or ask for allowlisting through Google Support team.
2343
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
2344
+ * Session specification.
2345
+ *
2346
+ * Can be used only when `session` is set.
2347
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
2348
+ * The global relevance threshold of the search results.
2349
+ *
2350
+ * Defaults to Google defined threshold, leveraging a balance of
2351
+ * precision and recall to deliver both highly accurate results and
2352
+ * comprehensive coverage of relevant information.
2353
+ *
2354
+ * If more granular relevance filtering is required, use the
2355
+ * `relevance_filter_spec` instead.
2356
+ *
2357
+ * This feature is not supported for healthcare search.
2358
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
2359
+ * Optional. The specification for returning the relevance score.
2120
2360
  * @param {object} [options]
2121
2361
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
2122
2362
  * @returns {Object}