Interface VectorStore

Abstract interface for vector store operations.

Enables dependency inversion and easier testing.

interface VectorStore {
    count(filter?: Record<string, unknown>): Promise<number>;
    delete(ids: string[]): Promise<void>;
    ensureCollection(): Promise<void>;
    ensureTextIndex(fieldName: string): Promise<void>;
    getCollectionInfo(): Promise<CollectionInfo>;
    getPayload(id: string): Promise<Record<string, unknown> | null>;
    getPointsWithVectors(ids: string[]): Promise<VectorPoint[]>;
    hybridSearch(
        vector: number[],
        queryText: string,
        limit: number,
        textWeight: number,
        filter?: Record<string, unknown>,
    ): Promise<SearchResult[]>;
    scroll(
        filter?: Record<string, unknown>,
        limit?: number,
    ): AsyncGenerator<ScrolledPoint>;
    scrollPage(
        filter?: Record<string, unknown>,
        limit?: number,
        offset?: string | number,
        fields?: string[],
    ): Promise<ScrollPageResult>;
    search(
        vector: number[],
        limit: number,
        filter?: Record<string, unknown>,
        offset?: number,
    ): Promise<SearchResult[]>;
    setPayload(ids: string[], payload: Record<string, unknown>): Promise<void>;
    upsert(points: VectorPoint[]): Promise<void>;
}

Implemented by

VectorStoreClient

Index

Methods

count delete ensureCollection ensureTextIndex getCollectionInfo getPayload getPointsWithVectors hybridSearch scroll scrollPage search setPayload upsert

Methods

count

count(filter?: Record<string, unknown>): Promise<number>
Count points matching a filter.
Parameters
- Optionalfilter: Record<string, unknown>
  Optional Qdrant filter.
Returns Promise<number>
The number of matching points.
- Defined in packages/service/src/vectorStore/types.ts:83

delete

delete(ids: string[]): Promise<void>
Delete points by their IDs.
Parameters
- ids: string[]
  The point IDs to delete.
Returns Promise<void>
- Defined in packages/service/src/vectorStore/types.ts:97

ensureCollection

ensureCollection(): Promise<void>
Ensure the collection exists with correct configuration.

Returns Promise<void>
- Defined in packages/service/src/vectorStore/types.ts:75

ensureTextIndex

ensureTextIndex(fieldName: string): Promise<void>
Create a full-text payload index on the specified field.
Parameters
- fieldName: string
  The payload field to index.
Returns Promise<void>
- Defined in packages/service/src/vectorStore/types.ts:169

getCollectionInfo

getCollectionInfo(): Promise<CollectionInfo>
Get collection info including point count, dimensions, and payload field schema.

Returns Promise<CollectionInfo>
- Defined in packages/service/src/vectorStore/types.ts:118

getPayload

getPayload(id: string): Promise<Record<string, unknown> | null>
Get the payload of a point by ID.
Parameters
- id: string
  The point ID.
Returns Promise<Record<string, unknown> | null>
The payload, or null if the point doesn't exist.
- Defined in packages/service/src/vectorStore/types.ts:113

getPointsWithVectors

getPointsWithVectors(ids: string[]): Promise<VectorPoint[]>
Retrieve points with their vectors by ID.
Parameters
- ids: string[]
  The point IDs to retrieve.
Returns Promise<VectorPoint[]>
Points with vectors and payloads; missing IDs are omitted.
- Defined in packages/service/src/vectorStore/types.ts:195

hybridSearch

hybridSearch(
    vector: number[],
    queryText: string,
    limit: number,
    textWeight: number,
    filter?: Record<string, unknown>,
): Promise<SearchResult[]>
Hybrid search combining dense vector and full-text match with RRF fusion.
Parameters
- vector: number[]
  The query vector.
- queryText: string
  The raw query text for full-text matching.
- limit: number
  Maximum results to return.
- textWeight: number
  Weight for text results in RRF (0–1).
- Optionalfilter: Record<string, unknown>
  Optional Qdrant filter.
Returns Promise<SearchResult[]>
An array of search results.
- Defined in packages/service/src/vectorStore/types.ts:181

scroll

scroll(
filter?: Record<string, unknown>,
limit?: number,
): AsyncGenerator<ScrolledPoint>
Scroll through all points matching a filter.
Parameters
- Optionalfilter: Record<string, unknown>
  Optional Qdrant filter.
- Optionallimit: number
  Page size for scrolling.
Returns AsyncGenerator<ScrolledPoint>
Yields
Scrolled points.
- Defined in packages/service/src/vectorStore/types.ts:159

scrollPage

scrollPage(
    filter?: Record<string, unknown>,
    limit?: number,
    offset?: string | number,
    fields?: string[],
): Promise<ScrollPageResult>
Scroll one page of points matching a filter.
Parameters
- Optionalfilter: Record<string, unknown>
  Optional Qdrant filter.
- Optionallimit: number
  Page size.
- Optionaloffset: string | number
  Cursor offset from previous page.
- Optionalfields: string[]
  Optional field projection.
Returns Promise<ScrollPageResult>
Page of points and next cursor.
- Defined in packages/service/src/vectorStore/types.ts:145

search

search(
    vector: number[],
    limit: number,
    filter?: Record<string, unknown>,
    offset?: number,
): Promise<SearchResult[]>
Search for similar vectors.
Parameters
- vector: number[]
  The query vector.
- limit: number
  Maximum results to return.
- Optionalfilter: Record<string, unknown>
  Optional Qdrant filter.
- Optionaloffset: number
  Optional result offset.
Returns Promise<SearchResult[]>
An array of search results.
- Defined in packages/service/src/vectorStore/types.ts:129

setPayload

setPayload(ids: string[], payload: Record<string, unknown>): Promise<void>
Set payload fields for the specified point IDs.
Parameters
- ids: string[]
  Point IDs to update.
- payload: Record<string, unknown>
  Payload fields to set.
Returns Promise<void>
- Defined in packages/service/src/vectorStore/types.ts:105

upsert

upsert(points: VectorPoint[]): Promise<void>
Upsert points into the collection.
Parameters
- points: VectorPoint[]
  The points to upsert.
Returns Promise<void>
- Defined in packages/service/src/vectorStore/types.ts:90

Interface VectorStore

Implemented by

Index

Methods

Methods

count

Parameters

Returns Promise<number>

delete

Parameters

Returns Promise<void>

ensureCollection

Returns Promise<void>

ensureTextIndex

Parameters

Returns Promise<void>

getCollectionInfo

Returns Promise<CollectionInfo>

getPayload

Parameters

Returns Promise<Record<string, unknown> | null>

getPointsWithVectors

Parameters

Returns Promise<VectorPoint[]>

hybridSearch

Parameters

Returns Promise<SearchResult[]>

scroll

Parameters

Returns AsyncGenerator<ScrolledPoint>

Yields

scrollPage

Parameters

Returns Promise<ScrollPageResult>

search

Parameters

Returns Promise<SearchResult[]>

setPayload

Parameters

Returns Promise<void>

upsert

Parameters

Returns Promise<void>

Settings

On This Page