Skip to content

Open-source LLM knowledge platform: turn raw documents into a queryable RAG, an autonomous reasoning agent, and a self-maintaining Wiki.

4.4 KB
Raw Blame
package rerank

import (
	"context"

	"github.com/Tencent/WeKnora/internal/tracing/langfuse"
)

const (
	langfuseRerankPreviewDocs = 8
	langfuseRerankMaxScores   = 50
)

// langfuseReranker wraps a Reranker and reports each rerank call as a
// Langfuse generation observation. Rerankers don't return token usage, but
// the call still incurs cost (billed per 1K documents by most vendors); we
// estimate input tokens from the query + documents so the Langfuse cost
// dashboard gets a proportional signal.
type langfuseReranker struct {
	inner Reranker
}

func (l *langfuseReranker) GetModelName() string { return l.inner.GetModelName() }
func (l *langfuseReranker) GetModelID() string   { return l.inner.GetModelID() }

// MaxPassageRunes forwards the wrapped reranker's limit.
func (l *langfuseReranker) MaxPassageRunes(query string) int { return MaxPassageRunes(l.inner, query) }

func (l *langfuseReranker) Rerank(ctx context.Context, query string, documents []string) ([]RankResult, error) {
	mgr := langfuse.GetManager()
	if !mgr.Enabled() {
		return l.inner.Rerank(ctx, query, documents)
	}

	totalChars := len([]rune(query))
	for _, doc := range documents {
		totalChars += len([]rune(doc))
	}

	genCtx, gen := mgr.StartGeneration(ctx, langfuse.GenerationOptions{
		Name:  "rerank",
		Model: l.inner.GetModelName(),
		Input: map[string]interface{}{
			"query":             query,
			"document_count":    len(documents),
			"documents_preview": previewDocs(documents, langfuseRerankPreviewDocs),
		},
		Metadata: map[string]interface{}{
			"model_id":      l.inner.GetModelID(),
			"num_queries":   1,
			"total_chars":   totalChars,
			"avg_doc_chars": avgDocChars(documents),
		},
	})

	results, err := l.inner.Rerank(genCtx, query, documents)

	output := map[string]interface{}{
		"results":     summarizeResults(results, documents, langfuseRerankMaxScores),
		"total_count": len(results),
		"score_stats": scoreStats(results),
	}
	if len(results) > langfuseRerankMaxScores {
		output["truncated"] = len(results) - langfuseRerankMaxScores
	}
	gen.Finish(output, approxRerankUsage(query, documents), err)
	return results, err
}

func avgDocChars(documents []string) int {
	if len(documents) == 0 {
		return 0
	}
	total := 0
	for _, doc := range documents {
		total += len([]rune(doc))
	}
	return total / len(documents)
}

func scoreStats(results []RankResult) map[string]interface{} {
	if len(results) == 0 {
		return nil
	}
	minScore := results[0].RelevanceScore
	maxScore := results[0].RelevanceScore
	sum := 0.0
	for _, r := range results {
		if r.RelevanceScore < minScore {
			minScore = r.RelevanceScore
		}
		if r.RelevanceScore > maxScore {
			maxScore = r.RelevanceScore
		}
		sum += r.RelevanceScore
	}
	return map[string]interface{}{
		"min": minScore,
		"max": maxScore,
		"avg": sum / float64(len(results)),
	}
}

func approxRerankUsage(query string, documents []string) *langfuse.TokenUsage {
	total := len([]rune(query))/4 + 1
	for _, d := range documents {
		total += len([]rune(d))/4 + 1
	}
	if total == 0 {
		return nil
	}
	return &langfuse.TokenUsage{
		Input: total,
		Total: total,
		Unit:  "TOKENS",
	}
}

func previewDocs(docs []string, n int) []map[string]interface{} {
	if len(docs) < n {
		n = len(docs)
	}
	out := make([]map[string]interface{}, 0, n)
	for i := 0; i < n; i++ {
		out = append(out, map[string]interface{}{
			"index":   i,
			"preview": truncateRunes(docs[i], 160),
			"length":  len([]rune(docs[i])),
		})
	}
	return out
}

func summarizeResults(results []RankResult, documents []string, n int) []map[string]interface{} {
	if len(results) < n {
		n = len(results)
	}
	out := make([]map[string]interface{}, 0, n)
	for i := 0; i < n; i++ {
		row := map[string]interface{}{
			"rank":        i + 1,
			"index":       results[i].Index,
			"model_score": results[i].RelevanceScore,
		}
		idx := results[i].Index
		if idx >= 0 && idx < len(documents) {
			row["preview"] = truncateRunes(documents[idx], 160)
		}
		out = append(out, row)
	}
	return out
}

func truncateRunes(s string, maxRunes int) string {
	r := []rune(s)
	if len(r) <= maxRunes {
		return s
	}
	return string(r[:maxRunes]) + "..."
}

// wrapRerankerLangfuse applies the Langfuse decorator when the manager is
// enabled. Called from NewReranker after the debug wrapper so both sinks see
// the same calls.
func wrapRerankerLangfuse(r Reranker, err error) (Reranker, error) {
	if err != nil || r == nil {
		return r, err
	}
	if !langfuse.GetManager().Enabled() {
		return r, nil
	}
	return &langfuseReranker{inner: r}, nil
}