langchain 0.0.170 → 0.0.172

package/dist/storage/file_system.cjs

@@ -0,0 +1,147 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalFileStore = void 0;
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const storage_js_1 = require("../schema/storage.cjs");
+/**
+ * File system implementation of the BaseStore using a dictionary. Used for
+ * storing key-value pairs in the file system.
+ */
+class LocalFileStore 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, "rootPath", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.rootPath = fields.rootPath;
+    }
+    /**
+     * Read and parse the file at the given path.
+     * @param key The key to read the file for.
+     * @returns Promise that resolves to the parsed file content.
+     */
+    async getParsedFile(key) {
+        try {
+            const fileContent = await fs_1.promises.readFile(this.getFullPath(key));
+            if (!fileContent) {
+                return undefined;
+            }
+            return fileContent;
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        }
+        catch (e) {
+            // File does not exist yet.
+            // eslint-disable-next-line no-instanceof/no-instanceof
+            if ("code" in e && e.code === "ENOENT") {
+                return undefined;
+            }
+            throw new Error(`Error reading and parsing file at path: ${this.rootPath}.\nError: ${JSON.stringify(e)}`);
+        }
+    }
+    /**
+     * Writes the given key-value pairs to the file at the given path.
+     * @param fileContent An object with the key-value pairs to be written to the file.
+     */
+    async setFileContent(content, key) {
+        try {
+            await fs_1.promises.writeFile(this.getFullPath(key), content);
+        }
+        catch (error) {
+            throw new Error(`Error writing file at path: ${this.getFullPath(key)}.\nError: ${JSON.stringify(error)}`);
+        }
+    }
+    /**
+     * Returns the full path of the file where the value of the given key is stored.
+     * @param key the key to get the full path for
+     */
+    getFullPath(key) {
+        try {
+            const keyAsTxtFile = `${key}.txt`;
+            const fullPath = path_1.default.join(this.rootPath, keyAsTxtFile);
+            return fullPath;
+        }
+        catch (e) {
+            throw new Error(`Error getting full path for key: ${key}.\nError: ${JSON.stringify(e)}`);
+        }
+    }
+    /**
+     * Retrieves the values associated with the given keys from the store.
+     * @param keys Keys to retrieve values for.
+     * @returns Array of values associated with the given keys.
+     */
+    async mget(keys) {
+        const values = [];
+        for (const key of keys) {
+            const fileContent = await this.getParsedFile(key);
+            values.push(fileContent);
+        }
+        return values;
+    }
+    /**
+     * Sets the values for the given keys in the store.
+     * @param keyValuePairs Array of key-value pairs to set in the store.
+     * @returns Promise that resolves when all key-value pairs have been set.
+     */
+    async mset(keyValuePairs) {
+        await Promise.all(keyValuePairs.map(([key, value]) => this.setFileContent(value, key)));
+    }
+    /**
+     * Deletes the given keys and their associated values from the store.
+     * @param keys Keys to delete from the store.
+     * @returns Promise that resolves when all keys have been deleted.
+     */
+    async mdelete(keys) {
+        await Promise.all(keys.map((key) => fs_1.promises.unlink(this.getFullPath(key))));
+    }
+    /**
+     * Asynchronous generator that yields keys from the store. If a prefix is
+     * provided, it only yields keys that start with the prefix.
+     * @param prefix Optional prefix to filter keys.
+     * @returns AsyncGenerator that yields keys from the store.
+     */
+    async *yieldKeys(prefix) {
+        const allFiles = await fs_1.promises.readdir(this.rootPath);
+        const allKeys = allFiles.map((file) => file.replace(".txt", ""));
+        for (const key of allKeys) {
+            if (prefix === undefined || key.startsWith(prefix)) {
+                yield key;
+            }
+        }
+    }
+    /**
+     * Static method for initializing the class.
+     * Preforms a check to see if the directory exists, and if not, creates it.
+     * @param path Path to the directory.
+     * @returns Promise that resolves to an instance of the class.
+     */
+    static async fromPath(rootPath) {
+        try {
+            // Verifies the directory exists at the provided path, and that it is readable and writable.
+            await fs_1.promises.access(rootPath, fs_1.promises.constants.R_OK | fs_1.promises.constants.W_OK);
+        }
+        catch (_) {
+            try {
+                // Directory does not exist, create it.
+                await fs_1.promises.mkdir(rootPath, { recursive: true });
+            }
+            catch (error) {
+                throw new Error(`An error occurred creating directory at: ${rootPath}.\nError: ${JSON.stringify(error)}`);
+            }
+        }
+        return new this({ rootPath });
+    }
+}
+exports.LocalFileStore = LocalFileStore;

