Retail v2 API - Class SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec (2.8.0)

Version 2.8.0

• 2.12.0 (latest)
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec : IMessage<SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec>, IEquatable<SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec>, IDeepCloneable<SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec>, IBufferMessage, IMessage

Reference documentation and code samples for the Retail v2 API class SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec.

Boost applies to products which match a condition.

Inheritance

object > SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec

Implements

IMessageSearchRequestTypesBoostSpecTypesConditionBoostSpec, IEquatableSearchRequestTypesBoostSpecTypesConditionBoostSpec, IDeepCloneableSearchRequestTypesBoostSpecTypesConditionBoostSpec, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

ConditionBoostSpec()

public ConditionBoostSpec()

ConditionBoostSpec(ConditionBoostSpec)

public ConditionBoostSpec(SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec other)

Parameter
Name	Description
other	SearchRequestTypesBoostSpecTypesConditionBoostSpec

Properties

Boost

public float Boost { get; set; }

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.

Property Value
Type	Description
float

Condition

public string Condition { get; set; }

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"))

Property Value
Type	Description
string