Send feedback
Class ConditionBoostSpec (1.42.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
ConditionBoostSpec ( mapping = None , * , ignore_unknown_fields = False , ** kwargs )
Boost applies to documents which match a condition.
Attributes
Name
Description
condition
str
Optional. An expression which specifies a boost condition.
The syntax and supported fields are the same as a filter
expression. Examples:
- To boost documents with document ID "doc_1" or "doc_2",
and color "Red" or "Blue":
- (id: ANY("doc_1", "doc_2")) AND (color:
ANY("Red","Blue"))
boost
float
Optional. Strength of the condition boost, which should be
in [-1, 1]. Negative boost means demotion. Default is 0.0.
Setting to 1.0 gives the document a big promotion. However,
it does not necessarily mean that the boosted document will
be the top result at all times, nor that other documents
will be excluded. Results could still be shown even when
none of them matches the condition. And results that are
significantly more relevant to the search query can still
trump your heavily favored but irrelevant documents.
Setting to -1.0 gives the document a big demotion. However,
results that are deeply relevant might still be shown. The
document will have an upstream battle to get a fairly high
ranking, but it is not blocked out completely.
Setting to 0.0 means no boost applied. The boosting
condition is ignored.
boost_control_spec
google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec.BoostControlSpec
Optional. Complex specification for custom
ranking based on customer defined attribute
value.
Classes
BoostControlSpec
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.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
Need to tell us more?
[[["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-08-28 UTC."],[],[],null,["# Class ConditionBoostSpec (1.42.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.42.0 (latest)](/python/docs/reference/dialogflow-cx/latest/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.41.1](/python/docs/reference/dialogflow-cx/1.41.1/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.40.0](/python/docs/reference/dialogflow-cx/1.40.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.39.0](/python/docs/reference/dialogflow-cx/1.39.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.38.0](/python/docs/reference/dialogflow-cx/1.38.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.37.0](/python/docs/reference/dialogflow-cx/1.37.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.36.0](/python/docs/reference/dialogflow-cx/1.36.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.35.0](/python/docs/reference/dialogflow-cx/1.35.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.34.1](/python/docs/reference/dialogflow-cx/1.34.1/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.33.0](/python/docs/reference/dialogflow-cx/1.33.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.32.1](/python/docs/reference/dialogflow-cx/1.32.1/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.31.1](/python/docs/reference/dialogflow-cx/1.31.1/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.30.1](/python/docs/reference/dialogflow-cx/1.30.1/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.29.0](/python/docs/reference/dialogflow-cx/1.29.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.28.0](/python/docs/reference/dialogflow-cx/1.28.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.27.0](/python/docs/reference/dialogflow-cx/1.27.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.26.0](/python/docs/reference/dialogflow-cx/1.26.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.25.0](/python/docs/reference/dialogflow-cx/1.25.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.24.0](/python/docs/reference/dialogflow-cx/1.24.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.23.1](/python/docs/reference/dialogflow-cx/1.23.1/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.22.0](/python/docs/reference/dialogflow-cx/1.22.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.21.0](/python/docs/reference/dialogflow-cx/1.21.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.20.1](/python/docs/reference/dialogflow-cx/1.20.1/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.19.0](/python/docs/reference/dialogflow-cx/1.19.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.18.0](/python/docs/reference/dialogflow-cx/1.18.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.17.1](/python/docs/reference/dialogflow-cx/1.17.1/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.16.0](/python/docs/reference/dialogflow-cx/1.16.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.15.0](/python/docs/reference/dialogflow-cx/1.15.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.14.1](/python/docs/reference/dialogflow-cx/1.14.1/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.13.5](/python/docs/reference/dialogflow-cx/1.13.5/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.12.1](/python/docs/reference/dialogflow-cx/1.12.1/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.11.0](/python/docs/reference/dialogflow-cx/1.11.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.10.0](/python/docs/reference/dialogflow-cx/1.10.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.9.1](/python/docs/reference/dialogflow-cx/1.9.1/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.8.0](/python/docs/reference/dialogflow-cx/1.8.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.7.0](/python/docs/reference/dialogflow-cx/1.7.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.6.0](/python/docs/reference/dialogflow-cx/1.6.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.5.0](/python/docs/reference/dialogflow-cx/1.5.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.4.0](/python/docs/reference/dialogflow-cx/1.4.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.3.2](/python/docs/reference/dialogflow-cx/1.3.2/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.2.0](/python/docs/reference/dialogflow-cx/1.2.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.1.1](/python/docs/reference/dialogflow-cx/1.1.1/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [1.0.0](/python/docs/reference/dialogflow-cx/1.0.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [0.8.2](/python/docs/reference/dialogflow-cx/0.8.2/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [0.7.1](/python/docs/reference/dialogflow-cx/0.7.1/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [0.6.0](/python/docs/reference/dialogflow-cx/0.6.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [0.5.0](/python/docs/reference/dialogflow-cx/0.5.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [0.4.1](/python/docs/reference/dialogflow-cx/0.4.1/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [0.3.0](/python/docs/reference/dialogflow-cx/0.3.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [0.2.0](/python/docs/reference/dialogflow-cx/0.2.0/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec)\n- [0.1.1](/python/docs/reference/dialogflow-cx/0.1.1/google.cloud.dialogflowcx_v3beta1.types.BoostSpec.ConditionBoostSpec) \n\n ConditionBoostSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nBoost applies to documents which match a condition.\n\nClasses\n-------\n\n### BoostControlSpec\n\n BoostControlSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nSpecification for custom ranking based on customer specified\nattribute value. It provides more controls for customized\nranking than the simple (condition, boost) combination above."]]