Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature #23931 api search index boosting #289

Merged
merged 2 commits into from
Oct 8, 2024
Merged

Feature #23931 api search index boosting #289

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06b62e6
#23931 index boosting
Oct 8, 2024
cc37a3a
#23931 add example section improve readability
Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/API/search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Loading