@anvia/pgvector API reference

All public symbols are exported from @anvia/pgvector.

import {
  PgVectorClient,
  PgVectorStore,
  filterToPgVectorWhere,
  type PgClientLike,
  type PgVectorClientOptions,
  type PgVectorDistance,
  type PgVectorStoreOptions,
  type PgVectorWhere,
} from '@anvia/pgvector'

PgVectorClient

class PgVectorClient {
  constructor(options?: PgVectorClientOptions)
  vectorStore<T, Metadata extends VectorMetadata = VectorMetadata>(
    options: PgVectorStoreOptions,
  ): PgVectorStore<T, Metadata>
  close(): Promise<void>
}

PgVectorClientOptions accepts an injected client?: PgClientLike or connectionString?: string. PgVectorStoreOptions contains tableName, dimensions, and optional metric. Native PgVectorDistance values are 'cosine' | 'l2' | 'innerProduct'.

PgVectorStore

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

filterToPgVectorWhere(filter) returns a { sql, values } PgVectorWhere value for direct queries.

Return to the package guide.