Class: Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec
- Inherits:
-
Object
- Object
- Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/retail/v2/search_service.rb
Overview
Specification to determine under which conditions query expansion should occur.
Defined Under Namespace
Modules: Condition
Instance Attribute Summary collapse
-
#condition ⇒ ::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec::Condition
The condition under which query expansion should occur.
-
#pin_unexpanded_results ⇒ ::Boolean
Whether to pin unexpanded results.
Instance Attribute Details
#condition ⇒ ::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec::Condition
Returns The condition under which query expansion should occur. Default to Condition.DISABLED.
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 |
# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 671 class QueryExpansionSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Enum describing under which condition query expansion should occur. module Condition # Unspecified query expansion condition. In this case, server behavior # defaults to # {::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}. CONDITION_UNSPECIFIED = 0 # Disabled query expansion. Only the exact search query is used, even if # {::Google::Cloud::Retail::V2::SearchResponse#total_size SearchResponse.total_size} # is zero. DISABLED = 1 # Automatic query expansion built by Google Retail Search. AUTO = 3 end end |
#pin_unexpanded_results ⇒ ::Boolean
Returns Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 |
# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 671 class QueryExpansionSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Enum describing under which condition query expansion should occur. module Condition # Unspecified query expansion condition. In this case, server behavior # defaults to # {::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}. CONDITION_UNSPECIFIED = 0 # Disabled query expansion. Only the exact search query is used, even if # {::Google::Cloud::Retail::V2::SearchResponse#total_size SearchResponse.total_size} # is zero. DISABLED = 1 # Automatic query expansion built by Google Retail Search. AUTO = 3 end end |