google-cloud-discovery_engine-v1 2.11.0 → 2.12.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 +56 -10
- data/lib/google/cloud/discovery_engine/v1/search_service/credentials.rb +4 -1
- data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +56 -10
- data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/search_service_pb.rb +7 -2
- data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +141 -21
- 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: 86229e5cb4005b768cf7f4dbd7e2d9e9ea2675b01f1924e0b218ca0201fe6a95
|
|
4
|
+
data.tar.gz: f2f3be72886c500a05583611c4a6abfea96134cd7b82d8dfd8e5bd3af61cfbde
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 18710d4f21f9dade17436823593ce78f9a1bdb092ccc1653ec13a4d6d7eeb35a01194998519d7a768d1e78ff789affb21c6d88d612fcdb1f733d873bcddc688b
|
|
7
|
+
data.tar.gz: de4bfdf1c55a68852de6c42167878380e2b457e0ff4e86c8f4ec0409b29adfcb9a63648d7ac7a97d500bbbcf3c4e00945a96e158ed9956bdb7a6bdb79ee9da9c
|
|
@@ -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, 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_filter_spec: nil, relevance_score_spec: 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, num_results_per_data_store: 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_filter_spec: nil, relevance_score_spec: nil, search_addon_spec: nil, custom_ranking_params: nil, entity: 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).
|
|
@@ -299,6 +299,11 @@ module Google
|
|
|
299
299
|
# stores. For engines with a single data store, the specs directly under
|
|
300
300
|
# {::Google::Cloud::DiscoveryEngine::V1::SearchRequest SearchRequest} should be
|
|
301
301
|
# used.
|
|
302
|
+
# @param num_results_per_data_store [::Integer]
|
|
303
|
+
# Optional. The maximum number of results to retrieve from each data store.
|
|
304
|
+
# If not specified, it will use the
|
|
305
|
+
# {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec#num_results SearchRequest.DataStoreSpec.num_results}
|
|
306
|
+
# if provided, otherwise there is no limit.
|
|
302
307
|
# @param filter [::String]
|
|
303
308
|
# The filter syntax consists of an expression language for constructing a
|
|
304
309
|
# predicate from one or more fields of the documents being filtered. Filter
|
|
@@ -491,6 +496,15 @@ module Google
|
|
|
491
496
|
# Google model to determine the keyword-based overlap between the query and
|
|
492
497
|
# the document.
|
|
493
498
|
# * `base_rank`: the default rank of the result
|
|
499
|
+
# * `media_actor_match`: whether the media actor matches the query
|
|
500
|
+
# * `media_director_match`: whether the media director matches the query
|
|
501
|
+
# * `media_genre_match`: whether the media genre matches the query
|
|
502
|
+
# * `media_language_match`: whether the media language matches the query
|
|
503
|
+
# * `media_title_match`: whether the media title matches the query
|
|
504
|
+
# * `media_prefix_similarity_rank`: prefix similarity rank for media
|
|
505
|
+
# results
|
|
506
|
+
# * `media_semantic_similarity_rank`: semantic similarity rank for media
|
|
507
|
+
# results
|
|
494
508
|
# @param ranking_expression_backend [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RankingExpressionBackend]
|
|
495
509
|
# Optional. The backend to use for the ranking expression evaluation.
|
|
496
510
|
# @param safe_search [::Boolean]
|
|
@@ -555,10 +569,6 @@ module Google
|
|
|
555
569
|
# Call /answer API with the session ID generated in the first call.
|
|
556
570
|
# Here, the answer generation happens in the context of the search
|
|
557
571
|
# 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
572
|
# @param session_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SessionSpec, ::Hash]
|
|
563
573
|
# Session specification.
|
|
564
574
|
#
|
|
@@ -584,6 +594,19 @@ module Google
|
|
|
584
594
|
# This feature is currently supported only for custom and site search.
|
|
585
595
|
# @param relevance_score_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceScoreSpec, ::Hash]
|
|
586
596
|
# Optional. The specification for returning the relevance score.
|
|
597
|
+
# @param search_addon_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAddonSpec, ::Hash]
|
|
598
|
+
# Optional. SearchAddonSpec is used to disable add-ons for search as per new
|
|
599
|
+
# repricing model.
|
|
600
|
+
# This field is only supported for search requests.
|
|
601
|
+
# @param custom_ranking_params [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::CustomRankingParams, ::Hash]
|
|
602
|
+
# Optional. Optional configuration for the Custom Ranking feature.
|
|
603
|
+
# @param entity [::String]
|
|
604
|
+
# Optional. The entity for customers that may run multiple different
|
|
605
|
+
# entities, domains, sites or regions, for example, "Google US", "Google
|
|
606
|
+
# Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
|
|
607
|
+
# be exactly matched with
|
|
608
|
+
# [UserEvent.entity][google.cloud.discoveryengine.v1.UserEvent.entity] to get
|
|
609
|
+
# search results boosted by entity.
|
|
587
610
|
#
|
|
588
611
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
589
612
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>]
|
|
@@ -680,7 +703,7 @@ module Google
|
|
|
680
703
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
681
704
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
682
705
|
#
|
|
683
|
-
# @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_filter_spec: nil, relevance_score_spec: nil)
|
|
706
|
+
# @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, num_results_per_data_store: 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_filter_spec: nil, relevance_score_spec: nil, search_addon_spec: nil, custom_ranking_params: nil, entity: nil)
|
|
684
707
|
# Pass arguments to `search_lite` via keyword arguments. Note that at
|
|
685
708
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
686
709
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -762,6 +785,11 @@ module Google
|
|
|
762
785
|
# stores. For engines with a single data store, the specs directly under
|
|
763
786
|
# {::Google::Cloud::DiscoveryEngine::V1::SearchRequest SearchRequest} should be
|
|
764
787
|
# used.
|
|
788
|
+
# @param num_results_per_data_store [::Integer]
|
|
789
|
+
# Optional. The maximum number of results to retrieve from each data store.
|
|
790
|
+
# If not specified, it will use the
|
|
791
|
+
# {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec#num_results SearchRequest.DataStoreSpec.num_results}
|
|
792
|
+
# if provided, otherwise there is no limit.
|
|
765
793
|
# @param filter [::String]
|
|
766
794
|
# The filter syntax consists of an expression language for constructing a
|
|
767
795
|
# predicate from one or more fields of the documents being filtered. Filter
|
|
@@ -954,6 +982,15 @@ module Google
|
|
|
954
982
|
# Google model to determine the keyword-based overlap between the query and
|
|
955
983
|
# the document.
|
|
956
984
|
# * `base_rank`: the default rank of the result
|
|
985
|
+
# * `media_actor_match`: whether the media actor matches the query
|
|
986
|
+
# * `media_director_match`: whether the media director matches the query
|
|
987
|
+
# * `media_genre_match`: whether the media genre matches the query
|
|
988
|
+
# * `media_language_match`: whether the media language matches the query
|
|
989
|
+
# * `media_title_match`: whether the media title matches the query
|
|
990
|
+
# * `media_prefix_similarity_rank`: prefix similarity rank for media
|
|
991
|
+
# results
|
|
992
|
+
# * `media_semantic_similarity_rank`: semantic similarity rank for media
|
|
993
|
+
# results
|
|
957
994
|
# @param ranking_expression_backend [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RankingExpressionBackend]
|
|
958
995
|
# Optional. The backend to use for the ranking expression evaluation.
|
|
959
996
|
# @param safe_search [::Boolean]
|
|
@@ -1018,10 +1055,6 @@ module Google
|
|
|
1018
1055
|
# Call /answer API with the session ID generated in the first call.
|
|
1019
1056
|
# Here, the answer generation happens in the context of the search
|
|
1020
1057
|
# results from the first search call.
|
|
1021
|
-
#
|
|
1022
|
-
# Multi-turn Search feature is currently at private GA stage. Please use
|
|
1023
|
-
# v1alpha or v1beta version instead before we launch this feature to public
|
|
1024
|
-
# GA. Or ask for allowlisting through Google Support team.
|
|
1025
1058
|
# @param session_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SessionSpec, ::Hash]
|
|
1026
1059
|
# Session specification.
|
|
1027
1060
|
#
|
|
@@ -1047,6 +1080,19 @@ module Google
|
|
|
1047
1080
|
# This feature is currently supported only for custom and site search.
|
|
1048
1081
|
# @param relevance_score_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceScoreSpec, ::Hash]
|
|
1049
1082
|
# Optional. The specification for returning the relevance score.
|
|
1083
|
+
# @param search_addon_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAddonSpec, ::Hash]
|
|
1084
|
+
# Optional. SearchAddonSpec is used to disable add-ons for search as per new
|
|
1085
|
+
# repricing model.
|
|
1086
|
+
# This field is only supported for search requests.
|
|
1087
|
+
# @param custom_ranking_params [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::CustomRankingParams, ::Hash]
|
|
1088
|
+
# Optional. Optional configuration for the Custom Ranking feature.
|
|
1089
|
+
# @param entity [::String]
|
|
1090
|
+
# Optional. The entity for customers that may run multiple different
|
|
1091
|
+
# entities, domains, sites or regions, for example, "Google US", "Google
|
|
1092
|
+
# Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
|
|
1093
|
+
# be exactly matched with
|
|
1094
|
+
# [UserEvent.entity][google.cloud.discoveryengine.v1.UserEvent.entity] to get
|
|
1095
|
+
# search results boosted by entity.
|
|
1050
1096
|
#
|
|
1051
1097
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1052
1098
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>]
|
|
@@ -26,7 +26,10 @@ module Google
|
|
|
26
26
|
# Credentials for the SearchService API.
|
|
27
27
|
class Credentials < ::Google::Auth::Credentials
|
|
28
28
|
self.scope = [
|
|
29
|
-
"https://www.googleapis.com/auth/cloud-platform"
|
|
29
|
+
"https://www.googleapis.com/auth/cloud-platform",
|
|
30
|
+
"https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
|
|
31
|
+
"https://www.googleapis.com/auth/discoveryengine.readwrite",
|
|
32
|
+
"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
|
|
30
33
|
]
|
|
31
34
|
self.env_vars = [
|
|
32
35
|
"GOOGLE_CLOUD_CREDENTIALS",
|
|
@@ -210,7 +210,7 @@ module Google
|
|
|
210
210
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
211
211
|
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
212
212
|
#
|
|
213
|
-
# @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_filter_spec: nil, relevance_score_spec: nil)
|
|
213
|
+
# @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, num_results_per_data_store: 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_filter_spec: nil, relevance_score_spec: nil, search_addon_spec: nil, custom_ranking_params: nil, entity: nil)
|
|
214
214
|
# Pass arguments to `search` via keyword arguments. Note that at
|
|
215
215
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
216
216
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -292,6 +292,11 @@ module Google
|
|
|
292
292
|
# stores. For engines with a single data store, the specs directly under
|
|
293
293
|
# {::Google::Cloud::DiscoveryEngine::V1::SearchRequest SearchRequest} should be
|
|
294
294
|
# used.
|
|
295
|
+
# @param num_results_per_data_store [::Integer]
|
|
296
|
+
# Optional. The maximum number of results to retrieve from each data store.
|
|
297
|
+
# If not specified, it will use the
|
|
298
|
+
# {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec#num_results SearchRequest.DataStoreSpec.num_results}
|
|
299
|
+
# if provided, otherwise there is no limit.
|
|
295
300
|
# @param filter [::String]
|
|
296
301
|
# The filter syntax consists of an expression language for constructing a
|
|
297
302
|
# predicate from one or more fields of the documents being filtered. Filter
|
|
@@ -484,6 +489,15 @@ module Google
|
|
|
484
489
|
# Google model to determine the keyword-based overlap between the query and
|
|
485
490
|
# the document.
|
|
486
491
|
# * `base_rank`: the default rank of the result
|
|
492
|
+
# * `media_actor_match`: whether the media actor matches the query
|
|
493
|
+
# * `media_director_match`: whether the media director matches the query
|
|
494
|
+
# * `media_genre_match`: whether the media genre matches the query
|
|
495
|
+
# * `media_language_match`: whether the media language matches the query
|
|
496
|
+
# * `media_title_match`: whether the media title matches the query
|
|
497
|
+
# * `media_prefix_similarity_rank`: prefix similarity rank for media
|
|
498
|
+
# results
|
|
499
|
+
# * `media_semantic_similarity_rank`: semantic similarity rank for media
|
|
500
|
+
# results
|
|
487
501
|
# @param ranking_expression_backend [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RankingExpressionBackend]
|
|
488
502
|
# Optional. The backend to use for the ranking expression evaluation.
|
|
489
503
|
# @param safe_search [::Boolean]
|
|
@@ -548,10 +562,6 @@ module Google
|
|
|
548
562
|
# Call /answer API with the session ID generated in the first call.
|
|
549
563
|
# Here, the answer generation happens in the context of the search
|
|
550
564
|
# results from the first search call.
|
|
551
|
-
#
|
|
552
|
-
# Multi-turn Search feature is currently at private GA stage. Please use
|
|
553
|
-
# v1alpha or v1beta version instead before we launch this feature to public
|
|
554
|
-
# GA. Or ask for allowlisting through Google Support team.
|
|
555
565
|
# @param session_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SessionSpec, ::Hash]
|
|
556
566
|
# Session specification.
|
|
557
567
|
#
|
|
@@ -577,6 +587,19 @@ module Google
|
|
|
577
587
|
# This feature is currently supported only for custom and site search.
|
|
578
588
|
# @param relevance_score_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceScoreSpec, ::Hash]
|
|
579
589
|
# Optional. The specification for returning the relevance score.
|
|
590
|
+
# @param search_addon_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAddonSpec, ::Hash]
|
|
591
|
+
# Optional. SearchAddonSpec is used to disable add-ons for search as per new
|
|
592
|
+
# repricing model.
|
|
593
|
+
# This field is only supported for search requests.
|
|
594
|
+
# @param custom_ranking_params [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::CustomRankingParams, ::Hash]
|
|
595
|
+
# Optional. Optional configuration for the Custom Ranking feature.
|
|
596
|
+
# @param entity [::String]
|
|
597
|
+
# Optional. The entity for customers that may run multiple different
|
|
598
|
+
# entities, domains, sites or regions, for example, "Google US", "Google
|
|
599
|
+
# Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
|
|
600
|
+
# be exactly matched with
|
|
601
|
+
# [UserEvent.entity][google.cloud.discoveryengine.v1.UserEvent.entity] to get
|
|
602
|
+
# search results boosted by entity.
|
|
580
603
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
581
604
|
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>]
|
|
582
605
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -666,7 +689,7 @@ module Google
|
|
|
666
689
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
667
690
|
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
668
691
|
#
|
|
669
|
-
# @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_filter_spec: nil, relevance_score_spec: nil)
|
|
692
|
+
# @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, num_results_per_data_store: 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_filter_spec: nil, relevance_score_spec: nil, search_addon_spec: nil, custom_ranking_params: nil, entity: nil)
|
|
670
693
|
# Pass arguments to `search_lite` via keyword arguments. Note that at
|
|
671
694
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
672
695
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -748,6 +771,11 @@ module Google
|
|
|
748
771
|
# stores. For engines with a single data store, the specs directly under
|
|
749
772
|
# {::Google::Cloud::DiscoveryEngine::V1::SearchRequest SearchRequest} should be
|
|
750
773
|
# used.
|
|
774
|
+
# @param num_results_per_data_store [::Integer]
|
|
775
|
+
# Optional. The maximum number of results to retrieve from each data store.
|
|
776
|
+
# If not specified, it will use the
|
|
777
|
+
# {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec#num_results SearchRequest.DataStoreSpec.num_results}
|
|
778
|
+
# if provided, otherwise there is no limit.
|
|
751
779
|
# @param filter [::String]
|
|
752
780
|
# The filter syntax consists of an expression language for constructing a
|
|
753
781
|
# predicate from one or more fields of the documents being filtered. Filter
|
|
@@ -940,6 +968,15 @@ module Google
|
|
|
940
968
|
# Google model to determine the keyword-based overlap between the query and
|
|
941
969
|
# the document.
|
|
942
970
|
# * `base_rank`: the default rank of the result
|
|
971
|
+
# * `media_actor_match`: whether the media actor matches the query
|
|
972
|
+
# * `media_director_match`: whether the media director matches the query
|
|
973
|
+
# * `media_genre_match`: whether the media genre matches the query
|
|
974
|
+
# * `media_language_match`: whether the media language matches the query
|
|
975
|
+
# * `media_title_match`: whether the media title matches the query
|
|
976
|
+
# * `media_prefix_similarity_rank`: prefix similarity rank for media
|
|
977
|
+
# results
|
|
978
|
+
# * `media_semantic_similarity_rank`: semantic similarity rank for media
|
|
979
|
+
# results
|
|
943
980
|
# @param ranking_expression_backend [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RankingExpressionBackend]
|
|
944
981
|
# Optional. The backend to use for the ranking expression evaluation.
|
|
945
982
|
# @param safe_search [::Boolean]
|
|
@@ -1004,10 +1041,6 @@ module Google
|
|
|
1004
1041
|
# Call /answer API with the session ID generated in the first call.
|
|
1005
1042
|
# Here, the answer generation happens in the context of the search
|
|
1006
1043
|
# results from the first search call.
|
|
1007
|
-
#
|
|
1008
|
-
# Multi-turn Search feature is currently at private GA stage. Please use
|
|
1009
|
-
# v1alpha or v1beta version instead before we launch this feature to public
|
|
1010
|
-
# GA. Or ask for allowlisting through Google Support team.
|
|
1011
1044
|
# @param session_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SessionSpec, ::Hash]
|
|
1012
1045
|
# Session specification.
|
|
1013
1046
|
#
|
|
@@ -1033,6 +1066,19 @@ module Google
|
|
|
1033
1066
|
# This feature is currently supported only for custom and site search.
|
|
1034
1067
|
# @param relevance_score_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceScoreSpec, ::Hash]
|
|
1035
1068
|
# Optional. The specification for returning the relevance score.
|
|
1069
|
+
# @param search_addon_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAddonSpec, ::Hash]
|
|
1070
|
+
# Optional. SearchAddonSpec is used to disable add-ons for search as per new
|
|
1071
|
+
# repricing model.
|
|
1072
|
+
# This field is only supported for search requests.
|
|
1073
|
+
# @param custom_ranking_params [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::CustomRankingParams, ::Hash]
|
|
1074
|
+
# Optional. Optional configuration for the Custom Ranking feature.
|
|
1075
|
+
# @param entity [::String]
|
|
1076
|
+
# Optional. The entity for customers that may run multiple different
|
|
1077
|
+
# entities, domains, sites or regions, for example, "Google US", "Google
|
|
1078
|
+
# Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
|
|
1079
|
+
# be exactly matched with
|
|
1080
|
+
# [UserEvent.entity][google.cloud.discoveryengine.v1.UserEvent.entity] to get
|
|
1081
|
+
# search results boosted by entity.
|
|
1036
1082
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
1037
1083
|
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>]
|
|
1038
1084
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -14,7 +14,7 @@ require 'google/cloud/discoveryengine/v1/document_pb'
|
|
|
14
14
|
require 'google/protobuf/struct_pb'
|
|
15
15
|
|
|
16
16
|
|
|
17
|
-
descriptor_data = "\n4google/cloud/discoveryengine/v1/search_service.proto\x12\x1fgoogle.cloud.discoveryengine.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a+google/cloud/discoveryengine/v1/chunk.proto\x1a,google/cloud/discoveryengine/v1/common.proto\x1a.google/cloud/discoveryengine/v1/document.proto\x1a\x1cgoogle/protobuf/struct.proto\"\xf9?\n\rSearchRequest\x12L\n\x0eserving_config\x18\x01 \x01(\tB4\xe0\x41\x02\xfa\x41.\n,discoveryengine.googleapis.com/ServingConfig\x12:\n\x06\x62ranch\x18\x02 \x01(\tB*\xfa\x41\'\n%discoveryengine.googleapis.com/Branch\x12\r\n\x05query\x18\x03 \x01(\t\x12\x1c\n\x0fpage_categories\x18? \x03(\tB\x03\xe0\x41\x01\x12N\n\x0bimage_query\x18\x13 \x01(\x0b\x32\x39.google.cloud.discoveryengine.v1.SearchRequest.ImageQuery\x12\x11\n\tpage_size\x18\x04 \x01(\x05\x12\x12\n\npage_token\x18\x05 \x01(\t\x12\x0e\n\x06offset\x18\x06 \x01(\x05\x12\x19\n\x11one_box_page_size\x18/ \x01(\x05\x12V\n\x10\x64\x61ta_store_specs\x18 \x03(\x0b\x32<.google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec\x12\x0e\n\x06\x66ilter\x18\x07 \x01(\t\x12\x18\n\x10\x63\x61nonical_filter\x18\x1d \x01(\t\x12\x10\n\x08order_by\x18\x08 \x01(\t\x12<\n\tuser_info\x18\x15 \x01(\x0b\x32).google.cloud.discoveryengine.v1.UserInfo\x12\x15\n\rlanguage_code\x18# \x01(\t\x12M\n\x0b\x66\x61\x63\x65t_specs\x18\t \x03(\x0b\x32\x38.google.cloud.discoveryengine.v1.SearchRequest.FacetSpec\x12L\n\nboost_spec\x18\n \x01(\x0b\x32\x38.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec\x12J\n\x06params\x18\x0b \x03(\x0b\x32:.google.cloud.discoveryengine.v1.SearchRequest.ParamsEntry\x12_\n\x14query_expansion_spec\x18\r \x01(\x0b\x32\x41.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec\x12\x61\n\x15spell_correction_spec\x18\x0e \x01(\x0b\x32\x42.google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec\x12\x1b\n\x0euser_pseudo_id\x18\x0f \x01(\tB\x03\xe0\x41\x01\x12]\n\x13\x63ontent_search_spec\x18\x18 \x01(\x0b\x32@.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec\x12\x1f\n\x12ranking_expression\x18\x1a \x01(\tB\x03\xe0\x41\x01\x12p\n\x1aranking_expression_backend\x18\x35 \x01(\x0e\x32G.google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackendB\x03\xe0\x41\x01\x12\x13\n\x0bsafe_search\x18\x14 \x01(\x08\x12S\n\x0buser_labels\x18\x16 \x03(\x0b\x32>.google.cloud.discoveryengine.v1.SearchRequest.UserLabelsEntry\x12\x8c\x01\n)natural_language_query_understanding_spec\x18\x1c \x01(\x0b\x32T.google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpecB\x03\xe0\x41\x01\x12\x63\n\x17search_as_you_type_spec\x18\x1f \x01(\x0b\x32\x42.google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec\x12U\n\x0c\x64isplay_spec\x18& \x01(\x0b\x32:.google.cloud.discoveryengine.v1.SearchRequest.DisplaySpecB\x03\xe0\x41\x01\x12X\n\x0e\x63rowding_specs\x18( \x03(\x0b\x32;.google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpecB\x03\xe0\x41\x01\x12<\n\x07session\x18) \x01(\tB+\xfa\x41(\n&discoveryengine.googleapis.com/Session\x12P\n\x0csession_spec\x18* \x01(\x0b\x32:.google.cloud.discoveryengine.v1.SearchRequest.SessionSpec\x12^\n\x13relevance_threshold\x18, \x01(\x0e\x32\x41.google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold\x12\x66\n\x15relevance_filter_spec\x18V \x01(\x0b\x32\x42.google.cloud.discoveryengine.v1.SearchRequest.RelevanceFilterSpecB\x03\xe0\x41\x01\x12\x64\n\x14relevance_score_spec\x18\x34 \x01(\x0b\x32\x41.google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpecB\x03\xe0\x41\x01\x1a,\n\nImageQuery\x12\x15\n\x0bimage_bytes\x18\x01 \x01(\tH\x00\x42\x07\n\x05image\x1a\xe3\x01\n\rDataStoreSpec\x12\x44\n\ndata_store\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(discoveryengine.googleapis.com/DataStore\x12\x13\n\x06\x66ilter\x18\x05 \x01(\tB\x03\xe0\x41\x01\x12Q\n\nboost_spec\x18\x06 \x01(\x0b\x32\x38.google.cloud.discoveryengine.v1.SearchRequest.BoostSpecB\x03\xe0\x41\x01\x12$\n\x17\x63ustom_search_operators\x18\x07 \x01(\tB\x03\xe0\x41\x01\x1a\xfc\x02\n\tFacetSpec\x12Y\n\tfacet_key\x18\x01 \x01(\x0b\x32\x41.google.cloud.discoveryengine.v1.SearchRequest.FacetSpec.FacetKeyB\x03\xe0\x41\x02\x12\r\n\x05limit\x18\x02 \x01(\x05\x12\x1c\n\x14\x65xcluded_filter_keys\x18\x03 \x03(\t\x12\x1f\n\x17\x65nable_dynamic_position\x18\x04 \x01(\x08\x1a\xc5\x01\n\x08\x46\x61\x63\x65tKey\x12\x10\n\x03key\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12<\n\tintervals\x18\x02 \x03(\x0b\x32).google.cloud.discoveryengine.v1.Interval\x12\x19\n\x11restricted_values\x18\x03 \x03(\t\x12\x10\n\x08prefixes\x18\x04 \x03(\t\x12\x10\n\x08\x63ontains\x18\x05 \x03(\t\x12\x18\n\x10\x63\x61se_insensitive\x18\x06 \x01(\x08\x12\x10\n\x08order_by\x18\x07 \x01(\t\x1a\xbc\x07\n\tBoostSpec\x12j\n\x15\x63ondition_boost_specs\x18\x01 \x03(\x0b\x32K.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec\x1a\xc2\x06\n\x12\x43onditionBoostSpec\x12\x11\n\tcondition\x18\x01 \x01(\t\x12\r\n\x05\x62oost\x18\x02 \x01(\x02\x12x\n\x12\x62oost_control_spec\x18\x03 \x01(\x0b\x32\\.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec\x1a\x8f\x05\n\x10\x42oostControlSpec\x12\x12\n\nfield_name\x18\x01 \x01(\t\x12\x82\x01\n\x0e\x61ttribute_type\x18\x02 \x01(\x0e\x32j.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType\x12\x8a\x01\n\x12interpolation_type\x18\x03 \x01(\x0e\x32n.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType\x12\x81\x01\n\x0e\x63ontrol_points\x18\x04 \x03(\x0b\x32i.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint\x1a=\n\x0c\x43ontrolPoint\x12\x17\n\x0f\x61ttribute_value\x18\x01 \x01(\t\x12\x14\n\x0c\x62oost_amount\x18\x02 \x01(\x02\"M\n\rAttributeType\x12\x1e\n\x1a\x41TTRIBUTE_TYPE_UNSPECIFIED\x10\x00\x12\r\n\tNUMERICAL\x10\x01\x12\r\n\tFRESHNESS\x10\x02\"C\n\x11InterpolationType\x12\"\n\x1eINTERPOLATION_TYPE_UNSPECIFIED\x10\x00\x12\n\n\x06LINEAR\x10\x01\x1a\xd4\x01\n\x12QueryExpansionSpec\x12^\n\tcondition\x18\x01 \x01(\x0e\x32K.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.Condition\x12\x1e\n\x16pin_unexpanded_results\x18\x02 \x01(\x08\">\n\tCondition\x12\x19\n\x15\x43ONDITION_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x44ISABLED\x10\x01\x12\x08\n\x04\x41UTO\x10\x02\x1a\xa9\x01\n\x13SpellCorrectionSpec\x12U\n\x04mode\x18\x01 \x01(\x0e\x32G.google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec.Mode\";\n\x04Mode\x12\x14\n\x10MODE_UNSPECIFIED\x10\x00\x12\x13\n\x0fSUGGESTION_ONLY\x10\x01\x12\x08\n\x04\x41UTO\x10\x02\x1a\xa2\x0c\n\x11\x43ontentSearchSpec\x12\x62\n\x0csnippet_spec\x18\x01 \x01(\x0b\x32L.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec\x12\x62\n\x0csummary_spec\x18\x02 \x01(\x0b\x32L.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec\x12w\n\x17\x65xtractive_content_spec\x18\x03 \x01(\x0b\x32V.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec\x12m\n\x12search_result_mode\x18\x04 \x01(\x0e\x32Q.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode\x12^\n\nchunk_spec\x18\x05 \x01(\x0b\x32J.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ChunkSpec\x1a`\n\x0bSnippetSpec\x12\x1d\n\x11max_snippet_count\x18\x01 \x01(\x05\x42\x02\x18\x01\x12\x1a\n\x0ereference_only\x18\x02 \x01(\x08\x42\x02\x18\x01\x12\x16\n\x0ereturn_snippet\x18\x03 \x01(\x08\x1a\xbc\x04\n\x0bSummarySpec\x12\x1c\n\x14summary_result_count\x18\x01 \x01(\x05\x12\x19\n\x11include_citations\x18\x02 \x01(\x08\x12 \n\x18ignore_adversarial_query\x18\x03 \x01(\x08\x12(\n ignore_non_summary_seeking_query\x18\x04 \x01(\x08\x12#\n\x1bignore_low_relevant_content\x18\t \x01(\x08\x12\'\n\x1aignore_jail_breaking_query\x18\n \x01(\x08\x42\x03\xe0\x41\x01\x12w\n\x11model_prompt_spec\x18\x05 \x01(\x0b\x32\\.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec\x12\x15\n\rlanguage_code\x18\x06 \x01(\t\x12j\n\nmodel_spec\x18\x07 \x01(\x0b\x32V.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec\x12\x1b\n\x13use_semantic_chunks\x18\x08 \x01(\x08\x1a#\n\x0fModelPromptSpec\x12\x10\n\x08preamble\x18\x01 \x01(\t\x1a\x1c\n\tModelSpec\x12\x0f\n\x07version\x18\x01 \x01(\t\x1a\xc5\x01\n\x15\x45xtractiveContentSpec\x12#\n\x1bmax_extractive_answer_count\x18\x01 \x01(\x05\x12$\n\x1cmax_extractive_segment_count\x18\x02 \x01(\x05\x12\'\n\x1freturn_extractive_segment_score\x18\x03 \x01(\x08\x12\x1d\n\x15num_previous_segments\x18\x04 \x01(\x05\x12\x19\n\x11num_next_segments\x18\x05 \x01(\x05\x1a\x41\n\tChunkSpec\x12\x1b\n\x13num_previous_chunks\x18\x01 \x01(\x05\x12\x17\n\x0fnum_next_chunks\x18\x02 \x01(\x05\"Q\n\x10SearchResultMode\x12\"\n\x1eSEARCH_RESULT_MODE_UNSPECIFIED\x10\x00\x12\r\n\tDOCUMENTS\x10\x01\x12\n\n\x06\x43HUNKS\x10\x02\x1a\xe0\x04\n%NaturalLanguageQueryUnderstandingSpec\x12\x93\x01\n\x1b\x66ilter_extraction_condition\x18\x01 \x01(\x0e\x32n.google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition\x12.\n&geo_search_query_detection_field_names\x18\x02 \x03(\t\x12\x94\x01\n\x19\x65xtracted_filter_behavior\x18\x03 \x01(\x0e\x32l.google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehaviorB\x03\xe0\x41\x01\x12 \n\x13\x61llowed_field_names\x18\x04 \x03(\tB\x03\xe0\x41\x01\"Q\n\x19\x46ilterExtractionCondition\x12\x19\n\x15\x43ONDITION_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x44ISABLED\x10\x01\x12\x0b\n\x07\x45NABLED\x10\x02\"e\n\x17\x45xtractedFilterBehavior\x12)\n%EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED\x10\x00\x12\x0f\n\x0bHARD_FILTER\x10\x01\x12\x0e\n\nSOFT_BOOST\x10\x02\x1a\xc3\x01\n\x13SearchAsYouTypeSpec\x12_\n\tcondition\x18\x01 \x01(\x0e\x32L.google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition\"K\n\tCondition\x12\x19\n\x15\x43ONDITION_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x44ISABLED\x10\x01\x12\x0b\n\x07\x45NABLED\x10\x02\x12\x08\n\x04\x41UTO\x10\x03\x1a\x98\x02\n\x0b\x44isplaySpec\x12{\n\x1cmatch_highlighting_condition\x18\x01 \x01(\x0e\x32U.google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec.MatchHighlightingCondition\"\x8b\x01\n\x1aMatchHighlightingCondition\x12,\n(MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED\x10\x00\x12\x1f\n\x1bMATCH_HIGHLIGHTING_DISABLED\x10\x01\x12\x1e\n\x1aMATCH_HIGHLIGHTING_ENABLED\x10\x02\x1a\xdb\x01\n\x0c\x43rowdingSpec\x12\r\n\x05\x66ield\x18\x01 \x01(\t\x12\x11\n\tmax_count\x18\x02 \x01(\x05\x12N\n\x04mode\x18\x03 \x01(\x0e\x32@.google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec.Mode\"Y\n\x04Mode\x12\x14\n\x10MODE_UNSPECIFIED\x10\x00\x12\x18\n\x14\x44ROP_CROWDED_RESULTS\x10\x01\x12!\n\x1d\x44\x45MOTE_CROWDED_RESULTS_TO_END\x10\x02\x1aq\n\x0bSessionSpec\x12\x10\n\x08query_id\x18\x01 \x01(\t\x12,\n\x1fsearch_result_persistence_count\x18\x02 \x01(\x05H\x00\x88\x01\x01\x42\"\n _search_result_persistence_count\x1a\x39\n\x12RelevanceScoreSpec\x12#\n\x16return_relevance_score\x18\x01 \x01(\x08\x42\x03\xe0\x41\x01\x1a\xdd\x03\n\x13RelevanceFilterSpec\x12\x80\x01\n\x18keyword_search_threshold\x18\x01 \x01(\x0b\x32Y.google.cloud.discoveryengine.v1.SearchRequest.RelevanceFilterSpec.RelevanceThresholdSpecB\x03\xe0\x41\x01\x12\x81\x01\n\x19semantic_search_threshold\x18\x02 \x01(\x0b\x32Y.google.cloud.discoveryengine.v1.SearchRequest.RelevanceFilterSpec.RelevanceThresholdSpecB\x03\xe0\x41\x01\x1a\xbe\x01\n\x16RelevanceThresholdSpec\x12`\n\x13relevance_threshold\x18\x01 \x01(\x0e\x32\x41.google.cloud.discoveryengine.v1.SearchRequest.RelevanceThresholdH\x00\x12&\n\x1csemantic_relevance_threshold\x18\x02 \x01(\x02H\x00\x42\x1a\n\x18relevance_threshold_spec\x1a\x45\n\x0bParamsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12%\n\x05value\x18\x02 \x01(\x0b\x32\x16.google.protobuf.Value:\x02\x38\x01\x1a\x31\n\x0fUserLabelsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"\x92\x01\n\x18RankingExpressionBackend\x12*\n&RANKING_EXPRESSION_BACKEND_UNSPECIFIED\x10\x00\x12\x0c\n\x04\x42YOE\x10\x01\x1a\x02\x08\x01\x12\x10\n\x08\x43LEARBOX\x10\x02\x1a\x02\x08\x01\x12\x15\n\x11RANK_BY_EMBEDDING\x10\x03\x12\x13\n\x0fRANK_BY_FORMULA\x10\x04\"d\n\x12RelevanceThreshold\x12#\n\x1fRELEVANCE_THRESHOLD_UNSPECIFIED\x10\x00\x12\n\n\x06LOWEST\x10\x01\x12\x07\n\x03LOW\x10\x02\x12\n\n\x06MEDIUM\x10\x03\x12\x08\n\x04HIGH\x10\x04\"\xe6/\n\x0eSearchResponse\x12M\n\x07results\x18\x01 \x03(\x0b\x32<.google.cloud.discoveryengine.v1.SearchResponse.SearchResult\x12\x45\n\x06\x66\x61\x63\x65ts\x18\x02 \x03(\x0b\x32\x35.google.cloud.discoveryengine.v1.SearchResponse.Facet\x12\x12\n\ntotal_size\x18\x03 \x01(\x05\x12\x19\n\x11\x61ttribution_token\x18\x04 \x01(\t\x12\x14\n\x0credirect_uri\x18\x0c \x01(\t\x12\x17\n\x0fnext_page_token\x18\x05 \x01(\t\x12\x17\n\x0f\x63orrected_query\x18\x07 \x01(\t\x12H\n\x07summary\x18\t \x01(\x0b\x32\x37.google.cloud.discoveryengine.v1.SearchResponse.Summary\x12`\n\x14query_expansion_info\x18\x0e \x01(\x0b\x32\x42.google.cloud.discoveryengine.v1.SearchResponse.QueryExpansionInfo\x12\x8d\x01\n)natural_language_query_understanding_info\x18\x0f \x01(\x0b\x32U.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfoB\x03\xe0\x41\x03\x12Q\n\x0csession_info\x18\x13 \x01(\x0b\x32;.google.cloud.discoveryengine.v1.SearchResponse.SessionInfo\x12T\n\x16search_link_promotions\x18\x17 \x03(\x0b\x32\x34.google.cloud.discoveryengine.v1.SearchLinkPromotion\x12Z\n\x0esemantic_state\x18$ \x01(\x0e\x32=.google.cloud.discoveryengine.v1.SearchResponse.SemanticStateB\x03\xe0\x41\x03\x1a\xa9\x08\n\x0cSearchResult\x12\n\n\x02id\x18\x01 \x01(\t\x12;\n\x08\x64ocument\x18\x02 \x01(\x0b\x32).google.cloud.discoveryengine.v1.Document\x12\x35\n\x05\x63hunk\x18\x12 \x01(\x0b\x32&.google.cloud.discoveryengine.v1.Chunk\x12h\n\x0cmodel_scores\x18\x04 \x03(\x0b\x32M.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.ModelScoresEntryB\x03\xe0\x41\x03\x12\x63\n\x0crank_signals\x18\x07 \x01(\x0b\x32H.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignalsB\x03\xe0\x41\x01\x1a\xe8\x04\n\x0bRankSignals\x12*\n\x18keyword_similarity_score\x18\x01 \x01(\x02\x42\x03\xe0\x41\x01H\x00\x88\x01\x01\x12!\n\x0frelevance_score\x18\x02 \x01(\x02\x42\x03\xe0\x41\x01H\x01\x88\x01\x01\x12+\n\x19semantic_similarity_score\x18\x03 \x01(\x02\x42\x03\xe0\x41\x01H\x02\x88\x01\x01\x12\x1b\n\tpctr_rank\x18\x04 \x01(\x02\x42\x03\xe0\x41\x01H\x03\x88\x01\x01\x12!\n\x0ftopicality_rank\x18\x06 \x01(\x02\x42\x03\xe0\x41\x01H\x04\x88\x01\x01\x12\x1e\n\x0c\x64ocument_age\x18\x07 \x01(\x02\x42\x03\xe0\x41\x01H\x05\x88\x01\x01\x12!\n\x0f\x62oosting_factor\x18\x08 \x01(\x02\x42\x03\xe0\x41\x01H\x06\x88\x01\x01\x12\x19\n\x0c\x64\x65\x66\x61ult_rank\x18 \x01(\x02\x42\x03\xe0\x41\x01\x12r\n\x0e\x63ustom_signals\x18! \x03(\x0b\x32U.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignalB\x03\xe0\x41\x01\x1a\x35\n\x0c\x43ustomSignal\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x01\x12\x12\n\x05value\x18\x02 \x01(\x02\x42\x03\xe0\x41\x01\x42\x1b\n\x19_keyword_similarity_scoreB\x12\n\x10_relevance_scoreB\x1c\n\x1a_semantic_similarity_scoreB\x0c\n\n_pctr_rankB\x12\n\x10_topicality_rankB\x0f\n\r_document_ageB\x12\n\x10_boosting_factor\x1a_\n\x10ModelScoresEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12:\n\x05value\x18\x02 \x01(\x0b\x32+.google.cloud.discoveryengine.v1.DoubleList:\x02\x38\x01\x1a\xf9\x01\n\x05\x46\x61\x63\x65t\x12\x0b\n\x03key\x18\x01 \x01(\t\x12P\n\x06values\x18\x02 \x03(\x0b\x32@.google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue\x12\x15\n\rdynamic_facet\x18\x03 \x01(\x08\x1az\n\nFacetValue\x12\x0f\n\x05value\x18\x01 \x01(\tH\x00\x12=\n\x08interval\x18\x02 \x01(\x0b\x32).google.cloud.discoveryengine.v1.IntervalH\x00\x12\r\n\x05\x63ount\x18\x03 \x01(\x03\x42\r\n\x0b\x66\x61\x63\x65t_value\x1a\xa1\x0c\n\x07Summary\x12\x14\n\x0csummary_text\x18\x01 \x01(\t\x12m\n\x17summary_skipped_reasons\x18\x02 \x03(\x0e\x32L.google.cloud.discoveryengine.v1.SearchResponse.Summary.SummarySkippedReason\x12\x63\n\x11safety_attributes\x18\x03 \x01(\x0b\x32H.google.cloud.discoveryengine.v1.SearchResponse.Summary.SafetyAttributes\x12j\n\x15summary_with_metadata\x18\x04 \x01(\x0b\x32K.google.cloud.discoveryengine.v1.SearchResponse.Summary.SummaryWithMetadata\x1a\x36\n\x10SafetyAttributes\x12\x12\n\ncategories\x18\x01 \x03(\t\x12\x0e\n\x06scores\x18\x02 \x03(\x02\x1ag\n\x10\x43itationMetadata\x12S\n\tcitations\x18\x01 \x03(\x0b\x32@.google.cloud.discoveryengine.v1.SearchResponse.Summary.Citation\x1a\x8b\x01\n\x08\x43itation\x12\x13\n\x0bstart_index\x18\x01 \x01(\x03\x12\x11\n\tend_index\x18\x02 \x01(\x03\x12W\n\x07sources\x18\x03 \x03(\x0b\x32\x46.google.cloud.discoveryengine.v1.SearchResponse.Summary.CitationSource\x1a)\n\x0e\x43itationSource\x12\x17\n\x0freference_index\x18\x04 \x01(\x03\x1a\x8c\x02\n\tReference\x12\r\n\x05title\x18\x01 \x01(\t\x12\x41\n\x08\x64ocument\x18\x02 \x01(\tB/\xe0\x41\x02\xfa\x41)\n\'discoveryengine.googleapis.com/Document\x12\x0b\n\x03uri\x18\x03 \x01(\t\x12\x66\n\x0e\x63hunk_contents\x18\x04 \x03(\x0b\x32N.google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent\x1a\x38\n\x0c\x43hunkContent\x12\x0f\n\x07\x63ontent\x18\x01 \x01(\t\x12\x17\n\x0fpage_identifier\x18\x02 \x01(\t\x1a\xe2\x01\n\x13SummaryWithMetadata\x12\x0f\n\x07summary\x18\x01 \x01(\t\x12\x63\n\x11\x63itation_metadata\x18\x02 \x01(\x0b\x32H.google.cloud.discoveryengine.v1.SearchResponse.Summary.CitationMetadata\x12U\n\nreferences\x18\x03 \x03(\x0b\x32\x41.google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference\"\xf1\x02\n\x14SummarySkippedReason\x12&\n\"SUMMARY_SKIPPED_REASON_UNSPECIFIED\x10\x00\x12\x1d\n\x19\x41\x44VERSARIAL_QUERY_IGNORED\x10\x01\x12%\n!NON_SUMMARY_SEEKING_QUERY_IGNORED\x10\x02\x12\x1f\n\x1bOUT_OF_DOMAIN_QUERY_IGNORED\x10\x03\x12\x1e\n\x1aPOTENTIAL_POLICY_VIOLATION\x10\x04\x12\x19\n\x15LLM_ADDON_NOT_ENABLED\x10\x05\x12\x17\n\x13NO_RELEVANT_CONTENT\x10\x06\x12\x1f\n\x1bJAIL_BREAKING_QUERY_IGNORED\x10\x07\x12\x1d\n\x19\x43USTOMER_POLICY_VIOLATION\x10\x08\x12(\n$NON_SUMMARY_SEEKING_QUERY_IGNORED_V2\x10\t\x12\x0c\n\x08TIME_OUT\x10\n\x1aI\n\x12QueryExpansionInfo\x12\x16\n\x0e\x65xpanded_query\x18\x01 \x01(\x08\x12\x1b\n\x13pinned_result_count\x18\x02 \x01(\x03\x1a\xf3\x10\n%NaturalLanguageQueryUnderstandingInfo\x12\x19\n\x11\x65xtracted_filters\x18\x01 \x01(\t\x12\x17\n\x0frewritten_query\x18\x02 \x01(\t\x12\x1a\n\x12\x63lassified_intents\x18\x05 \x03(\t\x12\x94\x01\n\x1bstructured_extracted_filter\x18\x03 \x01(\x0b\x32o.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter\x1a\xe2\x0e\n\x19StructuredExtractedFilter\x12\x8e\x01\n\nexpression\x18\x01 \x01(\x0b\x32z.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.Expression\x1aM\n\x10StringConstraint\x12\x12\n\nfield_name\x18\x01 \x01(\t\x12\x0e\n\x06values\x18\x02 \x03(\t\x12\x15\n\rquery_segment\x18\x03 \x01(\t\x1a\xf6\x02\n\x10NumberConstraint\x12\x12\n\nfield_name\x18\x01 \x01(\t\x12\xa0\x01\n\ncomparison\x18\x02 \x01(\x0e\x32\x8b\x01.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.NumberConstraint.Comparison\x12\r\n\x05value\x18\x03 \x01(\x01\x12\x15\n\rquery_segment\x18\x04 \x01(\t\"\x84\x01\n\nComparison\x12\x1a\n\x16\x43OMPARISON_UNSPECIFIED\x10\x00\x12\n\n\x06\x45QUALS\x10\x01\x12\x14\n\x10LESS_THAN_EQUALS\x10\x02\x12\r\n\tLESS_THAN\x10\x03\x12\x17\n\x13GREATER_THAN_EQUALS\x10\x04\x12\x10\n\x0cGREATER_THAN\x10\x05\x1a{\n\x15GeolocationConstraint\x12\x12\n\nfield_name\x18\x01 \x01(\t\x12\x0f\n\x07\x61\x64\x64ress\x18\x02 \x01(\t\x12\x10\n\x08latitude\x18\x04 \x01(\x01\x12\x11\n\tlongitude\x18\x05 \x01(\x01\x12\x18\n\x10radius_in_meters\x18\x03 \x01(\x02\x1a\xa1\x01\n\rAndExpression\x12\x8f\x01\n\x0b\x65xpressions\x18\x01 \x03(\x0b\x32z.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.Expression\x1a\xa0\x01\n\x0cOrExpression\x12\x8f\x01\n\x0b\x65xpressions\x18\x01 \x03(\x0b\x32z.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.Expression\x1a\xa7\x06\n\nExpression\x12\x9e\x01\n\x11string_constraint\x18\x01 \x01(\x0b\x32\x80\x01.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.StringConstraintH\x00\x12\x9e\x01\n\x11number_constraint\x18\x02 \x01(\x0b\x32\x80\x01.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.NumberConstraintH\x00\x12\xa8\x01\n\x16geolocation_constraint\x18\x03 \x01(\x0b\x32\x85\x01.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.GeolocationConstraintH\x00\x12\x91\x01\n\x08\x61nd_expr\x18\x04 \x01(\x0b\x32}.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.AndExpressionH\x00\x12\x8f\x01\n\x07or_expr\x18\x05 \x01(\x0b\x32|.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.OrExpressionH\x00\x42\x06\n\x04\x65xpr\x1a-\n\x0bSessionInfo\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x10\n\x08query_id\x18\x02 \x01(\t\"J\n\rSemanticState\x12\x1e\n\x1aSEMANTIC_STATE_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x44ISABLED\x10\x01\x12\x0b\n\x07\x45NABLED\x10\x02\x32\x97\x07\n\rSearchService\x12\x8f\x03\n\x06Search\x12..google.cloud.discoveryengine.v1.SearchRequest\x1a/.google.cloud.discoveryengine.v1.SearchResponse\"\xa3\x02\x82\xd3\xe4\x93\x02\x9c\x02\"P/v1/{serving_config=projects/*/locations/*/dataStores/*/servingConfigs/*}:search:\x01*Zc\"^/v1/{serving_config=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:search:\x01*Z`\"[/v1/{serving_config=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:search:\x01*\x12\x9f\x03\n\nSearchLite\x12..google.cloud.discoveryengine.v1.SearchRequest\x1a/.google.cloud.discoveryengine.v1.SearchResponse\"\xaf\x02\x82\xd3\xe4\x93\x02\xa8\x02\"T/v1/{serving_config=projects/*/locations/*/dataStores/*/servingConfigs/*}:searchLite:\x01*Zg\"b/v1/{serving_config=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:searchLite:\x01*Zd\"_/v1/{serving_config=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:searchLite:\x01*\x1aR\xca\x41\x1e\x64iscoveryengine.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\x85\x02\n#com.google.cloud.discoveryengine.v1B\x12SearchServiceProtoP\x01ZMcloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb\xa2\x02\x0f\x44ISCOVERYENGINE\xaa\x02\x1fGoogle.Cloud.DiscoveryEngine.V1\xca\x02\x1fGoogle\\Cloud\\DiscoveryEngine\\V1\xea\x02\"Google::Cloud::DiscoveryEngine::V1b\x06proto3"
|
|
17
|
+
descriptor_data = "\n4google/cloud/discoveryengine/v1/search_service.proto\x12\x1fgoogle.cloud.discoveryengine.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a+google/cloud/discoveryengine/v1/chunk.proto\x1a,google/cloud/discoveryengine/v1/common.proto\x1a.google/cloud/discoveryengine/v1/document.proto\x1a\x1cgoogle/protobuf/struct.proto\"\xc8\x45\n\rSearchRequest\x12L\n\x0eserving_config\x18\x01 \x01(\tB4\xe0\x41\x02\xfa\x41.\n,discoveryengine.googleapis.com/ServingConfig\x12:\n\x06\x62ranch\x18\x02 \x01(\tB*\xfa\x41\'\n%discoveryengine.googleapis.com/Branch\x12\r\n\x05query\x18\x03 \x01(\t\x12\x1c\n\x0fpage_categories\x18? \x03(\tB\x03\xe0\x41\x01\x12N\n\x0bimage_query\x18\x13 \x01(\x0b\x32\x39.google.cloud.discoveryengine.v1.SearchRequest.ImageQuery\x12\x11\n\tpage_size\x18\x04 \x01(\x05\x12\x12\n\npage_token\x18\x05 \x01(\t\x12\x0e\n\x06offset\x18\x06 \x01(\x05\x12\x19\n\x11one_box_page_size\x18/ \x01(\x05\x12V\n\x10\x64\x61ta_store_specs\x18 \x03(\x0b\x32<.google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec\x12\'\n\x1anum_results_per_data_store\x18\x41 \x01(\x05\x42\x03\xe0\x41\x01\x12\x0e\n\x06\x66ilter\x18\x07 \x01(\t\x12\x18\n\x10\x63\x61nonical_filter\x18\x1d \x01(\t\x12\x10\n\x08order_by\x18\x08 \x01(\t\x12<\n\tuser_info\x18\x15 \x01(\x0b\x32).google.cloud.discoveryengine.v1.UserInfo\x12\x15\n\rlanguage_code\x18# \x01(\t\x12M\n\x0b\x66\x61\x63\x65t_specs\x18\t \x03(\x0b\x32\x38.google.cloud.discoveryengine.v1.SearchRequest.FacetSpec\x12L\n\nboost_spec\x18\n \x01(\x0b\x32\x38.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec\x12J\n\x06params\x18\x0b \x03(\x0b\x32:.google.cloud.discoveryengine.v1.SearchRequest.ParamsEntry\x12_\n\x14query_expansion_spec\x18\r \x01(\x0b\x32\x41.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec\x12\x61\n\x15spell_correction_spec\x18\x0e \x01(\x0b\x32\x42.google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec\x12\x1b\n\x0euser_pseudo_id\x18\x0f \x01(\tB\x03\xe0\x41\x01\x12]\n\x13\x63ontent_search_spec\x18\x18 \x01(\x0b\x32@.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec\x12\x1f\n\x12ranking_expression\x18\x1a \x01(\tB\x03\xe0\x41\x01\x12p\n\x1aranking_expression_backend\x18\x35 \x01(\x0e\x32G.google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackendB\x03\xe0\x41\x01\x12\x13\n\x0bsafe_search\x18\x14 \x01(\x08\x12S\n\x0buser_labels\x18\x16 \x03(\x0b\x32>.google.cloud.discoveryengine.v1.SearchRequest.UserLabelsEntry\x12\x8c\x01\n)natural_language_query_understanding_spec\x18\x1c \x01(\x0b\x32T.google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpecB\x03\xe0\x41\x01\x12\x63\n\x17search_as_you_type_spec\x18\x1f \x01(\x0b\x32\x42.google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec\x12U\n\x0c\x64isplay_spec\x18& \x01(\x0b\x32:.google.cloud.discoveryengine.v1.SearchRequest.DisplaySpecB\x03\xe0\x41\x01\x12X\n\x0e\x63rowding_specs\x18( \x03(\x0b\x32;.google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpecB\x03\xe0\x41\x01\x12<\n\x07session\x18) \x01(\tB+\xfa\x41(\n&discoveryengine.googleapis.com/Session\x12P\n\x0csession_spec\x18* \x01(\x0b\x32:.google.cloud.discoveryengine.v1.SearchRequest.SessionSpec\x12^\n\x13relevance_threshold\x18, \x01(\x0e\x32\x41.google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold\x12\x66\n\x15relevance_filter_spec\x18V \x01(\x0b\x32\x42.google.cloud.discoveryengine.v1.SearchRequest.RelevanceFilterSpecB\x03\xe0\x41\x01\x12\x64\n\x14relevance_score_spec\x18\x34 \x01(\x0b\x32\x41.google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpecB\x03\xe0\x41\x01\x12^\n\x11search_addon_spec\x18> \x01(\x0b\x32>.google.cloud.discoveryengine.v1.SearchRequest.SearchAddonSpecB\x03\xe0\x41\x01\x12\x66\n\x15\x63ustom_ranking_params\x18@ \x01(\x0b\x32\x42.google.cloud.discoveryengine.v1.SearchRequest.CustomRankingParamsB\x03\xe0\x41\x01\x12\x13\n\x06\x65ntity\x18\x42 \x01(\tB\x03\xe0\x41\x01\x1a,\n\nImageQuery\x12\x15\n\x0bimage_bytes\x18\x01 \x01(\tH\x00\x42\x07\n\x05image\x1a\xfd\x01\n\rDataStoreSpec\x12\x44\n\ndata_store\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(discoveryengine.googleapis.com/DataStore\x12\x13\n\x06\x66ilter\x18\x05 \x01(\tB\x03\xe0\x41\x01\x12Q\n\nboost_spec\x18\x06 \x01(\x0b\x32\x38.google.cloud.discoveryengine.v1.SearchRequest.BoostSpecB\x03\xe0\x41\x01\x12$\n\x17\x63ustom_search_operators\x18\x07 \x01(\tB\x03\xe0\x41\x01\x12\x18\n\x0bnum_results\x18\t \x01(\x05\x42\x03\xe0\x41\x01\x1a\xfc\x02\n\tFacetSpec\x12Y\n\tfacet_key\x18\x01 \x01(\x0b\x32\x41.google.cloud.discoveryengine.v1.SearchRequest.FacetSpec.FacetKeyB\x03\xe0\x41\x02\x12\r\n\x05limit\x18\x02 \x01(\x05\x12\x1c\n\x14\x65xcluded_filter_keys\x18\x03 \x03(\t\x12\x1f\n\x17\x65nable_dynamic_position\x18\x04 \x01(\x08\x1a\xc5\x01\n\x08\x46\x61\x63\x65tKey\x12\x10\n\x03key\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12<\n\tintervals\x18\x02 \x03(\x0b\x32).google.cloud.discoveryengine.v1.Interval\x12\x19\n\x11restricted_values\x18\x03 \x03(\t\x12\x10\n\x08prefixes\x18\x04 \x03(\t\x12\x10\n\x08\x63ontains\x18\x05 \x03(\t\x12\x18\n\x10\x63\x61se_insensitive\x18\x06 \x01(\x08\x12\x10\n\x08order_by\x18\x07 \x01(\t\x1a\xbc\x07\n\tBoostSpec\x12j\n\x15\x63ondition_boost_specs\x18\x01 \x03(\x0b\x32K.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec\x1a\xc2\x06\n\x12\x43onditionBoostSpec\x12\x11\n\tcondition\x18\x01 \x01(\t\x12\r\n\x05\x62oost\x18\x02 \x01(\x02\x12x\n\x12\x62oost_control_spec\x18\x03 \x01(\x0b\x32\\.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec\x1a\x8f\x05\n\x10\x42oostControlSpec\x12\x12\n\nfield_name\x18\x01 \x01(\t\x12\x82\x01\n\x0e\x61ttribute_type\x18\x02 \x01(\x0e\x32j.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType\x12\x8a\x01\n\x12interpolation_type\x18\x03 \x01(\x0e\x32n.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType\x12\x81\x01\n\x0e\x63ontrol_points\x18\x04 \x03(\x0b\x32i.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint\x1a=\n\x0c\x43ontrolPoint\x12\x17\n\x0f\x61ttribute_value\x18\x01 \x01(\t\x12\x14\n\x0c\x62oost_amount\x18\x02 \x01(\x02\"M\n\rAttributeType\x12\x1e\n\x1a\x41TTRIBUTE_TYPE_UNSPECIFIED\x10\x00\x12\r\n\tNUMERICAL\x10\x01\x12\r\n\tFRESHNESS\x10\x02\"C\n\x11InterpolationType\x12\"\n\x1eINTERPOLATION_TYPE_UNSPECIFIED\x10\x00\x12\n\n\x06LINEAR\x10\x01\x1a\xd4\x01\n\x12QueryExpansionSpec\x12^\n\tcondition\x18\x01 \x01(\x0e\x32K.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.Condition\x12\x1e\n\x16pin_unexpanded_results\x18\x02 \x01(\x08\">\n\tCondition\x12\x19\n\x15\x43ONDITION_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x44ISABLED\x10\x01\x12\x08\n\x04\x41UTO\x10\x02\x1a\xa9\x01\n\x13SpellCorrectionSpec\x12U\n\x04mode\x18\x01 \x01(\x0e\x32G.google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec.Mode\";\n\x04Mode\x12\x14\n\x10MODE_UNSPECIFIED\x10\x00\x12\x13\n\x0fSUGGESTION_ONLY\x10\x01\x12\x08\n\x04\x41UTO\x10\x02\x1a\xa2\x0c\n\x11\x43ontentSearchSpec\x12\x62\n\x0csnippet_spec\x18\x01 \x01(\x0b\x32L.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec\x12\x62\n\x0csummary_spec\x18\x02 \x01(\x0b\x32L.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec\x12w\n\x17\x65xtractive_content_spec\x18\x03 \x01(\x0b\x32V.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec\x12m\n\x12search_result_mode\x18\x04 \x01(\x0e\x32Q.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode\x12^\n\nchunk_spec\x18\x05 \x01(\x0b\x32J.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ChunkSpec\x1a`\n\x0bSnippetSpec\x12\x1d\n\x11max_snippet_count\x18\x01 \x01(\x05\x42\x02\x18\x01\x12\x1a\n\x0ereference_only\x18\x02 \x01(\x08\x42\x02\x18\x01\x12\x16\n\x0ereturn_snippet\x18\x03 \x01(\x08\x1a\xbc\x04\n\x0bSummarySpec\x12\x1c\n\x14summary_result_count\x18\x01 \x01(\x05\x12\x19\n\x11include_citations\x18\x02 \x01(\x08\x12 \n\x18ignore_adversarial_query\x18\x03 \x01(\x08\x12(\n ignore_non_summary_seeking_query\x18\x04 \x01(\x08\x12#\n\x1bignore_low_relevant_content\x18\t \x01(\x08\x12\'\n\x1aignore_jail_breaking_query\x18\n \x01(\x08\x42\x03\xe0\x41\x01\x12w\n\x11model_prompt_spec\x18\x05 \x01(\x0b\x32\\.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec\x12\x15\n\rlanguage_code\x18\x06 \x01(\t\x12j\n\nmodel_spec\x18\x07 \x01(\x0b\x32V.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec\x12\x1b\n\x13use_semantic_chunks\x18\x08 \x01(\x08\x1a#\n\x0fModelPromptSpec\x12\x10\n\x08preamble\x18\x01 \x01(\t\x1a\x1c\n\tModelSpec\x12\x0f\n\x07version\x18\x01 \x01(\t\x1a\xc5\x01\n\x15\x45xtractiveContentSpec\x12#\n\x1bmax_extractive_answer_count\x18\x01 \x01(\x05\x12$\n\x1cmax_extractive_segment_count\x18\x02 \x01(\x05\x12\'\n\x1freturn_extractive_segment_score\x18\x03 \x01(\x08\x12\x1d\n\x15num_previous_segments\x18\x04 \x01(\x05\x12\x19\n\x11num_next_segments\x18\x05 \x01(\x05\x1a\x41\n\tChunkSpec\x12\x1b\n\x13num_previous_chunks\x18\x01 \x01(\x05\x12\x17\n\x0fnum_next_chunks\x18\x02 \x01(\x05\"Q\n\x10SearchResultMode\x12\"\n\x1eSEARCH_RESULT_MODE_UNSPECIFIED\x10\x00\x12\r\n\tDOCUMENTS\x10\x01\x12\n\n\x06\x43HUNKS\x10\x02\x1a\xe0\x04\n%NaturalLanguageQueryUnderstandingSpec\x12\x93\x01\n\x1b\x66ilter_extraction_condition\x18\x01 \x01(\x0e\x32n.google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition\x12.\n&geo_search_query_detection_field_names\x18\x02 \x03(\t\x12\x94\x01\n\x19\x65xtracted_filter_behavior\x18\x03 \x01(\x0e\x32l.google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehaviorB\x03\xe0\x41\x01\x12 \n\x13\x61llowed_field_names\x18\x04 \x03(\tB\x03\xe0\x41\x01\"Q\n\x19\x46ilterExtractionCondition\x12\x19\n\x15\x43ONDITION_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x44ISABLED\x10\x01\x12\x0b\n\x07\x45NABLED\x10\x02\"e\n\x17\x45xtractedFilterBehavior\x12)\n%EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED\x10\x00\x12\x0f\n\x0bHARD_FILTER\x10\x01\x12\x0e\n\nSOFT_BOOST\x10\x02\x1a\x99\x03\n\x13SearchAsYouTypeSpec\x12_\n\tcondition\x18\x01 \x01(\x0e\x32L.google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition\x12]\n\x06\x66ields\x18\x02 \x03(\x0b\x32H.google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.FieldB\x03\xe0\x41\x01\x12!\n\x0fscore_threshold\x18\x03 \x01(\x01\x42\x03\xe0\x41\x01H\x00\x88\x01\x01\x1a>\n\x05\x46ield\x12\x10\n\x03key\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12\x18\n\x06weight\x18\x02 \x01(\x01\x42\x03\xe0\x41\x01H\x00\x88\x01\x01\x42\t\n\x07_weight\"K\n\tCondition\x12\x19\n\x15\x43ONDITION_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x44ISABLED\x10\x01\x12\x0b\n\x07\x45NABLED\x10\x02\x12\x08\n\x04\x41UTO\x10\x03\x42\x12\n\x10_score_threshold\x1a\x98\x02\n\x0b\x44isplaySpec\x12{\n\x1cmatch_highlighting_condition\x18\x01 \x01(\x0e\x32U.google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec.MatchHighlightingCondition\"\x8b\x01\n\x1aMatchHighlightingCondition\x12,\n(MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED\x10\x00\x12\x1f\n\x1bMATCH_HIGHLIGHTING_DISABLED\x10\x01\x12\x1e\n\x1aMATCH_HIGHLIGHTING_ENABLED\x10\x02\x1a\xdb\x01\n\x0c\x43rowdingSpec\x12\r\n\x05\x66ield\x18\x01 \x01(\t\x12\x11\n\tmax_count\x18\x02 \x01(\x05\x12N\n\x04mode\x18\x03 \x01(\x0e\x32@.google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec.Mode\"Y\n\x04Mode\x12\x14\n\x10MODE_UNSPECIFIED\x10\x00\x12\x18\n\x14\x44ROP_CROWDED_RESULTS\x10\x01\x12!\n\x1d\x44\x45MOTE_CROWDED_RESULTS_TO_END\x10\x02\x1aq\n\x0bSessionSpec\x12\x10\n\x08query_id\x18\x01 \x01(\t\x12,\n\x1fsearch_result_persistence_count\x18\x02 \x01(\x05H\x00\x88\x01\x01\x42\"\n _search_result_persistence_count\x1a\xdd\x03\n\x13RelevanceFilterSpec\x12\x80\x01\n\x18keyword_search_threshold\x18\x01 \x01(\x0b\x32Y.google.cloud.discoveryengine.v1.SearchRequest.RelevanceFilterSpec.RelevanceThresholdSpecB\x03\xe0\x41\x01\x12\x81\x01\n\x19semantic_search_threshold\x18\x02 \x01(\x0b\x32Y.google.cloud.discoveryengine.v1.SearchRequest.RelevanceFilterSpec.RelevanceThresholdSpecB\x03\xe0\x41\x01\x1a\xbe\x01\n\x16RelevanceThresholdSpec\x12`\n\x13relevance_threshold\x18\x01 \x01(\x0e\x32\x41.google.cloud.discoveryengine.v1.SearchRequest.RelevanceThresholdH\x00\x12&\n\x1csemantic_relevance_threshold\x18\x02 \x01(\x02H\x00\x42\x1a\n\x18relevance_threshold_spec\x1a\x39\n\x12RelevanceScoreSpec\x12#\n\x16return_relevance_score\x18\x01 \x01(\x08\x42\x03\xe0\x41\x01\x1a\x97\x01\n\x0fSearchAddonSpec\x12$\n\x17\x64isable_semantic_add_on\x18\x01 \x01(\x08\x42\x03\xe0\x41\x01\x12/\n\"disable_kpi_personalization_add_on\x18\x02 \x01(\x08\x42\x03\xe0\x41\x01\x12-\n disable_generative_answer_add_on\x18\x03 \x01(\x08\x42\x03\xe0\x41\x01\x1a=\n\x13\x43ustomRankingParams\x12&\n\x19\x65xpressions_to_precompute\x18\x01 \x03(\tB\x03\xe0\x41\x01\x1a\x45\n\x0bParamsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12%\n\x05value\x18\x02 \x01(\x0b\x32\x16.google.protobuf.Value:\x02\x38\x01\x1a\x31\n\x0fUserLabelsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"\x92\x01\n\x18RankingExpressionBackend\x12*\n&RANKING_EXPRESSION_BACKEND_UNSPECIFIED\x10\x00\x12\x0c\n\x04\x42YOE\x10\x01\x1a\x02\x08\x01\x12\x10\n\x08\x43LEARBOX\x10\x02\x1a\x02\x08\x01\x12\x15\n\x11RANK_BY_EMBEDDING\x10\x03\x12\x13\n\x0fRANK_BY_FORMULA\x10\x04\"d\n\x12RelevanceThreshold\x12#\n\x1fRELEVANCE_THRESHOLD_UNSPECIFIED\x10\x00\x12\n\n\x06LOWEST\x10\x01\x12\x07\n\x03LOW\x10\x02\x12\n\n\x06MEDIUM\x10\x03\x12\x08\n\x04HIGH\x10\x04\"\xe4\x33\n\x0eSearchResponse\x12M\n\x07results\x18\x01 \x03(\x0b\x32<.google.cloud.discoveryengine.v1.SearchResponse.SearchResult\x12\x45\n\x06\x66\x61\x63\x65ts\x18\x02 \x03(\x0b\x32\x35.google.cloud.discoveryengine.v1.SearchResponse.Facet\x12\x12\n\ntotal_size\x18\x03 \x01(\x05\x12\x19\n\x11\x61ttribution_token\x18\x04 \x01(\t\x12\x14\n\x0credirect_uri\x18\x0c \x01(\t\x12\x17\n\x0fnext_page_token\x18\x05 \x01(\t\x12\x17\n\x0f\x63orrected_query\x18\x07 \x01(\t\x12H\n\x07summary\x18\t \x01(\x0b\x32\x37.google.cloud.discoveryengine.v1.SearchResponse.Summary\x12H\n\x10\x61pplied_controls\x18\n \x03(\tB.\xe0\x41\x01\xfa\x41(\n&discoveryengine.googleapis.com/Control\x12`\n\x14query_expansion_info\x18\x0e \x01(\x0b\x32\x42.google.cloud.discoveryengine.v1.SearchResponse.QueryExpansionInfo\x12\x8d\x01\n)natural_language_query_understanding_info\x18\x0f \x01(\x0b\x32U.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfoB\x03\xe0\x41\x03\x12Q\n\x0csession_info\x18\x13 \x01(\x0b\x32;.google.cloud.discoveryengine.v1.SearchResponse.SessionInfo\x12T\n\x16search_link_promotions\x18\x17 \x03(\x0b\x32\x34.google.cloud.discoveryengine.v1.SearchLinkPromotion\x12Z\n\x0esemantic_state\x18$ \x01(\x0e\x32=.google.cloud.discoveryengine.v1.SearchResponse.SemanticStateB\x03\xe0\x41\x03\x1a\xdd\x0b\n\x0cSearchResult\x12\n\n\x02id\x18\x01 \x01(\t\x12;\n\x08\x64ocument\x18\x02 \x01(\x0b\x32).google.cloud.discoveryengine.v1.Document\x12\x35\n\x05\x63hunk\x18\x12 \x01(\x0b\x32&.google.cloud.discoveryengine.v1.Chunk\x12h\n\x0cmodel_scores\x18\x04 \x03(\x0b\x32M.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.ModelScoresEntryB\x03\xe0\x41\x03\x12\x63\n\x0crank_signals\x18\x07 \x01(\x0b\x32H.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignalsB\x03\xe0\x41\x01\x12m\n\x11retrieval_signals\x18\x0b \x01(\x0b\x32M.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignalsB\x03\xe0\x41\x01\x1a\x94\x05\n\x0bRankSignals\x12*\n\x18keyword_similarity_score\x18\x01 \x01(\x02\x42\x03\xe0\x41\x01H\x00\x88\x01\x01\x12!\n\x0frelevance_score\x18\x02 \x01(\x02\x42\x03\xe0\x41\x01H\x01\x88\x01\x01\x12+\n\x19semantic_similarity_score\x18\x03 \x01(\x02\x42\x03\xe0\x41\x01H\x02\x88\x01\x01\x12\x1b\n\tpctr_rank\x18\x04 \x01(\x02\x42\x03\xe0\x41\x01H\x03\x88\x01\x01\x12!\n\x0ftopicality_rank\x18\x06 \x01(\x02\x42\x03\xe0\x41\x01H\x04\x88\x01\x01\x12\x1e\n\x0c\x64ocument_age\x18\x07 \x01(\x02\x42\x03\xe0\x41\x01H\x05\x88\x01\x01\x12!\n\x0f\x62oosting_factor\x18\x08 \x01(\x02\x42\x03\xe0\x41\x01H\x06\x88\x01\x01\x12\x19\n\x0c\x64\x65\x66\x61ult_rank\x18 \x01(\x02\x42\x03\xe0\x41\x01\x12r\n\x0e\x63ustom_signals\x18! \x03(\x0b\x32U.google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignalB\x03\xe0\x41\x01\x12*\n\x1dprecomputed_expression_values\x18\" \x03(\x02\x42\x03\xe0\x41\x01\x1a\x35\n\x0c\x43ustomSignal\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x01\x12\x12\n\x05value\x18\x02 \x01(\x02\x42\x03\xe0\x41\x01\x42\x1b\n\x19_keyword_similarity_scoreB\x12\n\x10_relevance_scoreB\x1c\n\x1a_semantic_similarity_scoreB\x0c\n\n_pctr_rankB\x12\n\x10_topicality_rankB\x0f\n\r_document_ageB\x12\n\x10_boosting_factor\x1a\x96\x02\n\x10RetrievalSignals\x12}\n\x11retrieval_sources\x18\x01 \x03(\x0e\x32].google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSourceB\x03\xe0\x41\x01\x12%\n\x18semantic_relevance_score\x18\x02 \x01(\x02\x42\x03\xe0\x41\x01\"\\\n\x0fRetrievalSource\x12 \n\x1cRETRIEVAL_SOURCE_UNSPECIFIED\x10\x00\x12\x12\n\x0eKEYWORD_SEARCH\x10\x01\x12\x13\n\x0fSEMANTIC_SEARCH\x10\x02\x1a_\n\x10ModelScoresEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12:\n\x05value\x18\x02 \x01(\x0b\x32+.google.cloud.discoveryengine.v1.DoubleList:\x02\x38\x01\x1a\xf9\x01\n\x05\x46\x61\x63\x65t\x12\x0b\n\x03key\x18\x01 \x01(\t\x12P\n\x06values\x18\x02 \x03(\x0b\x32@.google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue\x12\x15\n\rdynamic_facet\x18\x03 \x01(\x08\x1az\n\nFacetValue\x12\x0f\n\x05value\x18\x01 \x01(\tH\x00\x12=\n\x08interval\x18\x02 \x01(\x0b\x32).google.cloud.discoveryengine.v1.IntervalH\x00\x12\r\n\x05\x63ount\x18\x03 \x01(\x03\x42\r\n\x0b\x66\x61\x63\x65t_value\x1a\xa1\x0c\n\x07Summary\x12\x14\n\x0csummary_text\x18\x01 \x01(\t\x12m\n\x17summary_skipped_reasons\x18\x02 \x03(\x0e\x32L.google.cloud.discoveryengine.v1.SearchResponse.Summary.SummarySkippedReason\x12\x63\n\x11safety_attributes\x18\x03 \x01(\x0b\x32H.google.cloud.discoveryengine.v1.SearchResponse.Summary.SafetyAttributes\x12j\n\x15summary_with_metadata\x18\x04 \x01(\x0b\x32K.google.cloud.discoveryengine.v1.SearchResponse.Summary.SummaryWithMetadata\x1a\x36\n\x10SafetyAttributes\x12\x12\n\ncategories\x18\x01 \x03(\t\x12\x0e\n\x06scores\x18\x02 \x03(\x02\x1ag\n\x10\x43itationMetadata\x12S\n\tcitations\x18\x01 \x03(\x0b\x32@.google.cloud.discoveryengine.v1.SearchResponse.Summary.Citation\x1a\x8b\x01\n\x08\x43itation\x12\x13\n\x0bstart_index\x18\x01 \x01(\x03\x12\x11\n\tend_index\x18\x02 \x01(\x03\x12W\n\x07sources\x18\x03 \x03(\x0b\x32\x46.google.cloud.discoveryengine.v1.SearchResponse.Summary.CitationSource\x1a)\n\x0e\x43itationSource\x12\x17\n\x0freference_index\x18\x04 \x01(\x03\x1a\x8c\x02\n\tReference\x12\r\n\x05title\x18\x01 \x01(\t\x12\x41\n\x08\x64ocument\x18\x02 \x01(\tB/\xe0\x41\x02\xfa\x41)\n\'discoveryengine.googleapis.com/Document\x12\x0b\n\x03uri\x18\x03 \x01(\t\x12\x66\n\x0e\x63hunk_contents\x18\x04 \x03(\x0b\x32N.google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent\x1a\x38\n\x0c\x43hunkContent\x12\x0f\n\x07\x63ontent\x18\x01 \x01(\t\x12\x17\n\x0fpage_identifier\x18\x02 \x01(\t\x1a\xe2\x01\n\x13SummaryWithMetadata\x12\x0f\n\x07summary\x18\x01 \x01(\t\x12\x63\n\x11\x63itation_metadata\x18\x02 \x01(\x0b\x32H.google.cloud.discoveryengine.v1.SearchResponse.Summary.CitationMetadata\x12U\n\nreferences\x18\x03 \x03(\x0b\x32\x41.google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference\"\xf1\x02\n\x14SummarySkippedReason\x12&\n\"SUMMARY_SKIPPED_REASON_UNSPECIFIED\x10\x00\x12\x1d\n\x19\x41\x44VERSARIAL_QUERY_IGNORED\x10\x01\x12%\n!NON_SUMMARY_SEEKING_QUERY_IGNORED\x10\x02\x12\x1f\n\x1bOUT_OF_DOMAIN_QUERY_IGNORED\x10\x03\x12\x1e\n\x1aPOTENTIAL_POLICY_VIOLATION\x10\x04\x12\x19\n\x15LLM_ADDON_NOT_ENABLED\x10\x05\x12\x17\n\x13NO_RELEVANT_CONTENT\x10\x06\x12\x1f\n\x1bJAIL_BREAKING_QUERY_IGNORED\x10\x07\x12\x1d\n\x19\x43USTOMER_POLICY_VIOLATION\x10\x08\x12(\n$NON_SUMMARY_SEEKING_QUERY_IGNORED_V2\x10\t\x12\x0c\n\x08TIME_OUT\x10\n\x1aI\n\x12QueryExpansionInfo\x12\x16\n\x0e\x65xpanded_query\x18\x01 \x01(\x08\x12\x1b\n\x13pinned_result_count\x18\x02 \x01(\x03\x1a\xf3\x10\n%NaturalLanguageQueryUnderstandingInfo\x12\x19\n\x11\x65xtracted_filters\x18\x01 \x01(\t\x12\x17\n\x0frewritten_query\x18\x02 \x01(\t\x12\x1a\n\x12\x63lassified_intents\x18\x05 \x03(\t\x12\x94\x01\n\x1bstructured_extracted_filter\x18\x03 \x01(\x0b\x32o.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter\x1a\xe2\x0e\n\x19StructuredExtractedFilter\x12\x8e\x01\n\nexpression\x18\x01 \x01(\x0b\x32z.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.Expression\x1aM\n\x10StringConstraint\x12\x12\n\nfield_name\x18\x01 \x01(\t\x12\x0e\n\x06values\x18\x02 \x03(\t\x12\x15\n\rquery_segment\x18\x03 \x01(\t\x1a\xf6\x02\n\x10NumberConstraint\x12\x12\n\nfield_name\x18\x01 \x01(\t\x12\xa0\x01\n\ncomparison\x18\x02 \x01(\x0e\x32\x8b\x01.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.NumberConstraint.Comparison\x12\r\n\x05value\x18\x03 \x01(\x01\x12\x15\n\rquery_segment\x18\x04 \x01(\t\"\x84\x01\n\nComparison\x12\x1a\n\x16\x43OMPARISON_UNSPECIFIED\x10\x00\x12\n\n\x06\x45QUALS\x10\x01\x12\x14\n\x10LESS_THAN_EQUALS\x10\x02\x12\r\n\tLESS_THAN\x10\x03\x12\x17\n\x13GREATER_THAN_EQUALS\x10\x04\x12\x10\n\x0cGREATER_THAN\x10\x05\x1a{\n\x15GeolocationConstraint\x12\x12\n\nfield_name\x18\x01 \x01(\t\x12\x0f\n\x07\x61\x64\x64ress\x18\x02 \x01(\t\x12\x10\n\x08latitude\x18\x04 \x01(\x01\x12\x11\n\tlongitude\x18\x05 \x01(\x01\x12\x18\n\x10radius_in_meters\x18\x03 \x01(\x02\x1a\xa1\x01\n\rAndExpression\x12\x8f\x01\n\x0b\x65xpressions\x18\x01 \x03(\x0b\x32z.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.Expression\x1a\xa0\x01\n\x0cOrExpression\x12\x8f\x01\n\x0b\x65xpressions\x18\x01 \x03(\x0b\x32z.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.Expression\x1a\xa7\x06\n\nExpression\x12\x9e\x01\n\x11string_constraint\x18\x01 \x01(\x0b\x32\x80\x01.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.StringConstraintH\x00\x12\x9e\x01\n\x11number_constraint\x18\x02 \x01(\x0b\x32\x80\x01.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.NumberConstraintH\x00\x12\xa8\x01\n\x16geolocation_constraint\x18\x03 \x01(\x0b\x32\x85\x01.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.GeolocationConstraintH\x00\x12\x91\x01\n\x08\x61nd_expr\x18\x04 \x01(\x0b\x32}.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.AndExpressionH\x00\x12\x8f\x01\n\x07or_expr\x18\x05 \x01(\x0b\x32|.google.cloud.discoveryengine.v1.SearchResponse.NaturalLanguageQueryUnderstandingInfo.StructuredExtractedFilter.OrExpressionH\x00\x42\x06\n\x04\x65xpr\x1a-\n\x0bSessionInfo\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x10\n\x08query_id\x18\x02 \x01(\t\"J\n\rSemanticState\x12\x1e\n\x1aSEMANTIC_STATE_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x44ISABLED\x10\x01\x12\x0b\n\x07\x45NABLED\x10\x02\x32\xd6\x08\n\rSearchService\x12\x8f\x03\n\x06Search\x12..google.cloud.discoveryengine.v1.SearchRequest\x1a/.google.cloud.discoveryengine.v1.SearchResponse\"\xa3\x02\x82\xd3\xe4\x93\x02\x9c\x02\"P/v1/{serving_config=projects/*/locations/*/dataStores/*/servingConfigs/*}:search:\x01*Zc\"^/v1/{serving_config=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:search:\x01*Z`\"[/v1/{serving_config=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:search:\x01*\x12\x9f\x03\n\nSearchLite\x12..google.cloud.discoveryengine.v1.SearchRequest\x1a/.google.cloud.discoveryengine.v1.SearchResponse\"\xaf\x02\x82\xd3\xe4\x93\x02\xa8\x02\"T/v1/{serving_config=projects/*/locations/*/dataStores/*/servingConfigs/*}:searchLite:\x01*Zg\"b/v1/{serving_config=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:searchLite:\x01*Zd\"_/v1/{serving_config=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:searchLite:\x01*\x1a\x90\x02\xca\x41\x1e\x64iscoveryengine.googleapis.com\xd2\x41\xeb\x01https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/discoveryengine.assist.readwrite,https://www.googleapis.com/auth/discoveryengine.readwrite,https://www.googleapis.com/auth/discoveryengine.serving.readwriteB\x85\x02\n#com.google.cloud.discoveryengine.v1B\x12SearchServiceProtoP\x01ZMcloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb\xa2\x02\x0f\x44ISCOVERYENGINE\xaa\x02\x1fGoogle.Cloud.DiscoveryEngine.V1\xca\x02\x1fGoogle\\Cloud\\DiscoveryEngine\\V1\xea\x02\"Google::Cloud::DiscoveryEngine::V1b\x06proto3"
|
|
18
18
|
|
|
19
19
|
pool = ::Google::Protobuf::DescriptorPool.generated_pool
|
|
20
20
|
pool.add_serialized_file(descriptor_data)
|
|
@@ -50,21 +50,26 @@ module Google
|
|
|
50
50
|
SearchRequest::NaturalLanguageQueryUnderstandingSpec::FilterExtractionCondition = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition").enummodule
|
|
51
51
|
SearchRequest::NaturalLanguageQueryUnderstandingSpec::ExtractedFilterBehavior = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior").enummodule
|
|
52
52
|
SearchRequest::SearchAsYouTypeSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec").msgclass
|
|
53
|
+
SearchRequest::SearchAsYouTypeSpec::Field = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field").msgclass
|
|
53
54
|
SearchRequest::SearchAsYouTypeSpec::Condition = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition").enummodule
|
|
54
55
|
SearchRequest::DisplaySpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec").msgclass
|
|
55
56
|
SearchRequest::DisplaySpec::MatchHighlightingCondition = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec.MatchHighlightingCondition").enummodule
|
|
56
57
|
SearchRequest::CrowdingSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec").msgclass
|
|
57
58
|
SearchRequest::CrowdingSpec::Mode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec.Mode").enummodule
|
|
58
59
|
SearchRequest::SessionSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchRequest.SessionSpec").msgclass
|
|
59
|
-
SearchRequest::RelevanceScoreSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec").msgclass
|
|
60
60
|
SearchRequest::RelevanceFilterSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchRequest.RelevanceFilterSpec").msgclass
|
|
61
61
|
SearchRequest::RelevanceFilterSpec::RelevanceThresholdSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchRequest.RelevanceFilterSpec.RelevanceThresholdSpec").msgclass
|
|
62
|
+
SearchRequest::RelevanceScoreSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec").msgclass
|
|
63
|
+
SearchRequest::SearchAddonSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchRequest.SearchAddonSpec").msgclass
|
|
64
|
+
SearchRequest::CustomRankingParams = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchRequest.CustomRankingParams").msgclass
|
|
62
65
|
SearchRequest::RankingExpressionBackend = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend").enummodule
|
|
63
66
|
SearchRequest::RelevanceThreshold = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold").enummodule
|
|
64
67
|
SearchResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchResponse").msgclass
|
|
65
68
|
SearchResponse::SearchResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchResponse.SearchResult").msgclass
|
|
66
69
|
SearchResponse::SearchResult::RankSignals = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals").msgclass
|
|
67
70
|
SearchResponse::SearchResult::RankSignals::CustomSignal = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal").msgclass
|
|
71
|
+
SearchResponse::SearchResult::RetrievalSignals = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals").msgclass
|
|
72
|
+
SearchResponse::SearchResult::RetrievalSignals::RetrievalSource = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource").enummodule
|
|
68
73
|
SearchResponse::Facet = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchResponse.Facet").msgclass
|
|
69
74
|
SearchResponse::Facet::FacetValue = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue").msgclass
|
|
70
75
|
SearchResponse::Summary = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.SearchResponse.Summary").msgclass
|
|
@@ -111,6 +111,12 @@ module Google
|
|
|
111
111
|
# stores. For engines with a single data store, the specs directly under
|
|
112
112
|
# {::Google::Cloud::DiscoveryEngine::V1::SearchRequest SearchRequest} should be
|
|
113
113
|
# used.
|
|
114
|
+
# @!attribute [rw] num_results_per_data_store
|
|
115
|
+
# @return [::Integer]
|
|
116
|
+
# Optional. The maximum number of results to retrieve from each data store.
|
|
117
|
+
# If not specified, it will use the
|
|
118
|
+
# {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec#num_results SearchRequest.DataStoreSpec.num_results}
|
|
119
|
+
# if provided, otherwise there is no limit.
|
|
114
120
|
# @!attribute [rw] filter
|
|
115
121
|
# @return [::String]
|
|
116
122
|
# The filter syntax consists of an expression language for constructing a
|
|
@@ -316,6 +322,15 @@ module Google
|
|
|
316
322
|
# Google model to determine the keyword-based overlap between the query and
|
|
317
323
|
# the document.
|
|
318
324
|
# * `base_rank`: the default rank of the result
|
|
325
|
+
# * `media_actor_match`: whether the media actor matches the query
|
|
326
|
+
# * `media_director_match`: whether the media director matches the query
|
|
327
|
+
# * `media_genre_match`: whether the media genre matches the query
|
|
328
|
+
# * `media_language_match`: whether the media language matches the query
|
|
329
|
+
# * `media_title_match`: whether the media title matches the query
|
|
330
|
+
# * `media_prefix_similarity_rank`: prefix similarity rank for media
|
|
331
|
+
# results
|
|
332
|
+
# * `media_semantic_similarity_rank`: semantic similarity rank for media
|
|
333
|
+
# results
|
|
319
334
|
# @!attribute [rw] ranking_expression_backend
|
|
320
335
|
# @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RankingExpressionBackend]
|
|
321
336
|
# Optional. The backend to use for the ranking expression evaluation.
|
|
@@ -388,10 +403,6 @@ module Google
|
|
|
388
403
|
# Call /answer API with the session ID generated in the first call.
|
|
389
404
|
# Here, the answer generation happens in the context of the search
|
|
390
405
|
# results from the first search call.
|
|
391
|
-
#
|
|
392
|
-
# Multi-turn Search feature is currently at private GA stage. Please use
|
|
393
|
-
# v1alpha or v1beta version instead before we launch this feature to public
|
|
394
|
-
# GA. Or ask for allowlisting through Google Support team.
|
|
395
406
|
# @!attribute [rw] session_spec
|
|
396
407
|
# @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SessionSpec]
|
|
397
408
|
# Session specification.
|
|
@@ -421,6 +432,22 @@ module Google
|
|
|
421
432
|
# @!attribute [rw] relevance_score_spec
|
|
422
433
|
# @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceScoreSpec]
|
|
423
434
|
# Optional. The specification for returning the relevance score.
|
|
435
|
+
# @!attribute [rw] search_addon_spec
|
|
436
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAddonSpec]
|
|
437
|
+
# Optional. SearchAddonSpec is used to disable add-ons for search as per new
|
|
438
|
+
# repricing model.
|
|
439
|
+
# This field is only supported for search requests.
|
|
440
|
+
# @!attribute [rw] custom_ranking_params
|
|
441
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::CustomRankingParams]
|
|
442
|
+
# Optional. Optional configuration for the Custom Ranking feature.
|
|
443
|
+
# @!attribute [rw] entity
|
|
444
|
+
# @return [::String]
|
|
445
|
+
# Optional. The entity for customers that may run multiple different
|
|
446
|
+
# entities, domains, sites or regions, for example, "Google US", "Google
|
|
447
|
+
# Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
|
|
448
|
+
# be exactly matched with
|
|
449
|
+
# [UserEvent.entity][google.cloud.discoveryengine.v1.UserEvent.entity] to get
|
|
450
|
+
# search results boosted by entity.
|
|
424
451
|
class SearchRequest
|
|
425
452
|
include ::Google::Protobuf::MessageExts
|
|
426
453
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -461,6 +488,14 @@ module Google
|
|
|
461
488
|
# filter results from workspace data stores. For more information on custom
|
|
462
489
|
# search operators, see
|
|
463
490
|
# [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
|
|
491
|
+
# @!attribute [rw] num_results
|
|
492
|
+
# @return [::Integer]
|
|
493
|
+
# Optional. The maximum number of results to retrieve from this data store.
|
|
494
|
+
# If not specified, it will use the
|
|
495
|
+
# {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#num_results_per_data_store SearchRequest.num_results_per_data_store}
|
|
496
|
+
# if provided, otherwise there is no limit. If both this field and
|
|
497
|
+
# {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#num_results_per_data_store SearchRequest.num_results_per_data_store}
|
|
498
|
+
# are specified, this field will be used.
|
|
464
499
|
class DataStoreSpec
|
|
465
500
|
include ::Google::Protobuf::MessageExts
|
|
466
501
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -1089,9 +1124,6 @@ module Google
|
|
|
1089
1124
|
# Field names used for location-based filtering, where geolocation filters
|
|
1090
1125
|
# are detected in natural language search queries.
|
|
1091
1126
|
# Only valid when the FilterExtractionCondition is set to `ENABLED`.
|
|
1092
|
-
#
|
|
1093
|
-
# If this field is set, it overrides the field names set in
|
|
1094
|
-
# [ServingConfig.geo_search_query_detection_field_names][google.cloud.discoveryengine.v1.ServingConfig.geo_search_query_detection_field_names].
|
|
1095
1127
|
# @!attribute [rw] extracted_filter_behavior
|
|
1096
1128
|
# @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::NaturalLanguageQueryUnderstandingSpec::ExtractedFilterBehavior]
|
|
1097
1129
|
# Optional. Controls behavior of how extracted filters are applied to the
|
|
@@ -1155,10 +1187,32 @@ module Google
|
|
|
1155
1187
|
# The condition under which search as you type should occur.
|
|
1156
1188
|
# Default to
|
|
1157
1189
|
# {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAsYouTypeSpec::Condition::DISABLED Condition.DISABLED}.
|
|
1190
|
+
# @!attribute [rw] fields
|
|
1191
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAsYouTypeSpec::Field>]
|
|
1192
|
+
# Optional. The list of fields to be used for Search As You Type scoring.
|
|
1193
|
+
# @!attribute [rw] score_threshold
|
|
1194
|
+
# @return [::Float]
|
|
1195
|
+
# Optional. Search As You Type score threshold for filtering purpose.
|
|
1196
|
+
# We keep the result if `score` >= `score_threshold`.
|
|
1158
1197
|
class SearchAsYouTypeSpec
|
|
1159
1198
|
include ::Google::Protobuf::MessageExts
|
|
1160
1199
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1161
1200
|
|
|
1201
|
+
# A schema field to be used for Search As You Type scoring on this
|
|
1202
|
+
# request. Overrides any data-store-level Search As You Type field
|
|
1203
|
+
# configuration for the duration of the request.
|
|
1204
|
+
# @!attribute [rw] key
|
|
1205
|
+
# @return [::String]
|
|
1206
|
+
# Required. A field key that has been indexed for Search As You Type.
|
|
1207
|
+
# @!attribute [rw] weight
|
|
1208
|
+
# @return [::Float]
|
|
1209
|
+
# Optional. Weight for scores from this field. Defaults to 1.0 if not
|
|
1210
|
+
# specified.
|
|
1211
|
+
class Field
|
|
1212
|
+
include ::Google::Protobuf::MessageExts
|
|
1213
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1214
|
+
end
|
|
1215
|
+
|
|
1162
1216
|
# Enum describing under which condition search as you type should occur.
|
|
1163
1217
|
module Condition
|
|
1164
1218
|
# Server behavior defaults to
|
|
@@ -1238,10 +1292,6 @@ module Google
|
|
|
1238
1292
|
end
|
|
1239
1293
|
|
|
1240
1294
|
# Session specification.
|
|
1241
|
-
#
|
|
1242
|
-
# Multi-turn Search feature is currently at private GA stage. Please use
|
|
1243
|
-
# v1alpha or v1beta version instead before we launch this feature to public
|
|
1244
|
-
# GA. Or ask for allowlisting through Google Support team.
|
|
1245
1295
|
# @!attribute [rw] query_id
|
|
1246
1296
|
# @return [::String]
|
|
1247
1297
|
# If set, the search result gets stored to the "turn" specified by this
|
|
@@ -1283,16 +1333,6 @@ module Google
|
|
|
1283
1333
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1284
1334
|
end
|
|
1285
1335
|
|
|
1286
|
-
# The specification for returning the document relevance score.
|
|
1287
|
-
# @!attribute [rw] return_relevance_score
|
|
1288
|
-
# @return [::Boolean]
|
|
1289
|
-
# Optional. Whether to return the relevance score for search results.
|
|
1290
|
-
# The higher the score, the more relevant the document is to the query.
|
|
1291
|
-
class RelevanceScoreSpec
|
|
1292
|
-
include ::Google::Protobuf::MessageExts
|
|
1293
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1294
|
-
end
|
|
1295
|
-
|
|
1296
1336
|
# Relevance filtering specification.
|
|
1297
1337
|
# @!attribute [rw] keyword_search_threshold
|
|
1298
1338
|
# @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceFilterSpec::RelevanceThresholdSpec]
|
|
@@ -1323,6 +1363,49 @@ module Google
|
|
|
1323
1363
|
end
|
|
1324
1364
|
end
|
|
1325
1365
|
|
|
1366
|
+
# The specification for returning the document relevance score.
|
|
1367
|
+
# @!attribute [rw] return_relevance_score
|
|
1368
|
+
# @return [::Boolean]
|
|
1369
|
+
# Optional. Whether to return the relevance score for search results.
|
|
1370
|
+
# The higher the score, the more relevant the document is to the query.
|
|
1371
|
+
class RelevanceScoreSpec
|
|
1372
|
+
include ::Google::Protobuf::MessageExts
|
|
1373
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1374
|
+
end
|
|
1375
|
+
|
|
1376
|
+
# SearchAddonSpec is used to disable add-ons for search as per new
|
|
1377
|
+
# repricing model. By default if the SearchAddonSpec is not specified, we
|
|
1378
|
+
# consider that the customer wants to enable them wherever applicable.
|
|
1379
|
+
# @!attribute [rw] disable_semantic_add_on
|
|
1380
|
+
# @return [::Boolean]
|
|
1381
|
+
# Optional. If true, semantic add-on is disabled. Semantic add-on includes
|
|
1382
|
+
# embeddings and jetstream.
|
|
1383
|
+
# @!attribute [rw] disable_kpi_personalization_add_on
|
|
1384
|
+
# @return [::Boolean]
|
|
1385
|
+
# Optional. If true, disables event re-ranking and personalization to
|
|
1386
|
+
# optimize KPIs & personalize results.
|
|
1387
|
+
# @!attribute [rw] disable_generative_answer_add_on
|
|
1388
|
+
# @return [::Boolean]
|
|
1389
|
+
# Optional. If true, generative answer add-on is disabled. Generative
|
|
1390
|
+
# answer add-on includes natural language to filters and simple answers.
|
|
1391
|
+
class SearchAddonSpec
|
|
1392
|
+
include ::Google::Protobuf::MessageExts
|
|
1393
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1394
|
+
end
|
|
1395
|
+
|
|
1396
|
+
# Configuration parameters for the Custom Ranking feature.
|
|
1397
|
+
# @!attribute [rw] expressions_to_precompute
|
|
1398
|
+
# @return [::Array<::String>]
|
|
1399
|
+
# Optional. A list of ranking expressions (see `ranking_expression` for the
|
|
1400
|
+
# syntax documentation) to evaluate. The evaluation results will be
|
|
1401
|
+
# returned in
|
|
1402
|
+
# `SearchResponse.SearchResult.rank_signals.precomputed_expression_values`
|
|
1403
|
+
# field.
|
|
1404
|
+
class CustomRankingParams
|
|
1405
|
+
include ::Google::Protobuf::MessageExts
|
|
1406
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1407
|
+
end
|
|
1408
|
+
|
|
1326
1409
|
# @!attribute [rw] key
|
|
1327
1410
|
# @return [::String]
|
|
1328
1411
|
# @!attribute [rw] value
|
|
@@ -1435,6 +1518,9 @@ module Google
|
|
|
1435
1518
|
# This field is only returned if
|
|
1436
1519
|
# {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec#summary_spec SearchRequest.ContentSearchSpec.summary_spec}
|
|
1437
1520
|
# is set.
|
|
1521
|
+
# @!attribute [rw] applied_controls
|
|
1522
|
+
# @return [::Array<::String>]
|
|
1523
|
+
# Optional. Controls applied as part of the Control service.
|
|
1438
1524
|
# @!attribute [rw] query_expansion_info
|
|
1439
1525
|
# @return [::Google::Cloud::DiscoveryEngine::V1::SearchResponse::QueryExpansionInfo]
|
|
1440
1526
|
# Query expansion information for the returned results.
|
|
@@ -1480,6 +1566,10 @@ module Google
|
|
|
1480
1566
|
# @!attribute [rw] rank_signals
|
|
1481
1567
|
# @return [::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult::RankSignals]
|
|
1482
1568
|
# Optional. A set of ranking signals associated with the result.
|
|
1569
|
+
# @!attribute [rw] retrieval_signals
|
|
1570
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult::RetrievalSignals]
|
|
1571
|
+
# Optional. A set of signals used by the relevance filter meant for use to
|
|
1572
|
+
# fine-tune the relevance filter thresholds.
|
|
1483
1573
|
class SearchResult
|
|
1484
1574
|
include ::Google::Protobuf::MessageExts
|
|
1485
1575
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -1512,6 +1602,11 @@ module Google
|
|
|
1512
1602
|
# @!attribute [rw] custom_signals
|
|
1513
1603
|
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult::RankSignals::CustomSignal>]
|
|
1514
1604
|
# Optional. A list of custom clearbox signals.
|
|
1605
|
+
# @!attribute [rw] precomputed_expression_values
|
|
1606
|
+
# @return [::Array<::Float>]
|
|
1607
|
+
# Optional. A list of precomputed expression results for a given
|
|
1608
|
+
# document, in the same order as requested in
|
|
1609
|
+
# `SearchRequest.custom_ranking_params.expressions_to_precompute`.
|
|
1515
1610
|
class RankSignals
|
|
1516
1611
|
include ::Google::Protobuf::MessageExts
|
|
1517
1612
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -1530,6 +1625,31 @@ module Google
|
|
|
1530
1625
|
end
|
|
1531
1626
|
end
|
|
1532
1627
|
|
|
1628
|
+
# Contains a set of signals used by the relevance filter.
|
|
1629
|
+
# @!attribute [rw] retrieval_sources
|
|
1630
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult::RetrievalSignals::RetrievalSource>]
|
|
1631
|
+
# Optional. Indicates how the result was retrieved.
|
|
1632
|
+
# @!attribute [rw] semantic_relevance_score
|
|
1633
|
+
# @return [::Float]
|
|
1634
|
+
# Optional. Relevance score used by the filter when
|
|
1635
|
+
# semantic_relevance_threshold is set.
|
|
1636
|
+
class RetrievalSignals
|
|
1637
|
+
include ::Google::Protobuf::MessageExts
|
|
1638
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1639
|
+
|
|
1640
|
+
# Indicates the source of the retrieval.
|
|
1641
|
+
module RetrievalSource
|
|
1642
|
+
# Unspecified retrieval source.
|
|
1643
|
+
RETRIEVAL_SOURCE_UNSPECIFIED = 0
|
|
1644
|
+
|
|
1645
|
+
# Indicates the result was retrieved by keyword search.
|
|
1646
|
+
KEYWORD_SEARCH = 1
|
|
1647
|
+
|
|
1648
|
+
# Indicates the result was retrieved by semantic search.
|
|
1649
|
+
SEMANTIC_SEARCH = 2
|
|
1650
|
+
end
|
|
1651
|
+
end
|
|
1652
|
+
|
|
1533
1653
|
# @!attribute [rw] key
|
|
1534
1654
|
# @return [::String]
|
|
1535
1655
|
# @!attribute [rw] value
|