Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

fix(api): send a rerank window that covers top_k in Dify retrieval (#21427)

Yash Raj Pandey3d90503c4fae
diff --git a/internal/handler/dify_retrieval_handler.go b/internal/handler/dify_retrieval_handler.go
index cc6b2b29f1..9ee74eb6b3 100644
--- a/internal/handler/dify_retrieval_handler.go
+++ b/internal/handler/dify_retrieval_handler.go
@@ -232,6 +232,10 @@ func (h *DifyRetrievalHandler) Retrieval(c *gin.Context) {
}
pageSize := 1024
if topK != nil {
+ if *topK < 1 || *topK > 1024 {
+ common.ResponseWithHttpCodeData(c, http.StatusBadRequest, common.CodeArgumentError, nil, "top_k must be between 1 and 1024")
+ return
+ }
pageSize = *topK
}
@@ -262,18 +266,22 @@ func (h *DifyRetrievalHandler) Retrieval(c *gin.Context) {
kbs := []*entity.Knowledgebase{kb}
rankFeature := h.metadataSvc.LabelQuestion(ctx, req.Query, kbs)
- // Chunk retrieval
+ // Chunk retrieval. Without RerankCandidatesCount the service defaults the
+ // window to 64 and rejects any top_k above it, including the 1024 default.
+ // Keep 64 as the floor so a small top_k still ranks the same candidates.
+ rerankWindow := max(pageSize, 64)
sr := &nlp.RetrievalRequest{
- Question: req.Query,
- TenantIDs: []string{kb.TenantID},
- KbIDs: []string{req.KnowledgeID},
- DocIDs: docIDs,
- Page: 1,
- PageSize: pageSize,
- KNNTopK: topK,
- SimilarityThreshold: scoreThreshold,
- EmbeddingModel: embModel,
- Language: entity.KnowledgebasesLanguage(kbs),
+ Question: req.Query,
+ TenantIDs: []string{kb.TenantID},
+ KbIDs: []string{req.KnowledgeID},
+ DocIDs: docIDs,
+ Page: 1,
+ PageSize: pageSize,
+ RerankCandidatesCount: &rerankWindow,
+ KNNTopK: topK,
+ SimilarityThreshold: scoreThreshold,
+ EmbeddingModel: embModel,
+ Language: entity.KnowledgebasesLanguage(kbs),
}
if rankFeature != nil {
sr.RankFeature = &rankFeature
diff --git a/internal/handler/dify_retrieval_handler_test.go b/internal/handler/dify_retrieval_handler_test.go
index 5aa4348615..e9259729ab 100644
--- a/internal/handler/dify_retrieval_handler_test.go
+++ b/internal/handler/dify_retrieval_handler_test.go
@@ -495,3 +495,65 @@ func TestDifyRetrieval_RetrievalNotFound(t *testing.T) {
t.Errorf("expected 404 for not_found, got %d", w.Code)
}
}
+
+func TestDifyRetrieval_RerankWindowCoversTopK(t *testing.T) {
+ cases := []struct {
+ name, method, url, body string
+ wantPageSize, wantWindow int
+ }{
+ {"default top_k", "POST", "/api/v1/dify/retrieval", `{"knowledge_id": "kb1", "query": "test"}`, 1024, 1024},
+ {"top_k above 64", "POST", "/api/v1/dify/retrieval", `{"knowledge_id": "kb1", "query": "test", "retrieval_setting": {"top_k": 100}}`, 100, 100},
+ {"GET top_k", "GET", "/api/v1/dify/retrieval?knowledge_id=kb1&query=test&top_k=200", "", 200, 200},
+ {"top_k below 64 keeps the default window", "POST", "/api/v1/dify/retrieval", `{"knowledge_id": "kb1", "query": "test", "retrieval_setting": {"top_k": 10}}`, 10, 64},
+ }
+ for _, tc := range cases {
+ t.Run(tc.name, func(t *testing.T) {
+ h, r := setupDifyTest("user1")
+ var got *nlp.RetrievalRequest
+ h.retrievalSvc = &mockRetrievalService{
+ retrievalFn: func(ctx context.Context, req *nlp.RetrievalRequest) (*nlp.RetrievalResult, error) {
+ got = req
+ return &nlp.RetrievalResult{}, nil
+ },
+ }
+ w := httptest.NewRecorder()
+ req, _ := http.NewRequest(tc.method, tc.url, strings.NewReader(tc.body))
+ req.Header.Set("Content-Type", "application/json")
+ r.ServeHTTP(w, req)
+ if w.Code != http.StatusOK {
+ t.Fatalf("expected 200, got %d: %s", w.Code, w.Body.String())
+ }
+ if got.PageSize != tc.wantPageSize {
+ t.Errorf("PageSize = %d, want %d", got.PageSize, tc.wantPageSize)
+ }
+ if got.RerankCandidatesCount == nil {
+ t.Fatal("RerankCandidatesCount is nil")
+ }
+ if *got.RerankCandidatesCount != tc.wantWindow {
+ t.Errorf("RerankCandidatesCount = %d, want %d", *got.RerankCandidatesCount, tc.wantWindow)
+ }
+ })
+ }
+}
+
+func TestDifyRetrieval_TopKOutOfRange(t *testing.T) {
+ for _, topK := range []string{"0", "-1", "1025"} {
+ t.Run(topK, func(t *testing.T) {
+ h, r := setupDifyTest("user1")
+ h.retrievalSvc = &mockRetrievalService{
+ retrievalFn: func(ctx context.Context, req *nlp.RetrievalRequest) (*nlp.RetrievalResult, error) {
+ t.Fatal("retrieval must not run for an out-of-range top_k")
+ return nil, nil
+ },
+ }
+ w := httptest.NewRecorder()
+ body := `{"knowledge_id": "kb1", "query": "test", "retrieval_setting": {"top_k": ` + topK + `}}`
+ req, _ := http.NewRequest("POST", "/api/v1/dify/retrieval", strings.NewReader(body))
+ req.Header.Set("Content-Type", "application/json")
+ r.ServeHTTP(w, req)
+ if w.Code != http.StatusBadRequest {
+ t.Errorf("expected 400, got %d: %s", w.Code, w.Body.String())
+ }
+ })
+ }
+}