vectra 0.12.2 → 0.14.0

package/lib/LocalEmbeddings.spec.js

@@ -0,0 +1,155 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const assert = __importStar(require("assert"));
+const sinon = __importStar(require("sinon"));
+const LocalEmbeddings_1 = require("./LocalEmbeddings");
+describe('LocalEmbeddings', () => {
+    let requireStub;
+    let fakePipeline;
+    let fakePipelineFn;
+    beforeEach(() => {
+        // Create a fake pipeline function that returns tensor-like results
+        fakePipelineFn = sinon.stub();
+        fakePipeline = sinon.stub().resolves(fakePipelineFn);
+        // Stub require to intercept @huggingface/transformers
+        requireStub = sinon.stub(module.constructor.prototype, 'require');
+        requireStub.callThrough(); // Allow all other requires to pass through
+        requireStub.withArgs('@huggingface/transformers').returns({
+            pipeline: fakePipeline,
+        });
+    });
+    afterEach(() => {
+        sinon.restore();
+    });
+    describe('constructor', () => {
+        it('should use default model and maxTokens', () => {
+            const embeddings = new LocalEmbeddings_1.LocalEmbeddings();
+            assert.strictEqual(embeddings.model, 'Xenova/all-MiniLM-L6-v2');
+            assert.strictEqual(embeddings.maxTokens, 256);
+        });
+        it('should accept custom model name', () => {
+            const embeddings = new LocalEmbeddings_1.LocalEmbeddings({ model: 'custom/model' });
+            assert.strictEqual(embeddings.model, 'custom/model');
+        });
+        it('should accept custom maxTokens', () => {
+            const embeddings = new LocalEmbeddings_1.LocalEmbeddings({ maxTokens: 512 });
+            assert.strictEqual(embeddings.maxTokens, 512);
+        });
+    });
+    describe('createEmbeddings', () => {
+        it('should create embeddings for a single string input', () => __awaiter(void 0, void 0, void 0, function* () {
+            const fakeVector = new Float32Array([0.1, 0.2, 0.3]);
+            fakePipelineFn.resolves({ data: fakeVector });
+            const embeddings = new LocalEmbeddings_1.LocalEmbeddings();
+            const result = yield embeddings.createEmbeddings('hello world');
+            assert.strictEqual(result.status, 'success');
+            assert.ok(result.output);
+            assert.strictEqual(result.output.length, 1);
+            assert.deepStrictEqual(result.output[0], [0.10000000149011612, 0.20000000298023224, 0.30000001192092896]);
+        }));
+        it('should create embeddings for an array of inputs', () => __awaiter(void 0, void 0, void 0, function* () {
+            const vec1 = new Float32Array([0.1, 0.2, 0.3]);
+            const vec2 = new Float32Array([0.4, 0.5, 0.6]);
+            fakePipelineFn.onFirstCall().resolves({ data: vec1 });
+            fakePipelineFn.onSecondCall().resolves({ data: vec2 });
+            const embeddings = new LocalEmbeddings_1.LocalEmbeddings();
+            const result = yield embeddings.createEmbeddings(['hello', 'world']);
+            assert.strictEqual(result.status, 'success');
+            assert.ok(result.output);
+            assert.strictEqual(result.output.length, 2);
+        }));
+        it('should call pipeline with mean pooling and normalize', () => __awaiter(void 0, void 0, void 0, function* () {
+            const fakeVector = new Float32Array([0.5, 0.5]);
+            fakePipelineFn.resolves({ data: fakeVector });
+            const embeddings = new LocalEmbeddings_1.LocalEmbeddings();
+            yield embeddings.createEmbeddings('test');
+            assert.ok(fakePipelineFn.calledOnce);
+            const [input, options] = fakePipelineFn.firstCall.args;
+            assert.strictEqual(input, 'test');
+            assert.deepStrictEqual(options, { pooling: 'mean', normalize: true });
+        }));
+        it('should initialize the pipeline with correct model name', () => __awaiter(void 0, void 0, void 0, function* () {
+            const fakeVector = new Float32Array([0.5]);
+            fakePipelineFn.resolves({ data: fakeVector });
+            const embeddings = new LocalEmbeddings_1.LocalEmbeddings({ model: 'my/model' });
+            yield embeddings.createEmbeddings('test');
+            assert.ok(fakePipeline.calledOnce);
+            const [task, model] = fakePipeline.firstCall.args;
+            assert.strictEqual(task, 'feature-extraction');
+            assert.strictEqual(model, 'my/model');
+        }));
+        it('should reuse the pipeline across calls', () => __awaiter(void 0, void 0, void 0, function* () {
+            const fakeVector = new Float32Array([0.5]);
+            fakePipelineFn.resolves({ data: fakeVector });
+            const embeddings = new LocalEmbeddings_1.LocalEmbeddings();
+            yield embeddings.createEmbeddings('first');
+            yield embeddings.createEmbeddings('second');
+            // Pipeline should only be created once
+            assert.ok(fakePipeline.calledOnce);
+            // But the pipeline function should be called twice
+            assert.strictEqual(fakePipelineFn.callCount, 2);
+        }));
+        it('should return error status when pipeline fails', () => __awaiter(void 0, void 0, void 0, function* () {
+            fakePipelineFn.rejects(new Error('Model not found'));
+            const embeddings = new LocalEmbeddings_1.LocalEmbeddings();
+            const result = yield embeddings.createEmbeddings('test');
+            assert.strictEqual(result.status, 'error');
+            assert.ok(result.message);
+            assert.ok(result.message.includes('Model not found'));
+        }));
+    });
+    describe('optional dependency', () => {
+        it('should return error when @huggingface/transformers is not installed', () => __awaiter(void 0, void 0, void 0, function* () {
+            requireStub.withArgs('@huggingface/transformers').throws(new Error('Cannot find module'));
+            const embeddings = new LocalEmbeddings_1.LocalEmbeddings();
+            const result = yield embeddings.createEmbeddings('test');
+            assert.strictEqual(result.status, 'error');
+            assert.ok(result.message);
+            assert.ok(result.message.includes('@huggingface/transformers'));
+            assert.ok(result.message.includes('npm install'));
+        }));
+    });
+});
+//# sourceMappingURL=LocalEmbeddings.spec.js.map

