diff --git a/docs/API/search.md b/docs/API/search.md index e3c90a38..45d0ae7e 100644 --- a/docs/API/search.md +++ b/docs/API/search.md @@ -111,3 +111,21 @@ You can use the `random_seed` parameter to retrieve random content objects. The !!! Note Since random_seed is changing the order of retrieved content objects, it will override the value of your `order_by` parameter. + +## Increase scoring for specific content types + +!!! Note + Index boosting is available in Custom plan tier. + +Index boosting allows you to prioritize results from specific indices when performing searches across multiple content types (CTDs). This feature increases the score of results from certain indices based on user-defined weights, which is useful when some CTDs are more relevant than others. + +!!! Example + Pass the `indices_boost` parameter in your query to boost specific CTDs: + + ``` + /api/v1/search?indices_boost[ctd1Name]=2&indices_boost[ctd2Name]=1.5 + ``` + { data-search-exclude } + + * ctd1Name, ctd2Name – names of the CTDs. + * 2, 1.5 – boost values (higher means more weight)