Skip to content
1 min read · 173 words

@nhtio/adk/batteries/vector/contract ​

Classes ​

ClassDescription
BaseVectorStoreAbstract base shared by every bundled vector adapter. It implements the cross-cutting surface (query/schema/transaction/asCallable/encode) on top of the small set of backend-specific abstract methods each adapter fills in (connect, executeSearch, createCollection, …). Concrete adapters inherit the doc comments below unless they override them.

Interfaces ​

InterfaceDescription
VectorStoreThe public surface every vector store exposes: capability flags, lifecycle (connect/close), a callable form that opens a VectorQueryBuilder for a collection, schema access, and an optional transaction wrapper. Adapters extend BaseVectorStore, which implements this plus the low-level plan/schema executor contracts.
VectorTxOpaque handle for a backend transaction. Stores that support transactions return a driver-specific implementation; the harness only passes it back through VectorStore.transaction.

Type Aliases ​

Type AliasDescription
CallableVectorStoreA VectorStore in its callable form — store('collection') opens a query builder.