package/dist/storage/file_system.d.ts

@@ -0,0 +1,60 @@
+import { BaseStore } from "../schema/storage.js";
+/**
+ * File system implementation of the BaseStore using a dictionary. Used for
+ * storing key-value pairs in the file system.
+ */
+export declare class LocalFileStore extends BaseStore<string, Uint8Array> {
+    lc_namespace: string[];
+    rootPath: string;
+    constructor(fields: {
+        rootPath: string;
+    });
+    /**
+     * Read and parse the file at the given path.
+     * @param key The key to read the file for.
+     * @returns Promise that resolves to the parsed file content.
+     */
+    private getParsedFile;
+    /**
+     * Writes the given key-value pairs to the file at the given path.
+     * @param fileContent An object with the key-value pairs to be written to the file.
+     */
+    private setFileContent;
+    /**
+     * Returns the full path of the file where the value of the given key is stored.
+     * @param key the key to get the full path for
+     */
+    private getFullPath;
+    /**
+     * Retrieves the values associated with the given keys from the store.
+     * @param keys Keys to retrieve values for.
+     * @returns Array of values associated with the given keys.
+     */
+    mget(keys: string[]): Promise<(Uint8Array | undefined)[]>;
+    /**
+     * Sets the values for the given keys in the store.
+     * @param keyValuePairs Array of key-value pairs to set in the store.
+     * @returns Promise that resolves when all key-value pairs have been set.
+     */
+    mset(keyValuePairs: [string, Uint8Array][]): Promise<void>;
+    /**
+     * Deletes the given keys and their associated values from the store.
+     * @param keys Keys to delete from the store.
+     * @returns Promise that resolves when all keys have been deleted.
+     */
+    mdelete(keys: string[]): Promise<void>;
+    /**
+     * Asynchronous generator that yields keys from the store. If a prefix is
+     * provided, it only yields keys that start with the prefix.
+     * @param prefix Optional prefix to filter keys.
+     * @returns AsyncGenerator that yields keys from the store.
+     */
+    yieldKeys(prefix?: string): AsyncGenerator<string>;
+    /**
+     * Static method for initializing the class.
+     * Preforms a check to see if the directory exists, and if not, creates it.
+     * @param path Path to the directory.
+     * @returns Promise that resolves to an instance of the class.
+     */
+    static fromPath(rootPath: string): Promise<LocalFileStore>;
+}

package/dist/storage/file_system.js

