Package com.google.cloud.retail.v2alpha

Interface Rule.BoostActionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Rule.BoostAction, Rule.BoostAction.Builder
Enclosing class:
Rule
public static interface Rule.BoostActionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    getBoost()
    Strength of the condition boost, which must be in [-1, 1].
    String
    getProductsFilter()
    The filter can have a max size of 5000 characters.
    com.google.protobuf.ByteString
    getProductsFilterBytes()
    The filter can have a max size of 5000 characters.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getBoost

      float getBoost()
       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.
      float boost = 1;
      Returns:
      The boost.

    • getProductsFilter

      String getProductsFilter()
       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][google.cloud.retail.v2alpha.SearchRequest.filter]
 for detail syntax and limitations.

 Examples:

 * To boost products with product ID "product_1" or "product_2", and
 color
 "Red" or "Blue":<br>
 *(id: ANY("product_1", "product_2"))<br>*
 *AND<br>*
 *(colorFamilies: ANY("Red", "Blue"))<br>*
      string products_filter = 2;
      Returns:
      The productsFilter.

    • getProductsFilterBytes

      com.google.protobuf.ByteString getProductsFilterBytes()
       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][google.cloud.retail.v2alpha.SearchRequest.filter]
 for detail syntax and limitations.

 Examples:

 * To boost products with product ID "product_1" or "product_2", and
 color
 "Red" or "Blue":<br>
 *(id: ANY("product_1", "product_2"))<br>*
 *AND<br>*
 *(colorFamilies: ANY("Red", "Blue"))<br>*
      string products_filter = 2;
      Returns:
      The bytes for productsFilter.