Package com.google.cloud.retail.v2

Interface SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      float getBoost()
      Strength of the condition boost, which should be in [-1, 1].
      String getCondition()
      An expression which specifies a boost condition.
      com.google.protobuf.ByteString getConditionBytes()
      An expression which specifies a boost condition.

      • 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 Detail

      • getCondition

        String getCondition()
         An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression. See
 [SearchRequest.filter][google.cloud.retail.v2.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"))
        string condition = 1;
        Returns:
        The condition.

      • getConditionBytes

        com.google.protobuf.ByteString getConditionBytes()
         An expression which specifies a boost condition. The syntax and
 supported fields are the same as a filter expression. See
 [SearchRequest.filter][google.cloud.retail.v2.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"))
        string condition = 1;
        Returns:
        The bytes for condition.

      • getBoost

        float getBoost()
         Strength of the condition boost, which should 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 = 2;
        Returns:
        The boost.