package/lib/LocalEmbeddings.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalEmbeddings.spec.js","sourceRoot":"","sources":["../src/LocalEmbeddings.spec.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAiC;AACjC,6CAA+B;AAC/B,uDAAoD;AAEpD,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC7B,IAAI,WAA4B,CAAC;IACjC,IAAI,YAA6B,CAAC;IAClC,IAAI,cAA+B,CAAC;IAEpC,UAAU,CAAC,GAAG,EAAE;QACZ,mEAAmE;QACnE,cAAc,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAC9B,YAAY,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QAErD,sDAAsD;QACtD,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAClE,WAAW,CAAC,WAAW,EAAE,CAAC,CAAC,2CAA2C;QACtE,WAAW,CAAC,QAAQ,CAAC,2BAA2B,CAAC,CAAC,OAAO,CAAC;YACtD,QAAQ,EAAE,YAAY;SACzB,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACX,KAAK,CAAC,OAAO,EAAE,CAAC;IACpB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QACzB,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAC9C,MAAM,UAAU,GAAG,IAAI,iCAAe,EAAE,CAAC;YACzC,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,KAAK,EAAE,yBAAyB,CAAC,CAAC;YAChE,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;YACvC,MAAM,UAAU,GAAG,IAAI,iCAAe,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC,CAAC;YAClE,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;YACtC,MAAM,UAAU,GAAG,IAAI,iCAAe,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC;YAC3D,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,oDAAoD,EAAE,GAAS,EAAE;YAChE,MAAM,UAAU,GAAG,IAAI,YAAY,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;YACrD,cAAc,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;YAE9C,MAAM,UAAU,GAAG,IAAI,iCAAe,EAAE,CAAC;YACzC,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;YAEhE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YAC7C,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACzB,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAC7C,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,MAAO,CAAC,CAAC,CAAC,EAAE,CAAC,mBAAmB,EAAE,mBAAmB,EAAE,mBAAmB,CAAC,CAAC,CAAC;QAC/G,CAAC,CAAA,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE,GAAS,EAAE;YAC7D,MAAM,IAAI,GAAG,IAAI,YAAY,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;YAC/C,MAAM,IAAI,GAAG,IAAI,YAAY,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;YAC/C,cAAc,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YACtD,cAAc,CAAC,YAAY,EAAE,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YAEvD,MAAM,UAAU,GAAG,IAAI,iCAAe,EAAE,CAAC;YACzC,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,gBAAgB,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;YAErE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YAC7C,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACzB,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACjD,CAAC,CAAA,CAAC,CAAC;QAEH,EAAE,CAAC,sDAAsD,EAAE,GAAS,EAAE;YAClE,MAAM,UAAU,GAAG,IAAI,YAAY,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;YAChD,cAAc,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;YAE9C,MAAM,UAAU,GAAG,IAAI,iCAAe,EAAE,CAAC;YACzC,MAAM,UAAU,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;YAE1C,MAAM,CAAC,EAAE,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YACrC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,IAAI,CAAC;YACvD,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAClC,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1E,CAAC,CAAA,CAAC,CAAC;QAEH,EAAE,CAAC,wDAAwD,EAAE,GAAS,EAAE;YACpE,MAAM,UAAU,GAAG,IAAI,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3C,cAAc,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;YAE9C,MAAM,UAAU,GAAG,IAAI,iCAAe,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;YAC9D,MAAM,UAAU,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;YAE1C,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YACnC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC;YAClD,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;YAC/C,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC1C,CAAC,CAAA,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,GAAS,EAAE;YACpD,MAAM,UAAU,GAAG,IAAI,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3C,cAAc,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;YAE9C,MAAM,UAAU,GAAG,IAAI,iCAAe,EAAE,CAAC;YACzC,MAAM,UAAU,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAC3C,MAAM,UAAU,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YAE5C,uCAAuC;YACvC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YACnC,mDAAmD;YACnD,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QACpD,CAAC,CAAA,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,GAAS,EAAE;YAC5D,cAAc,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;YAErD,MAAM,UAAU,GAAG,IAAI,iCAAe,EAAE,CAAC;YACzC,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;YAEzD,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAC3C,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC1B,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,OAAQ,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC;QAC3D,CAAC,CAAA,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACjC,EAAE,CAAC,qEAAqE,EAAE,GAAS,EAAE;YACjF,WAAW,CAAC,QAAQ,CAAC,2BAA2B,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC;YAE1F,MAAM,UAAU,GAAG,IAAI,iCAAe,EAAE,CAAC;YACzC,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;YAEzD,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAC3C,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC1B,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,OAAQ,CAAC,QAAQ,CAAC,2BAA2B,CAAC,CAAC,CAAC;YACjE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,OAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC;QACvD,CAAC,CAAA,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/lib/LocalIndex.d.ts

