Retail V2 API - Class Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::RerankConfig (v1.0.0)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::RerankConfig.

Options to rerank based on facet values engaged by the user for the current key. That key needs to be a custom textual key and facetable. To use this control, you also need to pass all the facet keys engaged by the user in the request using the field [SearchRequest.FacetSpec]. In particular, if you don't pass the facet keys engaged that you want to rerank on, this control won't be effective. Moreover, to obtain better results, the facet values that you want to rerank on should be close to English (ideally made of words, underscores, and spaces).

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#facet_values

def facet_values() -> ::Array<::String>
Returns
  • (::Array<::String>) — If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.

#facet_values=

def facet_values=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.
Returns
  • (::Array<::String>) — If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.

#rerank_facet

def rerank_facet() -> ::Boolean
Returns
  • (::Boolean) — If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.

#rerank_facet=

def rerank_facet=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.
Returns
  • (::Boolean) — If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.