Skip to main content

Interface: PostgresVectorStoreConfig

Defined in: packages/agentos/src/cognition/rag/vector_stores/PostgresVectorStore.ts:60

Configuration specific to the Postgres vector store.

Extends​

Properties​

adapter?​

optional adapter: StorageAdapter

Defined in: packages/agentos/src/cognition/rag/vector_stores/PostgresVectorStore.ts:70

Open PostgreSQL adapter owned by the caller; exclusive with pool/connectionString. The store opens no pool of its own and close() leaves the adapter open. With pool or connectionString as well, initialize() throws.

connectionString?​

optional connectionString: string

Defined in: packages/agentos/src/cognition/rag/vector_stores/PostgresVectorStore.ts:63

Postgres connection string. Required unless pool or adapter is given.

customProps?​

optional customProps: Record<string, any>

Defined in: packages/agentos/src/core/vector-store/IVectorStore.ts:32

Any other custom properties or configurations specific to this provider instance not covered by standard fields.

Inherited from​

VectorStoreProviderConfig.customProps

defaultDimension?​

optional defaultDimension: number

Defined in: packages/agentos/src/cognition/rag/vector_stores/PostgresVectorStore.ts:74

Default embedding dimensions for new collections.

Default​

1536

efSearch?​

optional efSearch: number

Defined in: packages/agentos/src/cognition/rag/vector_stores/PostgresVectorStore.ts:93

hnsw.ef_search for a search (1 to 1000).

id​

id: string

Defined in: packages/agentos/src/core/vector-store/IVectorStore.ts:30

A unique identifier for this specific provider instance (e.g., "pinecone-main-prod", "weaviate-dev-local"). This ID is used by the VectorStoreManager to retrieve this provider.

Inherited from​

VectorStoreProviderConfig.id

iterativeScan?​

optional iterativeScan: "strict_order" | "relaxed_order"

Defined in: packages/agentos/src/cognition/rag/vector_stores/PostgresVectorStore.ts:91

pgvector's iterative index scan (0.8.0 and later) for query() and hybridSearch(): the HNSW scan goes on until a filtered search has its rows. Without it pgvector filters after the scan and can return fewer than top-K.

manageSchema?​

optional manageSchema: boolean

Defined in: packages/agentos/src/cognition/rag/vector_stores/PostgresVectorStore.ts:84

When false the store runs no DDL: no CREATE EXTENSION, no collections table, and createCollection() does nothing. The caller's migrations make the tables from PostgresVectorStore.schemaSql, and the metric is read from similarityMetric.

Default​

true

maxScanTuples?​

optional maxScanTuples: number

Defined in: packages/agentos/src/cognition/rag/vector_stores/PostgresVectorStore.ts:95

hnsw.max_scan_tuples for an iterative scan.

pool?​

optional pool: PgPoolLike

Defined in: packages/agentos/src/cognition/rag/vector_stores/PostgresVectorStore.ts:65

A pool the caller owns. The store opens none of its own, and close() leaves this one open.

poolSize?​

optional poolSize: number

Defined in: packages/agentos/src/cognition/rag/vector_stores/PostgresVectorStore.ts:72

Connection pool size when the store opens its own pool.

Default​

10

similarityMetric?​

optional similarityMetric: "cosine" | "euclidean" | "dotproduct"

Defined in: packages/agentos/src/cognition/rag/vector_stores/PostgresVectorStore.ts:76

Default similarity metric.

Default​

'cosine'

tablePrefix?​

optional tablePrefix: string

Defined in: packages/agentos/src/cognition/rag/vector_stores/PostgresVectorStore.ts:78

Table name prefix for multi-tenancy.

Default​

''

textSearchConfig?​

optional textSearchConfig: string

Defined in: packages/agentos/src/cognition/rag/vector_stores/PostgresVectorStore.ts:86

Text search configuration of the lexical column and its queries.

Default​

'english'

type​

type: "postgres"

Defined in: packages/agentos/src/cognition/rag/vector_stores/PostgresVectorStore.ts:61

The type of the vector store provider (e.g., "pinecone", "weaviate", "in_memory", "lancedb"). This helps in selecting the correct implementation.

Overrides​

VectorStoreProviderConfig.type