Retail V2 API - Class Google::Cloud::Retail::V2::ConversationalSearchRequest::SearchParams (v2.5.0)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::ConversationalSearchRequest::SearchParams.

Search parameters.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#boost_spec

def boost_spec() -> ::Google::Cloud::Retail::V2::SearchRequest::BoostSpec
Returns

#boost_spec=

def boost_spec=(value) -> ::Google::Cloud::Retail::V2::SearchRequest::BoostSpec
Parameter
Returns

#canonical_filter

def canonical_filter() -> ::String
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.

#canonical_filter=

def canonical_filter=(value) -> ::String
Parameter
  • value (::String) — 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.

#filter

def filter() -> ::String
Returns
  • (::String) — Optional. The filter string to restrict search results.

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

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — 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.

#sort_by

def sort_by() -> ::String
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][].

#sort_by=

def sort_by=(value) -> ::String
Parameter
  • value (::String) — 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][].