@malipetek/semantic-router 0.0.5 → 0.1.0

package/dist/semantic-router.d.ts

@@ -0,0 +1,31 @@
+import { FlagEmbedding } from "fastembed";
+export interface Route {
+    name: string;
+    documents: string[];
+    callback: (query: string) => void;
+    definitionVectors?: Float32Array[];
+}
+export interface DatabaseOptions {
+    save?: (vectors: Float32Array[]) => void;
+    query?: (query: string) => string[];
+}
+export interface SemanticRouterOptions {
+    fastEmbedOptions?: any;
+    db?: DatabaseOptions;
+}
+export declare class SemanticRouter {
+    private model?;
+    private loaded;
+    private routes;
+    private options;
+    private usedb;
+    constructor(options?: SemanticRouterOptions);
+    waitForModelLoad(): Promise<FlagEmbedding>;
+    onModelLoaded(callback: (...args: any[]) => void): void;
+    embed(texts: string[]): Promise<Float32Array[]>;
+    on(name: string, documents?: string[], callback?: (query: string) => void): Promise<void>;
+    route(query: string): Promise<Route | null>;
+}
+export declare const createRouter: (options?: SemanticRouterOptions) => SemanticRouter;
+export default createRouter;
+//# sourceMappingURL=semantic-router.d.ts.map

package/dist/semantic-router.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"semantic-router.d.ts","sourceRoot":"","sources":["../src/semantic-router.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,aAAa,EAAE,MAAM,WAAW,CAAC;AAE1D,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,iBAAiB,CAAC,EAAE,YAAY,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,KAAK,IAAI,CAAC;IACzC,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,qBAAqB;IACpC,gBAAgB,CAAC,EAAE,GAAG,CAAC;IACvB,EAAE,CAAC,EAAE,eAAe,CAAC;CACtB;AAWD,qBAAa,cAAc;IACzB,OAAO,CAAC,KAAK,CAAC,CAAgB;IAC9B,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,MAAM,CAAe;IAC7B,OAAO,CAAC,OAAO,CAAwB;IACvC,OAAO,CAAC,KAAK,CAAU;gBAEX,OAAO,GAAE,qBAA+D;IAmBpF,gBAAgB,IAAI,OAAO,CAAC,aAAa,CAAC;IAY1C,aAAa,CAAC,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,IAAI;IAOjD,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAc/C,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,GAAE,MAAM,EAAO,EAAE,QAAQ,GAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAUvG,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;CA2BlD;AAED,eAAO,MAAM,YAAY,GAAI,UAAU,qBAAqB,mBAAgC,CAAC;AAC7F,eAAe,YAAY,CAAC"}

package/dist/semantic-router.js

@@ -0,0 +1,97 @@
+import EventEmitter from 'events';
+import { EmbeddingModel, FlagEmbedding } from "fastembed";
+function similarity(xq, index) {
+    const indexNorm = index.map(vec => Math.sqrt(vec.reduce((sum, val) => sum + val ** 2, 0)));
+    const xqNorm = Math.sqrt(xq.reduce((sum, val) => sum + val ** 2, 0));
+    const sim = index.map((vec, i) => vec.reduce((sum, val, idx) => sum + val * xq[idx], 0) / (indexNorm[i] * xqNorm));
+    return Math.max(...sim);
+}
+const EMITTER = new EventEmitter();
+export class SemanticRouter {
+    model;
+    loaded = false;
+    routes = [];
+    options;
+    usedb;
+    constructor(options = { fastEmbedOptions: {}, db: undefined }) {
+        this.options = {
+            ...options,
+            fastEmbedOptions: {
+                model: EmbeddingModel.BGESmallENV15,
+                showDownloadProgress: true,
+                ...options.fastEmbedOptions
+            }
+        };
+        this.usedb = !!(this.options.db && this.options.db.save && this.options.db.query);
+        FlagEmbedding.init(this.options.fastEmbedOptions).then(model => {
+            this.model = model;
+            this.loaded = true;
+            EMITTER.emit('model-loaded');
+        });
+    }
+    waitForModelLoad() {
+        return new Promise(resolve => {
+            if (this.loaded && this.model) {
+                resolve(this.model);
+            }
+            else {
+                EMITTER.once('model-loaded', () => {
+                    if (this.model)
+                        resolve(this.model);
+                });
+            }
+        });
+    }
+    onModelLoaded(callback) {
+        if (typeof callback !== 'function') {
+            throw new Error('Callback must be a function');
+        }
+        EMITTER.prependListener('model-loaded', callback);
+    }
+    async embed(texts) {
+        const model = await this.waitForModelLoad();
+        const embeddings = model.embed(texts);
+        const result = [];
+        for await (const batch of embeddings) {
+            for (const vector of batch) {
+                result.push(vector instanceof Float32Array ? vector : new Float32Array(vector));
+            }
+        }
+        return result;
+    }
+    async on(name, documents = [], callback = () => { }) {
+        const vectors = await this.embed(documents);
+        this.routes.push({
+            name,
+            documents,
+            callback,
+            definitionVectors: vectors,
+        });
+    }
+    async route(query) {
+        const queryVectors = await this.embed([query]);
+        const queryVector = queryVectors[0];
+        const similarityScores = [];
+        for (const route of this.routes) {
+            if (!route.definitionVectors || route.definitionVectors.length === 0) {
+                similarityScores.push(0);
+                continue;
+            }
+            const score = similarity(queryVector, route.definitionVectors);
+            similarityScores.push(score);
+        }
+        if (similarityScores.length === 0)
+            return null;
+        const maxScore = Math.max(...similarityScores);
+        if (maxScore < 0.1) {
+            return null;
+        }
+        const mostSimilarIndex = similarityScores.indexOf(maxScore);
+        const likelyRoute = this.routes[mostSimilarIndex];
+        likelyRoute.callback(query);
+        return likelyRoute;
+    }
+}
+export const createRouter = (options) => new SemanticRouter(options);
+export default createRouter;
+//# sourceMappingURL=semantic-router.js.map

