Reference documentation and code samples for the Google Cloud Dialogflow V2 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.dialogflow.v2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec
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 Dialogflow V2 Client - Class BoostControlSpec (2.1.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.2 (latest)](/php/docs/reference/cloud-dialogflow/latest/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [2.1.1](/php/docs/reference/cloud-dialogflow/2.1.1/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [2.0.1](/php/docs/reference/cloud-dialogflow/2.0.1/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [1.17.2](/php/docs/reference/cloud-dialogflow/1.17.2/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [1.16.0](/php/docs/reference/cloud-dialogflow/1.16.0/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [1.15.1](/php/docs/reference/cloud-dialogflow/1.15.1/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [1.14.0](/php/docs/reference/cloud-dialogflow/1.14.0/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [1.13.0](/php/docs/reference/cloud-dialogflow/1.13.0/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [1.12.3](/php/docs/reference/cloud-dialogflow/1.12.3/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [1.11.0](/php/docs/reference/cloud-dialogflow/1.11.0/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [1.10.2](/php/docs/reference/cloud-dialogflow/1.10.2/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [1.9.0](/php/docs/reference/cloud-dialogflow/1.9.0/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [1.8.0](/php/docs/reference/cloud-dialogflow/1.8.0/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [1.7.2](/php/docs/reference/cloud-dialogflow/1.7.2/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [1.6.0](/php/docs/reference/cloud-dialogflow/1.6.0/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [1.5.0](/php/docs/reference/cloud-dialogflow/1.5.0/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [1.4.0](/php/docs/reference/cloud-dialogflow/1.4.0/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [1.3.2](/php/docs/reference/cloud-dialogflow/1.3.2/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [1.2.0](/php/docs/reference/cloud-dialogflow/1.2.0/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [1.1.1](/php/docs/reference/cloud-dialogflow/1.1.1/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec)\n- [1.0.1](/php/docs/reference/cloud-dialogflow/1.0.1/V2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec) \nReference documentation and code samples for the Google Cloud Dialogflow V2 Client class BoostControlSpec.\n\nSpecification for custom ranking based on customer specified\nattribute\nvalue. It provides more controls for customized ranking than the\nsimple (condition, boost) combination above.\n\nGenerated from protobuf message `google.cloud.dialogflow.v2.SearchKnowledgeRequest.SearchConfig.BoostSpecs.BoostSpec.ConditionBoostSpec.BoostControlSpec`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dialogflow \\\\ V2 \\\\ SearchKnowledgeRequest \\\\ SearchConfig \\\\ BoostSpecs \\\\ BoostSpec \\\\ ConditionBoostSpec\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getFieldName\n\nOptional. The name of the field whose value will be used to\ndetermine the boost amount.\n\n### setFieldName\n\nOptional. The name of the field whose value will be used to\ndetermine the boost amount.\n\n### getAttributeType\n\nOptional. The attribute type to be used to determine the boost\namount. The attribute value can be derived from the field value\nof the specified field_name. In the case of numerical it is\nstraightforward i.e. attribute_value = numerical_field_value. In\nthe case of freshness however, attribute_value = (time.now() -\ndatetime_field_value).\n\n### setAttributeType\n\nOptional. The attribute type to be used to determine the boost\namount. The attribute value can be derived from the field value\nof the specified field_name. In the case of numerical it is\nstraightforward i.e. attribute_value = numerical_field_value. In\nthe case of freshness however, attribute_value = (time.now() -\ndatetime_field_value).\n\n### getInterpolationType\n\nOptional. The interpolation type to be applied to connect the\ncontrol points listed below.\n\n### setInterpolationType\n\nOptional. The interpolation type to be applied to connect the\ncontrol points listed below.\n\n### getControlPoints\n\nOptional. The control points used to define the curve. The\nmonotonic function (defined through the interpolation_type above)\npasses through the control points listed here.\n\n### setControlPoints\n\nOptional. The control points used to define the curve. The\nmonotonic function (defined through the interpolation_type above)\npasses through the control points listed here."]]
