langchain 0.0.166 → 0.0.168

package/dist/retrievers/parent_document.js

@@ -1,7 +1,6 @@
 import * as uuid from "uuid";
-import { BaseRetriever } from "../schema/retriever.js";
 import { Document } from "../document.js";
-// TODO: Change this to subclass MultiVectorRetriever
+import { MultiVectorRetriever, } from "./multi_vector.js";
 /**
  * A type of document retriever that splits input documents into smaller chunks
  * while separately storing and preserving the original documents.
@@ -11,7 +10,7 @@ import { Document } from "../document.js";
  * This strikes a balance between better targeted retrieval with small documents
  * and the more context-rich larger documents.
  */
-export class ParentDocumentRetriever extends BaseRetriever {
+export class ParentDocumentRetriever extends MultiVectorRetriever {
     static lc_name() {
         return "ParentDocumentRetriever";
     }
@@ -29,12 +28,6 @@ export class ParentDocumentRetriever extends BaseRetriever {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "docstore", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
         Object.defineProperty(this, "childSplitter", {
             enumerable: true,
             configurable: true,
@@ -83,12 +76,9 @@ export class ParentDocumentRetriever extends BaseRetriever {
             }
         }
         const parentDocs = [];
-        for (const parentDocId of parentDocIds) {
-            const parentDoc = await this.docstore.search(parentDocId);
-            if (parentDoc !== undefined) {
-                parentDocs.push(parentDoc);
-            }
-        }
+        const storedParentDocs = await this.docstore.mget(parentDocIds);
+        const retrievedDocs = storedParentDocs.filter((doc) => doc !== undefined);
+        parentDocs.push(...retrievedDocs);
         return parentDocs.slice(0, this.parentK);
     }
     /**
@@ -136,7 +126,7 @@ export class ParentDocumentRetriever extends BaseRetriever {
         }
         await this.vectorstore.addDocuments(embeddedDocs);
         if (addToDocstore) {
-            await this.docstore.add(fullDocs);
+            await this.docstore.mset(Object.entries(fullDocs));
         }
     }
 }

package/dist/schema/storage.d.ts

@@ -1,8 +1,35 @@
 import { Serializable } from "../load/serializable.js";
+/** @deprecated For backwards compatibility only. Remove on next minor version upgrade. */
+export interface BaseStoreInterface<K, V> {
+    /**
+     * Method to get multiple values for a set of keys.
+     * @param {K[]} keys - An array of keys.
+     * @returns {Promise<(V | undefined)[]>} - A Promise that resolves with array of values or undefined if key not found.
+     */
+    mget(keys: K[]): Promise<(V | undefined)[]>;
+    /**
+     * Method to set a value for multiple keys.
+     * @param {[K, V][]} keyValuePairs - An array of key-value pairs.
+     * @returns {Promise<void>} - A Promise that resolves when the operation is complete.
+     */
+    mset(keyValuePairs: [K, V][]): Promise<void>;
+    /**
+     * Method to delete multiple keys.
+     * @param {K[]} keys - An array of keys to delete.
+     * @returns {Promise<void>} - A Promise that resolves when the operation is complete.
+     */
+    mdelete(keys: K[]): Promise<void>;
+    /**
+     * Method to yield keys optionally based on a prefix.
+     * @param {string} prefix - Optional prefix to filter keys.
+     * @returns {AsyncGenerator<K | string>} - An asynchronous generator that yields keys on iteration.
+     */
+    yieldKeys(prefix?: string): AsyncGenerator<K | string>;
+}
 /**
  * Abstract interface for a key-value store.
  */
-export declare abstract class BaseStore<K, V> extends Serializable {
+export declare abstract class BaseStore<K, V> extends Serializable implements BaseStoreInterface<K, V> {
     /**
      * Abstract method to get multiple values for a set of keys.
      * @param {K[]} keys - An array of keys.

package/dist/storage/encoder_backed.cjs

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EncoderBackedStore = void 0;
+exports.createDocumentStoreFromByteStore = exports.EncoderBackedStore = void 0;
 const storage_js_1 = require("../schema/storage.cjs");
+const document_js_1 = require("../document.cjs");
 /**
  * Class that provides a layer of abstraction over the base storage,
  * allowing for the encoding and decoding of keys and values. It extends
@@ -15,7 +16,7 @@ class EncoderBackedStore extends storage_js_1.BaseStore {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: ["langchain", "storage", "encoder_backed"]
+            value: ["langchain", "storage"]
         });
         Object.defineProperty(this, "store", {
             enumerable: true,
@@ -91,3 +92,14 @@ class EncoderBackedStore extends storage_js_1.BaseStore {
     }
 }
 exports.EncoderBackedStore = EncoderBackedStore;
+function createDocumentStoreFromByteStore(store) {
+    const encoder = new TextEncoder();
+    const decoder = new TextDecoder();
+    return new EncoderBackedStore({
+        store,
+        keyEncoder: (key) => key,
+        valueSerializer: (doc) => encoder.encode(JSON.stringify({ pageContent: doc.pageContent, metadata: doc.metadata })),
+        valueDeserializer: (bytes) => new document_js_1.Document(JSON.parse(decoder.decode(bytes))),
+    });
+}
+exports.createDocumentStoreFromByteStore = createDocumentStoreFromByteStore;

package/dist/storage/encoder_backed.d.ts

@@ -1,4 +1,5 @@
 import { BaseStore } from "../schema/storage.js";
+import { Document } from "../document.js";
 /**
  * Class that provides a layer of abstraction over the base storage,
  * allowing for the encoding and decoding of keys and values. It extends
@@ -43,3 +44,4 @@ export declare class EncoderBackedStore<K, V, SerializedType = any> extends Base
      */
     yieldKeys(prefix?: string | undefined): AsyncGenerator<string | K>;
 }
+export declare function createDocumentStoreFromByteStore(store: BaseStore<string, Uint8Array>): EncoderBackedStore<string, Document<Record<string, any>>, Uint8Array>;

package/dist/storage/encoder_backed.js

@@ -1,4 +1,5 @@
 import { BaseStore } from "../schema/storage.js";
+import { Document } from "../document.js";
 /**
  * Class that provides a layer of abstraction over the base storage,
  * allowing for the encoding and decoding of keys and values. It extends
@@ -12,7 +13,7 @@ export class EncoderBackedStore extends BaseStore {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: ["langchain", "storage", "encoder_backed"]
+            value: ["langchain", "storage"]
         });
         Object.defineProperty(this, "store", {
             enumerable: true,
@@ -87,3 +88,13 @@ export class EncoderBackedStore extends BaseStore {
         yield* this.store.yieldKeys(prefix);
     }
 }
+export function createDocumentStoreFromByteStore(store) {
+    const encoder = new TextEncoder();
+    const decoder = new TextDecoder();
+    return new EncoderBackedStore({
+        store,
+        keyEncoder: (key) => key,
+        valueSerializer: (doc) => encoder.encode(JSON.stringify({ pageContent: doc.pageContent, metadata: doc.metadata })),
+        valueDeserializer: (bytes) => new Document(JSON.parse(decoder.decode(bytes))),
+    });
+}

package/dist/storage/in_memory.cjs

@@ -14,7 +14,7 @@ class InMemoryStore extends storage_js_1.BaseStore {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: ["langchain", "storage", "in_memory"]
+            value: ["langchain", "storage"]
         });
         Object.defineProperty(this, "store", {
             enumerable: true,

package/dist/storage/in_memory.js

@@ -11,7 +11,7 @@ export class InMemoryStore extends BaseStore {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: ["langchain", "storage", "in_memory"]
+            value: ["langchain", "storage"]
         });
         Object.defineProperty(this, "store", {
             enumerable: true,

package/dist/storage/ioredis.cjs

@@ -14,7 +14,7 @@ class RedisByteStore extends storage_js_1.BaseStore {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: ["langchain", "storage", "ioredis"]
+            value: ["langchain", "storage"]
         });
         Object.defineProperty(this, "client", {
             enumerable: true,
@@ -68,12 +68,12 @@ class RedisByteStore extends storage_js_1.BaseStore {
     async mget(keys) {
         const prefixedKeys = keys.map(this._getPrefixedKey.bind(this));
         const retrievedValues = await this.client.mgetBuffer(prefixedKeys);
-        return retrievedValues.map((key) => {
-            if (!key) {
+        return retrievedValues.map((value) => {
+            if (!value) {
                 return undefined;
             }
             else {
-                return key;
+                return value;
             }
         });
     }

package/dist/storage/ioredis.js

@@ -11,7 +11,7 @@ export class RedisByteStore extends BaseStore {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: ["langchain", "storage", "ioredis"]
+            value: ["langchain", "storage"]
         });
         Object.defineProperty(this, "client", {
             enumerable: true,
@@ -65,12 +65,12 @@ export class RedisByteStore extends BaseStore {
     async mget(keys) {
         const prefixedKeys = keys.map(this._getPrefixedKey.bind(this));
         const retrievedValues = await this.client.mgetBuffer(prefixedKeys);
-        return retrievedValues.map((key) => {
-            if (!key) {
+        return retrievedValues.map((value) => {
+            if (!value) {
                 return undefined;
             }
             else {
-                return key;
+                return value;
             }
         });
     }

package/dist/storage/vercel_kv.cjs

@@ -0,0 +1,146 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VercelKVStore = void 0;
+const kv_1 = require("@vercel/kv");
+const storage_js_1 = require("../schema/storage.cjs");
+/**
+ * Class that extends the BaseStore class to interact with a Vercel KV
+ * database. It provides methods for getting, setting, and deleting data,
+ * as well as yielding keys from the database.
+ */
+class VercelKVStore extends storage_js_1.BaseStore {
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "lc_namespace", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ["langchain", "storage"]
+        });
+        Object.defineProperty(this, "client", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "ttl", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "namespace", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "yieldKeysScanBatchSize", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 1000
+        });
+        this.client = fields?.client ?? kv_1.kv;
+        this.ttl = fields?.ttl;
+        this.namespace = fields?.namespace;
+        this.yieldKeysScanBatchSize =
+            fields?.yieldKeysScanBatchSize ?? this.yieldKeysScanBatchSize;
+    }
+    _getPrefixedKey(key) {
+        if (this.namespace) {
+            const delimiter = "/";
+            return `${this.namespace}${delimiter}${key}`;
+        }
+        return key;
+    }
+    _getDeprefixedKey(key) {
+        if (this.namespace) {
+            const delimiter = "/";
+            return key.slice(this.namespace.length + delimiter.length);
+        }
+        return key;
+    }
+    /**
+     * Gets multiple keys from the Redis database.
+     * @param keys Array of keys to be retrieved.
+     * @returns An array of retrieved values.
+     */
+    async mget(keys) {
+        const prefixedKeys = keys.map(this._getPrefixedKey.bind(this));
+        const retrievedValues = await this.client.mget(...prefixedKeys);
+        const encoder = new TextEncoder();
+        return retrievedValues.map((value) => {
+            if (value === undefined || value === null) {
+                return undefined;
+            }
+            else if (typeof value === "object") {
+                return encoder.encode(JSON.stringify(value));
+            }
+            else {
+                return encoder.encode(value);
+            }
+        });
+    }
+    /**
+     * Sets multiple keys in the Redis database.
+     * @param keyValuePairs Array of key-value pairs to be set.
+     * @returns Promise that resolves when all keys have been set.
+     */
+    async mset(keyValuePairs) {
+        const decoder = new TextDecoder();
+        const decodedKeyValuePairs = keyValuePairs.map(([key, value]) => [
+            this._getPrefixedKey(key),
+            decoder.decode(value),
+        ]);
+        const pipeline = this.client.pipeline();
+        for (const [key, value] of decodedKeyValuePairs) {
+            if (this.ttl) {
+                pipeline.setex(key, this.ttl, value);
+            }
+            else {
+                pipeline.set(key, value);
+            }
+        }
+        await pipeline.exec();
+    }
+    /**
+     * Deletes multiple keys from the Redis database.
+     * @param keys Array of keys to be deleted.
+     * @returns Promise that resolves when all keys have been deleted.
+     */
+    async mdelete(keys) {
+        await this.client.del(...keys.map(this._getPrefixedKey.bind(this)));
+    }
+    /**
+     * Yields keys from the Redis database.
+     * @param prefix Optional prefix to filter the keys.
+     * @returns An AsyncGenerator that yields keys from the Redis database.
+     */
+    async *yieldKeys(prefix) {
+        let pattern;
+        if (prefix) {
+            pattern = this._getPrefixedKey(prefix);
+        }
+        else {
+            pattern = this._getPrefixedKey("*");
+        }
+        let [cursor, batch] = await this.client.scan(0, {
+            match: pattern,
+            count: this.yieldKeysScanBatchSize,
+        });
+        for (const key of batch) {
+            yield this._getDeprefixedKey(key);
+        }
+        while (cursor !== 0) {
+            [cursor, batch] = await this.client.scan(cursor, {
+                match: pattern,
+                count: this.yieldKeysScanBatchSize,
+            });
+            for (const key of batch) {
+                yield this._getDeprefixedKey(key);
+            }
+        }
+    }
+}
+exports.VercelKVStore = VercelKVStore;

