docs: add guidance on IndexDetails specification vs build strategy#6264
docs: add guidance on IndexDetails specification vs build strategy#6264wjones127 wants to merge 1 commit intolance-format:mainfrom
Conversation
Explains the distinction between index specification parameters (what was built, relevant at query time) and build strategy parameters (how it was built, irrelevant to readers). Includes guidance on designing spec parameters to be decoupled from dataset size, and the requirement that spec parameters fully describe an empty index. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
ReviewClean, well-structured documentation. Two substantive points: 1. The
|
Adds a new "Index Details" section to the index overview page explaining
the distinction between two categories of parameters in
index_detailsprotobuf messages:
query-time behavior; must be decoupled from dataset size; must fully
describe an empty index
to query execution; should not be stored in
index_detailsIncludes examples and a note on where to store build strategy parameters
if auditability is needed.
Looking for feedback on whether these criteria are the right ones and
whether the examples are well-chosen.