docs: document new IndexConfig metadata fields#270
Open
mintlify[bot] wants to merge 2 commits into
Open
Conversation
2 tasks
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
- Present new list_indices() metadata fields as a compact table instead of a doubled snake/camelCase bullet list - Collapse the "Option 1/Option 2" subheadings into one flowing "Check Index Status" section and name the LanceDB Enterprise UI - Correct the UI behavior: the "Index" column shows an "in progress" label while building (verified against the sophon UI), not blank - Drop the unsupported "few minutes for 1M vectors" perf claim - Promote "Custom Index Names" to a top-level section (it's a creation-time concern, not a child of "Use the API") Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
prrao87
added
the
needs_new_release
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new per-index metadata fields returned by
list_indices(), and tidies the surrounding "Check Index Status" section while doing so.Changes
num_indexed_rows,num_unindexed_rows,size_bytes,num_segments,index_version,created_at,index_uuid,type_url,index_details) as a compact table grouped by what each tells you, rather than a doubled snake/camelCase bullet list. Notes when they're populated vs.None/undefined.Option 1: Check the UI/Option 2: Use the APIsubheadings into one flowing "Check Index Status" section, and name the UI explicitly as the LanceDB Enterprise UI.####(nested under "Use the API") to a top-level section, since custom naming is a creation-time concern, not a status-checking sub-step. This also de-clutters the sidebar.Context
Surfaces user-facing changes from the upstream feature that exposes richer per-index metadata to Python and Node.js, so users can inspect index coverage, size, and details directly from
list_indices()results without a separateindex_stats()call.