langchain 0.0.171 → 0.0.173

package/dist/load/import_map.cjs

@@ -24,14 +24,21 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.schema__output_parser = exports.schema__document = exports.schema = exports.chat_models__fake = exports.chat_models__yandex = exports.chat_models__minimax = exports.chat_models__ollama = exports.chat_models__baiduwenxin = exports.chat_models__fireworks = exports.chat_models__cloudflare_workersai = exports.chat_models__anthropic = exports.chat_models__openai = exports.chat_models__base = exports.document_transformers__openai_functions = exports.document_loaders__web__sort_xyz_blockchain = exports.document_loaders__web__serpapi = exports.document_loaders__web__searchapi = exports.document_loaders__base = exports.document = exports.memory = exports.text_splitter = exports.vectorstores__xata = exports.vectorstores__vectara = exports.vectorstores__prisma = exports.vectorstores__memory = exports.vectorstores__base = exports.prompts = exports.llms__fake = exports.llms__yandex = exports.llms__fireworks = exports.llms__ollama = exports.llms__cloudflare_workersai = exports.llms__aleph_alpha = exports.llms__ai21 = exports.llms__openai = exports.llms__base = exports.embeddings__minimax = exports.embeddings__openai = exports.embeddings__ollama = exports.embeddings__fake = exports.embeddings__cache_backed = exports.embeddings__base = exports.chains__openai_functions = exports.chains = exports.tools = exports.base_language = exports.agents__format_scratchpad = exports.agents__toolkits = exports.agents = exports.load__serializable = void 0;
-exports.runnables__remote = exports.evaluation = exports.experimental__chains__violation_of_expectations = exports.experimental__chat_models__bittensor = exports.experimental__plan_and_execute = exports.experimental__generative_agents = exports.experimental__babyagi = exports.experimental__autogpt = exports.util__time = exports.util__math = exports.storage__in_memory = exports.storage__encoder_backed = exports.stores__message__in_memory = exports.stores__file__in_memory = exports.stores__doc__in_memory = exports.cache = exports.retrievers__vespa = exports.retrievers__score_threshold = exports.retrievers__hyde = exports.retrievers__document_compressors__embeddings_filter = exports.retrievers__document_compressors__chain_extract = exports.retrievers__time_weighted = exports.retrievers__tavily_search_api = exports.retrievers__parent_document = exports.retrievers__multi_vector = exports.retrievers__multi_query = exports.retrievers__document_compressors = exports.retrievers__contextual_compression = exports.retrievers__databerry = exports.retrievers__chaindesk = exports.retrievers__remote = exports.output_parsers = exports.callbacks = exports.schema__storage = exports.schema__runnable = exports.schema__retriever = exports.schema__query_constructor = void 0;
+exports.chat_models__baiduwenxin = exports.chat_models__fireworks = exports.chat_models__cloudflare_workersai = exports.chat_models__anthropic = exports.chat_models__openai = exports.chat_models__base = exports.document_transformers__openai_functions = exports.document_loaders__web__sort_xyz_blockchain = exports.document_loaders__web__serpapi = exports.document_loaders__web__searchapi = exports.document_loaders__base = exports.document = exports.memory = exports.text_splitter = exports.vectorstores__xata = exports.vectorstores__vectara = exports.vectorstores__prisma = exports.vectorstores__memory = exports.vectorstores__base = exports.prompts = exports.llms__fake = exports.llms__yandex = exports.llms__fireworks = exports.llms__ollama = exports.llms__cloudflare_workersai = exports.llms__aleph_alpha = exports.llms__ai21 = exports.llms__openai = exports.llms__base = exports.embeddings__minimax = exports.embeddings__openai = exports.embeddings__ollama = exports.embeddings__fake = exports.embeddings__cache_backed = exports.embeddings__base = exports.chains__openai_functions = exports.chains = exports.tools__render = exports.tools = exports.base_language = exports.agents__openai__output_parser = exports.agents__xml__output_parser = exports.agents__react__output_parser = exports.agents__format_scratchpad__log_to_message = exports.agents__format_scratchpad__xml = exports.agents__format_scratchpad__log = exports.agents__format_scratchpad = exports.agents__toolkits = exports.agents = exports.load__serializable = void 0;
+exports.runnables__remote = exports.evaluation = exports.experimental__chains__violation_of_expectations = exports.experimental__chat_models__bittensor = exports.experimental__plan_and_execute = exports.experimental__generative_agents = exports.experimental__babyagi = exports.experimental__autogpt = exports.util__time = exports.util__math = exports.util__document = exports.storage__in_memory = exports.storage__encoder_backed = exports.stores__message__in_memory = exports.stores__file__in_memory = exports.stores__doc__in_memory = exports.cache = exports.retrievers__vespa = exports.retrievers__score_threshold = exports.retrievers__hyde = exports.retrievers__document_compressors__embeddings_filter = exports.retrievers__document_compressors__chain_extract = exports.retrievers__time_weighted = exports.retrievers__tavily_search_api = exports.retrievers__parent_document = exports.retrievers__multi_vector = exports.retrievers__multi_query = exports.retrievers__document_compressors = exports.retrievers__contextual_compression = exports.retrievers__databerry = exports.retrievers__chaindesk = exports.retrievers__remote = exports.output_parsers = exports.callbacks = exports.schema__storage = exports.schema__runnable = exports.schema__retriever = exports.schema__query_constructor = exports.schema__output_parser = exports.schema__document = exports.schema = exports.chat_models__fake = exports.chat_models__yandex = exports.chat_models__minimax = exports.chat_models__ollama = void 0;
 exports.load__serializable = __importStar(require("../load/serializable.cjs"));
 exports.agents = __importStar(require("../agents/index.cjs"));
 exports.agents__toolkits = __importStar(require("../agents/toolkits/index.cjs"));
