spector-config ⚙️¶

Configuration system for Spector — YAML-driven, programmatic, and environment-aware.

spector-config defines all tuning parameters for the Spector engine, memory, ingestion, and persistence. It provides both programmatic builders and YAML file loading via SpectorConfigFactory.

🏗️ Architecture¶

graph TD
    subgraph "spector-config"
        SC["SpectorConfig<br/><i>immutable engine config</i>"]
        SP["SpectorProperties<br/><i>YAML-driven properties</i>"]
        SCF["SpectorConfigFactory<br/><i>YAML → config builder</i>"]
        HP["HnswParams<br/><i>HNSW tuning</i>"]
        IT["IndexType<br/><i>HNSW, IVF_PQ, FLAT</i>"]
        PM["PersistenceMode<br/><i>MEMORY, DISK</i>"]
        PF["PersistenceFiles<br/><i>data directory paths</i>"]
    end

    SCF -->|parses| SP
    SCF -->|builds| SC
    SC --> HP
    SC --> IT
    SC --> PM

📦 Key Classes¶

SpectorConfig¶

Immutable configuration record with fluent with*() builder methods:

var config = SpectorConfig.DEFAULT
    .withDimensions(384)
    .withCapacity(100_000)
    .withQuantization(QuantizationType.SVASQ)
    .withRescore(3)
    .withGpu(true);

SpectorProperties¶

Full YAML-mapped properties for all Spector subsystems:

spector:
  mode: memory
  memory:
    enabled: true
    persistence-mode: DISK
    persistence-path: .spector/memory
    dimensions: 768
  provider:
    embedding:
      model: nomic-embed-text
      base-url: http://localhost:11434
  memory:
    enabled: true
    persistence-mode: DISK
  ingestion:
    chunk-size: 800
    chunk-overlap: 100

SpectorConfigFactory¶

Creates SpectorConfig and SpectorProperties from YAML:

SpectorProperties props = SpectorConfigFactory.load(Path.of("spector.yml"));
SpectorConfig config = SpectorConfigFactory.toEngineConfig(props);

📊 Configuration Parameters¶

⚙️ Dependencies¶

<dependency>
    <groupId>com.spectrayan</groupId>
    <artifactId>spector-config</artifactId>
    <version>0.1.0-SNAPSHOT</version>
</dependency>