Base class for the scoring mode of a search query. More...

#include <couchbase/search_scoring.hxx>

Inheritance diagram for search_scoring:

Classes
struct	built
	Immutable value object representing a scoring mode. More...

Public Member Functions
virtual	~search_scoring ()=default
virtual auto	build () const -> built=0
	Returns the scoring mode as an immutable value.

Protected Member Functions
	search_scoring ()=default

Detailed Description

Base class for the scoring mode of a search query.

Score fusion controls how the FTS and vector result sets of a hybrid request are merged into a single ranked list. It is only meaningful for a hybrid request (both an FTS query and a vector search); when applied to a single result set the server re-scores the hits but leaves their ordering unchanged.

Each mode is its own type and only exposes its own parameters:

search_scoring_reciprocal_rank_fusion merges by rank.
search_scoring_relative_score_fusion merges by normalized score.
search_scoring_none disables scoring.

See also: search_options::scoring()

Since: 1.5.0

Committed: Generally available API and should be preferred in production

Constructor & Destructor Documentation

◆ ~search_scoring()

virtual ~search_scoring ( )

virtualdefault

◆ search_scoring()

search_scoring ( )

protecteddefault

Member Function Documentation

◆ build()

virtual auto build ( ) const -> built

nodiscardpure virtual

Returns the scoring mode as an immutable value.

Returns: the scoring mode as an immutable value

Since: 1.5.0

Internal: Internal interface

Implemented in search_scoring_none, search_scoring_reciprocal_rank_fusion, and search_scoring_relative_score_fusion.

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

couchbase/search_scoring.hxx

Classes