Class: CollectionBuilder

Defined in: src/batteries/vector/schema.ts:29

Chainable builder for a single collection definition — declares the vector column and the typed metadata fields, compiled to a CollectionSpec by CollectionBuilder.build.

Constructors

Constructor

new CollectionBuilder(): CollectionBuilder;

Returns

CollectionBuilder

Methods

boolean()

boolean(name: string): FieldChain;

Defined in: src/batteries/vector/schema.ts:58

Declare a boolean metadata field; returns a FieldChain for .index()/.nullable().

Parameters

Parameter	Type
name	string

Returns

FieldChain

---

build()

build(collection: string): CollectionSpec;

Defined in: src/batteries/vector/schema.ts:83

Compile the accumulated definition into a CollectionSpec.

Parameters

Parameter	Type
collection	string

Returns

CollectionSpec

Throws

when no CollectionBuilder.vector definition was declared.

---

integer()

integer(name: string): FieldChain;

Defined in: src/batteries/vector/schema.ts:48

Declare an integer metadata field; returns a FieldChain for .index()/.nullable().

Parameters

Parameter	Type
name	string

Returns

FieldChain

---

json()

json(name: string): FieldChain;

Defined in: src/batteries/vector/schema.ts:63

Declare a JSON metadata field; returns a FieldChain for .index()/.nullable().

Parameters

Parameter	Type
name	string

Returns

FieldChain

---

number()

number(name: string): FieldChain;

Defined in: src/batteries/vector/schema.ts:53

Declare a number metadata field; returns a FieldChain for .index()/.nullable().

Parameters

Parameter	Type
name	string

Returns

FieldChain

---

string()

string(name: string): FieldChain;

Defined in: src/batteries/vector/schema.ts:43

Declare a string metadata field; returns a FieldChain for .index()/.nullable().

Parameters

Parameter	Type
name	string

Returns

FieldChain

---

vector()

vector(def: {
  dimensions: number;
  metric?: DistanceMetric;
}): this;

Defined in: src/batteries/vector/schema.ts:34

Declare the vector column's dimensionality and (optionally) its distance metric (default 'cosine').

Parameters

Parameter	Type
def	{ dimensions: number; metric?: DistanceMetric; }
def.dimensions	number
def.metric?	DistanceMetric

Returns

this