Class: Couchbase::SearchScoring::SearchScoringReciprocalRankFusion

Inherits:
SearchScoring
  • Object
show all
Defined in:
lib/couchbase/search_options.rb,
/home/runner/work/couchbase-ruby-client/couchbase-ruby-client/lib/couchbase/search_options.rb

Overview

SearchScoringReciprocalRankFusion merges the FTS and vector result sets of a hybrid search by rank rather than raw score.

Stability:

  • Uncommitted: This API may change in the future.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|| ... } ⇒ SearchScoringReciprocalRankFusion

Returns a new instance of SearchScoringReciprocalRankFusion.

Yield Parameters:

Stability:

  • Uncommitted: This API may change in the future.



1297
1298
1299
1300
 
# File 'lib/couchbase/search_options.rb', line 1297

def initialize
  super
  yield self if block_given?
end

Instance Attribute Details

#rank_constant ⇒ Integer?

Returns the rank constant used when merging the result sets (the server defaults this to 60).

Returns:

  • (Integer, nil) —

    the rank constant used when merging the result sets (the server defaults this to 60)

Stability:

  • Uncommitted: This API may change in the future.



1290
1291
1292
 
# File 'lib/couchbase/search_options.rb', line 1290

def rank_constant
  @rank_constant
end

#window_size ⇒ Integer?

Returns how many results per list are considered for fusion (the server defaults this to the request limit).

Returns:

  • (Integer, nil) —

    how many results per list are considered for fusion (the server defaults this to the request limit)

Stability:

  • Uncommitted: This API may change in the future.



1294
1295
1296
 
# File 'lib/couchbase/search_options.rb', line 1294

def window_size
  @window_size
end