@vectorstores/mongodb 0.1.5 → 0.1.7

package/dist/index.cjs

@@ -71,7 +71,7 @@ class MongoKVStore extends core.BaseKVStore {
     }
 }
 
-var version = "0.1.5";
+var version = "0.1.7";
 var pkg = {
 	version: version};
 
@@ -123,7 +123,7 @@ function toMongoDBFilter(filters) {
  * This store uses the $vectorSearch aggregation stage to perform vector similarity search.
  */ class MongoDBAtlasVectorSearch extends core.BaseVectorStore {
     constructor(init){
-        super(init), this.storesText = true, this.flatMetadata = true;
+        super(), this.storesText = true, this.flatMetadata = true;
         if (init.mongodbClient) {
             this.mongodbClient = init.mongodbClient;
         } else {
@@ -232,6 +232,26 @@ function toMongoDBFilter(filters) {
    * @param query The query to run
    * @returns List of nodes and their similarities
    */ async query(query, options) {
+        switch(query.mode){
+            case "bm25":
+                return this.bm25Search(query);
+            case "hybrid":
+                {
+                    // Calculate prefetch limit for sub-searches
+                    const prefetchK = query.hybridPrefetch ?? query.similarityTopK * core.DEFAULT_HYBRID_PREFETCH_MULTIPLIER;
+                    const prefetchQuery = {
+                        ...query,
+                        similarityTopK: prefetchK
+                    };
+                    const vectorResult = await this.vectorSearch(prefetchQuery);
+                    const bm25Result = await this.bm25Search(prefetchQuery);
+                    return core.combineResults(vectorResult, bm25Result, query.alpha ?? 0.5, query.similarityTopK);
+                }
+            default:
+                return this.vectorSearch(query);
+        }
+    }
+    async vectorSearch(query) {
         const params = {
             queryVector: query.queryEmbedding,
             path: this.embeddingKey,
@@ -272,12 +292,59 @@ function toMongoDBFilter(filters) {
             nodes.push(node);
             similarities.push(score);
         }
-        const result = {
+        return {
+            nodes,
+            similarities,
+            ids
+        };
+    }
+    async bm25Search(query) {
+        if (!query.queryStr) {
+            throw new Error("queryStr is required for BM25 mode");
+        }
+        const pipeline = [
+            {
+                $search: {
+                    index: this.indexName,
+                    text: {
+                        query: query.queryStr,
+                        path: this.textKey
+                    }
+                }
+            },
+            {
+                $project: {
+                    score: {
+                        $meta: "searchScore"
+                    },
+                    [this.embeddingKey]: 0
+                }
+            },
+            {
+                $limit: query.similarityTopK
+            }
+        ];
+        const collection = await this.ensureCollection();
+        const cursor = await collection.aggregate(pipeline);
+        const nodes = [];
+        const ids = [];
+        const similarities = [];
+        for await (const res of (await cursor)){
+            const text = res[this.textKey];
+            const score = res.score;
+            const id = res[this.idKey];
+            const metadata = res[this.metadataKey];
+            const node = core.metadataDictToNode(metadata);
+            node.setContent(text);
+            ids.push(id);
+            nodes.push(node);
+            similarities.push(score);
+        }
+        return {
             nodes,
             similarities,
             ids
         };
-        return result;
     }
     async exists(refDocId) {
         const collection = await this.ensureCollection();

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { BaseKVStore, StoredValue, BaseVectorStore, VectorStoreQuery, BaseEmbedding, VectorStoreBaseParams, BaseNode, VectorStoreQueryResult, BaseReader, Document } from '@vectorstores/core';
+import { BaseKVStore, StoredValue, BaseVectorStore, VectorStoreQuery, BaseNode, VectorStoreQueryResult, BaseReader, Document } from '@vectorstores/core';
 import { MongoClient, BulkWriteOptions, Collection, Document as Document$1, Filter } from 'mongodb';
 
 interface MongoKVStoreConfig {
@@ -83,11 +83,10 @@ declare class MongoDBAtlasVectorSearch extends BaseVectorStore {
     constructor(init: Partial<MongoDBAtlasVectorSearch> & {
         dbName: string;
         collectionName: string;
-        embedModel?: BaseEmbedding;
         autoCreateIndex?: boolean;
         indexedMetadataFields?: string[];
         embeddingDefinition?: Record<string, unknown>;
-    } & VectorStoreBaseParams);
+    });
     ensureCollection(): Promise<Collection>;
     /**
      * Add nodes to the vector store.
@@ -111,6 +110,8 @@ declare class MongoDBAtlasVectorSearch extends BaseVectorStore {
      * @returns List of nodes and their similarities
      */
     query(query: VectorStoreQuery, options?: object): Promise<VectorStoreQueryResult>;
+    private vectorSearch;
+    private bm25Search;
     exists(refDocId: string): Promise<boolean>;
 }
 

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { BaseKVStore, StoredValue, BaseVectorStore, VectorStoreQuery, BaseEmbedding, VectorStoreBaseParams, BaseNode, VectorStoreQueryResult, BaseReader, Document } from '@vectorstores/core';
+import { BaseKVStore, StoredValue, BaseVectorStore, VectorStoreQuery, BaseNode, VectorStoreQueryResult, BaseReader, Document } from '@vectorstores/core';
 import { MongoClient, BulkWriteOptions, Collection, Document as Document$1, Filter } from 'mongodb';
 
 interface MongoKVStoreConfig {
@@ -83,11 +83,10 @@ declare class MongoDBAtlasVectorSearch extends BaseVectorStore {
     constructor(init: Partial<MongoDBAtlasVectorSearch> & {
         dbName: string;
         collectionName: string;
-        embedModel?: BaseEmbedding;
         autoCreateIndex?: boolean;
         indexedMetadataFields?: string[];
         embeddingDefinition?: Record<string, unknown>;
-    } & VectorStoreBaseParams);
+    });
     ensureCollection(): Promise<Collection>;
     /**
      * Add nodes to the vector store.
@@ -111,6 +110,8 @@ declare class MongoDBAtlasVectorSearch extends BaseVectorStore {
      * @returns List of nodes and their similarities
      */
     query(query: VectorStoreQuery, options?: object): Promise<VectorStoreQueryResult>;
+    private vectorSearch;
+    private bm25Search;
     exists(refDocId: string): Promise<boolean>;
 }
 

package/dist/index.edge-light.d.ts

@@ -1,4 +1,4 @@
-import { BaseKVStore, StoredValue, BaseVectorStore, VectorStoreQuery, BaseEmbedding, VectorStoreBaseParams, BaseNode, VectorStoreQueryResult, BaseReader, Document } from '@vectorstores/core';
+import { BaseKVStore, StoredValue, BaseVectorStore, VectorStoreQuery, BaseNode, VectorStoreQueryResult, BaseReader, Document } from '@vectorstores/core';
 import { MongoClient, BulkWriteOptions, Collection, Document as Document$1, Filter } from 'mongodb';
 
 interface MongoKVStoreConfig {
@@ -83,11 +83,10 @@ declare class MongoDBAtlasVectorSearch extends BaseVectorStore {
     constructor(init: Partial<MongoDBAtlasVectorSearch> & {
         dbName: string;
         collectionName: string;
-        embedModel?: BaseEmbedding;
         autoCreateIndex?: boolean;
         indexedMetadataFields?: string[];
         embeddingDefinition?: Record<string, unknown>;
-    } & VectorStoreBaseParams);
+    });
     ensureCollection(): Promise<Collection>;
     /**
      * Add nodes to the vector store.
@@ -111,6 +110,8 @@ declare class MongoDBAtlasVectorSearch extends BaseVectorStore {
      * @returns List of nodes and their similarities
      */
     query(query: VectorStoreQuery, options?: object): Promise<VectorStoreQueryResult>;
+    private vectorSearch;
+    private bm25Search;
     exists(refDocId: string): Promise<boolean>;
 }
 

package/dist/index.edge-light.js

@@ -1,4 +1,4 @@
-import { BaseKVStore, BaseVectorStore, nodeToMetadata, MetadataMode, metadataDictToNode, FilterCondition, Document } from '@vectorstores/core';
+import { BaseKVStore, BaseVectorStore, nodeToMetadata, MetadataMode, DEFAULT_HYBRID_PREFETCH_MULTIPLIER, combineResults, metadataDictToNode, FilterCondition, Document } from '@vectorstores/core';
 import { getEnv } from '@vectorstores/env';
 import { MongoClient } from 'mongodb';
 
@@ -69,7 +69,7 @@ class MongoKVStore extends BaseKVStore {
     }
 }
 
-var version = "0.1.5";
+var version = "0.1.7";
 var pkg = {
 	version: version};
 
@@ -121,7 +121,7 @@ function toMongoDBFilter(filters) {
  * This store uses the $vectorSearch aggregation stage to perform vector similarity search.
  */ class MongoDBAtlasVectorSearch extends BaseVectorStore {
     constructor(init){
-        super(init), this.storesText = true, this.flatMetadata = true;
+        super(), this.storesText = true, this.flatMetadata = true;
         if (init.mongodbClient) {
             this.mongodbClient = init.mongodbClient;
         } else {
@@ -230,6 +230,26 @@ function toMongoDBFilter(filters) {
    * @param query The query to run
    * @returns List of nodes and their similarities
    */ async query(query, options) {
+        switch(query.mode){
+            case "bm25":
+                return this.bm25Search(query);
+            case "hybrid":
+                {
+                    // Calculate prefetch limit for sub-searches
+                    const prefetchK = query.hybridPrefetch ?? query.similarityTopK * DEFAULT_HYBRID_PREFETCH_MULTIPLIER;
+                    const prefetchQuery = {
+                        ...query,
+                        similarityTopK: prefetchK
+                    };
+                    const vectorResult = await this.vectorSearch(prefetchQuery);
+                    const bm25Result = await this.bm25Search(prefetchQuery);
+                    return combineResults(vectorResult, bm25Result, query.alpha ?? 0.5, query.similarityTopK);
+                }
+            default:
+                return this.vectorSearch(query);
+        }
+    }
+    async vectorSearch(query) {
         const params = {
             queryVector: query.queryEmbedding,
             path: this.embeddingKey,
@@ -270,12 +290,59 @@ function toMongoDBFilter(filters) {
             nodes.push(node);
             similarities.push(score);
         }
-        const result = {
+        return {
+            nodes,
+            similarities,
+            ids
+        };
+    }
+    async bm25Search(query) {
+        if (!query.queryStr) {
+            throw new Error("queryStr is required for BM25 mode");
+        }
+        const pipeline = [
+            {
+                $search: {
+                    index: this.indexName,
+                    text: {
+                        query: query.queryStr,
+                        path: this.textKey
+                    }
+                }
+            },
+            {
+                $project: {
+                    score: {
+                        $meta: "searchScore"
+                    },
+                    [this.embeddingKey]: 0
+                }
+            },
+            {
+                $limit: query.similarityTopK
+            }
+        ];
+        const collection = await this.ensureCollection();
+        const cursor = await collection.aggregate(pipeline);
+        const nodes = [];
+        const ids = [];
+        const similarities = [];
+        for await (const res of (await cursor)){
+            const text = res[this.textKey];
+            const score = res.score;
+            const id = res[this.idKey];
+            const metadata = res[this.metadataKey];
+            const node = metadataDictToNode(metadata);
+            node.setContent(text);
+            ids.push(id);
+            nodes.push(node);
+            similarities.push(score);
+        }
+        return {
             nodes,
             similarities,
             ids
         };
-        return result;
     }
     async exists(refDocId) {
         const collection = await this.ensureCollection();

package/dist/index.js

@@ -1,4 +1,4 @@
-import { BaseKVStore, BaseVectorStore, nodeToMetadata, MetadataMode, metadataDictToNode, FilterCondition, Document } from '@vectorstores/core';
+import { BaseKVStore, BaseVectorStore, nodeToMetadata, MetadataMode, DEFAULT_HYBRID_PREFETCH_MULTIPLIER, combineResults, metadataDictToNode, FilterCondition, Document } from '@vectorstores/core';
 import { getEnv } from '@vectorstores/env';
 import { MongoClient } from 'mongodb';
 
@@ -69,7 +69,7 @@ class MongoKVStore extends BaseKVStore {
     }
 }
 
-var version = "0.1.5";
+var version = "0.1.7";
 var pkg = {
 	version: version};
 
@@ -121,7 +121,7 @@ function toMongoDBFilter(filters) {
  * This store uses the $vectorSearch aggregation stage to perform vector similarity search.
  */ class MongoDBAtlasVectorSearch extends BaseVectorStore {
     constructor(init){
-        super(init), this.storesText = true, this.flatMetadata = true;
+        super(), this.storesText = true, this.flatMetadata = true;
         if (init.mongodbClient) {
             this.mongodbClient = init.mongodbClient;
         } else {
@@ -230,6 +230,26 @@ function toMongoDBFilter(filters) {
    * @param query The query to run
    * @returns List of nodes and their similarities
    */ async query(query, options) {
+        switch(query.mode){
+            case "bm25":
+                return this.bm25Search(query);
+            case "hybrid":
+                {
+                    // Calculate prefetch limit for sub-searches
+                    const prefetchK = query.hybridPrefetch ?? query.similarityTopK * DEFAULT_HYBRID_PREFETCH_MULTIPLIER;
+                    const prefetchQuery = {
+                        ...query,
+                        similarityTopK: prefetchK
+                    };
+                    const vectorResult = await this.vectorSearch(prefetchQuery);
+                    const bm25Result = await this.bm25Search(prefetchQuery);
+                    return combineResults(vectorResult, bm25Result, query.alpha ?? 0.5, query.similarityTopK);
+                }
+            default:
+                return this.vectorSearch(query);
+        }
+    }
+    async vectorSearch(query) {
         const params = {
             queryVector: query.queryEmbedding,
             path: this.embeddingKey,
@@ -270,12 +290,59 @@ function toMongoDBFilter(filters) {
             nodes.push(node);
             similarities.push(score);
         }
-        const result = {
+        return {
+            nodes,
+            similarities,
+            ids
+        };
+    }
+    async bm25Search(query) {
+        if (!query.queryStr) {
+            throw new Error("queryStr is required for BM25 mode");
+        }
+        const pipeline = [
+            {
+                $search: {
+                    index: this.indexName,
+                    text: {
+                        query: query.queryStr,
+                        path: this.textKey
+                    }
+                }
+            },
+            {
+                $project: {
+                    score: {
+                        $meta: "searchScore"
+                    },
+                    [this.embeddingKey]: 0
+                }
+            },
+            {
+                $limit: query.similarityTopK
+            }
+        ];
+        const collection = await this.ensureCollection();
+        const cursor = await collection.aggregate(pipeline);
+        const nodes = [];
+        const ids = [];
+        const similarities = [];
+        for await (const res of (await cursor)){
+            const text = res[this.textKey];
+            const score = res.score;
+            const id = res[this.idKey];
+            const metadata = res[this.metadataKey];
+            const node = metadataDictToNode(metadata);
+            node.setContent(text);
+            ids.push(id);
+            nodes.push(node);
+            similarities.push(score);
+        }
+        return {
             nodes,
             similarities,
             ids
         };
-        return result;
     }
     async exists(refDocId) {
         const collection = await this.ensureCollection();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vectorstores/mongodb",
   "description": "MongoDB Storage for vectorstores",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -36,11 +36,11 @@
   "devDependencies": {
     "vitest": "2.1.0",
     "mongodb-memory-server": "^10.1.4",
-    "@vectorstores/core": "0.1.5",
+    "@vectorstores/core": "0.1.7",
     "@vectorstores/env": "0.1.0"
   },
   "peerDependencies": {
-    "@vectorstores/core": "0.1.5",
+    "@vectorstores/core": "0.1.7",
     "@vectorstores/env": "0.1.0"
   },
   "dependencies": {