-exports.agents__format_scratchpad = __importStar(require("../agents/format_scratchpad.cjs"));
+exports.agents__format_scratchpad = __importStar(require("../agents/format_scratchpad/openai_functions.cjs"));
+exports.agents__format_scratchpad__log = __importStar(require("../agents/format_scratchpad/log.cjs"));
+exports.agents__format_scratchpad__xml = __importStar(require("../agents/format_scratchpad/xml.cjs"));
+exports.agents__format_scratchpad__log_to_message = __importStar(require("../agents/format_scratchpad/log_to_message.cjs"));
+exports.agents__react__output_parser = __importStar(require("../agents/react/output_parser.cjs"));
+exports.agents__xml__output_parser = __importStar(require("../agents/xml/output_parser.cjs"));
+exports.agents__openai__output_parser = __importStar(require("../agents/openai/output_parser.cjs"));
 exports.base_language = __importStar(require("../base_language/index.cjs"));
 exports.tools = __importStar(require("../tools/index.cjs"));
+exports.tools__render = __importStar(require("../tools/render.cjs"));
 exports.chains = __importStar(require("../chains/index.cjs"));
 exports.chains__openai_functions = __importStar(require("../chains/openai_functions/index.cjs"));
 exports.embeddings__base = __importStar(require("../embeddings/base.cjs"));
