Skip to content
This repository was archived by the owner on Jan 15, 2026. It is now read-only.

Commit 3ad6362

Browse files
authored
docs: reword docstring for correctness (#12)
1 parent 1fa1227 commit 3ad6362

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

query.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ type QueryRequest struct {
1212
// DistanceMetric is the distance metric to use for vector search.
1313
// Required if Vector is set.
1414
DistanceMetric DistanceMetric `json:"distance_metric,omitempty"`
15-
// RankBy is the fields to rank by for BM25 search.
16-
// Either Vector or RankBy, but not both, may be set.
15+
// RankBy is the fields to rank by, for BM25 search, or fields to order by,
16+
// for filter-only search. Either Vector or RankBy, but not both, may be set.
1717
RankBy []interface{} `json:"rank_by,omitempty"`
1818
// TopK is the maximum number of results to return. Default 10.
1919
TopK int `json:"top_k,omitempty"`

0 commit comments

Comments
 (0)