# Function overview This function implements dynamic boosting and demotion configurations via API, allowing users to specify fields, operators, values, and weight intensity (between \-1 and 1) directly within a request, enabling real\-time adjustment of search result ranking weights. It solves the limitation of only being able to manually adjust weights through the console. # Core values 1. **Reduced Manual Maintenance:** Eliminates the risk of human error or omissions during manual weight adjustments, empowering more efficient business operations. 2. **Dynamic Business Integration:** Enables customers to integrate boosting/demotion logic with their own business systems (such as inventory, marketing, or risk control) for real\-time adjustments and faster response times. 3. **User\-Level Personalization:** Supports weight configurations at the individual user level, significantly enhancing the personalized search experience. --- # API configuration :::tip \*Preconditions You must have already successfully integrated the AI Search Engine **Search API**. Please refer to [Search](/docs/393/92284). ::: When sending a search request, simply add the relevant boosting and demotion parameters. The platform will automatically merge the weight rules configured in the **Console** with those provided via the **API**. ## Request parameters |**Parameters** |**Type** |**Required** |**Example value** | |---|---|---|---| |conditional_boost |Array <**Conds**\> |**`Required`** |See below: [Conds](/docs/85296/2166627#ca81d523) | ### Conds :::tip \*Tip If a rule is invalid, the service will automatically ignore individual privilege escalation or reduction rules to ensure other valid rules remain effective. ::: |**Parameter name** |**Data format** |**Required** |**Example value** |**Description** | |---|---|---|---|---| |conds |Array <**BoostConfig**\> |**`Required`** |See: [BoostConfig](/docs/85296/2166627#38cf87d9) |**Boost and Demotion Configuration**|\ | | | | |The platform only boosts or demotes items that meet the criteria. | |boost |Float |**`Required`** |0.3、\-0.3 |**Boost and Demotion Intensity**|\ | | | | |Supports any value between \-1 and 1. | ### BoostConfig |**Parameter Name** |**Data Format** |**Required** |**Example value** |**Description** | |---|---|---|---|---| |field |String |**`Required`** |`"author"` |**Conditional field**|\ | | | | |Field used for boosting or demotion condition.|\ | | | | |:::tip \*Tip for nested field|\ | | | | |Fields can be configured using`.`; for example:`category.name`|\ | | | | ||\ | | | | |:::| |op |String |**`Required`** |`"must"` |**operator**|\ | | | | |Operators supported by each field type are as follows: [字段—算子—条件值配置](/docs/85296/2166627#6099735e) | |conds |Based on the field |**`Required`** | |**Condition value**|\ | | | | |A set of conditions for boosting and demotion. Supported values for each field type and operator are as follows: [字段—算子—条件值配置](/docs/85296/2166627#6099735e) | ### **Field–Operator–** Condition value **configuration** |**Field type (field)** |**Field attribute** |**Supported operator (op)** |**Condition value input (conds)** | |---|---|---|---| |**Int32** |No attribute, other attributes |* `equal` (equals)|Int32 format data |\ | | |* `not_equal` (not equals)| |\ | | |* `lte` (less than or equal to)| |\ | | |* `lt` (less than)| |\ | | |* `gte` (greater than or equal to)| |\ | | |* `gt` (greater than) | | |**Int64** |no attribute, other attributes |* `equal` (equal to)|Int64 format data |\ | | |* `not_equal` (not equal to)| |\ | | |* `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` (in range) |* `Xd` (X days)|\ | | | |* `Xh` (X hours)|\ | | | |* `Xm` (X minutes) | |**Float** |Unsupported attribute |* `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) | | |^^|release time |* `before` (earlier than)|UNIX timestamp |\ | | |* `after` (later than) | | |^^|^^|* `within` (within 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

| | |\ | | | | | --- ## Response parameters The system returns the search results after weight adjustment. Additionally, the `extra_info` field provides the execution status of your dynamic boosting and burying rules. ### ExtraInfo > For more information, see the search interface: [Search](/docs/393/92284) |**parameter** |**type** |**example value** |**description** | |---|---|---|---| |`boost_status` |Array |`["success", "field not found", "invalid operator"]` |The execution status of each boosting/demotion rule. status meanings, see below: [Status](/docs/85296/2166627#49cb8580)|\ | | | |:::tip \*Tip|\ | | | | **\*\*Strictly follow ** **\*\* ** **the order ** **of ** [BoostConfig](/docs/85296/2166627#38cf87d9) ** specified in the ** [Conds](/docs/85296/2166627#ca81d523) **parameters**；|\ | | | |For example: the first [BoostConfig](/docs/85296/2166627#38cf87d9) configuration executes successfully,`boost_status`'s first status will be `"success"`|\ | | | ||\ | | | |:::| ### Status |**Status value** |**Execution status** |**Meaning** | |---|---|---| |success |✅ success |**The rule configuration meets expectations**|\ | | |The boosting and demotion rules successfully are applied to this request. | |field not found |❌ failure |**The field (** **`field`** **) validation failed**|\ | | |Ensure the configured field exists in the item dataset. | |invalid field type |❌ failure |**The data type of the field (** **`field`** **) does not support boosting or demotion**|\ | | |Currently, Array, Array, and Boolean fields do not support weighting or weight reduction rules.|\ | | |Ensure the field type matches the expectation. For details, see: [字段—算子—条件值配置](/docs/85296/2123292#6099735e) | |invalid date field |❌ failure |**The field (** **`field`** **) is not a time attribute**|\ | | |The condition value input (`conds`) uses the time attribute configuration format, but the field (`field`) is not configured as "timestamp" or "publish time" | |invalid operator |❌ failed |**The field (** **`field`** **) is valid but the configured operator (** **`op`** **) is invalid**|\ | | |Please ensure operator configuration meets expectations. 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. field is configured with “timestamp” or “publish time” attribute|\ | | ||\ | | |Please ensure the condition value input meets expectations. For details, see: [字段—算子—条件值配置](/docs/85296/2123292#6099735e) | |invalid boost |❌ failure |**The configuration for boost and demotion intensity is invalid.** |\ | | |Make sure the input is a number between \-1 and 1. | --- # Example ```mixin-react return ( ); ``` --- # FAQ **Q: What happens if a boost or demotion rule is invalid?** A: The system automatically ignores invalid boost and demotion rules; other valid rules remain effective. **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 of the request body parameters, including success, field not found, invalid field type, and other information. See details at [Status](/docs/85296/2166627#49cb8580).

Viking AI Search