@anvia/lancedb API reference

All public symbols are exported from @anvia/lancedb.

import {
  LanceDBVectorClient,
  LanceDBVectorStore,
  type LanceDBConnectionLike,
  type LanceDBTableLike,
  type LanceDBVectorClientOptions,
  type LanceDBVectorStoreOptions,
} from '@anvia/lancedb'

LanceDBVectorClient

class LanceDBVectorClient {
  constructor(options?: LanceDBVectorClientOptions)
  vectorStore<T, Metadata extends VectorMetadata = VectorMetadata>(
    options: LanceDBVectorStoreOptions,
  ): LanceDBVectorStore<T, Metadata>
  close(): Promise<void>
}

LanceDBVectorClientOptions accepts an injected client?: LanceDBConnectionLike or uri?: string. LanceDBVectorStoreOptions contains tableName, dimensions, and optional metric.

LanceDBVectorStore

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

ensure() creates a missing table and validates it; validate() only checks an existing table. Metadata filters use Core's provider-neutral matcher after retrieval. The package no longer exports SQL-expression generation for the serialized metadata column.

Return to the package guide.