Skip to main content

Interface: SqlVectorStoreConfig

Defined in: packages/agentos/src/cognition/rag/vector_stores/SqlVectorStore.ts:79

Configuration for SQL-backed vector store.

Interface​

SqlVectorStoreConfig

Extends​

Properties​

adapter?​

optional adapter: StorageAdapter

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

Pre-initialized storage adapter. If provided, storage config is ignored.


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


defaultEmbeddingDimension?​

optional defaultEmbeddingDimension: number

Defined in: packages/agentos/src/cognition/rag/vector_stores/SqlVectorStore.ts:98

Default embedding dimension for new collections.


enableFullTextSearch?​

optional enableFullTextSearch: boolean

Defined in: packages/agentos/src/cognition/rag/vector_stores/SqlVectorStore.ts:111

Enable full-text search index provisioning. Creates FTS5 virtual tables for SQLite or tsvector columns for PostgreSQL.

Default​

true

hnswDimensions?​

optional hnswDimensions: number

Defined in: packages/agentos/src/cognition/rag/vector_stores/SqlVectorStore.ts:139

Embedding dimensions for the HNSW sidecar index.

Default​

1536

hnswSidecarFactory()?​

optional hnswSidecarFactory: () => HnswIndexSidecar

Defined in: packages/agentos/src/cognition/rag/vector_stores/SqlVectorStore.ts:146

Optional custom HNSW sidecar factory. Primarily useful for tests or advanced hosts that need to provide their own ANN sidecar implementation.

Returns​

HnswIndexSidecar


hnswThreshold?​

optional hnswThreshold: number

Defined in: packages/agentos/src/cognition/rag/vector_stores/SqlVectorStore.ts:133

Document count threshold before HNSW sidecar activates. Below this count, brute-force cosine similarity is used. Set to 0 to disable HNSW. Set to Infinity to always use brute-force.

Default​

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


pipeline?​

optional pipeline: TextProcessingPipeline

Defined in: packages/agentos/src/cognition/rag/vector_stores/SqlVectorStore.ts:125

Optional text processing pipeline for hybrid search tokenization. Replaces the built-in regex tokenizer with configurable stemming, lemmatization, and stop word handling.

See​

createRagPipeline from nlp


similarityMetric?​

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

Defined in: packages/agentos/src/cognition/rag/vector_stores/SqlVectorStore.ts:104

Default similarity metric.

Default​

'cosine'

storage?​

optional storage: StorageResolutionOptions

Defined in: packages/agentos/src/cognition/rag/vector_stores/SqlVectorStore.ts:87

Storage adapter configuration. Passed directly to resolveStorageAdapter().


tablePrefix?​

optional tablePrefix: string

Defined in: packages/agentos/src/cognition/rag/vector_stores/SqlVectorStore.ts:117

Table name prefix for all vector store tables.

Default​

'agentos_rag_'

type​

type: "sql"

Defined in: packages/agentos/src/cognition/rag/vector_stores/SqlVectorStore.ts:81

Must be 'sql' for this provider

Overrides​

VectorStoreProviderConfig.type