Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class InterpolationBoostSpec.
Specification for custom ranking based on customer specified attribute
value. It provides more controls for customized ranking than the simple
(condition, boost) combination above.
Generated from protobuf message google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ Control \ BoostAction
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ field_name
string
Optional. The name of the field whose value will be used to determine the boost amount.
↳ attribute_type
int
Optional. 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
int
Optional. The interpolation type to be applied to connect the control points listed below.
Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
getFieldName
Optional. The name of the field whose value will be used to determine
the boost amount.
Returns
Type
Description
string
setFieldName
Optional. The name of the field whose value will be used to determine
the boost amount.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAttributeType
Optional. 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).
Returns
Type
Description
int
setAttributeType
Optional. 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).
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getInterpolationType
Optional. The interpolation type to be applied to connect the control
points listed below.
Returns
Type
Description
int
setInterpolationType
Optional. The interpolation type to be applied to connect the control
points listed below.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getControlPoints
Optional. The control points used to define the curve. The monotonic
function (defined through the interpolation_type above) passes through
the control points listed here.
Optional. The control points used to define the curve. The monotonic
function (defined through the interpolation_type above) passes through
the control points listed here.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Discovery Engine V1 Client - Class InterpolationBoostSpec (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.Control.BoostAction.InterpolationBoostSpec)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.Control.BoostAction.InterpolationBoostSpec)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.Control.BoostAction.InterpolationBoostSpec)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.Control.BoostAction.InterpolationBoostSpec)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.Control.BoostAction.InterpolationBoostSpec)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.Control.BoostAction.InterpolationBoostSpec)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.Control.BoostAction.InterpolationBoostSpec)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.Control.BoostAction.InterpolationBoostSpec)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.Control.BoostAction.InterpolationBoostSpec)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.Control.BoostAction.InterpolationBoostSpec)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.Control.BoostAction.InterpolationBoostSpec)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.Control.BoostAction.InterpolationBoostSpec)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.Control.BoostAction.InterpolationBoostSpec)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.Control.BoostAction.InterpolationBoostSpec)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.Control.BoostAction.InterpolationBoostSpec)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.Control.BoostAction.InterpolationBoostSpec)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.Control.BoostAction.InterpolationBoostSpec) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class InterpolationBoostSpec.\n\nSpecification for custom ranking based on customer specified attribute\nvalue. It provides more controls for customized ranking than the simple\n(condition, boost) combination above.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1 \\\\ Control \\\\ BoostAction\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getFieldName\n\nOptional. The name of the field whose value will be used to determine\nthe boost amount.\n\n### setFieldName\n\nOptional. The name of the field whose value will be used to determine\nthe boost amount.\n\n### getAttributeType\n\nOptional. The attribute type to be used to determine the boost amount.\n\nThe attribute value can be derived from the field value of the\nspecified field_name. In the case of numerical it is straightforward\ni.e. attribute_value = numerical_field_value. In the case of freshness\nhowever, attribute_value = (time.now() - datetime_field_value).\n\n### setAttributeType\n\nOptional. The attribute type to be used to determine the boost amount.\n\nThe attribute value can be derived from the field value of the\nspecified field_name. In the case of numerical it is straightforward\ni.e. attribute_value = numerical_field_value. In the case of freshness\nhowever, attribute_value = (time.now() - datetime_field_value).\n\n### getInterpolationType\n\nOptional. The interpolation type to be applied to connect the control\npoints listed below.\n\n### setInterpolationType\n\nOptional. The interpolation type to be applied to connect the control\npoints listed below.\n\n### getControlPoints\n\nOptional. The control points used to define the curve. The monotonic\nfunction (defined through the interpolation_type above) passes through\nthe control points listed here.\n\n### setControlPoints\n\nOptional. The control points used to define the curve. The monotonic\nfunction (defined through the interpolation_type above) passes through\nthe control points listed here."]]