package/dist/storage/vercel_kv.d.ts

@@ -0,0 +1,46 @@
+import { type VercelKV } from "@vercel/kv";
+import { BaseStore } from "../schema/storage.js";
+/**
+ * Class that extends the BaseStore class to interact with a Vercel KV
+ * database. It provides methods for getting, setting, and deleting data,
+ * as well as yielding keys from the database.
+ */
+export declare class VercelKVStore extends BaseStore<string, Uint8Array> {
+    lc_namespace: string[];
+    protected client: VercelKV;
+    protected ttl?: number;
+    protected namespace?: string;
+    protected yieldKeysScanBatchSize: number;
+    constructor(fields?: {
+        client?: VercelKV;
+        ttl?: number;
+        namespace?: string;
+        yieldKeysScanBatchSize?: number;
+    });
+    _getPrefixedKey(key: string): string;
+    _getDeprefixedKey(key: string): string;
+    /**
+     * Gets multiple keys from the Redis database.
+     * @param keys Array of keys to be retrieved.
+     * @returns An array of retrieved values.
+     */
+    mget(keys: string[]): Promise<(Uint8Array | undefined)[]>;
+    /**
+     * Sets multiple keys in the Redis database.
+     * @param keyValuePairs Array of key-value pairs to be set.
+     * @returns Promise that resolves when all keys have been set.
+     */
+    mset(keyValuePairs: [string, Uint8Array][]): Promise<void>;
+    /**
+     * Deletes multiple keys from the Redis database.
+     * @param keys Array of keys to be deleted.
+     * @returns Promise that resolves when all keys have been deleted.
+     */
+    mdelete(keys: string[]): Promise<void>;
+    /**
+     * Yields keys from the Redis database.
+     * @param prefix Optional prefix to filter the keys.
+     * @returns An AsyncGenerator that yields keys from the Redis database.
+     */
+    yieldKeys(prefix?: string): AsyncGenerator<string>;
+}

