# Function overview This feature uses an API interface to dynamically configure boost and demotion rules, allowing users to directly specify fields, operators, values, and weight intensity (ranging from \-1 to 1) in requests to adjust the ranking weights of recommendation results in real time. It addresses the previous limitation of only being able to adjust weights manually through the console. # Core value 1. **Reduced Operational Overhead:** Eliminates the need for manual maintenance and prevents human error in rule updates, empowering more efficient business operations. 2. **Seamless System Integration:** Allows you to sync weighting logic with your own internal systems (such as **Inventory, Marketing, or Risk Management**) for automated, real\-time responses. 3. **Hyper\-Personalization:** Supports user\-level weighting configurations, enabling the system to react instantly to a specific user's latest actions for a better experience. ## Use Cases 1. **E\-commerce platform: ** When users click on an electronic product's homepage, the next recommendation request can dynamically boost the weight of related brand products via API to prioritize their recommendation to users. 2. **Content platform: ** When users newly follow a specific author, the next recommendation request can use the API to boost the weight of articles by the same author, meeting users' short\-term reading interests. 3. **Marketing scenario: ** During promotional events, the platform can dynamically boost the weight of promotional products through the API to increase their exposure. This article explains how to configure dynamic boosting and suppression through API request parameters. --- # API Configuration :::tip \*Preconditions Successful integration with the AI search engine recommendation interface is required. Please refer to [Recommendation](/docs/393/92213). ::: Add the top\-level field `conditional_boost` in the request body during **recommendation requests**. The platform automatically merges boost and demotion rules configured in the console and API. ## Request Parameters |**Parameters** |**Type** |**Required** |**Example value** | |---|---|---|---| |conditional_boost |Array <**Conds**\> |**`Required`** |See below: [Conds](/docs/85296/2123292#ca81d523) | ### Conds :::tip \*Automatic Loss Mitigation If an individual boosting or burying rule is found to be invalid or "illegal" (e.g., incorrect syntax, unsupported field, or out\-of\-range values), the service will **automatically ignore only that specific rule**. This ensures that all other valid rules continue to function normally without interrupting the recommendation service. ::: |**Parameter name** |**Data format** |**Required** |**Example value** |**Description** | |---|---|---|---|---| |conds |Array <**BoostConfig**\> |**`Required`** |See below: [BoostConfig](/docs/85296/2123292#38cf87d9) |**Boost and Demotion Configuration**|\ | | | | |The platform only boosts or demotes the specified items that meet the conditions. | |boost |Float |**`Required`** |0.3、\-0.3 |**Boost and Demotion strength**|\ | | | | |Supports any value from \-1 to 1 | #### BoostConfig |**Parameter name** |**Data format** |**Required** |**Example value** |**Description** | |---|---|---|---|---| |field |String |**`mandatory`** |"author" |**Conditional field**|\ | | | | |field for conditions to boost or demote|\ | | | | |:::tip \*Nested field|\ | | | | |You may use`.`to configure, for example:`category.name`|\ | | | | ||\ | | | | |:::| |op |String |**`mandatory`** |"must" |**Operator**|\ | | | | |Supported operators for each field type are as follows: [字段—算子—条件值配置](/docs/85296/2123292#6099735e) | |conds |Based on the field |**`Required`** | |**Condition value**|\ | | | | |A collection of values for boost and demotion condition judgment. Supported values for each field type and operator are as follows: [字段—算子—条件值配置](/docs/85296/2123292#6099735e) | ### **Field—Operator—** Condition Value **Configuration** |**Field type (field)** |**Field attribute** |**Supported operators (op)** |**Condition value input (conds)** | |---|---|---|---| |**Int32** |No attribute, other attributes |* equal (equals)|Int32 format data |\ | | |* not_equal (does not equal)| |\ | | |* lte (less than or equal to)| |\ | | |* lt (less than)| |\ | | |* gte (greater than or equal to)| |\ | | |* gt (greater than) | | |**Int64** |No attribute, other attributes |* equal (equals)|Int64 format data |\ | | |* not_equal (not equals)| |\ | | |* lte (less than or equal to)| |\ | | |* lt (less than)| |\ | | |* gte (greater than or equal to)| |\ | | |* gt (greater than) | | |^^|timestamp|* before|UNIX timestamp |\ | |Release time \- UNIX format |* after | | |^^|^^|* within |* `Xd` (X days)|\ | | | |* `Xh` (X hours)|\ | | | |* `Xm` (X minutes) | |**Float** |Attribute not supported |* lt (less than)|Float format data |\ | | |* gt (greater than) | | |**String** |no attribute, other attributes |* must (include)|Array format data |\ | | |* must_not (exclude) | | |^^|^^|* equal (equals)|String format data |\ | | |* not_equal (not equals) | | |^^|new arrival time |* before (earlier than)|UNIX timestamp |\ | | |* after (later than) | | |^^|^^|* within (in range) |* `Xd` (X days)|\ | | | |* `Xh` (X hours)|\ | | | |* `Xm` (X minutes) | |**Array(String)** |No special attributes |* must (include)|Array format data |\ | | |* must_not (exclude) | | |**Array(Int)** |No special attributes |* must (include)|Array format data |\ | | |* must_not (exclude) | | |**Array(Float)** |

