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

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

Possible options for the facet that corresponds to the current attribute config.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#facet_intervals

def facet_intervals() -> ::Array<::Google::Cloud::Retail::V2::Interval>
Returns
  • (::Array<::Google::Cloud::Retail::V2::Interval>) — If you don't set the facet SearchRequest.FacetSpec.FacetKey.intervals in the request to a numerical attribute, then we use the computed intervals with rounded bounds obtained from all its product numerical attribute values. The computed intervals might not be ideal for some attributes. Therefore, we give you the option to overwrite them with the facet_intervals field. The maximum of facet intervals per CatalogAttribute is 40. Each interval must have a lower bound or an upper bound. If both bounds are provided, then the lower bound must be smaller or equal than the upper bound.

#facet_intervals=

def facet_intervals=(value) -> ::Array<::Google::Cloud::Retail::V2::Interval>
Parameter
  • value (::Array<::Google::Cloud::Retail::V2::Interval>) — If you don't set the facet SearchRequest.FacetSpec.FacetKey.intervals in the request to a numerical attribute, then we use the computed intervals with rounded bounds obtained from all its product numerical attribute values. The computed intervals might not be ideal for some attributes. Therefore, we give you the option to overwrite them with the facet_intervals field. The maximum of facet intervals per CatalogAttribute is 40. Each interval must have a lower bound or an upper bound. If both bounds are provided, then the lower bound must be smaller or equal than the upper bound.
Returns
  • (::Array<::Google::Cloud::Retail::V2::Interval>) — If you don't set the facet SearchRequest.FacetSpec.FacetKey.intervals in the request to a numerical attribute, then we use the computed intervals with rounded bounds obtained from all its product numerical attribute values. The computed intervals might not be ideal for some attributes. Therefore, we give you the option to overwrite them with the facet_intervals field. The maximum of facet intervals per CatalogAttribute is 40. Each interval must have a lower bound or an upper bound. If both bounds are provided, then the lower bound must be smaller or equal than the upper bound.

#ignored_facet_values

def ignored_facet_values() -> ::Array<::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::IgnoredFacetValues>
Returns

#ignored_facet_values=

def ignored_facet_values=(value) -> ::Array<::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::IgnoredFacetValues>
Parameter
Returns

#merged_facet

def merged_facet() -> ::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacet
Returns

#merged_facet=

def merged_facet=(value) -> ::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacet
Parameter
Returns

#merged_facet_values

def merged_facet_values() -> ::Array<::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacetValue>
Returns
  • (::Array<::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacetValue>) — Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes.

#merged_facet_values=

def merged_facet_values=(value) -> ::Array<::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacetValue>
Parameter
  • value (::Array<::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacetValue>) — Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes.
Returns
  • (::Array<::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::MergedFacetValue>) — Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes.

#rerank_config

def rerank_config() -> ::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::RerankConfig
Returns

#rerank_config=

def rerank_config=(value) -> ::Google::Cloud::Retail::V2::CatalogAttribute::FacetConfig::RerankConfig
Parameter
Returns