Class BoostControlSpec (0.13.11) 

BoostControlSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

Attributes
Name Description
field_name str
The name of the field whose value will be used to determine the boost amount.
attribute_type google.cloud.discoveryengine_v1.types.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType
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).
interpolation_type google.cloud.discoveryengine_v1.types.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType
The interpolation type to be applied to connect the control points listed below.
control_points MutableSequence[google.cloud.discoveryengine_v1.types.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint]
The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.

Classes

AttributeType

AttributeType(value)

The attribute(or function) for which the custom ranking is to be applied.

ControlPoint

ControlPoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).

InterpolationType

InterpolationType(value)

The interpolation type to be applied. Default will be linear (Piecewise Linear).