FileDocumentStoreOptions
Options & Configuration · AiDotNet.RetrievalAugmentedGeneration.DocumentStores
Configuration options for the file-based document store.
For Beginners
These settings control how the file-based document store operates, including where files are stored, HNSW index parameters, and WAL behavior. The defaults work well for most use cases.
Constructors
| Constructor | Summary |
|---|---|
FileDocumentStoreOptions() |
Properties
| Property | Summary |
|---|---|
bool FlushOnEveryWrite { get; set; } |
Gets or sets whether to flush data to disk after every write operation. |
bool SyncWalWrites { get; set; } |
Gets or sets whether WAL writes should be synchronous (fsync on every write). |
double CompactionTombstoneRatio { get; set; } |
Gets or sets the ratio of tombstones to total documents that triggers automatic compaction. |
int HnswEfConstruction { get; set; } |
Gets or sets the HNSW efConstruction parameter (search depth during index building). |
int HnswEfSearch { get; set; } |
Gets or sets the HNSW efSearch parameter (search depth during queries). |
int HnswMaxConnections { get; set; } |
Gets or sets the HNSW M parameter (max connections per node). |
int HnswSeed { get; set; } |
Gets or sets the random seed for the HNSW index. |
int MinimumDocumentCountForCompaction { get; set; } |
Gets or sets the minimum total document count (live + tombstones) required before automatic compaction is considered. |
long MaxWalSizeBytes { get; set; } |
Gets or sets the maximum WAL size in bytes before auto-flushing to main files. |
string DirectoryPath { get; set; } |
Gets or sets the directory path where store files are written. |