@delali/narsil 0.1.6 → 0.1.7

package/dist/index.d.ts

@@ -1,46 +1,6 @@
 import { L as LanguageModule } from './language-ClUGLuoC.js';
-import { P as PersistenceAdapter, I as InvalidationAdapter } from './adapters-XODT2F3h.js';
-export { a as InvalidationEvent, b as PartitionStatistics } from './adapters-XODT2F3h.js';
-
-declare const ErrorCodes: {
-    readonly SCHEMA_INVALID_TYPE: "SCHEMA_INVALID_TYPE";
-    readonly SCHEMA_MISSING_FIELD: "SCHEMA_MISSING_FIELD";
-    readonly SCHEMA_DEPTH_EXCEEDED: "SCHEMA_DEPTH_EXCEEDED";
-    readonly SCHEMA_INVALID_VECTOR_DIMENSION: "SCHEMA_INVALID_VECTOR_DIMENSION";
-    readonly SCHEMA_INVALID_GEOPOINT: "SCHEMA_INVALID_GEOPOINT";
-    readonly DOC_NOT_FOUND: "DOC_NOT_FOUND";
-    readonly DOC_ALREADY_EXISTS: "DOC_ALREADY_EXISTS";
-    readonly DOC_VALIDATION_FAILED: "DOC_VALIDATION_FAILED";
-    readonly INDEX_NOT_FOUND: "INDEX_NOT_FOUND";
-    readonly INDEX_ALREADY_EXISTS: "INDEX_ALREADY_EXISTS";
-    readonly PARTITION_CORRUPTED: "PARTITION_CORRUPTED";
-    readonly PARTITION_REBALANCING_BACKPRESSURE: "PARTITION_REBALANCING_BACKPRESSURE";
-    readonly WORKER_CRASHED: "WORKER_CRASHED";
-    readonly WORKER_BUSY: "WORKER_BUSY";
-    readonly WORKER_TIMEOUT: "WORKER_TIMEOUT";
-    readonly PERSISTENCE_SAVE_FAILED: "PERSISTENCE_SAVE_FAILED";
-    readonly PERSISTENCE_LOAD_FAILED: "PERSISTENCE_LOAD_FAILED";
-    readonly PERSISTENCE_DELETE_FAILED: "PERSISTENCE_DELETE_FAILED";
-    readonly PERSISTENCE_CRC_MISMATCH: "PERSISTENCE_CRC_MISMATCH";
-    readonly SEARCH_INVALID_FIELD: "SEARCH_INVALID_FIELD";
-    readonly SEARCH_INVALID_VECTOR_SIZE: "SEARCH_INVALID_VECTOR_SIZE";
-    readonly SEARCH_INVALID_FILTER: "SEARCH_INVALID_FILTER";
-    readonly SEARCH_INVALID_MODE: "SEARCH_INVALID_MODE";
-    readonly SEARCH_INVALID_CURSOR: "SEARCH_INVALID_CURSOR";
-    readonly LANGUAGE_NOT_SUPPORTED: "LANGUAGE_NOT_SUPPORTED";
-    readonly ENVELOPE_VERSION_MISMATCH: "ENVELOPE_VERSION_MISMATCH";
-    readonly ENVELOPE_INVALID_MAGIC: "ENVELOPE_INVALID_MAGIC";
-    readonly PARTITION_CAPACITY_EXCEEDED: "PARTITION_CAPACITY_EXCEEDED";
-};
-type ErrorCode = (typeof ErrorCodes)[keyof typeof ErrorCodes];
-declare class NarsilError extends Error {
-    readonly code: ErrorCode;
-    readonly details: Record<string, unknown>;
-    constructor(code: ErrorCode, message: string, details?: Record<string, unknown>);
-}
-
-declare function registerLanguage(module: LanguageModule): void;
-declare function getLanguage(name: string): LanguageModule;
+import { E as EmbeddingAdapter, P as PersistenceAdapter, I as InvalidationAdapter } from './adapters-BbRkoiu9.js';
+export { a as InvalidationEvent, b as PartitionStatistics } from './adapters-BbRkoiu9.js';
 
 type AnyDocument = Record<string, unknown> & {
     id?: string;
@@ -49,14 +9,20 @@ type FieldType = 'string' | 'number' | 'boolean' | 'enum' | 'geopoint' | `vector
 type SchemaDefinition = {
     [field: string]: FieldType | SchemaDefinition;
 };
-interface VectorPromotionConfig {
+type VectorQuantizationMode = 'sq8' | 'none';
+interface VectorIndexConfig {
     threshold?: number;
+    filterThreshold?: number;
     hnswConfig?: {
         m?: number;
         efConstruction?: number;
         metric?: 'cosine' | 'dotProduct' | 'euclidean';
     };
-    workerStrategy?: 'worker-threads' | 'web-worker' | 'synchronous';
+    quantization?: VectorQuantizationMode;
+}
+interface EmbeddingFieldConfig {
+    adapter?: EmbeddingAdapter;
+    fields: Record<string, string | string[]>;
 }
 interface IndexConfig {
     schema: SchemaDefinition;
@@ -67,8 +33,10 @@ interface IndexConfig {
     stopWords?: Set<string> | ((defaults: Set<string>) => Set<string>);
     tokenizer?: CustomTokenizer;
     trackPositions?: boolean;
-    vectorPromotion?: VectorPromotionConfig;
+    vectorPromotion?: VectorIndexConfig;
     strict?: boolean;
+    embedding?: EmbeddingFieldConfig;
+    required?: string[];
 }
 interface BM25Params {
     k1?: number;
@@ -89,6 +57,58 @@ interface InsertOptions {
     skipClone?: boolean;
 }
 
+declare function configureNormalizationCache(maxSize: number): void;
+declare function clearNormalizationCache(): void;
+declare function resetNormalizationCache(): void;
+declare function getNormalizationCacheSize(): number;
+
+declare const ErrorCodes: {
+    readonly SCHEMA_INVALID_TYPE: "SCHEMA_INVALID_TYPE";
+    readonly SCHEMA_MISSING_FIELD: "SCHEMA_MISSING_FIELD";
+    readonly SCHEMA_DEPTH_EXCEEDED: "SCHEMA_DEPTH_EXCEEDED";
+    readonly SCHEMA_INVALID_VECTOR_DIMENSION: "SCHEMA_INVALID_VECTOR_DIMENSION";
+    readonly SCHEMA_INVALID_GEOPOINT: "SCHEMA_INVALID_GEOPOINT";
+    readonly DOC_NOT_FOUND: "DOC_NOT_FOUND";
+    readonly DOC_ALREADY_EXISTS: "DOC_ALREADY_EXISTS";
+    readonly DOC_VALIDATION_FAILED: "DOC_VALIDATION_FAILED";
+    readonly INDEX_NOT_FOUND: "INDEX_NOT_FOUND";
+    readonly INDEX_ALREADY_EXISTS: "INDEX_ALREADY_EXISTS";
+    readonly PARTITION_CORRUPTED: "PARTITION_CORRUPTED";
+    readonly PARTITION_REBALANCING_BACKPRESSURE: "PARTITION_REBALANCING_BACKPRESSURE";
+    readonly WORKER_CRASHED: "WORKER_CRASHED";
+    readonly WORKER_BUSY: "WORKER_BUSY";
+    readonly WORKER_TIMEOUT: "WORKER_TIMEOUT";
+    readonly PERSISTENCE_SAVE_FAILED: "PERSISTENCE_SAVE_FAILED";
+    readonly PERSISTENCE_LOAD_FAILED: "PERSISTENCE_LOAD_FAILED";
+    readonly PERSISTENCE_DELETE_FAILED: "PERSISTENCE_DELETE_FAILED";
+    readonly PERSISTENCE_CRC_MISMATCH: "PERSISTENCE_CRC_MISMATCH";
+    readonly SEARCH_INVALID_FIELD: "SEARCH_INVALID_FIELD";
+    readonly SEARCH_INVALID_VECTOR_SIZE: "SEARCH_INVALID_VECTOR_SIZE";
+    readonly VECTOR_DIMENSION_MISMATCH: "VECTOR_DIMENSION_MISMATCH";
+    readonly SEARCH_INVALID_FILTER: "SEARCH_INVALID_FILTER";
+    readonly SEARCH_INVALID_MODE: "SEARCH_INVALID_MODE";
+    readonly SEARCH_INVALID_CURSOR: "SEARCH_INVALID_CURSOR";
+    readonly LANGUAGE_NOT_SUPPORTED: "LANGUAGE_NOT_SUPPORTED";
+    readonly ENVELOPE_VERSION_MISMATCH: "ENVELOPE_VERSION_MISMATCH";
+    readonly ENVELOPE_INVALID_MAGIC: "ENVELOPE_INVALID_MAGIC";
+    readonly PARTITION_CAPACITY_EXCEEDED: "PARTITION_CAPACITY_EXCEEDED";
+    readonly EMBEDDING_FAILED: "EMBEDDING_FAILED";
+    readonly EMBEDDING_DIMENSION_MISMATCH: "EMBEDDING_DIMENSION_MISMATCH";
+    readonly EMBEDDING_NO_SOURCE: "EMBEDDING_NO_SOURCE";
+    readonly EMBEDDING_CONFIG_INVALID: "EMBEDDING_CONFIG_INVALID";
+    readonly DOC_MISSING_REQUIRED_FIELD: "DOC_MISSING_REQUIRED_FIELD";
+    readonly CONFIG_INVALID: "CONFIG_INVALID";
+};
+type ErrorCode = (typeof ErrorCodes)[keyof typeof ErrorCodes];
+declare class NarsilError extends Error {
+    readonly code: ErrorCode;
+    readonly details: Record<string, unknown>;
+    constructor(code: ErrorCode, message: string, details?: Record<string, unknown>);
+}
+
+declare function registerLanguage(module: LanguageModule): void;
+declare function getLanguage(name: string): LanguageModule;
+
 interface QueryResult<T = AnyDocument> {
     hits: Array<Hit<T>>;
     count: number;
@@ -153,8 +173,6 @@ interface PartitionStatsResult {
     partitionId: number;
     documentCount: number;
     estimatedMemoryBytes: number;
-    vectorFieldCount: number;
-    isHnswPromoted: boolean;
 }
 interface SuggestResult {
     terms: Array<{
@@ -172,6 +190,15 @@ interface MemoryStats {
         external: number;
     }>;
 }
+interface VectorMaintenanceResult {
+    fieldName: string;
+    tombstoneRatio: number;
+    graphCount: number;
+    bufferSize: number;
+    building: boolean;
+    estimatedCompactMs: number;
+    estimatedOptimizeMs: number;
+}
 
 type ComparisonFilter = {
     eq?: number | string | boolean;
@@ -258,12 +285,15 @@ interface QueryParams {
 }
 interface VectorQueryConfig {
     field: string;
-    value: number[];
+    value?: number[];
+    text?: string;
     similarity?: number;
     metric?: 'cosine' | 'dotProduct' | 'euclidean';
     efSearch?: number;
 }
 interface HybridConfig {
+    strategy?: 'rrf' | 'linear';
+    k?: number;
     alpha?: number;
 }
 interface FacetConfig {
@@ -353,6 +383,7 @@ interface NarsilConfig {
     workers?: WorkerConfig;
     flush?: FlushConfig;
     eagerLoad?: boolean;
+    embedding?: EmbeddingAdapter;
 }
 interface WorkerConfig {
     enabled?: boolean;
@@ -416,6 +447,9 @@ interface Narsil {
     rebalance(indexName: string, targetPartitionCount: number): Promise<void>;
     updatePartitionConfig(indexName: string, config: Partial<PartitionConfig>): Promise<void>;
     getMemoryStats(): MemoryStats;
+    compactVectors(indexName: string, fieldName?: string): Promise<void>;
+    optimizeVectors(indexName: string, fieldName?: string): Promise<void>;
+    vectorMaintenanceStatus(indexName: string): VectorMaintenanceResult[];
     on<K extends keyof NarsilEventMap>(event: K, handler: (payload: NarsilEventMap[K]) => void): void;
     off<K extends keyof NarsilEventMap>(event: K, handler: (payload: NarsilEventMap[K]) => void): void;
     shutdown(): Promise<void>;
@@ -426,4 +460,4 @@ declare function isSimdAvailable(): boolean;
 
 declare const VERSION = "0.1.0";
 
-export { type AnyDocument, type ArrayFilter, type BM25Params, type BatchResult, type ComparisonFilter, type CustomTokenizer, type ErrorCode, ErrorCodes, type FacetConfig, type FacetResult, type FieldType, type FilterExpression, type FlushConfig, type GeoPolygonFilter, type GeoRadiusFilter, type GroupConfig, type GroupReducer, type GroupResult, type HighlightConfig, type HighlightMatch, type Hit, type HybridConfig, type IndexConfig, type IndexContext, type IndexInfo, type IndexStats, type InsertContext, type InsertOptions, InvalidationAdapter, LanguageModule, type MemoryStats, type Narsil, type NarsilConfig, NarsilError, type NarsilEventMap, type NarsilPlugin, type PartitionConfig, type PartitionContext, type PartitionStatsResult, PersistenceAdapter, type PreflightResult, type PresenceFilter, type QueryParams, type QueryResult, type RemoveContext, type SchemaDefinition, type ScoreComponents, type ScoringMode, type SearchContext, type SearchMode, type StringFilter, type SuggestParams, type SuggestResult, type TermMatchPolicy, type UpdateContext, VERSION, type VectorQueryConfig, type WorkerConfig, type WorkerContext, createNarsil, getLanguage, isSimdAvailable, registerLanguage };
+export { type AnyDocument, type ArrayFilter, type BM25Params, type BatchResult, type ComparisonFilter, type CustomTokenizer, EmbeddingAdapter, type EmbeddingFieldConfig, type ErrorCode, ErrorCodes, type FacetConfig, type FacetResult, type FieldType, type FilterExpression, type FlushConfig, type GeoPolygonFilter, type GeoRadiusFilter, type GroupConfig, type GroupReducer, type GroupResult, type HighlightConfig, type HighlightMatch, type Hit, type HybridConfig, type IndexConfig, type IndexContext, type IndexInfo, type IndexStats, type InsertContext, type InsertOptions, InvalidationAdapter, LanguageModule, type MemoryStats, type Narsil, type NarsilConfig, NarsilError, type NarsilEventMap, type NarsilPlugin, type PartitionConfig, type PartitionContext, type PartitionStatsResult, PersistenceAdapter, type PreflightResult, type PresenceFilter, type QueryParams, type QueryResult, type RemoveContext, type SchemaDefinition, type ScoreComponents, type ScoringMode, type SearchContext, type SearchMode, type StringFilter, type SuggestParams, type SuggestResult, type TermMatchPolicy, type UpdateContext, VERSION, type VectorMaintenanceResult, type VectorQueryConfig, type WorkerConfig, type WorkerContext, clearNormalizationCache, configureNormalizationCache, createNarsil, getLanguage, getNormalizationCacheSize, isSimdAvailable, registerLanguage, resetNormalizationCache };