vectra 0.1.1 → 0.2.0

package/lib/LocalIndex.d.ts

@@ -0,0 +1,130 @@
+import { IndexItem, IndexStats, MetadataFilter, MetadataTypes, QueryResult } from './types';
+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 {
+    private readonly _folderPath;
+    private _data?;
+    private _update?;
+    /**
+     * Creates a new instance of LocalIndex.
+     * @param folderPath - Path to the index folder
+     */
+    constructor(folderPath: string);
+    /**
+     * Path to the index folder.
+     */
+    get folderPath(): string;
+    /**
+     * 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 - Item id
+     */
+    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 Item id
+     * @returns Item or undefined if not found
+     */
+    getItem<TMetadata = Record<string, MetadataTypes>>(id: string): Promise<IndexItem<TMetadata> | 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<TMetadata = Record<string, MetadataTypes>>(item: Partial<IndexItem<TMetadata>>): Promise<IndexItem<TMetadata>>;
+    /**
+     * 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 All items in the index
+     */
+    listItems<TMetadata = Record<string, MetadataTypes>>(): Promise<IndexItem<TMetadata>[]>;
+    /**
+     * 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 Items matching the filter
+     */
+    listItemsByMetadata<TMetadata = Record<string, MetadataTypes>>(filter: MetadataFilter): Promise<IndexItem<TMetadata>[]>;
+    /**
+     * 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 topK Number of items to return
+     * @param filter Optional filter to apply
+     * @returns Similar items to the vector that matches the filter
+     */
+    queryItems<TMetadata = Record<string, MetadataTypes>>(vector: number[], topK: number, filter?: MetadataFilter): Promise<QueryResult<TMetadata>[]>;
+    /**
+     * 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<TMetadata = Record<string, MetadataTypes>>(item: Partial<IndexItem<TMetadata>>): Promise<IndexItem<TMetadata>>;
+    /**
+     * Ensures that the index has been loaded into memory.
+     */
+    protected loadIndexData(): Promise<void>;
+    private addItemToUpdate;
+}
+//# sourceMappingURL=LocalIndex.d.ts.map

package/lib/LocalIndex.d.ts.map

@@ -0,0 +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;AAE5F,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;IACnB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,KAAK,CAAC,CAAY;IAC1B,OAAO,CAAC,OAAO,CAAC,CAAY;IAE5B;;;OAGG;gBACgB,UAAU,EAAE,MAAM;IAIrC;;OAEG;IACH,IAAW,UAAU,IAAI,MAAM,CAE9B;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;IA2BjF;;;;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,SAAS,GAAG,MAAM,CAAC,MAAM,EAAC,aAAa,CAAC,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;IAKrH;;;;;;;OAOG;IACU,UAAU,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,EAAC,aAAa,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAWrI;;OAEG;IACU,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC;IAS/C;;;;;;OAMG;IACU,SAAS,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,EAAC,aAAa,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;IAKnG;;;;;;OAMG;IACU,mBAAmB,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,EAAC,aAAa,CAAC,EAAE,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;IAKnI;;;;;;;;;OASG;IACU,UAAU,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,EAAC,aAAa,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC;IAyC7J;;;;;;;OAOG;IACU,UAAU,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,EAAC,aAAa,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAWrI;;OAEG;cACa,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;YAahC,eAAe;CA8DhC"}

package/lib/LocalIndex.js

