Skip to content

Commit 58e8da6

Browse files
committed
Document that default combination method is RRF
1 parent d8accf5 commit 58e8da6

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

redisvl/query/hybrid.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,10 @@ def __init__(
109109
accuracy of the search.
110110
yield_vsim_score_as: The name of the field to yield the vector similarity score as.
111111
vector_filter_expression: The filter expression to use for the vector similarity search. Defaults to None.
112-
combination_method: The combination method to use. Options are {RRF, LINEAR}. Defaults to None. If "RRF" is
113-
specified, then at least one of `rrf_window` or `rrf_constant` must be provided. If "LINEAR" is
114-
specified, then at least one of `linear_alpha` or `linear_beta` must be provided.
112+
combination_method: The combination method to use. Options are {RRF, LINEAR}. If not specified, the server
113+
defaults to RRF. If "RRF" is specified, then at least one of `rrf_window` or `rrf_constant` must be
114+
provided. If "LINEAR" is specified, then at least one of `linear_alpha` or `linear_beta` must be
115+
provided.
115116
rrf_window: The window size to use for the reciprocal rank fusion (RRF) combination method. Limits
116117
fusion scope.
117118
rrf_constant: The constant to use for the reciprocal rank fusion (RRF) combination method. Controls decay

0 commit comments

Comments
 (0)