package/dist/storage/vercel_kv.js

@@ -0,0 +1,142 @@
+import { kv } from "@vercel/kv";
+import { BaseStore } from "../schema/storage.js";
+/**
+ * Class that extends the BaseStore class to interact with a Vercel KV
+ * database. It provides methods for getting, setting, and deleting data,
+ * as well as yielding keys from the database.
+ */
+export class VercelKVStore extends BaseStore {
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "lc_namespace", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ["langchain", "storage"]
+        });
+        Object.defineProperty(this, "client", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "ttl", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "namespace", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "yieldKeysScanBatchSize", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 1000
+        });
+        this.client = fields?.client ?? kv;
+        this.ttl = fields?.ttl;
+        this.namespace = fields?.namespace;
+        this.yieldKeysScanBatchSize =
+            fields?.yieldKeysScanBatchSize ?? this.yieldKeysScanBatchSize;
+    }
+    _getPrefixedKey(key) {
+        if (this.namespace) {
+            const delimiter = "/";
+            return `${this.namespace}${delimiter}${key}`;
+        }
+        return key;
+    }
+    _getDeprefixedKey(key) {
+        if (this.namespace) {
+            const delimiter = "/";
+            return key.slice(this.namespace.length + delimiter.length);
+        }
+        return key;
+    }
+    /**
+     * Gets multiple keys from the Redis database.
+     * @param keys Array of keys to be retrieved.
+     * @returns An array of retrieved values.
+     */
+    async mget(keys) {
+        const prefixedKeys = keys.map(this._getPrefixedKey.bind(this));
+        const retrievedValues = await this.client.mget(...prefixedKeys);
+        const encoder = new TextEncoder();
+        return retrievedValues.map((value) => {
+            if (value === undefined || value === null) {
+                return undefined;
+            }
+            else if (typeof value === "object") {
+                return encoder.encode(JSON.stringify(value));
+            }
+            else {
+                return encoder.encode(value);
+            }
+        });
+    }
+    /**
+     * Sets multiple keys in the Redis database.
+     * @param keyValuePairs Array of key-value pairs to be set.
+     * @returns Promise that resolves when all keys have been set.
+     */
+    async mset(keyValuePairs) {
+        const decoder = new TextDecoder();
+        const decodedKeyValuePairs = keyValuePairs.map(([key, value]) => [
+            this._getPrefixedKey(key),
+            decoder.decode(value),
+        ]);
+        const pipeline = this.client.pipeline();
+        for (const [key, value] of decodedKeyValuePairs) {
+            if (this.ttl) {
+                pipeline.setex(key, this.ttl, value);
+            }
+            else {
+                pipeline.set(key, value);
+            }
+        }
+        await pipeline.exec();
+    }
+    /**
+     * Deletes multiple keys from the Redis database.
+     * @param keys Array of keys to be deleted.
+     * @returns Promise that resolves when all keys have been deleted.
+     */
+    async mdelete(keys) {
+        await this.client.del(...keys.map(this._getPrefixedKey.bind(this)));
+    }
+    /**
+     * Yields keys from the Redis database.
+     * @param prefix Optional prefix to filter the keys.
+     * @returns An AsyncGenerator that yields keys from the Redis database.
+     */
+    async *yieldKeys(prefix) {
+        let pattern;
+        if (prefix) {
+            pattern = this._getPrefixedKey(prefix);
+        }
+        else {
+            pattern = this._getPrefixedKey("*");
+        }
+        let [cursor, batch] = await this.client.scan(0, {
+            match: pattern,
+            count: this.yieldKeysScanBatchSize,
+        });
+        for (const key of batch) {
+            yield this._getDeprefixedKey(key);
+        }
+        while (cursor !== 0) {
+            [cursor, batch] = await this.client.scan(cursor, {
+                match: pattern,
+                count: this.yieldKeysScanBatchSize,
+            });
+            for (const key of batch) {
+                yield this._getDeprefixedKey(key);
+            }
+        }
+    }
+}

