Interface: PgVectorStoreOptions

Defined in: batteries/vector/pgvector/index.ts:25

Construction options for PgVectorStore.

Extends

• BaseVectorStoreOptions

Properties

Property	Type	Description	Inherited from	Defined in
connection?	| string | { connectionString?: string; database?: string; host?: string; password?: string; port?: number; user?: string; }	Connection details: a connection string, or a discrete host/port/credentials object.	-	batteries/vector/pgvector/index.ts:27
consistency?	VectorConsistency	Store-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.consistency	batteries/vector/types.ts:129
defaultCollection?	string	Collection name used when a call omits an explicit one.	BaseVectorStoreOptions.defaultCollection	batteries/vector/types.ts:122
dimensions?	number	Embedding dimensionality. Required by backends that must declare it at collection-creation time.	BaseVectorStoreOptions.dimensions	batteries/vector/types.ts:120
encoder?	VectorEncoderFn	Function that turns text into vectors. Required unless the backend has built-in encoding.	BaseVectorStoreOptions.encoder	batteries/vector/types.ts:118
metric?	DistanceMetric	Distance metric used for similarity (e.g. cosine, euclidean, dot). Defaults to the adapter's preferred metric.	BaseVectorStoreOptions.metric	batteries/vector/types.ts:116
pool?	any	An existing pg Pool/Client to reuse instead of constructing one from connection.	-	batteries/vector/pgvector/index.ts:38