@@ -0,0 +1,159 @@
+import { IndexItem, IndexStats, MetadataFilter, MetadataTypes, QueryResult } from './types';
+import { FileStorage } from './storage';
+import { IndexCodec } from './codecs';
+export interface CreateIndexConfig {
+    version: number;
+    deleteIfExists?: boolean;
+    metadata_config?: {
+        indexed?: string[];
+    };
+}
+/**
+ * Local vector index instance.
+ * @remarks
+ * This class is used to create, update, and query a local vector index.
+ * Each index is a folder on disk containing an index.json file and an optional set of metadata files.
+ */
+export declare class LocalIndex<TMetadata extends Record<string, MetadataTypes> = Record<string, MetadataTypes>> {
+    private readonly _folderPath;
+    private readonly _indexName;
+    private readonly _storage;
+    private readonly _codec;
+    private _data?;
+    private _update?;
+    private _bm25Engine;
+    private readonly _bm25Factory;
+    private readonly _docReader;
+    /**
+     * Creates a new instance of LocalIndex.
+     * @param folderPath Path to the index folder.
+     * @param indexName Optional index file name. Defaults to 'index' + codec.extension.
+     * @param storage Optional file storage instance. Defaults to LocalFileStorage.
+     * @param codec Optional codec for serialization. Defaults to JsonCodec.
+     * @param options Optional constructor options for dependency injection.
+     */
+    constructor(folderPath: string, indexName?: string, storage?: FileStorage, codec?: IndexCodec, options?: {
+        bm25Factory?: () => any;
+        docReader?: (docId: string) => Promise<string>;
+    });
+    /** Path to the index folder. */
+    get folderPath(): string;
+    /** Name of the index file. */
+    get indexName(): string;
+    /** Storage provider used to store the index. */
+    get storage(): FileStorage;
+    /** Codec used for serialization. */
+    get codec(): IndexCodec;
+    /**
+     * Begins an update to the index.
+     * @remarks
+     * This method loads the index into memory and prepares it for updates.
+     */
+    beginUpdate(): Promise<void>;
+    /**
+     * Cancels an update to the index.
+     * @remarks
+     * This method discards any changes made to the index since the update began.
+     */
+    cancelUpdate(): void;
+    /**
+     * Creates a new index.
+     * @remarks
+     * This method creates a new folder on disk containing an index.json file.
+     * @param config Index configuration.
+     */
+    createIndex(config?: CreateIndexConfig): Promise<void>;
+    /**
+     * Deletes the index.
+     * @remarks
+     * This method deletes the index folder from disk.
+     */
+    deleteIndex(): Promise<void>;
+    /**
+     * Deletes an item from the index.
+     * @param id ID of item to delete.
+     */
+    deleteItem(id: string): Promise<void>;
+    /**
+     * Ends an update to the index.
+     * @remarks
+     * This method saves the index to disk.
+     */
+    endUpdate(): Promise<void>;
+    /**
+     * Loads an index from disk and returns its stats.
+     * @returns Index stats.
+     */
+    getIndexStats(): Promise<IndexStats>;
+    /**
+     * Returns an item from the index given its ID.
+     * @param id ID of the item to retrieve.
+     * @returns Item or undefined if not found.
+     */
+    getItem<TItemMetadata extends TMetadata = TMetadata>(id: string): Promise<IndexItem<TItemMetadata> | undefined>;
+    /**
+     * Adds an item to the index.
+     * @remarks
+     * A new update is started if one is not already in progress. If an item with the same ID
+     * already exists, an error will be thrown.
+     * @param item Item to insert.
+     * @returns Inserted item.
+     */
+    insertItem<TItemMetadata extends TMetadata = TMetadata>(item: Partial<IndexItem<TItemMetadata>>): Promise<IndexItem<TItemMetadata>>;
+    /**
+     * Adds a batch of items to the index.
+     * @remarks
+     * Batch update requires no update to be in progress. This is necessary so that if any one
+     * insert operation fails, the entire update can be safely cancelled. This prevents partial
+     * updates from being applied to the local index.
+     * @param items Items to insert.
+     * @returns Inserted items.
+     */
+    batchInsertItems<TItemMetadata extends TMetadata = TMetadata>(items: Partial<IndexItem<TItemMetadata>>[]): Promise<IndexItem[]>;
+    /** Returns true if the index exists. */
+    isIndexCreated(): Promise<boolean>;
+    /**
+     * Returns all items in the index.
+     * @remarks
+     * This method loads the index into memory and returns all its items. A copy of the items
+     * array is returned so no modifications should be made to the array.
+     * @returns Array of all items in the index.
+     */
+    listItems<TItemMetadata extends TMetadata = TMetadata>(): Promise<IndexItem<TItemMetadata>[]>;
+    /**
+     * Returns all items in the index matching the filter.
+     * @remarks
+     * This method loads the index into memory and returns all its items matching the filter.
+     * @param filter Filter to apply.
+     * @returns Array of items matching the filter.
+     */
+    listItemsByMetadata<TItemMetadata extends TMetadata = TMetadata>(filter: MetadataFilter): Promise<IndexItem<TItemMetadata>[]>;
+    /**
+     * Finds the top k items in the index that are most similar to the vector.
+     * @remarks
+     * This method loads the index into memory and returns the top k items that are most similar.
+     * An optional filter can be applied to the metadata of the items.
+     * @param vector Vector to query against.
+     * @param query Query string (used when isBm25=true).
+     * @param topK Number of items to return.
+     * @param filter Optional. Filter to apply.
+     * @param isBm25 Optional. If true, append BM25 keyword results to semantic results.
+     * @returns Similar items to the vector that match the supplied filter.
+     */
+    queryItems<TItemMetadata extends TMetadata = TMetadata>(vector: number[], query: string, topK: number, filter?: MetadataFilter, isBm25?: boolean): Promise<QueryResult<TItemMetadata>[]>;
+    /**
+     * Adds or replaces an item in the index.
+     * @remarks
+     * A new update is started if one is not already in progress. If an item with the same ID
+     * already exists, it will be replaced.
+     * @param item Item to insert or replace.
+     * @returns Upserted item.
+     */
+    upsertItem<TItemMetadata extends TMetadata = TMetadata>(item: Partial<IndexItem<TItemMetadata>>): Promise<IndexItem<TItemMetadata>>;
+    /** Ensures that the index has been loaded into memory. */
+    protected loadIndexData(): Promise<void>;
+    private addItemToUpdate;
+    private setupBm25;
+    private bm25Search;
+}
+//# sourceMappingURL=LocalIndex.d.ts.map

