Discovery Engine v1 API - Class SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec (1.6.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 Discovery Engine v1 API class SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec.

Boost applies to documents which match a condition.

Inheritance

object > SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.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 document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents 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 documents.

Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document 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. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.

Property Value
Type Description
float

BoostControlSpec

public SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec.Types.BoostControlSpec BoostControlSpec { get; set; }

Complex specification for custom ranking based on customer defined attribute value.

Property Value
Type Description
SearchRequestTypesBoostSpecTypesConditionBoostSpecTypesBoostControlSpec

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.discoveryengine.v1.SearchRequest.filter] for detail syntax and limitations.

Examples:

  • To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))
Property Value
Type Description
string