package/dist/semantic-router.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"semantic-router.js","sourceRoot":"","sources":["../src/semantic-router.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAmB1D,SAAS,UAAU,CAAC,EAAgB,EAAE,KAAqB;IACzD,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3F,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACrE,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IACnH,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,OAAO,GAAG,IAAI,YAAY,EAAE,CAAC;AAEnC,MAAM,OAAO,cAAc;IACjB,KAAK,CAAiB;IACtB,MAAM,GAAG,KAAK,CAAC;IACf,MAAM,GAAY,EAAE,CAAC;IACrB,OAAO,CAAwB;IAC/B,KAAK,CAAU;IAEvB,YAAY,UAAiC,EAAE,gBAAgB,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE;QAClF,IAAI,CAAC,OAAO,GAAG;YACb,GAAG,OAAO;YACV,gBAAgB,EAAE;gBAChB,KAAK,EAAE,cAAc,CAAC,aAAa;gBACnC,oBAAoB,EAAE,IAAI;gBAC1B,GAAG,OAAO,CAAC,gBAAgB;aAC5B;SACF,CAAC;QAEF,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;QAElF,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YAC7D,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YACnB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,gBAAgB;QACd,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;YAC3B,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBAC9B,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,EAAE;oBAChC,IAAI,IAAI,CAAC,KAAK;wBAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACtC,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,aAAa,CAAC,QAAkC;QAC9C,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;QACD,OAAO,CAAC,eAAe,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,KAAe;QACzB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC5C,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACtC,MAAM,MAAM,GAAmB,EAAE,CAAC;QAElC,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,UAAU,EAAE,CAAC;YACrC,KAAK,MAAM,MAAM,IAAI,KAAK,EAAE,CAAC;gBAC3B,MAAM,CAAC,IAAI,CAAC,MAAM,YAAY,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YAClF,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,EAAE,CAAC,IAAY,EAAE,YAAsB,EAAE,EAAE,WAAoC,GAAG,EAAE,GAAE,CAAC;QAC3F,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACf,IAAI;YACJ,SAAS;YACT,QAAQ;YACR,iBAAiB,EAAE,OAAO;SAC3B,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,KAAa;QACvB,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAC/C,MAAM,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;QAEpC,MAAM,gBAAgB,GAAa,EAAE,CAAC;QACtC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,CAAC,iBAAiB,IAAI,KAAK,CAAC,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACrE,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBACzB,SAAS;YACX,CAAC;YACD,MAAM,KAAK,GAAG,UAAU,CAAC,WAAW,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;YAC/D,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;QAED,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAE/C,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,CAAC;QAC/C,IAAI,QAAQ,GAAG,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC5D,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;QAElD,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC5B,OAAO,WAAW,CAAC;IACrB,CAAC;CACF;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAA+B,EAAE,EAAE,CAAC,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC;AAC7F,eAAe,YAAY,CAAC"}

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@malipetek/semantic-router",
-  "version": "0.0.5",
+  "version": "0.1.0",
   "description": "Semantic router for nodejs for my personal use, pretty straightforward, inspired by semantic router by aureliolabs",
   "repository": {
     "type": "git",
     "url": "https://github.com/malipetek/semantic-router.git"
   },
   "homepage": "https://github.com/malipetek/semantic-router",
-  "main": "src/semantic-router.js",
+  "main": "dist/semantic-router.js",
+  "types": "dist/semantic-router.d.ts",
   "author": "m.ali petek",
   "license": "MIT",
   "private": false,
@@ -15,7 +16,16 @@
   "dependencies": {
     "fastembed": "^1.14.1"
   },
+  "devDependencies": {
+    "@types/node": "^25.0.3",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3"
+  },
+  "files": [
+    "dist"
+  ],
   "scripts": {
-    "test": "node tests/*.js" 
+    "build": "tsc",
+    "test": "tsx --test tests/*.ts"
   }