@@ -0,0 +1,405 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __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 });
+exports.LocalIndex = void 0;
+const fs = __importStar(require("fs/promises"));
+const path = __importStar(require("path"));
+const uuid_1 = require("uuid");
+const ItemSelector_1 = require("./ItemSelector");
+/**
+ * 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.
+ */
+class LocalIndex {
+    /**
+     * Creates a new instance of LocalIndex.
+     * @param folderPath - Path to the index folder
+     */
+    constructor(folderPath) {
+        this._folderPath = folderPath;
+    }
+    /**
+     * Path to the index folder.
+     */
+    get folderPath() {
+        return this._folderPath;
+    }
+    /**
+     * Begins an update to the index.
+     * @remarks
+     * This method loads the index into memory and prepares it for updates.
+     */
+    beginUpdate() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._update) {
+                throw new Error('Update already in progress');
+            }
+            yield this.loadIndexData();
+            this._update = Object.assign({}, this._data);
+        });
+    }
+    /**
+     * Cancels an update to the index.
+     * @remarks
+     * This method discards any changes made to the index since the update began.
+     */
+    cancelUpdate() {
+        this._update = undefined;
+    }
+    /**
+     * Creates a new index.
+     * @remarks
+     * This method creates a new folder on disk containing an index.json file.
+     * @param config - Index configuration
+     */
+    createIndex(config = { version: 1 }) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            // Delete if exists
+            if (yield this.isIndexCreated()) {
+                if (config.deleteIfExists) {
+                    yield this.deleteIndex();
+                }
+                else {
+                    throw new Error('Index already exists');
+                }
+            }
+            try {
+                // Create folder for index
+                yield fs.mkdir(this._folderPath, { recursive: true });
+                // Initialize index.json file
+                this._data = {
+                    version: config.version,
+                    metadata_config: (_a = config.metadata_config) !== null && _a !== void 0 ? _a : {},
+                    items: []
+                };
+                yield fs.writeFile(path.join(this._folderPath, 'index.json'), JSON.stringify(this._data));
+            }
+            catch (err) {
+                yield this.deleteIndex();
+                throw new Error('Error creating index');
+            }
+        });
+    }
+    /**
+     * Deletes the index.
+     * @remarks
+     * This method deletes the index folder from disk.
+     */
+    deleteIndex() {
+        this._data = undefined;
+        return fs.rm(this._folderPath, {
+            recursive: true,
+            maxRetries: 3
+        });
+    }
+    /**
+     * Deletes an item from the index.
+     * @param id - Item id
+     */
+    deleteItem(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._update) {
+                const index = this._update.items.findIndex(i => i.id === id);
+                if (index >= 0) {
+                    this._update.items.splice(index, 1);
+                }
+            }
+            else {
+                yield this.beginUpdate();
+                const index = this._update.items.findIndex(i => i.id === id);
+                if (index >= 0) {
+                    this._update.items.splice(index, 1);
+                }
+                yield this.endUpdate();
+            }
+        });
+    }
+    /**
+     * Ends an update to the index.
+     * @remarks
+     * This method saves the index to disk.
+     */
+    endUpdate() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this._update) {
+                throw new Error('No update in progress');
+            }
+            try {
+                // Save index
+                yield fs.writeFile(path.join(this._folderPath, 'index.json'), JSON.stringify(this._update));
+                this._data = this._update;
+                this._update = undefined;
+            }
+            catch (err) {
+                throw new Error(`Error saving index: ${err.toString()}`);
+            }
+        });
+    }
+    /**
+     * Loads an index from disk and returns its stats.
+     * @returns Index stats
+     */
+    getIndexStats() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.loadIndexData();
+            return {
+                version: this._data.version,
+                metadata_config: this._data.metadata_config,
+                items: this._data.items.length
+            };
+        });
+    }
+    /**
+     * Returns an item from the index given its ID.
+     * @param id Item id
+     * @returns Item or undefined if not found
+     */
+    getItem(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.loadIndexData();
+            return this._data.items.find(i => i.id === id);
+        });
+    }
+    /**
+     * 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(item) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._update) {
+                return yield this.addItemToUpdate(item, true);
+            }
+            else {
+                yield this.beginUpdate();
+                const newItem = yield this.addItemToUpdate(item, true);
+                yield this.endUpdate();
+                return newItem;
+            }
+        });
+    }
+    /**
+     * Returns true if the index exists.
+     */
+    isIndexCreated() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield fs.access(path.join(this._folderPath, 'index.json'));
+                return true;
+            }
+            catch (err) {
+                return false;
+            }
+        });
+    }
+    /**
+     * 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 All items in the index
+     */
+    listItems() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.loadIndexData();
+            return this._data.items.slice();
+        });
+    }
+    /**
+     * 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 Items matching the filter
+     */
+    listItemsByMetadata(filter) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.loadIndexData();
+            return this._data.items.filter(i => ItemSelector_1.ItemSelector.select(i.metadata, filter));
+        });
+    }
+    /**
+     * 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 topK Number of items to return
+     * @param filter Optional filter to apply
+     * @returns Similar items to the vector that matches the filter
+     */
+    queryItems(vector, topK, filter) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.loadIndexData();
+            // Filter items
+            let items = this._data.items;
+            if (filter) {
+                items = items.filter(i => ItemSelector_1.ItemSelector.select(i.metadata, filter));
+            }
+            // Calculate distances
+            const norm = ItemSelector_1.ItemSelector.normalize(vector);
+            const distances = [];
+            for (let i = 0; i < items.length; i++) {
+                const item = items[i];
+                const distance = ItemSelector_1.ItemSelector.normalizedCosineSimilarity(vector, norm, item.vector, item.norm);
+                distances.push({ index: i, distance: distance });
+            }
+            // Sort by distance DESCENDING
+            distances.sort((a, b) => b.distance - a.distance);
+            // Find top k
+            const top = distances.slice(0, topK).map(d => {
+                return {
+                    item: Object.assign({}, items[d.index]),
+                    score: d.distance
+                };
+            });
+            // Load external metadata
+            for (const item of top) {
+                if (item.item.metadataFile) {
+                    const metadataPath = path.join(this._folderPath, item.item.metadataFile);
+                    const metadata = yield fs.readFile(metadataPath);
+                    item.item.metadata = JSON.parse(metadata.toString());
+                }
+            }
+            return top;
+        });
+    }
+    /**
+     * 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(item) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._update) {
+                return yield this.addItemToUpdate(item, false);
+            }
+            else {
+                yield this.beginUpdate();
+                const newItem = yield this.addItemToUpdate(item, false);
+                yield this.endUpdate();
+                return newItem;
+            }
+        });
+    }
+    /**
+     * Ensures that the index has been loaded into memory.
+     */
+    loadIndexData() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._data) {
+                return;
+            }
+            if (!(yield this.isIndexCreated())) {
+                throw new Error('Index does not exist');
+            }
+            const data = yield fs.readFile(path.join(this._folderPath, 'index.json'));
+            this._data = JSON.parse(data.toString());
+        });
+    }
+    addItemToUpdate(item, unique) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            // Ensure vector is provided
+            if (!item.vector) {
+                throw new Error('Vector is required');
+            }
+            // Ensure unique
+            const id = (_a = item.id) !== null && _a !== void 0 ? _a : (0, uuid_1.v4)();
+            if (unique) {
+                const existing = this._update.items.find(i => i.id === id);
+                if (existing) {
+                    throw new Error(`Item with id ${id} already exists`);
+                }
+            }
+            // Check for indexed metadata
+            let metadata = {};
+            let metadataFile;
+            if (this._update.metadata_config.indexed && this._update.metadata_config.indexed.length > 0 && item.metadata) {
+                // Copy only indexed metadata
+                for (const key of this._update.metadata_config.indexed) {
+                    if (item.metadata && item.metadata[key]) {
+                        metadata[key] = item.metadata[key];
+                    }
+                }
+                // Save remaining metadata to disk
+                metadataFile = `${uuid_1.v4}.json`;
+                const metadataPath = path.join(this._folderPath, metadataFile);
+                yield fs.writeFile(metadataPath, JSON.stringify(item.metadata));
+            }
+            else if (item.metadata) {
+                metadata = item.metadata;
+            }
+            // Create new item
+            const newItem = {
+                id: id,
+                metadata: metadata,
+                vector: item.vector,
+                norm: ItemSelector_1.ItemSelector.normalize(item.vector)
+            };
+            if (metadataFile) {
+                newItem.metadataFile = metadataFile;
+            }
+            // Add item to index
+            if (!unique) {
+                const existing = this._update.items.find(i => i.id === id);
+                if (existing) {
+                    existing.metadata = newItem.metadata;
+                    existing.vector = newItem.vector;
+                    existing.metadataFile = newItem.metadataFile;
+                    return existing;
+                }
+                else {
+                    this._update.items.push(newItem);
+                    return newItem;
+                }
+            }
+            else {
+                this._update.items.push(newItem);
+                return newItem;
+            }
+        });
+    }
+}
+exports.LocalIndex = LocalIndex;
+//# sourceMappingURL=LocalIndex.js.map

