@anvia/milvus API reference

All public symbols are exported from @anvia/milvus.

import {
  MilvusVectorClient,
  MilvusVectorStore,
  filterToMilvusExpr,
  type MilvusClientLike,
  type MilvusMetric,
  type MilvusVectorClientOptions,
  type MilvusVectorStoreOptions,
} from '@anvia/milvus'

MilvusVectorClient

class MilvusVectorClient {
  constructor(options?: MilvusVectorClientOptions)
  vectorStore<T, Metadata extends VectorMetadata = VectorMetadata>(
    options: MilvusVectorStoreOptions,
  ): MilvusVectorStore<T, Metadata>
  close(): Promise<void>
}

MilvusVectorClientOptions accepts an injected client?: MilvusClientLike, or address?: string and optional token. MilvusVectorStoreOptions contains collectionName, dimensions, and optional metric taking the core VectorMetric values 'cosine' | 'euclidean' | 'dotProduct' (default cosine). The native MilvusMetric values 'COSINE' | 'L2' | 'IP' are the adapter's internal mapping (euclidean → L2, dotProduct → IP). close() releases a client the adapter created; injected clients are left open.

MilvusVectorStore

await store.ensure()
await store.validate()
await store.upsert({ documents, providerOptions })
const results = await store.search({ vector, topK, minScore, filter, providerOptions, abortSignal })

filterToMilvusExpr(filter) converts an Anvia VectorFilter to a Milvus expression.

Return to the package guide.