@@ -0,0 +1,140 @@
+import { promises as fsPromises } from "fs";
+import nodePath from "path";
+import { BaseStore } from "../schema/storage.js";
+/**
+ * File system implementation of the BaseStore using a dictionary. Used for
+ * storing key-value pairs in the file system.
+ */
+export class LocalFileStore extends BaseStore {
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "lc_namespace", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ["langchain", "storage"]
+        });
+        Object.defineProperty(this, "rootPath", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.rootPath = fields.rootPath;
+    }
+    /**
+     * Read and parse the file at the given path.
+     * @param key The key to read the file for.
+     * @returns Promise that resolves to the parsed file content.
+     */
+    async getParsedFile(key) {
+        try {
+            const fileContent = await fsPromises.readFile(this.getFullPath(key));
+            if (!fileContent) {
+                return undefined;
+            }
+            return fileContent;
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        }
+        catch (e) {
+            // File does not exist yet.
+            // eslint-disable-next-line no-instanceof/no-instanceof
+            if ("code" in e && e.code === "ENOENT") {
+                return undefined;
+            }
+            throw new Error(`Error reading and parsing file at path: ${this.rootPath}.\nError: ${JSON.stringify(e)}`);
+        }
+    }
+    /**
+     * Writes the given key-value pairs to the file at the given path.
+     * @param fileContent An object with the key-value pairs to be written to the file.
+     */
+    async setFileContent(content, key) {
+        try {
+            await fsPromises.writeFile(this.getFullPath(key), content);
+        }
+        catch (error) {
+            throw new Error(`Error writing file at path: ${this.getFullPath(key)}.\nError: ${JSON.stringify(error)}`);
+        }
+    }
+    /**
+     * Returns the full path of the file where the value of the given key is stored.
+     * @param key the key to get the full path for
+     */
+    getFullPath(key) {
+        try {
+            const keyAsTxtFile = `${key}.txt`;
+            const fullPath = nodePath.join(this.rootPath, keyAsTxtFile);
+            return fullPath;
+        }
+        catch (e) {
+            throw new Error(`Error getting full path for key: ${key}.\nError: ${JSON.stringify(e)}`);
+        }
+    }
+    /**
+     * Retrieves the values associated with the given keys from the store.
+     * @param keys Keys to retrieve values for.
+     * @returns Array of values associated with the given keys.
+     */
+    async mget(keys) {
+        const values = [];
+        for (const key of keys) {
+            const fileContent = await this.getParsedFile(key);
+            values.push(fileContent);
+        }
+        return values;
+    }
+    /**
+     * Sets the values for the given keys in the store.
+     * @param keyValuePairs Array of key-value pairs to set in the store.
+     * @returns Promise that resolves when all key-value pairs have been set.
+     */
+    async mset(keyValuePairs) {
+        await Promise.all(keyValuePairs.map(([key, value]) => this.setFileContent(value, key)));
+    }
+    /**
+     * Deletes the given keys and their associated values from the store.
+     * @param keys Keys to delete from the store.
+     * @returns Promise that resolves when all keys have been deleted.
+     */
+    async mdelete(keys) {
+        await Promise.all(keys.map((key) => fsPromises.unlink(this.getFullPath(key))));
+    }
+    /**
+     * Asynchronous generator that yields keys from the store. If a prefix is
+     * provided, it only yields keys that start with the prefix.
+     * @param prefix Optional prefix to filter keys.
+     * @returns AsyncGenerator that yields keys from the store.
+     */
+    async *yieldKeys(prefix) {
+        const allFiles = await fsPromises.readdir(this.rootPath);
+        const allKeys = allFiles.map((file) => file.replace(".txt", ""));
+        for (const key of allKeys) {
+            if (prefix === undefined || key.startsWith(prefix)) {
+                yield key;
+            }
+        }
+    }
+    /**
+     * Static method for initializing the class.
+     * Preforms a check to see if the directory exists, and if not, creates it.
+     * @param path Path to the directory.
+     * @returns Promise that resolves to an instance of the class.
+     */
+    static async fromPath(rootPath) {
+        try {
+            // Verifies the directory exists at the provided path, and that it is readable and writable.
+            await fsPromises.access(rootPath, fsPromises.constants.R_OK | fsPromises.constants.W_OK);
+        }
+        catch (_) {
+            try {
+                // Directory does not exist, create it.
+                await fsPromises.mkdir(rootPath, { recursive: true });
+            }
+            catch (error) {
+                throw new Error(`An error occurred creating directory at: ${rootPath}.\nError: ${JSON.stringify(error)}`);
+            }
+        }
+        return new this({ rootPath });
+    }
+}