package/lib/LocalIndex.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LocalIndex.d.ts","sourceRoot":"","sources":["../src/LocalIndex.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAM5F,MAAM,WAAW,iBAAiB;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE;QACd,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;KACtB,CAAC;CACL;AAED;;;;;GAKG;AACH,qBAAa,UAAU,CAAC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAC,aAAa,CAAC,GAAG,MAAM,CAAC,MAAM,EAAC,aAAa,CAAC;IACjG,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IAEpC,OAAO,CAAC,KAAK,CAAC,CAAY;IAC1B,OAAO,CAAC,OAAO,CAAC,CAAY;IAE5B,OAAO,CAAC,WAAW,CAAM;IAEzB;;;;OAIG;gBACgB,UAAU,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM;IAKzD;;OAEG;IACH,IAAW,UAAU,IAAI,MAAM,CAE9B;IAED;;OAEG;IACH,IAAW,SAAS,IAAI,MAAM,CAE7B;IAED;;;;OAIG;IACU,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IASzC;;;;OAIG;IACI,YAAY,IAAI,IAAI;IAI3B;;;;;OAKG;IACU,WAAW,CAAC,MAAM,GAAE,iBAAgC,GAAG,OAAO,CAAC,IAAI,CAAC;IA4BjF;;;;OAIG;IACI,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAQnC;;;OAGG;IACU,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBlD;;;;OAIG;IACU,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAevC;;;OAGG;IACU,aAAa,IAAI,OAAO,CAAC,UAAU,CAAC;IASjD;;;;OAIG;IACU,OAAO,CAAC,aAAa,SAAS,SAAS,GAAG,SAAS,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC;IAK5H;;;;;;;OAOG;IACU,UAAU,CAAC,aAAa,SAAS,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAWhJ;;;;;;;;OAQG;IACU,gBAAgB,CAAC,aAAa,SAAS,SAAS,GAAG,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAiB5I;;OAEG;IACU,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC;IAS/C;;;;;;OAMG;IACU,SAAS,CAAC,aAAa,SAAS,SAAS,GAAG,SAAS,KAAK,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;IAK1G;;;;;;OAMG;IACU,mBAAmB,CAAC,aAAa,SAAS,SAAS,GAAG,SAAS,EAAE,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;IAK1I;;;;;;;;;OASG;IACU,UAAU,CAAC,aAAa,SAAS,SAAS,GAAG,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,cAAc,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,CAAC;IAuErM;;;;;;;OAOG;IACU,UAAU,CAAC,aAAa,SAAS,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAWhJ;;OAEG;cACa,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;YAahC,eAAe;YA+Df,SAAS;YAsBT,UAAU;CAQ3B"}
+{"version":3,"file":"LocalIndex.d.ts","sourceRoot":"","sources":["../src/LocalIndex.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAM5F,OAAO,EAAE,WAAW,EAAoB,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAa,MAAM,UAAU,CAAC;AAEjD,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE;QAChB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;KACpB,CAAC;CACH;AAED;;;;;GAKG;AACH,qBAAa,UAAU,CAAC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC;IACrG,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAwB;IACnD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAc;IACvC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAa;IACpC,OAAO,CAAC,KAAK,CAAC,CAAY;IAC1B,OAAO,CAAC,OAAO,CAAC,CAAY;IAG5B,OAAO,CAAC,WAAW,CAAM;IACzB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAY;IACzC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAqC;IAEhE;;;;;;;OAOG;gBAED,UAAU,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,WAAW,EACrB,KAAK,CAAC,EAAE,UAAU,EAClB,OAAO,CAAC,EAAE;QACR,WAAW,CAAC,EAAE,MAAM,GAAG,CAAC;QACxB,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;KAChD;IAiBH,gCAAgC;IAChC,IAAW,UAAU,IAAI,MAAM,CAE9B;IAED,8BAA8B;IAC9B,IAAW,SAAS,IAAI,MAAM,CAE7B;IAED,gDAAgD;IAChD,IAAW,OAAO,IAAI,WAAW,CAEhC;IAED,oCAAoC;IACpC,IAAW,KAAK,IAAI,UAAU,CAE7B;IAED;;;;OAIG;IACU,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAQzC;;;;OAIG;IACI,YAAY,IAAI,IAAI;IAI3B;;;;;OAKG;IACU,WAAW,CAAC,MAAM,GAAE,iBAAkC,GAAG,OAAO,CAAC,IAAI,CAAC;IA2BnF;;;;OAIG;IACU,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAKzC;;;OAGG;IACU,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBlD;;;;OAIG;IACU,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAevC;;;OAGG;IACU,aAAa,IAAI,OAAO,CAAC,UAAU,CAAC;IASjD;;;;OAIG;IACU,OAAO,CAAC,aAAa,SAAS,SAAS,GAAG,SAAS,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC;IAK5H;;;;;;;OAOG;IACU,UAAU,CAAC,aAAa,SAAS,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAWhJ;;;;;;;;OAQG;IACU,gBAAgB,CAAC,aAAa,SAAS,SAAS,GAAG,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAiB5I,wCAAwC;IAC3B,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC;IAI/C;;;;;;OAMG;IACU,SAAS,CAAC,aAAa,SAAS,SAAS,GAAG,SAAS,KAAK,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;IAK1G;;;;;;OAMG;IACU,mBAAmB,CAAC,aAAa,SAAS,SAAS,GAAG,SAAS,EAAE,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;IAK1I;;;;;;;;;;;OAWG;IACU,UAAU,CAAC,aAAa,SAAS,SAAS,GAAG,SAAS,EACjE,MAAM,EAAE,MAAM,EAAE,EAChB,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,cAAc,EACvB,MAAM,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,CAAC;IA0FxC;;;;;;;OAOG;IACU,UAAU,CAAC,aAAa,SAAS,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAWhJ,0DAA0D;cAC1C,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;YAYhC,eAAe;YAyEf,SAAS;YAmBT,UAAU;CAIzB"}