Skip to content

Docs updates to reranker section from audit workflow#228

Merged
prrao87 merged 4 commits intomainfrom
fix/workflow-3
May 4, 2026
Merged

Docs updates to reranker section from audit workflow#228
prrao87 merged 4 commits intomainfrom
fix/workflow-3

Conversation

@prrao87
Copy link
Copy Markdown
Contributor

@prrao87 prrao87 commented May 4, 2026

Reranking docs gaps — fixes from audit run 20260504T152409Z

Addresses the six gaps flagged in the docs-audit report for the reranking area, cross-checked against the lancedb source repo.

Overview page

  • Multi-vector example: added .with_row_id(True) on each search call and a warning explaining that deduplicate=True raises ValueError without _rowid (which is opt-in, so this is the default failure mode). Also calls out that RRFReranker.rerank_multivector(...) requires _rowid regardless of the flag.
  • SDK coverage: added a note after the Supported Rerankers table clarifying that CohereReranker / CrossEncoderReranker / ColbertReranker are Python-only — TypeScript and Rust currently expose only the generic Reranker interface and RRFReranker.

Custom rerankers page

  • Intro: rewritten to explain which methods to override (rerank_hybrid() required; rerank_vector() / rerank_fts() optional) and to flag that the base class raises NotImplementedError if you call rerank on a single-modality path you didn't override.
  • Return-shape contract: added a short paragraph to the Interface section stating the actual rule — your reranker must attach a _relevance_score column sorted descending, otherwise LanceDB rejects the table or .limit(...) returns rows in the wrong order.

Evaluation page

  • Score-based bullet: reframed so RRF is mentioned as the default and linear combination is one option, rather than implying linear combination is the only score-based path.
  • Default reranker: added an info callout noting that hybrid .rerank() defaults to RRFReranker().
  • normalize parameter: added a tip documenting normalize="score" (default) vs normalize="rank" and why it matters when evaluating score-based rerankers.

No test files changed, so no snippet regeneration was done as a result.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 4, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
lancedb-bcbb4faf 🟢 Ready View Preview May 4, 2026, 4:10 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@prrao87 prrao87 merged commit b3e4a5a into main May 4, 2026
2 checks passed
@prrao87 prrao87 deleted the fix/workflow-3 branch May 4, 2026 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant