Skip to content
1 min read · 152 words

Interface: SearchPlan

Defined in: src/batteries/vector/plan.ts:27

A compiled nearest-neighbour search operation, consumed by an adapter's executeSearch.

Properties

PropertyTypeDescriptionDefined in
collectionstringCollection to search.src/batteries/vector/plan.ts:29
filter?VectorFilterOptional metadata filter applied alongside the vector search.src/batteries/vector/plan.ts:42
near?| { vector: number[]; } | { serverText: string; } | { id: string; }The nearest-neighbour anchor: a client vector, server-embedded text, or an existing record id.src/batteries/vector/plan.ts:31
offset?numberNumber of leading matches to skip.src/batteries/vector/plan.ts:46
projectionProjectionWhich fields each match projects.src/batteries/vector/plan.ts:48
topKnumberMaximum number of matches to return.src/batteries/vector/plan.ts:44