package/lib/LocalIndex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalIndex.js","sourceRoot":"","sources":["../src/LocalIndex.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gDAAkC;AAClC,2CAA6B;AAC7B,+BAA0B;AAC1B,iDAA8C;AAW9C;;;;;GAKG;AACH,MAAa,UAAU;IAKnB;;;OAGG;IACH,YAAmB,UAAkB;QACjC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACU,WAAW;;YACpB,IAAI,IAAI,CAAC,OAAO,EAAE;gBACd,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;aACjD;YAED,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC3B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACjD,CAAC;KAAA;IAED;;;;OAIG;IACI,YAAY;QACf,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACU,WAAW,CAAC,SAA4B,EAAC,OAAO,EAAE,CAAC,EAAC;;;YAC7D,mBAAmB;YACnB,IAAI,MAAM,IAAI,CAAC,cAAc,EAAE,EAAE;gBAC7B,IAAI,MAAM,CAAC,cAAc,EAAE;oBACvB,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;iBAC5B;qBAAM;oBACH,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;iBAC3C;aACJ;YAED,IAAI;gBACA,0BAA0B;gBAC1B,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBAEtD,6BAA6B;gBAC7B,IAAI,CAAC,KAAK,GAAG;oBACT,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,eAAe,EAAE,MAAA,MAAM,CAAC,eAAe,mCAAI,EAAE;oBAC7C,KAAK,EAAE,EAAE;iBACZ,CAAC;gBACF,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;aAC7F;YAAC,OAAO,GAAY,EAAE;gBACnB,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;aAC3C;;KACJ;IAED;;;;OAIG;IACI,WAAW;QACd,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACvB,OAAO,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE;YAC3B,SAAS,EAAE,IAAI;YACf,UAAU,EAAE,CAAC;SAChB,CAAC,CAAC;IACP,CAAC;IAED;;;OAGG;IACU,UAAU,CAAC,EAAU;;YAC9B,IAAI,IAAI,CAAC,OAAO,EAAE;gBACd,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC7D,IAAI,KAAK,IAAI,CAAC,EAAE;oBACZ,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;iBACvC;aACJ;iBAAM;gBACH,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;gBACzB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC9D,IAAI,KAAK,IAAI,CAAC,EAAE;oBACZ,IAAI,CAAC,OAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;iBACxC;gBACD,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;aAC1B;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,SAAS;;YAClB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;gBACf,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;aAC5C;YAED,IAAI;gBACA,aAAa;gBACb,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC5F,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC;gBAC1B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;aAC5B;YAAC,OAAM,GAAY,EAAE;gBAClB,MAAM,IAAI,KAAK,CAAC,uBAAwB,GAAW,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;aACrE;QACL,CAAC;KAAA;IAED;;;OAGG;IACU,aAAa;;YACtB,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC3B,OAAO;gBACH,OAAO,EAAE,IAAI,CAAC,KAAM,CAAC,OAAO;gBAC5B,eAAe,EAAE,IAAI,CAAC,KAAM,CAAC,eAAe;gBAC5C,KAAK,EAAE,IAAI,CAAC,KAAM,CAAC,KAAK,CAAC,MAAM;aAClC,CAAC;QACN,CAAC;KAAA;IAED;;;;OAIG;IACU,OAAO,CAA2C,EAAU;;YACrE,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC,KAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAoB,CAAC;QACvE,CAAC;KAAA;IAED;;;;;;;OAOG;IACU,UAAU,CAA2C,IAAmC;;YACjG,IAAI,IAAI,CAAC,OAAO,EAAE;gBACd,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,CAAQ,CAAC;aACxD;iBAAM;gBACH,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;gBACzB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACvD,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;gBACvB,OAAO,OAAc,CAAC;aACzB;QACL,CAAC;KAAA;IAED;;OAEG;IACU,cAAc;;YACvB,IAAI;gBACA,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC;gBAC3D,OAAO,IAAI,CAAC;aACf;YAAC,OAAO,GAAY,EAAE;gBACnB,OAAO,KAAK,CAAC;aAChB;QACL,CAAC;KAAA;IAED;;;;;;OAMG;IACU,SAAS;;YAClB,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC,KAAM,CAAC,KAAK,CAAC,KAAK,EAAS,CAAC;QAC5C,CAAC;KAAA;IAED;;;;;;OAMG;IACU,mBAAmB,CAA2C,MAAsB;;YAC7F,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC,KAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,2BAAY,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAQ,CAAC;QACzF,CAAC;KAAA;IAED;;;;;;;;;OASG;IACU,UAAU,CAA2C,MAAgB,EAAE,IAAY,EAAE,MAAuB;;YACrH,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAE3B,eAAe;YACf,IAAI,KAAK,GAAG,IAAI,CAAC,KAAM,CAAC,KAAK,CAAC;YAC9B,IAAI,MAAM,EAAE;gBACR,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,2BAAY,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;aACtE;YAED,sBAAsB;YACtB,MAAM,IAAI,GAAG,2BAAY,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAC5C,MAAM,SAAS,GAA0C,EAAE,CAAC;YAC5D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBACnC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;gBACtB,MAAM,QAAQ,GAAG,2BAAY,CAAC,0BAA0B,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC/F,SAAS,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;aACpD;YAED,8BAA8B;YAC9B,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;YAElD,aAAa;YACb,MAAM,GAAG,GAA6B,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;gBACnE,OAAO;oBACH,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAQ;oBAC9C,KAAK,EAAE,CAAC,CAAC,QAAQ;iBACpB,CAAC;YACN,CAAC,CAAC,CAAC;YAEH,yBAAyB;YACzB,KAAK,MAAM,IAAI,IAAI,GAAG,EAAE;gBACpB,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;oBACxB,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;oBACzE,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;oBACjD,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;iBACxD;aACJ;YAED,OAAO,GAAG,CAAC;QACf,CAAC;KAAA;IAED;;;;;;;OAOG;IACU,UAAU,CAA2C,IAAmC;;YACjG,IAAI,IAAI,CAAC,OAAO,EAAE;gBACd,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,KAAK,CAAQ,CAAC;aACzD;iBAAM;gBACH,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;gBACzB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBACxD,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;gBACvB,OAAO,OAAc,CAAC;aACzB;QACL,CAAC;KAAA;IAED;;OAEG;IACa,aAAa;;YACzB,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO;aACV;YAED,IAAI,CAAC,CAAA,MAAM,IAAI,CAAC,cAAc,EAAE,CAAA,EAAE;gBAC9B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;aAC3C;YAED,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC;YAC1E,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC7C,CAAC;KAAA;IAEa,eAAe,CAAC,IAA6B,EAAE,MAAe;;;YACxE,4BAA4B;YAC5B,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBACd,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;aACzC;YAED,gBAAgB;YAChB,MAAM,EAAE,GAAG,MAAA,IAAI,CAAC,EAAE,mCAAI,IAAA,SAAE,GAAE,CAAC;YAC3B,IAAI,MAAM,EAAE;gBACR,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC5D,IAAI,QAAQ,EAAE;oBACV,MAAM,IAAI,KAAK,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,CAAC;iBACxD;aACJ;YAED,6BAA6B;YAC7B,IAAI,QAAQ,GAAuB,EAAE,CAAC;YACtC,IAAI,YAAgC,CAAC;YACrC,IAAI,IAAI,CAAC,OAAQ,CAAC,eAAe,CAAC,OAAO,IAAI,IAAI,CAAC,OAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE;gBAC5G,6BAA6B;gBAC7B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,OAAQ,CAAC,eAAe,CAAC,OAAO,EAAE;oBACrD,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;wBACrC,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;qBACtC;iBACJ;gBAED,kCAAkC;gBAClC,YAAY,GAAG,GAAG,SAAE,OAAO,CAAC;gBAC5B,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;gBAC/D,MAAM,EAAE,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;aACnE;iBAAM,IAAI,IAAI,CAAC,QAAQ,EAAE;gBACtB,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;aAC5B;YAED,kBAAkB;YAClB,MAAM,OAAO,GAAc;gBACvB,EAAE,EAAE,EAAE;gBACN,QAAQ,EAAE,QAAQ;gBAClB,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,IAAI,EAAE,2BAAY,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC;aAC5C,CAAC;YACF,IAAI,YAAY,EAAE;gBACd,OAAO,CAAC,YAAY,GAAG,YAAY,CAAC;aACvC;YAED,oBAAoB;YACpB,IAAI,CAAC,MAAM,EAAE;gBACT,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC5D,IAAI,QAAQ,EAAE;oBACV,QAAQ,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;oBACrC,QAAQ,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;oBACjC,QAAQ,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;oBAC7C,OAAO,QAAQ,CAAC;iBACnB;qBAAM;oBACH,IAAI,CAAC,OAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBAClC,OAAO,OAAO,CAAC;iBAClB;aACJ;iBAAM;gBACH,IAAI,CAAC,OAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAClC,OAAO,OAAO,CAAC;aAClB;;KACJ;CACJ;AAnWD,gCAmWC"}

