Skip to content
1 min read · 222 words

Interface: SqliteVecVectorStoreOptions

Defined in: batteries/vector/sqlite_vec/index.ts:22

Construction options for SqliteVecVectorStore.

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
connection{ path: string; }Database location: a filesystem path, or ':memory:' for an in-memory database.-batteries/vector/sqlite_vec/index.ts:24
connection.pathstring--batteries/vector/sqlite_vec/index.ts:25
consistency?VectorConsistencyStore-wide read-after-write guarantee for writes. Overrides the adapter's declared VectorStoreCapabilities.consistency default; a per-operation .consistency() on the builder overrides this in turn (precedence: per-op > store option > adapter default). Ignored by strongly-consistent adapters. See VectorConsistency.BaseVectorStoreOptions.consistencybatteries/vector/types.ts:129
defaultCollection?stringCollection name used when a call omits an explicit one.BaseVectorStoreOptions.defaultCollectionbatteries/vector/types.ts:122
dimensions?numberEmbedding dimensionality. Required by backends that must declare it at collection-creation time.BaseVectorStoreOptions.dimensionsbatteries/vector/types.ts:120
encoder?VectorEncoderFnFunction that turns text into vectors. Required unless the backend has built-in encoding.BaseVectorStoreOptions.encoderbatteries/vector/types.ts:118
metric?DistanceMetricDistance metric used for similarity (e.g. cosine, euclidean, dot). Defaults to the adapter's preferred metric.BaseVectorStoreOptions.metricbatteries/vector/types.ts:116