rag-lite-ts 2.1.1 → 2.2.0

package/dist/esm/index-manager.d.ts

@@ -0,0 +1,116 @@
+import type { EmbeddingResult } from './core/types.js';
+export interface IndexStats {
+    totalVectors: number;
+    modelVersion: string;
+    lastUpdated: Date;
+}
+export declare class IndexManager {
+    private modelName?;
+    private vectorIndex;
+    private textIndex?;
+    private imageIndex?;
+    private db;
+    private indexPath;
+    private dbPath;
+    private isInitialized;
+    private hashToEmbeddingId;
+    private embeddingIdToHash;
+    private groupedEmbeddings?;
+    private vectorIndexOptions;
+    constructor(indexPath: string, dbPath: string, dimensions: number, modelName?: string | undefined);
+    /**
+     * Initialize the index manager and load existing index if available
+     * @param skipModelCheck - Skip model compatibility check (used for rebuilds)
+     * @param forceRecreate - Force recreation of index (used for model changes)
+     */
+    initialize(skipModelCheck?: boolean, forceRecreate?: boolean): Promise<void>;
+    /**
+     * Check model compatibility between stored and current configuration
+     * Requirements: 2.1, 2.2, 2.4, 5.1, 5.2, 5.3, 5.4
+     */
+    private checkModelCompatibility;
+    /**
+     * Add vectors to the index with corresponding metadata (incremental addition)
+     * Requirements: 5.3 - When new documents are added THEN system SHALL append new chunks and vectors without rebuilding existing index
+     */
+    addVectors(embeddings: EmbeddingResult[]): Promise<void>;
+    /**
+     * Add grouped embeddings by content type (for new grouped format)
+     */
+    addGroupedEmbeddings(textEmbeddings: EmbeddingResult[], imageEmbeddings: EmbeddingResult[]): Promise<void>;
+    /**
+     * Rebuild the entire index from scratch
+     * Requirements: 5.2, 5.4 - Create full index rebuild functionality for model changes or document deletions
+     */
+    rebuildIndex(newModelVersion?: string): Promise<void>;
+    /**
+     * Trigger a full rebuild when documents are modified or deleted
+     * Requirements: 5.4 - When documents are modified or deleted THEN system SHALL trigger full index rebuild
+     */
+    triggerRebuildForDocumentChanges(reason: string): Promise<void>;
+    /**
+     * Complete rebuild workflow with embedding regeneration
+     * This method should be called by higher-level components that have access to the EmbeddingEngine
+     * Requirements: 5.2, 5.4 - Full index rebuild functionality
+     */
+    rebuildWithEmbeddings(embeddingEngine: {
+        embedDocumentBatch: (texts: string[]) => Promise<EmbeddingResult[]>;
+        getModelVersion: () => string;
+    }): Promise<void>;
+    /**
+     * Check if the current model version matches stored version
+     * Requirements: 5.1, 5.2 - Compare current embedding model version with stored version
+     */
+    checkModelVersion(currentVersion: string): Promise<boolean>;
+    /**
+     * Update the stored model version after successful rebuild
+     * Requirements: 5.5 - Save model name and hash in SQLite for version tracking
+     */
+    updateModelVersion(version: string): Promise<void>;
+    /**
+     * Validate model version and exit if mismatch detected
+     * Requirements: 5.2 - System SHALL exit with error message until full index rebuild is completed
+     */
+    validateModelVersionOrExit(currentVersion: string): Promise<void>;
+    /**
+     * Save the vector index to disk
+     */
+    saveIndex(): Promise<void>;
+    /**
+     * Create specialized indexes for text and image content when grouped data is available
+     */
+    private createSpecializedIndexes;
+    /**
+     * Save index with content type grouping (for new grouped format)
+     */
+    saveGroupedIndex(textEmbeddings: EmbeddingResult[], imageEmbeddings: EmbeddingResult[]): Promise<void>;
+    /**
+     * Search for similar vectors
+     */
+    search(queryVector: Float32Array, k?: number, contentType?: 'text' | 'image' | 'combined'): {
+        embeddingIds: string[];
+        distances: number[];
+    };
+    /**
+     * Get index statistics
+     */
+    getStats(): Promise<IndexStats>;
+    /**
+     * Get all chunks from database for rebuild (returns chunk data, not embeddings)
+     * Note: Embeddings need to be regenerated during rebuild since we don't store vectors in DB
+     */
+    private getAllChunksFromDB;
+    /**
+     * Convert embedding ID string to numeric ID for hnswlib with collision handling
+     */
+    private hashEmbeddingId;
+    /**
+     * Convert numeric ID back to embedding ID using the maintained mapping
+     */
+    private unhashEmbeddingId;
+    /**
+     * Close database connection
+     */
+    close(): Promise<void>;
+}
+//# sourceMappingURL=index-manager.d.ts.map