google-cloud-discovery_engine-v1 2.6.2 → 2.7.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.
- checksums.yaml +4 -4
- data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +222 -142
- data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +222 -142
- data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/data_store_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1/search_service_pb.rb +17 -2
- data/proto_docs/google/cloud/discoveryengine/v1/data_store.rb +30 -0
- data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +463 -113
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 97faf1bad8d9c6d8a56e6b864a128d7f87c67669a282bac4431fa34eb05a4631
|
|
4
|
+
data.tar.gz: 9d35e9c168149e02ebbaf54138329112d4d6c9aa209cd6fe863097c6c55de171
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5a6a06e5992aacdc516e0328e7483cee8702ea62ce508491d1a30826fe446c4c44ae60787786af33324941f2531e1c2d856bb11ceabb9e9fa4ee7e439f5f1c23
|
|
7
|
+
data.tar.gz: a0491fc9063ce9c289a3de27f6739a9f6af93e2b8805bf80b711acaeb6109daab632ef9febee23c11a80a30bb4c60a7f82bca1e5ba56fbbfbb8ec48f635dc8f7
|
|
@@ -217,7 +217,7 @@ module Google
|
|
|
217
217
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
218
218
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
219
219
|
#
|
|
220
|
-
# @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil,
|
|
220
|
+
# @overload search(serving_config: nil, branch: nil, query: nil, page_categories: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, ranking_expression: nil, ranking_expression_backend: nil, safe_search: nil, user_labels: nil, natural_language_query_understanding_spec: nil, search_as_you_type_spec: nil, display_spec: nil, crowding_specs: nil, session: nil, session_spec: nil, relevance_threshold: nil, relevance_score_spec: nil)
|
|
221
221
|
# Pass arguments to `search` via keyword arguments. Note that at
|
|
222
222
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
223
223
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -237,6 +237,24 @@ module Google
|
|
|
237
237
|
# documents under the default branch.
|
|
238
238
|
# @param query [::String]
|
|
239
239
|
# Raw search query.
|
|
240
|
+
# @param page_categories [::Array<::String>]
|
|
241
|
+
# Optional. The categories associated with a category page. Must be set for
|
|
242
|
+
# category navigation queries to achieve good search quality. The format
|
|
243
|
+
# should be the same as
|
|
244
|
+
# {::Google::Cloud::DiscoveryEngine::V1::PageInfo#page_category PageInfo.page_category}.
|
|
245
|
+
# This field is the equivalent of the query for browse (navigation) queries.
|
|
246
|
+
# It's used by the browse model when the query is empty.
|
|
247
|
+
#
|
|
248
|
+
# If the field is empty, it will not be used by the browse model.
|
|
249
|
+
# If the field contains more than one element, only the first element will
|
|
250
|
+
# be used.
|
|
251
|
+
#
|
|
252
|
+
# To represent full path of a category, use '>' character to separate
|
|
253
|
+
# different hierarchies. If '>' is part of the category name, replace it with
|
|
254
|
+
# other character(s).
|
|
255
|
+
# For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
|
|
256
|
+
# 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
|
|
257
|
+
# > Founders Edition`
|
|
240
258
|
# @param image_query [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ImageQuery, ::Hash]
|
|
241
259
|
# Raw image query.
|
|
242
260
|
# @param page_size [::Integer]
|
|
@@ -267,6 +285,8 @@ module Google
|
|
|
267
285
|
# unset.
|
|
268
286
|
#
|
|
269
287
|
# If this field is negative, an `INVALID_ARGUMENT` is returned.
|
|
288
|
+
#
|
|
289
|
+
# A large offset may be capped to a reasonable threshold.
|
|
270
290
|
# @param one_box_page_size [::Integer]
|
|
271
291
|
# The maximum number of results to return for OneBox.
|
|
272
292
|
# This applies to each OneBox type individually.
|
|
@@ -364,10 +384,10 @@ module Google
|
|
|
364
384
|
# The spell correction specification that specifies the mode under
|
|
365
385
|
# which spell correction takes effect.
|
|
366
386
|
# @param user_pseudo_id [::String]
|
|
367
|
-
# A unique identifier for tracking visitors. For example, this
|
|
368
|
-
# implemented with an HTTP cookie, which should be able to uniquely
|
|
369
|
-
# a visitor on a single device. This unique identifier should not
|
|
370
|
-
# the visitor logs in or out of the website.
|
|
387
|
+
# Optional. A unique identifier for tracking visitors. For example, this
|
|
388
|
+
# could be implemented with an HTTP cookie, which should be able to uniquely
|
|
389
|
+
# identify a visitor on a single device. This unique identifier should not
|
|
390
|
+
# change if the visitor logs in or out of the website.
|
|
371
391
|
#
|
|
372
392
|
# This field should NOT have a fixed value such as `unknown_visitor`.
|
|
373
393
|
#
|
|
@@ -380,72 +400,9 @@ module Google
|
|
|
380
400
|
# characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
381
401
|
# @param content_search_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec, ::Hash]
|
|
382
402
|
# A specification for configuring the behavior of content search.
|
|
383
|
-
# @param safe_search [::Boolean]
|
|
384
|
-
# Whether to turn on safe search. This is only supported for
|
|
385
|
-
# website search.
|
|
386
|
-
# @param user_labels [::Hash{::String => ::String}]
|
|
387
|
-
# The user labels applied to a resource must meet the following requirements:
|
|
388
|
-
#
|
|
389
|
-
# * Each resource can have multiple labels, up to a maximum of 64.
|
|
390
|
-
# * Each label must be a key-value pair.
|
|
391
|
-
# * Keys have a minimum length of 1 character and a maximum length of 63
|
|
392
|
-
# characters and cannot be empty. Values can be empty and have a maximum
|
|
393
|
-
# length of 63 characters.
|
|
394
|
-
# * Keys and values can contain only lowercase letters, numeric characters,
|
|
395
|
-
# underscores, and dashes. All characters must use UTF-8 encoding, and
|
|
396
|
-
# international characters are allowed.
|
|
397
|
-
# * The key portion of a label must be unique. However, you can use the same
|
|
398
|
-
# key with multiple resources.
|
|
399
|
-
# * Keys must start with a lowercase letter or international character.
|
|
400
|
-
#
|
|
401
|
-
# See [Google Cloud
|
|
402
|
-
# Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
|
403
|
-
# for more details.
|
|
404
|
-
# @param search_as_you_type_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAsYouTypeSpec, ::Hash]
|
|
405
|
-
# Search as you type configuration. Only supported for the
|
|
406
|
-
# {::Google::Cloud::DiscoveryEngine::V1::IndustryVertical::MEDIA IndustryVertical.MEDIA}
|
|
407
|
-
# vertical.
|
|
408
|
-
# @param display_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DisplaySpec, ::Hash]
|
|
409
|
-
# Optional. Config for display feature, like match highlighting on search
|
|
410
|
-
# results.
|
|
411
|
-
# @param session [::String]
|
|
412
|
-
# The session resource name. Optional.
|
|
413
|
-
#
|
|
414
|
-
# Session allows users to do multi-turn /search API calls or coordination
|
|
415
|
-
# between /search API calls and /answer API calls.
|
|
416
|
-
#
|
|
417
|
-
# Example #1 (multi-turn /search API calls):
|
|
418
|
-
# Call /search API with the session ID generated in the first call.
|
|
419
|
-
# Here, the previous search query gets considered in query
|
|
420
|
-
# standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
|
421
|
-
# and the current query is "How about 2023?", the current query will
|
|
422
|
-
# be interpreted as "How did Alphabet do in 2023?".
|
|
423
|
-
#
|
|
424
|
-
# Example #2 (coordination between /search API calls and /answer API calls):
|
|
425
|
-
# Call /answer API with the session ID generated in the first call.
|
|
426
|
-
# Here, the answer generation happens in the context of the search
|
|
427
|
-
# results from the first search call.
|
|
428
|
-
#
|
|
429
|
-
# Multi-turn Search feature is currently at private GA stage. Please use
|
|
430
|
-
# v1alpha or v1beta version instead before we launch this feature to public
|
|
431
|
-
# GA. Or ask for allowlisting through Google Support team.
|
|
432
|
-
# @param session_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SessionSpec, ::Hash]
|
|
433
|
-
# Session specification.
|
|
434
|
-
#
|
|
435
|
-
# Can be used only when `session` is set.
|
|
436
|
-
# @param relevance_threshold [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceThreshold]
|
|
437
|
-
# The relevance threshold of the search results.
|
|
438
|
-
#
|
|
439
|
-
# Default to Google defined threshold, leveraging a balance of
|
|
440
|
-
# precision and recall to deliver both highly accurate results and
|
|
441
|
-
# comprehensive coverage of relevant information.
|
|
442
|
-
#
|
|
443
|
-
# This feature is not supported for healthcare search.
|
|
444
|
-
# @param relevance_score_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceScoreSpec, ::Hash]
|
|
445
|
-
# Optional. The specification for returning the relevance score.
|
|
446
403
|
# @param ranking_expression [::String]
|
|
447
|
-
# The ranking expression controls the customized ranking on
|
|
448
|
-
# documents. This overrides
|
|
404
|
+
# Optional. The ranking expression controls the customized ranking on
|
|
405
|
+
# retrieval documents. This overrides
|
|
449
406
|
# {::Google::Cloud::DiscoveryEngine::V1::ServingConfig#ranking_expression ServingConfig.ranking_expression}.
|
|
450
407
|
# The syntax and supported features depend on the
|
|
451
408
|
# `ranking_expression_backend` value. If `ranking_expression_backend` is not
|
|
@@ -535,7 +492,90 @@ module Google
|
|
|
535
492
|
# the document.
|
|
536
493
|
# * `base_rank`: the default rank of the result
|
|
537
494
|
# @param ranking_expression_backend [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RankingExpressionBackend]
|
|
538
|
-
# The backend to use for the ranking expression evaluation.
|
|
495
|
+
# Optional. The backend to use for the ranking expression evaluation.
|
|
496
|
+
# @param safe_search [::Boolean]
|
|
497
|
+
# Whether to turn on safe search. This is only supported for
|
|
498
|
+
# website search.
|
|
499
|
+
# @param user_labels [::Hash{::String => ::String}]
|
|
500
|
+
# The user labels applied to a resource must meet the following requirements:
|
|
501
|
+
#
|
|
502
|
+
# * Each resource can have multiple labels, up to a maximum of 64.
|
|
503
|
+
# * Each label must be a key-value pair.
|
|
504
|
+
# * Keys have a minimum length of 1 character and a maximum length of 63
|
|
505
|
+
# characters and cannot be empty. Values can be empty and have a maximum
|
|
506
|
+
# length of 63 characters.
|
|
507
|
+
# * Keys and values can contain only lowercase letters, numeric characters,
|
|
508
|
+
# underscores, and dashes. All characters must use UTF-8 encoding, and
|
|
509
|
+
# international characters are allowed.
|
|
510
|
+
# * The key portion of a label must be unique. However, you can use the same
|
|
511
|
+
# key with multiple resources.
|
|
512
|
+
# * Keys must start with a lowercase letter or international character.
|
|
513
|
+
#
|
|
514
|
+
# See [Google Cloud
|
|
515
|
+
# Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
|
516
|
+
# for more details.
|
|
517
|
+
# @param natural_language_query_understanding_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::NaturalLanguageQueryUnderstandingSpec, ::Hash]
|
|
518
|
+
# Optional. Config for natural language query understanding capabilities,
|
|
519
|
+
# such as extracting structured field filters from the query. Refer to [this
|
|
520
|
+
# documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
|
|
521
|
+
# for more information.
|
|
522
|
+
# If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
|
|
523
|
+
# natural language query understanding will be done.
|
|
524
|
+
# @param search_as_you_type_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAsYouTypeSpec, ::Hash]
|
|
525
|
+
# Search as you type configuration. Only supported for the
|
|
526
|
+
# {::Google::Cloud::DiscoveryEngine::V1::IndustryVertical::MEDIA IndustryVertical.MEDIA}
|
|
527
|
+
# vertical.
|
|
528
|
+
# @param display_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DisplaySpec, ::Hash]
|
|
529
|
+
# Optional. Config for display feature, like match highlighting on search
|
|
530
|
+
# results.
|
|
531
|
+
# @param crowding_specs [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::CrowdingSpec, ::Hash>]
|
|
532
|
+
# Optional. Crowding specifications for improving result diversity.
|
|
533
|
+
# If multiple CrowdingSpecs are specified, crowding will be evaluated on
|
|
534
|
+
# each unique combination of the `field` values, and max_count will be the
|
|
535
|
+
# maximum value of `max_count` across all CrowdingSpecs.
|
|
536
|
+
# For example, if the first CrowdingSpec has `field` = "color" and
|
|
537
|
+
# `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
|
|
538
|
+
# `max_count` = 2, then after 3 documents that share the same color AND size
|
|
539
|
+
# have been returned, subsequent ones should be
|
|
540
|
+
# removed or demoted.
|
|
541
|
+
# @param session [::String]
|
|
542
|
+
# The session resource name. Optional.
|
|
543
|
+
#
|
|
544
|
+
# Session allows users to do multi-turn /search API calls or coordination
|
|
545
|
+
# between /search API calls and /answer API calls.
|
|
546
|
+
#
|
|
547
|
+
# Example #1 (multi-turn /search API calls):
|
|
548
|
+
# Call /search API with the session ID generated in the first call.
|
|
549
|
+
# Here, the previous search query gets considered in query
|
|
550
|
+
# standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
|
551
|
+
# and the current query is "How about 2023?", the current query will
|
|
552
|
+
# be interpreted as "How did Alphabet do in 2023?".
|
|
553
|
+
#
|
|
554
|
+
# Example #2 (coordination between /search API calls and /answer API calls):
|
|
555
|
+
# Call /answer API with the session ID generated in the first call.
|
|
556
|
+
# Here, the answer generation happens in the context of the search
|
|
557
|
+
# results from the first search call.
|
|
558
|
+
#
|
|
559
|
+
# Multi-turn Search feature is currently at private GA stage. Please use
|
|
560
|
+
# v1alpha or v1beta version instead before we launch this feature to public
|
|
561
|
+
# GA. Or ask for allowlisting through Google Support team.
|
|
562
|
+
# @param session_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SessionSpec, ::Hash]
|
|
563
|
+
# Session specification.
|
|
564
|
+
#
|
|
565
|
+
# Can be used only when `session` is set.
|
|
566
|
+
# @param relevance_threshold [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceThreshold]
|
|
567
|
+
# The global relevance threshold of the search results.
|
|
568
|
+
#
|
|
569
|
+
# Defaults to Google defined threshold, leveraging a balance of
|
|
570
|
+
# precision and recall to deliver both highly accurate results and
|
|
571
|
+
# comprehensive coverage of relevant information.
|
|
572
|
+
#
|
|
573
|
+
# If more granular relevance filtering is required, use the
|
|
574
|
+
# `relevance_filter_spec` instead.
|
|
575
|
+
#
|
|
576
|
+
# This feature is not supported for healthcare search.
|
|
577
|
+
# @param relevance_score_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceScoreSpec, ::Hash]
|
|
578
|
+
# Optional. The specification for returning the relevance score.
|
|
539
579
|
#
|
|
540
580
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
541
581
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>]
|
|
@@ -632,7 +672,7 @@ module Google
|
|
|
632
672
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
633
673
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
634
674
|
#
|
|
635
|
-
# @overload search_lite(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil,
|
|
675
|
+
# @overload search_lite(serving_config: nil, branch: nil, query: nil, page_categories: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, ranking_expression: nil, ranking_expression_backend: nil, safe_search: nil, user_labels: nil, natural_language_query_understanding_spec: nil, search_as_you_type_spec: nil, display_spec: nil, crowding_specs: nil, session: nil, session_spec: nil, relevance_threshold: nil, relevance_score_spec: nil)
|
|
636
676
|
# Pass arguments to `search_lite` via keyword arguments. Note that at
|
|
637
677
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
638
678
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -652,6 +692,24 @@ module Google
|
|
|
652
692
|
# documents under the default branch.
|
|
653
693
|
# @param query [::String]
|
|
654
694
|
# Raw search query.
|
|
695
|
+
# @param page_categories [::Array<::String>]
|
|
696
|
+
# Optional. The categories associated with a category page. Must be set for
|
|
697
|
+
# category navigation queries to achieve good search quality. The format
|
|
698
|
+
# should be the same as
|
|
699
|
+
# {::Google::Cloud::DiscoveryEngine::V1::PageInfo#page_category PageInfo.page_category}.
|
|
700
|
+
# This field is the equivalent of the query for browse (navigation) queries.
|
|
701
|
+
# It's used by the browse model when the query is empty.
|
|
702
|
+
#
|
|
703
|
+
# If the field is empty, it will not be used by the browse model.
|
|
704
|
+
# If the field contains more than one element, only the first element will
|
|
705
|
+
# be used.
|
|
706
|
+
#
|
|
707
|
+
# To represent full path of a category, use '>' character to separate
|
|
708
|
+
# different hierarchies. If '>' is part of the category name, replace it with
|
|
709
|
+
# other character(s).
|
|
710
|
+
# For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
|
|
711
|
+
# 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
|
|
712
|
+
# > Founders Edition`
|
|
655
713
|
# @param image_query [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ImageQuery, ::Hash]
|
|
656
714
|
# Raw image query.
|
|
657
715
|
# @param page_size [::Integer]
|
|
@@ -682,6 +740,8 @@ module Google
|
|
|
682
740
|
# unset.
|
|
683
741
|
#
|
|
684
742
|
# If this field is negative, an `INVALID_ARGUMENT` is returned.
|
|
743
|
+
#
|
|
744
|
+
# A large offset may be capped to a reasonable threshold.
|
|
685
745
|
# @param one_box_page_size [::Integer]
|
|
686
746
|
# The maximum number of results to return for OneBox.
|
|
687
747
|
# This applies to each OneBox type individually.
|
|
@@ -779,10 +839,10 @@ module Google
|
|
|
779
839
|
# The spell correction specification that specifies the mode under
|
|
780
840
|
# which spell correction takes effect.
|
|
781
841
|
# @param user_pseudo_id [::String]
|
|
782
|
-
# A unique identifier for tracking visitors. For example, this
|
|
783
|
-
# implemented with an HTTP cookie, which should be able to uniquely
|
|
784
|
-
# a visitor on a single device. This unique identifier should not
|
|
785
|
-
# the visitor logs in or out of the website.
|
|
842
|
+
# Optional. A unique identifier for tracking visitors. For example, this
|
|
843
|
+
# could be implemented with an HTTP cookie, which should be able to uniquely
|
|
844
|
+
# identify a visitor on a single device. This unique identifier should not
|
|
845
|
+
# change if the visitor logs in or out of the website.
|
|
786
846
|
#
|
|
787
847
|
# This field should NOT have a fixed value such as `unknown_visitor`.
|
|
788
848
|
#
|
|
@@ -795,72 +855,9 @@ module Google
|
|
|
795
855
|
# characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
796
856
|
# @param content_search_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec, ::Hash]
|
|
797
857
|
# A specification for configuring the behavior of content search.
|
|
798
|
-
# @param safe_search [::Boolean]
|
|
799
|
-
# Whether to turn on safe search. This is only supported for
|
|
800
|
-
# website search.
|
|
801
|
-
# @param user_labels [::Hash{::String => ::String}]
|
|
802
|
-
# The user labels applied to a resource must meet the following requirements:
|
|
803
|
-
#
|
|
804
|
-
# * Each resource can have multiple labels, up to a maximum of 64.
|
|
805
|
-
# * Each label must be a key-value pair.
|
|
806
|
-
# * Keys have a minimum length of 1 character and a maximum length of 63
|
|
807
|
-
# characters and cannot be empty. Values can be empty and have a maximum
|
|
808
|
-
# length of 63 characters.
|
|
809
|
-
# * Keys and values can contain only lowercase letters, numeric characters,
|
|
810
|
-
# underscores, and dashes. All characters must use UTF-8 encoding, and
|
|
811
|
-
# international characters are allowed.
|
|
812
|
-
# * The key portion of a label must be unique. However, you can use the same
|
|
813
|
-
# key with multiple resources.
|
|
814
|
-
# * Keys must start with a lowercase letter or international character.
|
|
815
|
-
#
|
|
816
|
-
# See [Google Cloud
|
|
817
|
-
# Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
|
818
|
-
# for more details.
|
|
819
|
-
# @param search_as_you_type_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAsYouTypeSpec, ::Hash]
|
|
820
|
-
# Search as you type configuration. Only supported for the
|
|
821
|
-
# {::Google::Cloud::DiscoveryEngine::V1::IndustryVertical::MEDIA IndustryVertical.MEDIA}
|
|
822
|
-
# vertical.
|
|
823
|
-
# @param display_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DisplaySpec, ::Hash]
|
|
824
|
-
# Optional. Config for display feature, like match highlighting on search
|
|
825
|
-
# results.
|
|
826
|
-
# @param session [::String]
|
|
827
|
-
# The session resource name. Optional.
|
|
828
|
-
#
|
|
829
|
-
# Session allows users to do multi-turn /search API calls or coordination
|
|
830
|
-
# between /search API calls and /answer API calls.
|
|
831
|
-
#
|
|
832
|
-
# Example #1 (multi-turn /search API calls):
|
|
833
|
-
# Call /search API with the session ID generated in the first call.
|
|
834
|
-
# Here, the previous search query gets considered in query
|
|
835
|
-
# standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
|
836
|
-
# and the current query is "How about 2023?", the current query will
|
|
837
|
-
# be interpreted as "How did Alphabet do in 2023?".
|
|
838
|
-
#
|
|
839
|
-
# Example #2 (coordination between /search API calls and /answer API calls):
|
|
840
|
-
# Call /answer API with the session ID generated in the first call.
|
|
841
|
-
# Here, the answer generation happens in the context of the search
|
|
842
|
-
# results from the first search call.
|
|
843
|
-
#
|
|
844
|
-
# Multi-turn Search feature is currently at private GA stage. Please use
|
|
845
|
-
# v1alpha or v1beta version instead before we launch this feature to public
|
|
846
|
-
# GA. Or ask for allowlisting through Google Support team.
|
|
847
|
-
# @param session_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SessionSpec, ::Hash]
|
|
848
|
-
# Session specification.
|
|
849
|
-
#
|
|
850
|
-
# Can be used only when `session` is set.
|
|
851
|
-
# @param relevance_threshold [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceThreshold]
|
|
852
|
-
# The relevance threshold of the search results.
|
|
853
|
-
#
|
|
854
|
-
# Default to Google defined threshold, leveraging a balance of
|
|
855
|
-
# precision and recall to deliver both highly accurate results and
|
|
856
|
-
# comprehensive coverage of relevant information.
|
|
857
|
-
#
|
|
858
|
-
# This feature is not supported for healthcare search.
|
|
859
|
-
# @param relevance_score_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceScoreSpec, ::Hash]
|
|
860
|
-
# Optional. The specification for returning the relevance score.
|
|
861
858
|
# @param ranking_expression [::String]
|
|
862
|
-
# The ranking expression controls the customized ranking on
|
|
863
|
-
# documents. This overrides
|
|
859
|
+
# Optional. The ranking expression controls the customized ranking on
|
|
860
|
+
# retrieval documents. This overrides
|
|
864
861
|
# {::Google::Cloud::DiscoveryEngine::V1::ServingConfig#ranking_expression ServingConfig.ranking_expression}.
|
|
865
862
|
# The syntax and supported features depend on the
|
|
866
863
|
# `ranking_expression_backend` value. If `ranking_expression_backend` is not
|
|
@@ -950,7 +947,90 @@ module Google
|
|
|
950
947
|
# the document.
|
|
951
948
|
# * `base_rank`: the default rank of the result
|
|
952
949
|
# @param ranking_expression_backend [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RankingExpressionBackend]
|
|
953
|
-
# The backend to use for the ranking expression evaluation.
|
|
950
|
+
# Optional. The backend to use for the ranking expression evaluation.
|
|
951
|
+
# @param safe_search [::Boolean]
|
|
952
|
+
# Whether to turn on safe search. This is only supported for
|
|
953
|
+
# website search.
|
|
954
|
+
# @param user_labels [::Hash{::String => ::String}]
|
|
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 natural_language_query_understanding_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::NaturalLanguageQueryUnderstandingSpec, ::Hash]
|
|
973
|
+
# Optional. Config for natural language query understanding capabilities,
|
|
974
|
+
# such as extracting structured field filters from the query. Refer to [this
|
|
975
|
+
# documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
|
|
976
|
+
# for more information.
|
|
977
|
+
# If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
|
|
978
|
+
# natural language query understanding will be done.
|
|
979
|
+
# @param search_as_you_type_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAsYouTypeSpec, ::Hash]
|
|
980
|
+
# Search as you type configuration. Only supported for the
|
|
981
|
+
# {::Google::Cloud::DiscoveryEngine::V1::IndustryVertical::MEDIA IndustryVertical.MEDIA}
|
|
982
|
+
# vertical.
|
|
983
|
+
# @param display_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DisplaySpec, ::Hash]
|
|
984
|
+
# Optional. Config for display feature, like match highlighting on search
|
|
985
|
+
# results.
|
|
986
|
+
# @param crowding_specs [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::CrowdingSpec, ::Hash>]
|
|
987
|
+
# Optional. Crowding specifications for improving result diversity.
|
|
988
|
+
# If multiple CrowdingSpecs are specified, crowding will be evaluated on
|
|
989
|
+
# each unique combination of the `field` values, and max_count will be the
|
|
990
|
+
# maximum value of `max_count` across all CrowdingSpecs.
|
|
991
|
+
# For example, if the first CrowdingSpec has `field` = "color" and
|
|
992
|
+
# `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
|
|
993
|
+
# `max_count` = 2, then after 3 documents that share the same color AND size
|
|
994
|
+
# have been returned, subsequent ones should be
|
|
995
|
+
# removed or demoted.
|
|
996
|
+
# @param session [::String]
|
|
997
|
+
# The session resource name. Optional.
|
|
998
|
+
#
|
|
999
|
+
# Session allows users to do multi-turn /search API calls or coordination
|
|
1000
|
+
# between /search API calls and /answer API calls.
|
|
1001
|
+
#
|
|
1002
|
+
# Example #1 (multi-turn /search API calls):
|
|
1003
|
+
# Call /search API with the session ID generated in the first call.
|
|
1004
|
+
# Here, the previous search query gets considered in query
|
|
1005
|
+
# standing. I.e., if the first query is "How did Alphabet do in 2022?"
|
|
1006
|
+
# and the current query is "How about 2023?", the current query will
|
|
1007
|
+
# be interpreted as "How did Alphabet do in 2023?".
|
|
1008
|
+
#
|
|
1009
|
+
# Example #2 (coordination between /search API calls and /answer API calls):
|
|
1010
|
+
# Call /answer API with the session ID generated in the first call.
|
|
1011
|
+
# Here, the answer generation happens in the context of the search
|
|
1012
|
+
# results from the first search call.
|
|
1013
|
+
#
|
|
1014
|
+
# Multi-turn Search feature is currently at private GA stage. Please use
|
|
1015
|
+
# v1alpha or v1beta version instead before we launch this feature to public
|
|
1016
|
+
# GA. Or ask for allowlisting through Google Support team.
|
|
1017
|
+
# @param session_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SessionSpec, ::Hash]
|
|
1018
|
+
# Session specification.
|
|
1019
|
+
#
|
|
1020
|
+
# Can be used only when `session` is set.
|
|
1021
|
+
# @param relevance_threshold [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceThreshold]
|
|
1022
|
+
# The global relevance threshold of the search results.
|
|
1023
|
+
#
|
|
1024
|
+
# Defaults to Google defined threshold, leveraging a balance of
|
|
1025
|
+
# precision and recall to deliver both highly accurate results and
|
|
1026
|
+
# comprehensive coverage of relevant information.
|
|
1027
|
+
#
|
|
1028
|
+
# If more granular relevance filtering is required, use the
|
|
1029
|
+
# `relevance_filter_spec` instead.
|
|
1030
|
+
#
|
|
1031
|
+
# This feature is not supported for healthcare search.
|
|
1032
|
+
# @param relevance_score_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceScoreSpec, ::Hash]
|
|
1033
|
+
# Optional. The specification for returning the relevance score.
|
|
954
1034
|
#
|
|
955
1035
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
956
1036
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>]
|