package/dist/tools/render.cjs

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderTextDescription = void 0;
+/**
+ * Render the tool name and description in plain text.
+ *
+ * Output will be in the format of:
+ * ```
+ * search: This tool is used for search
+ * calculator: This tool is used for math
+ * ```
+ * @param tools
+ * @returns a string of all tools and their descriptions
+ */
+function renderTextDescription(tools) {
+    return tools.map((tool) => `${tool.name}: ${tool.description}`).join("\n");
+}
+exports.renderTextDescription = renderTextDescription;

package/dist/tools/render.d.ts

@@ -0,0 +1,13 @@
+import { StructuredTool } from "./base.js";
+/**
+ * Render the tool name and description in plain text.
+ *
+ * Output will be in the format of:
+ * ```
+ * search: This tool is used for search
+ * calculator: This tool is used for math
+ * ```
+ * @param tools
+ * @returns a string of all tools and their descriptions
+ */
+export declare function renderTextDescription(tools: StructuredTool[]): string;

package/dist/tools/render.js

@@ -0,0 +1,14 @@
+/**
+ * Render the tool name and description in plain text.
+ *
+ * Output will be in the format of:
+ * ```
+ * search: This tool is used for search
+ * calculator: This tool is used for math
+ * ```
+ * @param tools
+ * @returns a string of all tools and their descriptions
+ */
+export function renderTextDescription(tools) {
+    return tools.map((tool) => `${tool.name}: ${tool.description}`).join("\n");
+}

package/dist/util/stream.cjs

@@ -62,6 +62,9 @@ class IterableReadableStream extends ReadableStream {
                     });
                 }
             },
+            cancel() {
+                reader.releaseLock();
+            },
         });
     }
     static fromAsyncGenerator(generator) {

package/dist/util/stream.js

@@ -59,6 +59,9 @@ export class IterableReadableStream extends ReadableStream {
                     });
                 }
             },
