Struct google_api_proto::google::cloud::retail::v2::catalog_attribute::FacetConfig

pub struct FacetConfig {
    pub facet_intervals: Vec<Interval>,
    pub ignored_facet_values: Vec<IgnoredFacetValues>,
    pub merged_facet_values: Vec<MergedFacetValue>,
    pub merged_facet: Option<MergedFacet>,
    pub rerank_config: Option<RerankConfig>,
}

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

Fields

facet_intervals: Vec<Interval>

If you don’t set the facet [SearchRequest.FacetSpec.FacetKey.intervals][google.cloud.retail.v2.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][google.cloud.retail.v2.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: Vec<IgnoredFacetValues>

Each instance represents a list of attribute values to ignore as facet values for a specific time range. The maximum number of instances per [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] is 25.

merged_facet_values: Vec<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][google.cloud.retail.v2.CatalogAttribute] is 100. This feature is available only for textual custom attributes.

merged_facet: Option<MergedFacet>

Use this field only if you want to merge a facet key into another facet key.

rerank_config: Option<RerankConfig>

Set this field only if you want to rerank based on facet values engaged by the user for the current key. This option is only possible for custom facetable textual keys.

Trait Implementations

impl Clone for FacetConfig

fn clone(&self) -> FacetConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FacetConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FacetConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for FacetConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for FacetConfig

fn eq(&self, other: &FacetConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FacetConfig