package/dist/stores/doc/in_memory.cjs

@@ -46,6 +46,19 @@ class InMemoryDocstore extends index_js_1.Docstore {
             this._docs.set(key, value);
         }
     }
+    async mget(keys) {
+        return Promise.all(keys.map((key) => this.search(key)));
+    }
+    async mset(keyValuePairs) {
+        await Promise.all(keyValuePairs.map(([key, value]) => this.add({ [key]: value })));
+    }
+    async mdelete(_keys) {
+        throw new Error("Not implemented.");
+    }
+    // eslint-disable-next-line require-yield
+    async *yieldKeys(_prefix) {
+        throw new Error("Not implemented");
+    }
 }
 exports.InMemoryDocstore = InMemoryDocstore;
 /**

package/dist/stores/doc/in_memory.d.ts

@@ -1,10 +1,11 @@
 import { Document } from "../../document.js";
 import { Docstore } from "../../schema/index.js";
+import { BaseStoreInterface } from "../../schema/storage.js";
 /**
  * Class for storing and retrieving documents in memory asynchronously.
  * Extends the Docstore class.
  */
-export declare class InMemoryDocstore extends Docstore {
+export declare class InMemoryDocstore extends Docstore implements BaseStoreInterface<string, Document> {
     _docs: Map<string, Document>;
     constructor(docs?: Map<string, Document>);
     /**
@@ -19,6 +20,10 @@ export declare class InMemoryDocstore extends Docstore {
      * @returns Void
      */
     add(texts: Record<string, Document>): Promise<void>;
+    mget(keys: string[]): Promise<Document[]>;
+    mset(keyValuePairs: [string, Document][]): Promise<void>;
+    mdelete(_keys: string[]): Promise<void>;
+    yieldKeys(_prefix?: string): AsyncGenerator<string>;
 }
 /**
  * Class for storing and retrieving documents in memory synchronously.

package/dist/stores/doc/in_memory.js

@@ -43,6 +43,19 @@ export class InMemoryDocstore extends Docstore {
             this._docs.set(key, value);
         }
     }
+    async mget(keys) {
+        return Promise.all(keys.map((key) => this.search(key)));
+    }
+    async mset(keyValuePairs) {
+        await Promise.all(keyValuePairs.map(([key, value]) => this.add({ [key]: value })));
+    }
+    async mdelete(_keys) {
+        throw new Error("Not implemented.");
+    }
+    // eslint-disable-next-line require-yield
+    async *yieldKeys(_prefix) {
+        throw new Error("Not implemented");
+    }
 }
 /**
  * Class for storing and retrieving documents in memory synchronously.

package/dist/util/axios-fetch-adapter.cjs

@@ -293,7 +293,7 @@ function createRequest(config) {
     }
     // Some `fetch` implementations will override the Content-Type to text/plain
     // when body is a string.
-    // See https://github.com/hwchase17/langchainjs/issues/1010
+    // See https://github.com/langchain-ai/langchainjs/issues/1010
     if (typeof options.body === "string") {
         options.body = new TextEncoder().encode(options.body);
     }

package/dist/util/axios-fetch-adapter.js

@@ -287,7 +287,7 @@ function createRequest(config) {
     }
     // Some `fetch` implementations will override the Content-Type to text/plain
     // when body is a string.
-    // See https://github.com/hwchase17/langchainjs/issues/1010
+    // See https://github.com/langchain-ai/langchainjs/issues/1010
     if (typeof options.body === "string") {
         options.body = new TextEncoder().encode(options.body);
     }

package/dist/util/env.cjs

@@ -59,7 +59,7 @@ async function getRuntimeEnvironment() {
 exports.getRuntimeEnvironment = getRuntimeEnvironment;
 function getEnvironmentVariable(name) {
     // Certain Deno setups will throw an error if you try to access environment variables
-    // https://github.com/hwchase17/langchainjs/issues/1412
+    // https://github.com/langchain-ai/langchainjs/issues/1412
     try {
         return typeof process !== "undefined"
             ? // eslint-disable-next-line no-process-env