-}
+}

package/src/semantic-router.js

@@ -1,141 +0,0 @@
-import EventEmitter from 'events';
-import { EmbeddingModel, FlagEmbedding } from "fastembed";
-/**
- * @typedef {{ name: string, documents: string[], callback: Function, definitionVectors: Float32Array[] }} Route
-*/
-
-  /**
-   * Calculates the similarity between the query vector and the index vectors.
-   *
-   * @param {Float32Array} xq - The query vector
-   * @param {Float32Array[]} index - The array dxszawof index vectors
-   * @return {Number} The maximum similarity score
-   */
-  function similarity(xq, index) {
-    const indexNorm = index.map(vec => Math.sqrt(vec.reduce((sum, val) => sum + val ** 2, 0)));
-    const xqNorm = Math.sqrt(xq.reduce((sum, val) => sum + val ** 2, 0));
-    const sim = index.map((vec, i) => vec.reduce((sum, val, i) => sum + val * xq[i], 0) / (indexNorm[i] * xqNorm));
-    return Math.max(...sim); // Return the maximum similarity score
-  }
-
-const EMITTER = new EventEmitter();
-export class SemanticRouter {
-  constructor({ fastEmbedOptions } = {}) {
-    fastEmbedOptions = {
-      model: EmbeddingModel.BGESmallENV15,
-      showDownloadProgress: true,
-      ...fastEmbedOptions
-    }
-
-    /** @type {FlagEmbedding} */
-    this.model;
-    this.loaded = false;
-    /** @type {Route[]} */
-    this.routes = [];
-
-    FlagEmbedding.init(fastEmbedOptions).then(
-      /** @type {FlagEmbedding} */
-      model => {
-      this.model = model;
-      this.loaded = true;
-      EMITTER.emit('model-loaded');
-    });
-  }
-
-  /**
-   * Waits for the model to be loaded and resolves with the model.
-   *
-   * @return {Promise<FlagEmbedding>} A promise that resolves with the loaded model.
-   */
-  waitForModelLoad() {
-    return new Promise(resolve => {
-      if (this.loaded) {
-        resolve(this.model);
-      } else {
-        EMITTER.on('model-loaded', () => resolve(this.model));
-      }
-    });
-  }
-
-  /**
-   * onModelLoaded - A function to register a callback for when the model is loaded.
-   *
-   * @param {(...args: any[]) => void} callback - The callback function to be executed when the model is loaded.
-   * @return {void} 
-   */
-  onModelLoaded(callback) {
-    // make sure callback is a function 
-    if (typeof callback !== 'function') {
-      throw new Error('Callback must be a function');
-    }
-    EMITTER.prependListener('model-loaded', callback);
-  }
-  /**
-   * Asynchronously embeds the given text using the model after waiting for the model to load.
-   *
-   * @param {string[]} texts - the text to embed
-   * @return {Promise<Float32Array[]>} the embedded result
-   */
-  async embed(texts) {
-    await this.waitForModelLoad();
-    const embeddings = this.model.embed(texts);
-    const embeddingsRes = [];
-    for await (const batch of embeddings) {
-      // make sure batch is Float32Array
-      embeddingsRes.push(batch);
-    }
-    /** @type {Float32Array[]} */
-    const result = embeddingsRes.flat();
-    
-    return result;
-  }
-  
-  /**
-   * Adds a new route to the routes object.
-   *
-   * @param {string} name - the name of the route
-   * @param {string[]} documents - the documents associated with the route
-   * @param {function} callback - the callback function for the route
-   * @return {Promise<undefined>} 
-   */
-  async on(name, documents = [], callback = () => {}) {
-    const vector = await this.embed(documents);
-    this.routes.push({
-      name,
-      documents,
-      callback,
-      definitionVectors: vector,
-    });
-  }
-
-  /**
-   * Asynchronously routes a query to the most similar route.
-   *
-   * @param {string} query - the query to be routed
-   * @return {Promise<any>} the result of the routed query
-   */
-  async route(query) {
-    const queryVector = await this.embed([query]);
-    /** @type {number[]} */
-    const similarityScores = [];
-    for (let index in this.routes) {
-      const route = this.routes[index];
-      if(!route.definitionVectors) {
-        continue;
-      }
-      const similarityScore = similarity(queryVector[0], route.definitionVectors);
-      similarityScores.push(similarityScore);
-    }
-    const mostSimilarIndex = similarityScores.indexOf(similarityScores.find((x, i) => x === Math.max(...similarityScores)));
-    const likelyRoute = this.routes[mostSimilarIndex];
-    // if top score has very low score return null
-    if (similarityScores[mostSimilarIndex] < 0.1) {
-      return null;
-    }
-
-    likelyRoute.callback(query);
-
-    return likelyRoute;
-  }
-}
-export default () => new SemanticRouter();