|||\ | |Not supported temporarily

| | |\ | | | | | |**Array(Object)** |

|||\ | |Not supported temporarily

| | |\ | | | | | |**Boolean** |

|||\ | |Not supported temporarily

| | |\ | | | | | --- ## Return Parameters After a request is processed, the system returns the re\-ranked recommendation results based on your dynamic weightage adjustments. Additionally, the `extra_info` field provides a detailed execution status for each dynamic boosting or demotion rule. ### ExtraInfo > For more information, see the recommendation API: [ExtraInfo](/docs/393/92213#09fcad10) |**Parameter** |**Type** |**Example value** |**Description** | |---|---|---|---| |boost_status |Array |`["success", "field not found", "invalid operator"]` |**Execution status of boost and demotion rules**|\ | | | |Status meanings, see below: [Status](/docs/85296/2123292#49cb8580)|\ | | | |:::tip \*Explanation|\ | | | |The system processes rules in the **exact order ** they are provided in the [Conds](/docs/85296/2123292#ca81d523) parameter within your [BoostConfig](/docs/85296/2123292#38cf87d9). Consequently, the order of status reports in the `boost_status` field will mirror your request perfectly.|\ | | | |For example: the first [BoostConfig](/docs/85296/2123292#38cf87d9)configuration executes successfully, the first status within `boost_status` will be `"success"`|\ | | | ||\ | | | |:::| #### Status |**Status value** |**Execution status** |**Meaning** | |---|---|---| |success |✅ success |**Rules configuration meets expectations**|\ | | |Boost and demotion rules take effect successfully in the current request. | |field not found |❌ Failed |**Field (** **`field`** **) validation failed.** |\ | | |Ensure the configured field exists in the item dataset | |invalid field type |❌ Failed |**Field (** **`field`** **) data format does not support boost or demotion.** |\ | | |Currently, Array, Array, and Boolean fields do not support boost or demotion rules.|\ | | |Ensure the field type matches the expected format, details at: [字段—算子—条件值配置](/docs/85296/2123292#6099735e) | |invalid date field |❌ Failed |**The field (** **`field`** **) is not a time attribute**|\ | | |The condition value input (`conds`) uses a time attribute format, but the field (`field`) is not configured as "timestamp" or "Launch time". | |invalid operator |❌ Failed |**The field (** **`field`** **) is valid, but the configured operator (** **`op`** **) is invalid.** |\ | | |Ensure the operator configuration matches the expected format, details at: [字段—算子—条件值配置](/docs/85296/2123292#6099735e) | |invalid conds |❌ failed |**The field (** **`field`** **) and operator (** **`op`** **) are valid, but the condition value input (** **`conds`** **) is invalid.** |\ | | |Possible reasons include:|\ | | ||\ | | |1. Incorrect data format|\ | | |2. The field is configured with "timestamp" or "Launch time" attribute|\ | | ||\ | | |Ensure the condition value input meets expectations. Details at: [字段—算子—条件值配置](/docs/85296/2123292#6099735e) | |invalid boost |❌ failed |**Invalid configuration of boost or demotion intensity.** |\ | | |Ensure the input is a number between \-1 and 1. | --- # Example ```mixin-react return ( ); ``` --- # Frequently Asked Questions (FAQ) **Q: What happens if a boost or demotion configuration is invalid?** The system automatically ignores invalid boost and demote rules; other valid rules remain effective as usual. **Q: How can users know the execution results of dynamic boost and demotion rules?** A: The system returns the execution results of dynamic boost and demotion rules in the order specified in the request body parameters, including success, field not found, invalid field type, and other information. For details, please refer to [Status](/docs/85296/2123292#49cb8580).

Viking AI Search