Retail V2 API - Class Google::Cloud::Retail::V2::Rule::BoostAction (v1.0.1)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::Rule::BoostAction.

A boost action to apply to results matching condition specified above.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#boost

def boost() -> ::Float
Returns
  • (::Float) — Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0.

    Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items.

    Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely.

    Setting to 0.0 means no boost applied. The boosting condition is ignored.

#boost=

def boost=(value) -> ::Float
Parameter
  • value (::Float) — Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0.

    Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items.

    Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely.

    Setting to 0.0 means no boost applied. The boosting condition is ignored.

Returns
  • (::Float) — Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0.

    Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items.

    Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely.

    Setting to 0.0 means no boost applied. The boosting condition is ignored.

#products_filter

def products_filter() -> ::String
Returns
  • (::String) —

    The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations.

    Examples:

    • To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue":
      (id: ANY("product_1", "product_2"))
       AND
       (colorFamilies: ANY("Red", "Blue"))

#products_filter=

def products_filter=(value) -> ::String
Parameter
  • value (::String) —

    The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations.

    Examples:

    • To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue":
      (id: ANY("product_1", "product_2"))
       AND
       (colorFamilies: ANY("Red", "Blue"))
Returns
  • (::String) —

    The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations.

    Examples:

    • To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue":
      (id: ANY("product_1", "product_2"))
       AND
       (colorFamilies: ANY("Red", "Blue"))