@@ -103,6 +110,7 @@ exports.stores__file__in_memory = __importStar(require("../stores/file/in_memory
 exports.stores__message__in_memory = __importStar(require("../stores/message/in_memory.cjs"));
 exports.storage__encoder_backed = __importStar(require("../storage/encoder_backed.cjs"));
 exports.storage__in_memory = __importStar(require("../storage/in_memory.cjs"));
+exports.util__document = __importStar(require("../util/document.cjs"));
 exports.util__math = __importStar(require("../util/math.cjs"));
 exports.util__time = __importStar(require("../util/time.cjs"));
 exports.experimental__autogpt = __importStar(require("../experimental/autogpt/index.cjs"));

package/dist/load/import_map.d.ts

@@ -1,9 +1,16 @@
 export * as load__serializable from "../load/serializable.js";
 export * as agents from "../agents/index.js";
 export * as agents__toolkits from "../agents/toolkits/index.js";
-export * as agents__format_scratchpad from "../agents/format_scratchpad.js";
+export * as agents__format_scratchpad from "../agents/format_scratchpad/openai_functions.js";
+export * as agents__format_scratchpad__log from "../agents/format_scratchpad/log.js";
+export * as agents__format_scratchpad__xml from "../agents/format_scratchpad/xml.js";
+export * as agents__format_scratchpad__log_to_message from "../agents/format_scratchpad/log_to_message.js";
+export * as agents__react__output_parser from "../agents/react/output_parser.js";
+export * as agents__xml__output_parser from "../agents/xml/output_parser.js";
+export * as agents__openai__output_parser from "../agents/openai/output_parser.js";
 export * as base_language from "../base_language/index.js";
 export * as tools from "../tools/index.js";
+export * as tools__render from "../tools/render.js";
 export * as chains from "../chains/index.js";
 export * as chains__openai_functions from "../chains/openai_functions/index.js";
 export * as embeddings__base from "../embeddings/base.js";
@@ -75,6 +82,7 @@ export * as stores__file__in_memory from "../stores/file/in_memory.js";
 export * as stores__message__in_memory from "../stores/message/in_memory.js";
 export * as storage__encoder_backed from "../storage/encoder_backed.js";
 export * as storage__in_memory from "../storage/in_memory.js";
+export * as util__document from "../util/document.js";
 export * as util__math from "../util/math.js";
 export * as util__time from "../util/time.js";
 export * as experimental__autogpt from "../experimental/autogpt/index.js";

package/dist/load/import_map.js

@@ -2,9 +2,16 @@
 export * as load__serializable from "../load/serializable.js";
 export * as agents from "../agents/index.js";
 export * as agents__toolkits from "../agents/toolkits/index.js";
-export * as agents__format_scratchpad from "../agents/format_scratchpad.js";
+export * as agents__format_scratchpad from "../agents/format_scratchpad/openai_functions.js";
+export * as agents__format_scratchpad__log from "../agents/format_scratchpad/log.js";
+export * as agents__format_scratchpad__xml from "../agents/format_scratchpad/xml.js";
+export * as agents__format_scratchpad__log_to_message from "../agents/format_scratchpad/log_to_message.js";
+export * as agents__react__output_parser from "../agents/react/output_parser.js";
+export * as agents__xml__output_parser from "../agents/xml/output_parser.js";
+export * as agents__openai__output_parser from "../agents/openai/output_parser.js";
 export * as base_language from "../base_language/index.js";
 export * as tools from "../tools/index.js";
+export * as tools__render from "../tools/render.js";
 export * as chains from "../chains/index.js";
 export * as chains__openai_functions from "../chains/openai_functions/index.js";
 export * as embeddings__base from "../embeddings/base.js";
@@ -76,6 +83,7 @@ export * as stores__file__in_memory from "../stores/file/in_memory.js";
 export * as stores__message__in_memory from "../stores/message/in_memory.js";
 export * as storage__encoder_backed from "../storage/encoder_backed.js";
 export * as storage__in_memory from "../storage/in_memory.js";
+export * as util__document from "../util/document.js";
 export * as util__math from "../util/math.js";
 export * as util__time from "../util/time.js";
 export * as experimental__autogpt from "../experimental/autogpt/index.js";

package/dist/memory/vector_store.cjs

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VectorStoreRetrieverMemory = void 0;
 const document_js_1 = require("../document.cjs");
+const document_js_2 = require("../util/document.cjs");
 const base_js_1 = require("./base.cjs");
 /**
  * Class for managing long-term memory in Large Language Model (LLM)
@@ -58,7 +59,7 @@ class VectorStoreRetrieverMemory extends base_js_1.BaseMemory {
         return {
             [this.memoryKey]: this.returnDocs
                 ? results
-                : results.map((r) => r.pageContent).join("\n"),
+                : (0, document_js_2.formatDocumentsAsString)(results, "\n"),
         };
     }
     /**

package/dist/memory/vector_store.js

@@ -1,4 +1,5 @@
 import { Document } from "../document.js";
+import { formatDocumentsAsString } from "../util/document.js";
 import { BaseMemory, getInputValue, } from "./base.js";
 /**
  * Class for managing long-term memory in Large Language Model (LLM)
@@ -55,7 +56,7 @@ export class VectorStoreRetrieverMemory extends BaseMemory {
         return {
             [this.memoryKey]: this.returnDocs
                 ? results
-                : results.map((r) => r.pageContent).join("\n"),
+                : formatDocumentsAsString(results, "\n"),
         };
     }
     /**

package/dist/storage/file_system.cjs

@@ -0,0 +1,167 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalFileStore = void 0;
+const fs = __importStar(require("node:fs/promises"));
+const path = __importStar(require("node: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.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.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.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.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.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.access(rootPath, fs.constants.R_OK | fs.constants.W_OK);
+        }
+        catch (_) {
+            try {
+                // Directory does not exist, create it.
+                await fs.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 * as fs from "node:fs/promises";
+import * as path from "node: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 fs.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.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.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.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.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.access(rootPath, fs.constants.R_OK | fs.constants.W_OK);
+        }
+        catch (_) {
+            try {
+                // Directory does not exist, create it.
+                await fs.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/index.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchApi = exports.SearxngSearch = exports.DataForSeoAPISearch = exports.WolframAlphaTool = exports.WikipediaQueryRun = exports.BraveSearch = exports.WriteFileTool = exports.ReadFileTool = exports.AIPluginTool = exports.GoogleCustomSearch = exports.Serper = exports.ZapierNLAWrapper = exports.ZapierNLARunAction = exports.VectorStoreQATool = exports.RequestsPostTool = exports.RequestsGetTool = exports.JsonGetValueTool = exports.JsonListKeysTool = exports.JsonSpec = exports.ChainTool = exports.IFTTTWebhook = exports.DynamicStructuredTool = exports.DynamicTool = exports.StructuredTool = exports.Tool = exports.BingSerpAPI = exports.DadJokeAPI = exports.SerpAPI = void 0;
+exports.formatToOpenAIFunction = exports.SearchApi = exports.SearxngSearch = exports.DataForSeoAPISearch = exports.WolframAlphaTool = exports.WikipediaQueryRun = exports.BraveSearch = exports.WriteFileTool = exports.ReadFileTool = exports.AIPluginTool = exports.GoogleCustomSearch = exports.Serper = exports.ZapierNLAWrapper = exports.ZapierNLARunAction = exports.VectorStoreQATool = exports.RequestsPostTool = exports.RequestsGetTool = exports.JsonGetValueTool = exports.JsonListKeysTool = exports.JsonSpec = exports.ChainTool = exports.IFTTTWebhook = exports.DynamicStructuredTool = exports.DynamicTool = exports.StructuredTool = exports.Tool = exports.BingSerpAPI = exports.DadJokeAPI = exports.SerpAPI = void 0;
 var serpapi_js_1 = require("./serpapi.cjs");
 Object.defineProperty(exports, "SerpAPI", { enumerable: true, get: function () { return serpapi_js_1.SerpAPI; } });
 var dadjokeapi_js_1 = require("./dadjokeapi.cjs");
@@ -50,3 +50,5 @@ var searxng_search_js_1 = require("./searxng_search.cjs");
 Object.defineProperty(exports, "SearxngSearch", { enumerable: true, get: function () { return searxng_search_js_1.SearxngSearch; } });
 var searchapi_js_1 = require("./searchapi.cjs");
 Object.defineProperty(exports, "SearchApi", { enumerable: true, get: function () { return searchapi_js_1.SearchApi; } });
+var convert_to_openai_js_1 = require("./convert_to_openai.cjs");
+Object.defineProperty(exports, "formatToOpenAIFunction", { enumerable: true, get: function () { return convert_to_openai_js_1.formatToOpenAIFunction; } });

package/dist/tools/index.d.ts

@@ -19,3 +19,4 @@ export { WolframAlphaTool } from "./wolframalpha.js";
 export { DataForSeoAPISearch, type DataForSeoApiConfig, } from "./dataforseo_api_search.js";
 export { SearxngSearch } from "./searxng_search.js";
 export { SearchApi, type SearchApiParameters } from "./searchapi.js";
+export { formatToOpenAIFunction } from "./convert_to_openai.js";

package/dist/tools/index.js

@@ -19,3 +19,4 @@ export { WolframAlphaTool } from "./wolframalpha.js";
 export { DataForSeoAPISearch, } from "./dataforseo_api_search.js";
 export { SearxngSearch } from "./searxng_search.js";
 export { SearchApi } from "./searchapi.js";
+export { formatToOpenAIFunction } from "./convert_to_openai.js";

package/dist/tools/render.cjs

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderTextDescriptionAndArgs = exports.renderTextDescription = void 0;
+const zod_to_json_schema_1 = require("zod-to-json-schema");
+/**
+ * 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;
+/**
+ * Render the tool name, description, and args in plain text.
+ * Output will be in the format of:'
+ * ```
+ * search: This tool is used for search, args: {"query": {"type": "string"}}
+ * calculator: This tool is used for math,
+ * args: {"expression": {"type": "string"}}
+ * ```
+ * @param tools
+ * @returns a string of all tools, their descriptions and a stringified version of their schemas
+ */
+function renderTextDescriptionAndArgs(tools) {
+    return tools
+        .map((tool) => `${tool.name}: ${tool.description}, args: ${JSON.stringify((0, zod_to_json_schema_1.zodToJsonSchema)(tool.schema).properties)}`)
+        .join("\n");
+}
+exports.renderTextDescriptionAndArgs = renderTextDescriptionAndArgs;

package/dist/tools/render.d.ts

@@ -0,0 +1,25 @@
+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;
+/**
+ * Render the tool name, description, and args in plain text.
+ * Output will be in the format of:'
+ * ```
+ * search: This tool is used for search, args: {"query": {"type": "string"}}
+ * calculator: This tool is used for math,
+ * args: {"expression": {"type": "string"}}
+ * ```
+ * @param tools
+ * @returns a string of all tools, their descriptions and a stringified version of their schemas
+ */
+export declare function renderTextDescriptionAndArgs(tools: StructuredTool[]): string;

package/dist/tools/render.js

@@ -0,0 +1,31 @@
+import { zodToJsonSchema } from "zod-to-json-schema";
+/**
+ * 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");
+}
+/**
+ * Render the tool name, description, and args in plain text.
+ * Output will be in the format of:'
+ * ```
+ * search: This tool is used for search, args: {"query": {"type": "string"}}
+ * calculator: This tool is used for math,
+ * args: {"expression": {"type": "string"}}
+ * ```
+ * @param tools
+ * @returns a string of all tools, their descriptions and a stringified version of their schemas
+ */
+export function renderTextDescriptionAndArgs(tools) {
+    return tools
+        .map((tool) => `${tool.name}: ${tool.description}, args: ${JSON.stringify(zodToJsonSchema(tool.schema).properties)}`)
+        .join("\n");
+}

package/dist/tools/serpapi.d.ts

@@ -66,8 +66,8 @@ export interface SerpAPIParameters extends BaseParameters {
      * Additional Google Place ID
      * Parameter that you might have to use to force the knowledge graph map view to
      * show up. You can find the lsig ID by using our [Local Pack
-     * API](https://serpapi.com/local-pack) or [Places Results
-     * API](https://serpapi.com/places-results).
+     * API](https://serpapi.com/local-pack) or [Local Places Results
+     * API](https://serpapi.com/local-results).
      * lsig ID is also available via a redirect Google uses within [Google My
      * Business](https://www.google.com/business/).
      */

package/dist/tools/webbrowser.cjs

@@ -35,6 +35,7 @@ const memory_js_1 = require("../vectorstores/memory.cjs");
 const document_js_1 = require("../document.cjs");
 const base_js_1 = require("./base.cjs");
 const axios_fetch_adapter_js_1 = __importDefault(require("../util/axios-fetch-adapter.cjs"));
+const document_js_2 = require("../util/document.cjs");
 const parseInputs = (inputs) => {
     const [baseUrl, task] = inputs.split(",").map((input) => {
         let t = input.trim();
@@ -234,7 +235,7 @@ class WebBrowser extends base_js_1.Tool {
             }));
             const vectorStore = await memory_js_1.MemoryVectorStore.fromDocuments(docs, this.embeddings);
             const results = await vectorStore.similaritySearch(task, 4, undefined, runManager?.getChild("vectorstore"));
-            context = results.map((res) => res.pageContent).join("\n");
+            context = (0, document_js_2.formatDocumentsAsString)(results, "\n");
         }
         const input = `Text:${context}\n\nI need ${doSummary ? "a summary" : task} from the above text, also provide up to 5 markdown links from within that would be of interest (always including URL and text). Links should be provided, if present, in markdown syntax as a list under the heading "Relevant Links:".`;
         return this.model.predict(input, undefined, runManager?.getChild());