Class VectorStoreClient

Client wrapper for Qdrant vector store operations.

Implements the VectorStore interface for dependency inversion. Writes (upsert, delete, set/delete payload) are retried, each retry on a fresh client (see QdrantWriter).

Implements

VectorStore

Index

Constructors

constructor

Methods

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

Constructors

constructor

new VectorStoreClient(
    config: {
        apiKey?: string;
        collectionName: string;
        payloadIndexes?: {
            field: string;
            isPrincipal?: boolean;
            isTenant?: boolean;
            type:
                | "text"
                | "uuid"
                | "datetime"
                | "keyword"
                | "integer"
                | "float"
                | "bool";
        }[];
        url: string;
    },
    dimensions: number,
    logger?: Logger<never, boolean>,
): VectorStoreClient
Create a new VectorStoreClient.
Parameters
- config: {
      apiKey?: string;
      collectionName: string;
      payloadIndexes?: {
          field: string;
          isPrincipal?: boolean;
          isTenant?: boolean;
          type:
              | "text"
              | "uuid"
              | "datetime"
              | "keyword"
              | "integer"
              | "float"
              | "bool";
      }[];
      url: string;
  }
  Vector store configuration.
  - OptionalapiKey?: string
    
    Qdrant API key.
  - collectionName: string
    
    Qdrant collection name.
  - OptionalpayloadIndexes?: {
        field: string;
        isPrincipal?: boolean;
        isTenant?: boolean;
        type:
            | "text"
            | "uuid"
            | "datetime"
            | "keyword"
            | "integer"
            | "float"
            | "bool";
    }[]
    
    Payload indexes created at startup when missing (never dropped).
  - url: string
    
    Qdrant server URL.
- dimensions: number
  The embedding vector dimensions.
- Optionallogger: Logger<never, boolean>
  Optional pino logger for retry warnings.
Returns VectorStoreClient
- Defined in packages/service/src/vectorStore/index.ts:63

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.
Implementation of VectorStore.count
- Defined in packages/service/src/vectorStore/index.ts:103

delete

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

deletePayload

deletePayload(ids: string[], keys: string[]): Promise<void>
Remove payload keys from the specified point IDs (other keys kept).
Parameters
- ids: string[]
  Point IDs to update.
- keys: string[]
  Payload keys to remove.
Returns Promise<void>
Implementation of VectorStore.deletePayload
- Defined in packages/service/src/vectorStore/index.ts:139

ensureCollection

ensureCollection(): Promise<void>
Ensure the collection exists (Cosine, configured dimensions) and create any missing payload indexes (configured plus source/source_rule).

Returns Promise<void>
Implementation of VectorStore.ensureCollection
- Defined in packages/service/src/vectorStore/index.ts:111

ensureTextIndex

ensureTextIndex(fieldName: string): Promise<void>
Create a full-text payload index on the specified field. Idempotent — skips if the field already has a text index.
Parameters
- fieldName: string
  The payload field to index.
Returns Promise<void>
Implementation of VectorStore.ensureTextIndex
- Defined in packages/service/src/vectorStore/index.ts:198

getCollectionInfo

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

When Qdrant has payload indexes, uses payload_schema directly. Otherwise samples points to discover fields and infer types.

Returns Promise<CollectionInfo>
Implementation of VectorStore.getCollectionInfo
- Defined in packages/service/src/vectorStore/index.ts:160

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.

Throws
When the read fails (never reported as a missing point).
Implementation of VectorStore.getPayload
- Defined in packages/service/src/vectorStore/index.ts:150

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.

Throws
When the read fails (never reported as missing points).
Implementation of VectorStore.getPointsWithVectors
- Defined in packages/service/src/vectorStore/index.ts:248

hybridSearch

hybridSearch(
    vector: number[],
    queryText: string,
    limit: number,
    textWeight: number,
    filter?: Record<string, unknown>,
    offset?: number,
): 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.
- Optionaloffset: number
  Optional result offset for pagination.
Returns Promise<SearchResult[]>
An array of search results.
Implementation of VectorStore.hybridSearch
- Defined in packages/service/src/vectorStore/index.ts:221

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.
- limit: number = 100
  Page size for scrolling.
Returns AsyncGenerator<ScrolledPoint>

Yields
Scrolled points.
Implementation of VectorStore.scroll
- Defined in packages/service/src/vectorStore/index.ts:284

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.
- limit: number = 100
  Page size.
- Optionaloffset: string | number
  Cursor offset from previous page.
- Optionalfields: string[]
  Optional field projection.
Returns Promise<ScrollPageResult>
Page of points and next cursor.
Implementation of VectorStore.scrollPage
- Defined in packages/service/src/vectorStore/index.ts:261

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.
Implementation of VectorStore.search
- Defined in packages/service/src/vectorStore/index.ts:172

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>
Implementation of VectorStore.setPayload
- Defined in packages/service/src/vectorStore/index.ts:131

upsert

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

Class VectorStoreClient

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

OptionalapiKey?: string

collectionName: string

OptionalpayloadIndexes?: { field: string; isPrincipal?: boolean; isTenant?: boolean; type: | "text" | "uuid" | "datetime" | "keyword" | "integer" | "float" | "bool";}[]

url: string

Returns VectorStoreClient

Methods

count

Parameters

Returns Promise<number>

delete

Parameters

Returns Promise<void>

deletePayload

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>

Throws

getPointsWithVectors

Parameters

Returns Promise<VectorPoint[]>

Throws

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

`Optional`apiKey?: string

`Optional`payloadIndexes?: {
field: string;
isPrincipal?: boolean;
isTenant?: boolean;
type:
| "text"
| "uuid"
| "datetime"
| "keyword"
| "integer"
| "float"
| "bool";
}[]