Discovery Engine v1beta API - Class AdvancedCompleteQueryRequest.Types.BoostSpec.Types.ConditionBoostSpec (1.0.0-beta18)

Version latest

• 1.0.0-beta18 (latest)
• 1.0.0-beta17

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

Reference documentation and code samples for the Discovery Engine v1beta API class AdvancedCompleteQueryRequest.Types.BoostSpec.Types.ConditionBoostSpec.

Boost applies to suggestions which match a condition.

Inheritance

object > AdvancedCompleteQueryRequest.Types.BoostSpec.Types.ConditionBoostSpec

Implements

IMessageAdvancedCompleteQueryRequestTypesBoostSpecTypesConditionBoostSpec, IEquatableAdvancedCompleteQueryRequestTypesBoostSpecTypesConditionBoostSpec, IDeepCloneableAdvancedCompleteQueryRequestTypesBoostSpecTypesConditionBoostSpec, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

ConditionBoostSpec()

public ConditionBoostSpec()

ConditionBoostSpec(ConditionBoostSpec)

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

Parameter
Name	Description
other	AdvancedCompleteQueryRequestTypesBoostSpecTypesConditionBoostSpec

Properties

Boost

public float Boost { get; set; }

Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0.

Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion.

Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown.

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 is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes.

Example:

• To boost suggestions in languages en or fr: (lang_code: ANY("en", "fr"))

Property Value
Type	Description
string