Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class 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.
Generated from protobuf message google.cloud.discoveryengine.v1.SearchRequest.BoostSpec.ConditionBoostSpec.BoostControlSpec
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ SearchRequest \ BoostSpec \ ConditionBoostSpecMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ field_name |
string
The name of the field whose value will be used to determine the boost amount. |
↳ attribute_type |
int
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
The interpolation type to be applied to connect the control points listed below. |
↳ control_points |
array<Google\Cloud\DiscoveryEngine\V1\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. |
getFieldName
The name of the field whose value will be used to determine the boost amount.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFieldName
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
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
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
The interpolation type to be applied to connect the control points listed below.
| Returns | |
|---|---|
| Type | Description |
int |
|
setInterpolationType
The interpolation type to be applied to connect the control points listed below.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getControlPoints
The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setControlPoints
The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\DiscoveryEngine\V1\SearchRequest\BoostSpec\ConditionBoostSpec\BoostControlSpec\ControlPoint>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|