Class: Google::Cloud::Retail::V2::ConversationalSearchRequest::SearchParams

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/conversational_search_service.rb

Overview

Search parameters.

Instance Attribute Summary collapse

Instance Attribute Details

#boost_spec ⇒ ::Google::Cloud::Retail::V2::SearchRequest::BoostSpec

Returns Optional. The boost spec to specify the boosting of search results.

The syntax of the boost spec is the same as SearchRequest.boost_spec.

Returns:



143
144
145
146
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 143

class SearchParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#canonical_filter ⇒ ::String

Returns Optional. The canonical filter string to restrict search results.

The syntax of the canonical filter string is the same as SearchRequest.canonical_filter.

Returns:

  • (::String) —

    Optional. The canonical filter string to restrict search results.

    The syntax of the canonical filter string is the same as SearchRequest.canonical_filter.



143
144
145
146
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 143

class SearchParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#filter ⇒ ::String

Returns Optional. The filter string to restrict search results.

The syntax of the filter string is the same as SearchRequest.filter.

Returns:

  • (::String) —

    Optional. The filter string to restrict search results.

    The syntax of the filter string is the same as SearchRequest.filter.



143
144
145
146
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 143

class SearchParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#sort_by ⇒ ::String

Returns Optional. The sort string to specify the sorting of search results.

The syntax of the sort string is the same as [SearchRequest.sort][].

Returns:

  • (::String) —

    Optional. The sort string to specify the sorting of search results.

    The syntax of the sort string is the same as [SearchRequest.sort][].



143
144
145
146
 
# File 'proto_docs/google/cloud/retail/v2/conversational_search_service.rb', line 143

class SearchParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end