Class VectorStoreClient

Client wrapper for Qdrant vector store operations.

Implements the VectorStore interface for dependency inversion.

Implements

VectorStore

Index

Constructors

constructor

Methods

delete ensureCollection ensureTextIndex getCollectionInfo getPayload hybridSearch scroll search setPayload upsert

Constructors

constructor

new VectorStoreClient(
    config: { apiKey?: string; collectionName: string; url: string },
    dimensions: number,
    logger?: Logger<never, boolean>,
): VectorStoreClient
Create a new VectorStoreClient.
Parameters
- config: { apiKey?: string; collectionName: string; url: string }
  Vector store configuration.
  - OptionalapiKey?: string
    Qdrant API key.
  - collectionName: string
    Qdrant collection name.
  - 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 vectorStore/index.ts:52

Methods

delete

delete(ids: string[]): Promise<void>
Delete points by their IDs.

Uses a fresh QdrantClient per attempt to avoid stale keep-alive connections.
Parameters
- ids: string[]
  The point IDs to delete.
Returns Promise<void>
Implementation of VectorStore.delete
- Defined in vectorStore/index.ts:173

ensureCollection

ensureCollection(): Promise<void>
Ensure the collection exists with correct dimensions and Cosine distance.

Returns Promise<void>
Implementation of VectorStore.ensureCollection
- Defined in vectorStore/index.ts:83

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 vectorStore/index.ts:269

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 vectorStore/index.ts:231

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.
Implementation of VectorStore.getPayload
- Defined in vectorStore/index.ts:211

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.
Implementation of VectorStore.hybridSearch
- Defined in vectorStore/index.ts:291

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 vectorStore/index.ts:316

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
Returns Promise<SearchResult[]>
An array of search results.
Implementation of VectorStore.search
- Defined in vectorStore/index.ts:243

setPayload

setPayload(ids: string[], payload: Record<string, unknown>): Promise<void>
Set payload fields for the specified point IDs.

This merges the given payload object into each point's existing payload.
Parameters
- ids: string[]
  Point IDs to update.
- payload: Record<string, unknown>
  Payload fields to set.
Returns Promise<void>
Implementation of VectorStore.setPayload
- Defined in vectorStore/index.ts:193

upsert

upsert(points: VectorPoint[]): Promise<void>
Upsert points into the collection.

Uses a fresh QdrantClient per attempt to avoid stale keep-alive connections. Between embedding calls and upserts, idle connections may be closed by the server, causing ECONNRESET on reuse.
Parameters
- points: VectorPoint[]
  The points to upsert.
Returns Promise<void>
Implementation of VectorStore.upsert
- Defined in vectorStore/index.ts:150

Class VectorStoreClient

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

OptionalapiKey?: string

collectionName: string

url: string

Returns VectorStoreClient

Methods

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>

hybridSearch

Parameters

Returns Promise<SearchResult[]>

scroll

Parameters

Returns AsyncGenerator<ScrolledPoint>

Yields

search

Parameters

Returns Promise<SearchResult[]>

setPayload

Parameters

Returns Promise<void>

upsert

Parameters

Returns Promise<void>

Settings

On This Page

`Optional`apiKey?: string