Class: Google::Apis::RetailV2::GoogleCloudRetailV2CatalogAttributeFacetConfigRerankConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2/classes.rb,
lib/google/apis/retail_v2/representations.rb,
lib/google/apis/retail_v2/representations.rb

Overview

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).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2CatalogAttributeFacetConfigRerankConfig

Returns a new instance of GoogleCloudRetailV2CatalogAttributeFacetConfigRerankConfig.



927
928
929
 
# File 'lib/google/apis/retail_v2/classes.rb', line 927

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#facet_values ⇒ Array<String>

If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only. Corresponds to the JSON property facetValues

Returns:

  • (Array<String>) 


918
919
920
 
# File 'lib/google/apis/retail_v2/classes.rb', line 918

def facet_values
  @facet_values
end

#rerank_facet ⇒ Boolean Also known as: rerank_facet?

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. Corresponds to the JSON property rerankFacet

Returns:

  • (Boolean) 


924
925
926
 
# File 'lib/google/apis/retail_v2/classes.rb', line 924

def rerank_facet
  @rerank_facet
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



932
933
934
935
 
# File 'lib/google/apis/retail_v2/classes.rb', line 932

def update!(**args)
  @facet_values = args[:facet_values] if args.key?(:facet_values)
  @rerank_facet = args[:rerank_facet] if args.key?(:rerank_facet)
end