Skip to content
1 min read · 141 words

Interface: Projection

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

Normalized projection from .select(); REQUIRED on reads — every column opt-in, id included.

Properties

PropertyTypeDescriptionDefined in
document| false | { field?: string; }Whether to return the document body (optionally from a named field); false to omit.src/batteries/vector/plan.ts:21
idbooleanWhether to return each match's id.src/batteries/vector/plan.ts:17
metadata| false | { fields?: string[]; }Whether to return metadata (optionally a subset of fields); false to omit.src/batteries/vector/plan.ts:23
vector| false | { name?: string; }Whether to return the stored vector (optionally renamed); false to omit.src/batteries/vector/plan.ts:19