Merges the FTS and vector result sets by rank rather than by raw score. More...

#include <couchbase/search_scoring_reciprocal_rank_fusion.hxx>

Inheritance diagram for search_scoring_reciprocal_rank_fusion:

Public Member Functions
	search_scoring_reciprocal_rank_fusion ()=default
auto	rank_constant (std::uint32_t rank_constant) -> search_scoring_reciprocal_rank_fusion &
	The rank constant of the Reciprocal Rank Fusion formula.
auto	window_size (std::uint32_t window_size) -> search_scoring_reciprocal_rank_fusion &
	How many results per list are considered for fusion.
auto	build () const -> search_scoring::built override
	Returns the scoring mode as an immutable value.
Public Member Functions inherited from search_scoring
virtual	~search_scoring ()=default

Additional Inherited Members
Protected Member Functions inherited from search_scoring
	search_scoring ()=default

Detailed Description

Merges the FTS and vector result sets by rank rather than by raw score.

It works well with the server defaults, and is the recommended strategy.

Note: available from Couchbase Server 8.1. Setting it makes the SDK check for the score fusion cluster capability, and fail the operation with feature_not_available if the cluster does not advertise it.

Since: 1.5.0

Uncommitted: Might be changed in the future, and eventually promoted to committed

Constructor & Destructor Documentation

◆ search_scoring_reciprocal_rank_fusion()

search_scoring_reciprocal_rank_fusion ( )

default

Member Function Documentation

◆ build()

auto build ( ) const -> search_scoring::built

inlinenodiscardoverridevirtual

Returns the scoring mode as an immutable value.

Returns: the scoring mode as an immutable value

Since: 1.5.0

Internal: Internal interface

Implements search_scoring.

◆ rank_constant()

auto rank_constant ( std::uint32_t rank_constant ) -> search_scoring_reciprocal_rank_fusion &

inline

The rank constant of the Reciprocal Rank Fusion formula.

Parameters

rank_constant the rank constant

Returns: this scoring mode for chaining purposes.

Since: 1.5.0

Uncommitted: Might be changed in the future, and eventually promoted to committed

◆ window_size()

auto window_size ( std::uint32_t window_size ) -> search_scoring_reciprocal_rank_fusion &

inline

How many results per list are considered for fusion.

Parameters

window_size the window size

Returns: this scoring mode for chaining purposes.

Since: 1.5.0

Uncommitted: Might be changed in the future, and eventually promoted to committed

The documentation for this class was generated from the following file:

couchbase/search_scoring_reciprocal_rank_fusion.hxx

Public Member Functions