Discovery Engine v1 API - Class SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec.Types.BoostControlSpec (1.6.0)

Version latest

• 1.6.0 (latest)
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0-beta06

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

Reference documentation and code samples for the Discovery Engine v1 API class SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec.Types.BoostControlSpec.

Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.

Inheritance

object > SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec.Types.BoostControlSpec

Implements

IMessageSearchRequestTypesBoostSpecTypesConditionBoostSpecTypesBoostControlSpec, IEquatableSearchRequestTypesBoostSpecTypesConditionBoostSpecTypesBoostControlSpec, IDeepCloneableSearchRequestTypesBoostSpecTypesConditionBoostSpecTypesBoostControlSpec, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

BoostControlSpec()

public BoostControlSpec()

BoostControlSpec(BoostControlSpec)

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

Parameter
Name	Description
other	SearchRequestTypesBoostSpecTypesConditionBoostSpecTypesBoostControlSpec

Properties

AttributeType

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

The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).

Property Value
Type	Description
SearchRequestTypesBoostSpecTypesConditionBoostSpecTypesBoostControlSpecTypesAttributeType

ControlPoints

public RepeatedField<SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec.Types.BoostControlSpec.Types.ControlPoint> ControlPoints { get; }

The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.

Property Value
Type	Description
RepeatedFieldSearchRequestTypesBoostSpecTypesConditionBoostSpecTypesBoostControlSpecTypesControlPoint

FieldName

public string FieldName { get; set; }

The name of the field whose value will be used to determine the boost amount.

Property Value
Type	Description
string

InterpolationType

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

The interpolation type to be applied to connect the control points listed below.

Property Value
Type	Description
SearchRequestTypesBoostSpecTypesConditionBoostSpecTypesBoostControlSpecTypesInterpolationType