VectorRepository
Defined in: types.ts:135
Extends
Section titled “Extends”Repository<T,D>
Type Parameters
Section titled “Type Parameters”T extends Record<string, unknown>
D = Partial<T>
Methods
Section titled “Methods”count()
Section titled “count()”count(
params?):Promise<number>
Defined in: types.ts:123
Parameters
Section titled “Parameters”params?
Section titled “params?”Returns
Section titled “Returns”Promise<number>
Inherited from
Section titled “Inherited from”deleteById()
Section titled “deleteById()”deleteById(
id):Promise<T>
Defined in: types.ts:122
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<T>
Inherited from
Section titled “Inherited from”deleteVector()
Section titled “deleteVector()”deleteVector(
id):Promise<T>
Defined in: types.ts:145
Delete a vector and its associated record
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<T>
describe()?
Section titled “describe()?”
optionaldescribe():RepositoryCapabilities
Defined in: types.ts:132
Optional capability introspection. All
Returns
Section titled “Returns”Mantlejs
Section titled “Mantlejs”adapters implement it; user repositories may omit it.
Inherited from
Section titled “Inherited from”findAll()
Section titled “findAll()”findAll(
params?):Promise<T[]>
Defined in: types.ts:116
Parameters
Section titled “Parameters”params?
Section titled “params?”Returns
Section titled “Returns”Promise<T[]>
Inherited from
Section titled “Inherited from”findById()
Section titled “findById()”findById(
id):Promise<T|null>
Defined in: types.ts:117
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<T | null>
Inherited from
Section titled “Inherited from”findPage()?
Section titled “findPage()?”
optionalfindPage(params?):Promise<CursorPage<T>>
Defined in: types.ts:130
Optional cursor pagination. Implemented by adapters whose backend is natively cursored
(DynamoDB, Qdrant, Pinecone) — describe().pagination reports "cursor" or "both" when
available. Stateless: the cursor lives entirely in the returned page, so concurrent calls
on one repository instance never interfere.
Parameters
Section titled “Parameters”params?
Section titled “params?”QueryParams & object
Returns
Section titled “Returns”Promise<CursorPage<T>>
Inherited from
Section titled “Inherited from”findSimilar()
Section titled “findSimilar()”findSimilar(
vector,topK,params?):Promise<T&object[]>
Defined in: types.ts:141
Find the top-K records most similar to the given embedding vector.
Every result carries the adapter’s native match metric as _score — whether a higher
or lower value means “more similar” is adapter-specific; see the adapter README.
Parameters
Section titled “Parameters”vector
Section titled “vector”number[]
number
params?
Section titled “params?”Returns
Section titled “Returns”Promise<T & object[]>
patchById()
Section titled “patchById()”patchById(
id,data):Promise<T>
Defined in: types.ts:121
Parameters
Section titled “Parameters”D
Returns
Section titled “Returns”Promise<T>
Inherited from
Section titled “Inherited from”save()
Section titled “save()”save(
data):Promise<T>
Defined in: types.ts:118
Parameters
Section titled “Parameters”D
Returns
Section titled “Returns”Promise<T>
Inherited from
Section titled “Inherited from”saveAll()
Section titled “saveAll()”saveAll(
data):Promise<T[]>
Defined in: types.ts:119
Parameters
Section titled “Parameters”D[]
Returns
Section titled “Returns”Promise<T[]>
Inherited from
Section titled “Inherited from”updateById()
Section titled “updateById()”updateById(
id,data):Promise<T>
Defined in: types.ts:120
Parameters
Section titled “Parameters”D
Returns
Section titled “Returns”Promise<T>
Inherited from
Section titled “Inherited from”upsertVector()
Section titled “upsertVector()”upsertVector(
id,vector,data):Promise<T>
Defined in: types.ts:143
Upsert a record with its embedding vector
Parameters
Section titled “Parameters”vector
Section titled “vector”number[]
Partial<T>
Returns
Section titled “Returns”Promise<T>