Class SearchScoring

Controls how the search service scores the results of a request.

Inheritance

object

SearchScoring

NoneScoring

ReciprocalRankFusionScoring

RelativeScoreFusionScoring

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Couchbase.Search

Assembly: Couchbase.NetClient.dll

Syntax

[InterfaceStability(Level.Uncommitted)]
public abstract class SearchScoring

Remarks

The fusion strategies control how the FTS and vector result sets of a hybrid request - one which combines a search query with a vector search - are merged into a single ranked list. They require a version of Couchbase Server that supports score fusion. Applied to a single result set they re-score the hits, but leave their ordering unchanged.

Under a fusion strategy the top-level boost of the search query and of each vector query is that side's fusion weight. A boost of 2.0 on the search query and 1.0 on the vector query counts the search side twice as much as the vector side. Boosts within a compound query keep their existing meaning, scaling a clause within the FTS score.

Methods

None()

Disables scoring. This is not a fusion strategy, and works against any server version.

Declaration

public static NoneScoring None()

Returns

Type	Description
NoneScoring	A NoneScoring.

ReciprocalRankFusion()

Merges the FTS and vector result sets by rank rather than by raw score. The recommended fusion strategy; it works well with the server defaults.

Declaration

public static ReciprocalRankFusionScoring ReciprocalRankFusion()

Returns

Type	Description
ReciprocalRankFusionScoring	A ReciprocalRankFusionScoring for chaining method calls.

RelativeScoreFusion()

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

Declaration

public static RelativeScoreFusionScoring RelativeScoreFusion()

Returns

Type	Description
RelativeScoreFusionScoring	A RelativeScoreFusionScoring for chaining method calls.