package/lib/OpenAIEmbeddings.d.ts

@@ -0,0 +1,98 @@
+import { AxiosResponse, AxiosRequestConfig } from 'axios';
+import { EmbeddingsModel, EmbeddingsResponse } from "./types";
+import { CreateEmbeddingRequest, CreateEmbeddingResponse } from "./internals";
+export interface BaseOpenAIEmbeddingsOptions {
+    /**
+     * Optional. Retry policy to use when calling the OpenAI API.
+     * @remarks
+     * The default retry policy is `[2000, 5000]` which means that the first retry will be after
+     * 2 seconds and the second retry will be after 5 seconds.
+     */
+    retryPolicy?: number[];
+    /**
+     * Optional. Request options to use when calling the OpenAI API.
+     */
+    requestConfig?: AxiosRequestConfig;
+}
+/**
+ * Options for configuring an `OpenAIEmbeddings` to generate embeddings using an OpenAI hosted model.
+ */
+export interface OpenAIEmbeddingsOptions extends BaseOpenAIEmbeddingsOptions {
+    /**
+     * API key to use when calling the OpenAI API.
+     * @remarks
+     * A new API key can be created at https://platform.openai.com/account/api-keys.
+     */
+    apiKey: string;
+    /**
+     * Model to use for completion.
+     * @remarks
+     * For Azure OpenAI this is the name of the deployment to use.
+     */
+    model: string;
+    /**
+     * Optional. Organization to use when calling the OpenAI API.
+     */
+    organization?: string;
+    /**
+     * Optional. Endpoint to use when calling the OpenAI API.
+     * @remarks
+     * For Azure OpenAI this is the deployment endpoint.
+     */
+    endpoint?: string;
+}
+/**
+ * Options for configuring an `OpenAIEmbeddings` to generate embeddings using an Azure OpenAI hosted model.
+ */
+export interface AzureOpenAIEmbeddingsOptions extends BaseOpenAIEmbeddingsOptions {
+    /**
+     * API key to use when making requests to Azure OpenAI.
+     */
+    azureApiKey: string;
+    /**
+     * Deployment endpoint to use.
+     */
+    azureEndpoint: string;
+    /**
+     * Name of the Azure OpenAI deployment (model) to use.
+     */
+    azureDeployment: string;
+    /**
+     * Optional. Version of the API being called. Defaults to `2023-05-15`.
+     */
+    azureApiVersion?: string;
+}
+/**
+ * A `PromptCompletionModel` for calling OpenAI and Azure OpenAI hosted models.
+ * @remarks
+ */
+export declare class OpenAIEmbeddings implements EmbeddingsModel {
+    private readonly _httpClient;
+    private readonly _useAzure;
+    private readonly UserAgent;
+    /**
+     * Options the client was configured with.
+     */
+    readonly options: OpenAIEmbeddingsOptions | AzureOpenAIEmbeddingsOptions;
+    /**
+     * Creates a new `OpenAIClient` instance.
+     * @param options Options for configuring an `OpenAIClient`.
+     */
+    constructor(options: OpenAIEmbeddingsOptions | AzureOpenAIEmbeddingsOptions);
+    /**
+     * Creates embeddings for the given inputs using the OpenAI API.
+     * @param model Name of the model to use (or deployment for Azure).
+     * @param inputs Text inputs to create embeddings for.
+     * @returns A `EmbeddingsResponse` with a status and the generated embeddings or a message when an error occurs.
+     */
+    createEmbeddings(inputs: string | string[]): Promise<EmbeddingsResponse>;
+    /**
+     * @private
+     */
+    protected createEmbeddingRequest(request: CreateEmbeddingRequest): Promise<AxiosResponse<CreateEmbeddingResponse>>;
+    /**
+     * @private
+     */
+    protected post<TData>(url: string, body: object, retryCount?: number): Promise<AxiosResponse<TData>>;
+}
+//# sourceMappingURL=OpenAIEmbeddings.d.ts.map

package/lib/OpenAIEmbeddings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OpenAIEmbeddings.d.ts","sourceRoot":"","sources":["../src/OpenAIEmbeddings.ts"],"names":[],"mappings":"AAAA,OAAc,EAAiB,aAAa,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAChF,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,uBAAuB,EAAgC,MAAM,aAAa,CAAC;AAE5G,MAAM,WAAW,2BAA2B;IACxC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,2BAA2B;IACxE;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,2BAA2B;IAC7E;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;GAGG;AACH,qBAAa,gBAAiB,YAAW,eAAe;IACpD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAgB;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAU;IAEpC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IAEzC;;OAEG;IACH,SAAgB,OAAO,EAAE,uBAAuB,GAAC,4BAA4B,CAAC;IAE9E;;;OAGG;gBACgB,OAAO,EAAE,uBAAuB,GAAC,4BAA4B;IAiChF;;;;;OAKG;IACU,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAerF;;OAEG;IACH,SAAS,CAAC,sBAAsB,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;IAalH;;OAEG;cACa,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,SAAI,GAAG,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;CAqCxG"}