+            cancel() {
+                reader.releaseLock();
+            },
         });
     }
     static fromAsyncGenerator(generator) {

package/dist/vectorstores/analyticdb.cjs

@@ -34,7 +34,6 @@ const promises_1 = require("node:stream/promises");
 const node_stream_1 = require("node:stream");
 const base_js_1 = require("./base.cjs");
 const document_js_1 = require("../document.cjs");
-const _LANGCHAIN_DEFAULT_EMBEDDING_DIM = 1536;
 const _LANGCHAIN_DEFAULT_COLLECTION_NAME = "langchain_document";
 /**
  * Class that provides methods for creating and managing a collection of
@@ -85,8 +84,7 @@ class AnalyticDBVectorStore extends base_js_1.VectorStore {
             user: args.connectionOptions.user,
             password: args.connectionOptions.password,
         });
-        this.embeddingDimension =
-            args.embeddingDimension || _LANGCHAIN_DEFAULT_EMBEDDING_DIM;
+        this.embeddingDimension = args.embeddingDimension;
         this.collectionName =
             args.collectionName || _LANGCHAIN_DEFAULT_COLLECTION_NAME;
         this.preDeleteCollection = args.preDeleteCollection || false;
@@ -106,6 +104,9 @@ class AnalyticDBVectorStore extends base_js_1.VectorStore {
      * @returns Promise that resolves when the table and index are created.
      */
     async createTableIfNotExists() {
+        if (!this.embeddingDimension) {
+            this.embeddingDimension = (await this.embeddings.embedQuery("test")).length;
+        }
         const client = await this.pool.connect();
         try {
             await client.query("BEGIN");
@@ -194,6 +195,9 @@ class AnalyticDBVectorStore extends base_js_1.VectorStore {
         if (vectors.length !== documents.length) {
             throw new Error(`Vectors and documents must have the same length`);
         }
+        if (!this.embeddingDimension) {
+            this.embeddingDimension = (await this.embeddings.embedQuery("test")).length;
+        }
         if (vectors[0].length !== this.embeddingDimension) {
             throw new Error(`Vectors must have the same length as the number of dimensions (${this.embeddingDimension})`);
         }

package/dist/vectorstores/analyticdb.d.ts

@@ -21,7 +21,7 @@ export interface AnalyticDBArgs {
 export declare class AnalyticDBVectorStore extends VectorStore {
     FilterType: Record<string, any>;
     private pool;
-    private embeddingDimension;
+    private embeddingDimension?;
     private collectionName;
     private preDeleteCollection;
     private isCreateCollection;

package/dist/vectorstores/analyticdb.js

@@ -5,7 +5,6 @@ import { pipeline } from "node:stream/promises";
 import { Readable } from "node:stream";
 import { VectorStore } from "./base.js";
 import { Document } from "../document.js";
-const _LANGCHAIN_DEFAULT_EMBEDDING_DIM = 1536;
 const _LANGCHAIN_DEFAULT_COLLECTION_NAME = "langchain_document";
 /**
  * Class that provides methods for creating and managing a collection of
@@ -56,8 +55,7 @@ export class AnalyticDBVectorStore extends VectorStore {
             user: args.connectionOptions.user,
             password: args.connectionOptions.password,
         });
-        this.embeddingDimension =
-            args.embeddingDimension || _LANGCHAIN_DEFAULT_EMBEDDING_DIM;
+        this.embeddingDimension = args.embeddingDimension;
         this.collectionName =
             args.collectionName || _LANGCHAIN_DEFAULT_COLLECTION_NAME;
         this.preDeleteCollection = args.preDeleteCollection || false;
@@ -77,6 +75,9 @@ export class AnalyticDBVectorStore extends VectorStore {
      * @returns Promise that resolves when the table and index are created.
      */
     async createTableIfNotExists() {
+        if (!this.embeddingDimension) {
+            this.embeddingDimension = (await this.embeddings.embedQuery("test")).length;
+        }
         const client = await this.pool.connect();
         try {
             await client.query("BEGIN");
@@ -165,6 +166,9 @@ export class AnalyticDBVectorStore extends VectorStore {
         if (vectors.length !== documents.length) {
             throw new Error(`Vectors and documents must have the same length`);
         }
+        if (!this.embeddingDimension) {
+            this.embeddingDimension = (await this.embeddings.embedQuery("test")).length;
+        }
         if (vectors[0].length !== this.embeddingDimension) {
             throw new Error(`Vectors must have the same length as the number of dimensions (${this.embeddingDimension})`);
         }

package/dist/vectorstores/cassandra.cjs

@@ -53,6 +53,12 @@ class CassandraStore extends base_js_1.VectorStore {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "indices", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "isInitialized", {
             enumerable: true,
             configurable: true,
@@ -65,6 +71,7 @@ class CassandraStore extends base_js_1.VectorStore {
         this.table = args.table;
         this.primaryKey = args.primaryKey;
         this.metadataColumns = args.metadataColumns;
+        this.indices = args.indices;
     }
     /**
      * Method to save vectors to the Cassandra database.
@@ -94,13 +101,14 @@ class CassandraStore extends base_js_1.VectorStore {
      * Method to search for vectors that are similar to a given query vector.
      * @param query The query vector.
      * @param k The number of similar vectors to return.
+     * @param filter
      * @returns Promise that resolves with an array of tuples, each containing a Document and a score.
      */
-    async similaritySearchVectorWithScore(query, k) {
+    async similaritySearchVectorWithScore(query, k, filter) {
         if (!this.isInitialized) {
             await this.initialize();
         }
-        const queryStr = this.buildSearchQuery(query, k);
+        const queryStr = this.buildSearchQuery(query, k, filter);
         const queryResultSet = await this.client.execute(queryStr);
         return queryResultSet?.rows.map((row, index) => {
             const textContent = row.text;
@@ -173,6 +181,11 @@ class CassandraStore extends base_js_1.VectorStore {
         await this.client
             .execute(`CREATE CUSTOM INDEX IF NOT EXISTS idx_vector_${this.table}
   ON ${this.keyspace}.${this.table}(vector) USING 'StorageAttachedIndex';`);
+        for await (const { name, value } of this.indices) {
+            await this.client
+                .execute(`CREATE CUSTOM INDEX IF NOT EXISTS idx_${this.table}_${name}
+  ON ${this.keyspace}.${this.table} ${value} USING 'StorageAttachedIndex';`);
+        }
         this.isInitialized = true;
     }
     /**
@@ -200,15 +213,23 @@ class CassandraStore extends base_js_1.VectorStore {
         }
         return queries;
     }
+    buildWhereClause(filter) {
+        const whereClause = Object.entries(filter)
+            .map(([key, value]) => `${key} = '${value}'`)
+            .join(" AND ");
+        return `WHERE ${whereClause}`;
+    }
     /**
      * Method to build an CQL query for searching for similar vectors in the
      * Cassandra database.
      * @param query The query vector.
      * @param k The number of similar vectors to return.
+     * @param filter
      * @returns The CQL query string.
      */
-    buildSearchQuery(query, k) {
-        return `SELECT * FROM ${this.keyspace}.${this.table} ORDER BY vector ANN OF [${query}] LIMIT ${k || 1};`;
+    buildSearchQuery(query, k = 1, filter = undefined) {
+        const whereClause = filter ? this.buildWhereClause(filter) : "";
+        return `SELECT * FROM ${this.keyspace}.${this.table} ${whereClause} ORDER BY vector ANN OF [${query}] LIMIT ${k}`;
     }
 }
 exports.CassandraStore = CassandraStore;

package/dist/vectorstores/cassandra.d.ts

@@ -6,12 +6,17 @@ export interface Column {
     type: string;
     name: string;
 }
+export interface Index {
+    name: string;
+    value: string;
+}
 export interface CassandraLibArgs extends DseClientOptions {
     table: string;
     keyspace: string;
     dimensions: number;
     primaryKey: Column;
     metadataColumns: Column[];
+    indices: Index[];
 }
 /**
  * Class for interacting with the Cassandra database. It extends the
@@ -20,12 +25,14 @@ export interface CassandraLibArgs extends DseClientOptions {
  * texts or documents.
  */
 export declare class CassandraStore extends VectorStore {
+    FilterType: Record<string, any>;
     private client;
     private readonly dimensions;
     private readonly keyspace;
     private primaryKey;
     private metadataColumns;
     private readonly table;
+    private indices;
     private isInitialized;
     _vectorstoreType(): string;
     constructor(embeddings: Embeddings, args: CassandraLibArgs);
@@ -46,9 +53,10 @@ export declare class CassandraStore extends VectorStore {
      * Method to search for vectors that are similar to a given query vector.
      * @param query The query vector.
      * @param k The number of similar vectors to return.
+     * @param filter
      * @returns Promise that resolves with an array of tuples, each containing a Document and a score.
      */
-    similaritySearchVectorWithScore(query: number[], k: number): Promise<[Document, number][]>;
+    similaritySearchVectorWithScore(query: number[], k: number, filter?: this["FilterType"]): Promise<[Document, number][]>;
     /**
      * Static method to create an instance of CassandraStore from texts.
      * @param texts The texts to use.
@@ -87,11 +95,13 @@ export declare class CassandraStore extends VectorStore {
      * @returns The CQL query string.
      */
     private buildInsertQuery;
+    private buildWhereClause;
     /**
      * Method to build an CQL query for searching for similar vectors in the
      * Cassandra database.
      * @param query The query vector.
      * @param k The number of similar vectors to return.
+     * @param filter
      * @returns The CQL query string.
      */
     private buildSearchQuery;