Weighted Reciprocal Rank Fusion

Weighted Reciprocal Rank Fusion (WRRF) method for combining ranked lists.
You can use this endpoint to combine and ranked document items
from different systems or user preferences.

This API allows you to provide a list of ranked items and supporting
weights and scores so that you can get one list of ranked items
that caters to the user preferences.

Each list can have a weight. In addition, each item inside a list can have a score.
The position and score of each item is used to determinie the normalized
rank of the item. Items that come earlier in the list are given more weight,
and normalized after applying the additional score. A smoothing function
is applied to the position scores to ensure that the absolute position of items
does not skew the final ranking.

The final ranking is based on the combined score of each item and
the weight of the list it belongs to.

Item scores and list weights can be combined to formulate a
ranking that reflects the user's preferences.
For example, if one list comes from a search engine and another list
comes from human recommendation, you can assign higher weight to the
human recommendation list. If each item has a score that can be derived
from its attributes, e.g. date, it can be used to boost the
rank of certain types of items higher, despite their position in any list.
us-east-2

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
ranked_items
array of objects
required

List of items to be ranked. Each list has a weight, and items in the list are ranked such that higher ranked items come first. Each item can have a score to further influence its final rank.

Ranked Items*
string
enum
Defaults to sigmoid

Method to be used for smoothing the position scores. 'sigmoid' uses a sigmoid function, 'linear' uses a linear function to transform the position of items into a score, and scale it between 0 and 1.

Allowed:
number
Defaults to 0

Weight assigned to the item's score. Default is 0.0, i.e. item scores are not used by default.

number
Defaults to 1

Weight assigned to the item's position in the lists.It is used to combine and scale the score of an item globally after its position in each list has been transformed scores by the specified 'method'.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json