Skip to content

Document fine-grained IVF search controls and custom index names#220

Merged
prrao87 merged 2 commits intomainfrom
docs/vector-index-search-controls
Apr 21, 2026
Merged

Document fine-grained IVF search controls and custom index names#220
prrao87 merged 2 commits intomainfrom
docs/vector-index-search-controls

Conversation

@prrao87
Copy link
Copy Markdown
Contributor

@prrao87 prrao87 commented Apr 21, 2026

Summary

  • Expand the Vector Index page with clearer IVF search-time guidance, replacing the crowded Search Configuration bullet list with markdown tables (core knobs + per-index-type nprobes guidance).
  • Document minimum_nprobes / maximum_nprobes, including the filtered-query case where LanceDB adaptively scans extra partitions only when the initial pass under-returns.
  • Add a new Advanced Search Controls subsection covering distance_range(...) (thresholded retrieval) and bypass_vector_index() (flat search for recall measurement or unsupported metrics).
  • Document that vector index names can be customized via name=...; the _idx suffix is a default convention, not the only supported path.
  • Add four runnable pytest snippet tests so the new code examples stay in sync with the lancedb Python SDK.

All referenced APIs verified against the lancedb source (query.py, table.py).

Test plan

  • pytest tests/py/test_indexing.py — all 22 tests pass
  • scripts/mdx_snippets_gen.py regenerated snippets cleanly
  • Visual review of the rendered Mintlify page (tables, callouts, code blocks)

🤖 Generated with Claude Code

…nd custom index names

- Replace Search Configuration bullets with markdown tables covering
  core knobs and per-index-type nprobes guidance
- Document minimum_nprobes / maximum_nprobes with a note on adaptive
  partition scanning under filtered queries
- Add Advanced Search Controls subsection covering distance_range()
  for thresholded retrieval and bypass_vector_index() for recall
  measurement against flat-scan ground truth
- Document that vector indexes support custom names via name=...,
  clarifying that the _idx suffix is a default convention
- Add four runnable pytest snippet tests backing the new examples

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Apr 21, 2026

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

Project Status Preview Updated (UTC)
lancedb-bcbb4faf 🟢 Ready View Preview Apr 21, 2026, 6:35 AM

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

@prrao87 prrao87 merged commit 7d261e7 into main Apr 21, 2026
2 checks passed
@prrao87 prrao87 deleted the docs/vector-index-search-controls branch April 21, 2026 07:01
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