langchain 0.0.172 → 0.0.174

package/dist/document_loaders/fs/pdf.js

@@ -1,5 +1,6 @@
 import { Document } from "../../document.js";
 import { BufferLoader } from "./buffer.js";
+import { formatDocumentsAsString } from "../../util/document.js";
 /**
  * A class that extends the `BufferLoader` class. It represents a document
  * loader that loads documents from PDF files.
@@ -82,7 +83,7 @@ export class PDFLoader extends BufferLoader {
         }
         return [
             new Document({
-                pageContent: documents.map((doc) => doc.pageContent).join("\n\n"),
+                pageContent: formatDocumentsAsString(documents),
                 metadata: {
                     ...metadata,
                     pdf: {

package/dist/document_loaders/web/pdf.cjs

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebPDFLoader = void 0;
 const document_js_1 = require("../../document.cjs");
 const base_js_1 = require("../base.cjs");
+const document_js_2 = require("../../util/document.cjs");
 /**
  * A document loader for loading data from PDFs.
  */
@@ -77,7 +78,7 @@ class WebPDFLoader extends base_js_1.BaseDocumentLoader {
         }
         return [
             new document_js_1.Document({
-                pageContent: documents.map((doc) => doc.pageContent).join("\n\n"),
+                pageContent: (0, document_js_2.formatDocumentsAsString)(documents),
                 metadata: {
                     pdf: {
                         version,

package/dist/document_loaders/web/pdf.js

@@ -1,5 +1,6 @@
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+import { formatDocumentsAsString } from "../../util/document.js";
 /**
  * A document loader for loading data from PDFs.
  */
@@ -74,7 +75,7 @@ export class WebPDFLoader extends BaseDocumentLoader {
         }
         return [
             new Document({
-                pageContent: documents.map((doc) => doc.pageContent).join("\n\n"),
+                pageContent: formatDocumentsAsString(documents),
                 metadata: {
                     pdf: {
                         version,

package/dist/load/import_map.cjs

@@ -24,8 +24,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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__render = exports.tools = exports.base_language = 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.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 = 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"));
@@ -34,6 +34,8 @@ exports.agents__format_scratchpad__log = __importStar(require("../agents/format_
 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"));
@@ -108,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

@@ -6,6 +6,8 @@ export * as agents__format_scratchpad__log from "../agents/format_scratchpad/log
 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";
@@ -80,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

@@ -7,6 +7,8 @@ export * as agents__format_scratchpad__log from "../agents/format_scratchpad/log
 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";
@@ -81,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/index.cjs

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConversationSummaryBufferMemory = exports.CombinedMemory = exports.ENTITY_MEMORY_CONVERSATION_TEMPLATE = exports.EntityMemory = exports.VectorStoreRetrieverMemory = exports.MotorheadMemory = exports.ChatMessageHistory = exports.BaseChatMemory = exports.BufferWindowMemory = exports.BaseConversationSummaryMemory = exports.ConversationSummaryMemory = exports.getBufferString = exports.getInputValue = exports.BaseMemory = exports.BufferMemory = void 0;
+exports.ConversationSummaryBufferMemory = exports.CombinedMemory = exports.ENTITY_MEMORY_CONVERSATION_TEMPLATE = exports.EntityMemory = exports.VectorStoreRetrieverMemory = exports.MotorheadMemory = exports.ChatMessageHistory = exports.BaseChatMemory = exports.BufferWindowMemory = exports.BaseConversationSummaryMemory = exports.ConversationSummaryMemory = exports.getBufferString = exports.getOutputValue = exports.getInputValue = exports.BaseMemory = exports.BufferMemory = void 0;
 var buffer_memory_js_1 = require("./buffer_memory.cjs");
 Object.defineProperty(exports, "BufferMemory", { enumerable: true, get: function () { return buffer_memory_js_1.BufferMemory; } });
 var base_js_1 = require("./base.cjs");
 Object.defineProperty(exports, "BaseMemory", { enumerable: true, get: function () { return base_js_1.BaseMemory; } });
 Object.defineProperty(exports, "getInputValue", { enumerable: true, get: function () { return base_js_1.getInputValue; } });
+Object.defineProperty(exports, "getOutputValue", { enumerable: true, get: function () { return base_js_1.getOutputValue; } });
 Object.defineProperty(exports, "getBufferString", { enumerable: true, get: function () { return base_js_1.getBufferString; } });
 var summary_js_1 = require("./summary.cjs");
 Object.defineProperty(exports, "ConversationSummaryMemory", { enumerable: true, get: function () { return summary_js_1.ConversationSummaryMemory; } });

package/dist/memory/index.d.ts

@@ -1,5 +1,5 @@
 export { BufferMemory, type BufferMemoryInput } from "./buffer_memory.js";
-export { BaseMemory, getInputValue, getBufferString, type InputValues, type OutputValues, type MemoryVariables, } from "./base.js";
+export { BaseMemory, getInputValue, getOutputValue, getBufferString, type InputValues, type OutputValues, type MemoryVariables, } from "./base.js";
 export { ConversationSummaryMemory, type ConversationSummaryMemoryInput, BaseConversationSummaryMemory, type BaseConversationSummaryMemoryInput, } from "./summary.js";
 export { BufferWindowMemory, type BufferWindowMemoryInput, } from "./buffer_window_memory.js";
 export { BaseChatMemory, type BaseChatMemoryInput } from "./chat_memory.js";

package/dist/memory/index.js

@@ -1,5 +1,5 @@
 export { BufferMemory } from "./buffer_memory.js";
-export { BaseMemory, getInputValue, getBufferString, } from "./base.js";
+export { BaseMemory, getInputValue, getOutputValue, getBufferString, } from "./base.js";
 export { ConversationSummaryMemory, BaseConversationSummaryMemory, } from "./summary.js";
 export { BufferWindowMemory, } from "./buffer_window_memory.js";
 export { BaseChatMemory } from "./chat_memory.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/prompts/selectors/SemanticSimilarityExampleSelector.cjs

@@ -15,18 +15,12 @@ function sortedValues(values) {
 class SemanticSimilarityExampleSelector extends base_js_1.BaseExampleSelector {
     constructor(data) {
         super(data);
-        Object.defineProperty(this, "vectorStore", {
+        Object.defineProperty(this, "vectorStoreRetriever", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "k", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 4
-        });
         Object.defineProperty(this, "exampleKeys", {
             enumerable: true,
             configurable: true,
@@ -39,17 +33,20 @@ class SemanticSimilarityExampleSelector extends base_js_1.BaseExampleSelector {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "filter", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.vectorStore = data.vectorStore;
-        this.k = data.k ?? 4;
         this.exampleKeys = data.exampleKeys;
         this.inputKeys = data.inputKeys;
-        this.filter = data.filter;
+        if (data.vectorStore !== undefined) {
+            this.vectorStoreRetriever = data.vectorStore.asRetriever({
+                k: data.k ?? 4,
+                filter: data.filter,
+            });
+        }
+        else if (data.vectorStoreRetriever) {
+            this.vectorStoreRetriever = data.vectorStoreRetriever;
+        }
+        else {
+            throw new Error(`You must specify one of "vectorStore" and "vectorStoreRetriever".`);
+        }
     }
     /**
      * Method that adds a new example to the vectorStore. The example is
@@ -60,7 +57,7 @@ class SemanticSimilarityExampleSelector extends base_js_1.BaseExampleSelector {
     async addExample(example) {
         const inputKeys = this.inputKeys ?? Object.keys(example);
         const stringExample = sortedValues(inputKeys.reduce((acc, key) => ({ ...acc, [key]: example[key] }), {})).join(" ");
-        await this.vectorStore.addDocuments([
+        await this.vectorStoreRetriever.addDocuments([
             new document_js_1.Document({
                 pageContent: stringExample,
                 metadata: example,
@@ -77,7 +74,7 @@ class SemanticSimilarityExampleSelector extends base_js_1.BaseExampleSelector {
     async selectExamples(inputVariables) {
         const inputKeys = this.inputKeys ?? Object.keys(inputVariables);
         const query = sortedValues(inputKeys.reduce((acc, key) => ({ ...acc, [key]: inputVariables[key] }), {})).join(" ");
-        const exampleDocs = await this.vectorStore.similaritySearch(query, this.k, this.filter);
+        const exampleDocs = await this.vectorStoreRetriever.invoke(query);
         const examples = exampleDocs.map((doc) => doc.metadata);
         if (this.exampleKeys) {
             // If example keys are provided, filter examples to those keys.

package/dist/prompts/selectors/SemanticSimilarityExampleSelector.d.ts

@@ -1,28 +1,34 @@
 import { Embeddings } from "../../embeddings/base.js";
-import { VectorStore } from "../../vectorstores/base.js";
+import { VectorStore, VectorStoreRetriever } from "../../vectorstores/base.js";
 import { Example } from "../../schema/index.js";
 import { BaseExampleSelector } from "../base.js";
 /**
  * Interface for the input data of the SemanticSimilarityExampleSelector
  * class.
  */
-export interface SemanticSimilarityExampleSelectorInput<V extends VectorStore = VectorStore> {
+export type SemanticSimilarityExampleSelectorInput<V extends VectorStore = VectorStore> = {
     vectorStore: V;
     k?: number;
     filter?: V["FilterType"];
     exampleKeys?: string[];
     inputKeys?: string[];
-}
+    vectorStoreRetriever?: never;
+} | {
+    vectorStoreRetriever: VectorStoreRetriever<V>;
+    exampleKeys?: string[];
+    inputKeys?: string[];
+    vectorStore?: never;
+    k?: never;
+    filter?: never;
+};
 /**
  * Class that selects examples based on semantic similarity. It extends
  * the BaseExampleSelector class.
  */
 export declare class SemanticSimilarityExampleSelector<V extends VectorStore = VectorStore> extends BaseExampleSelector {
-    vectorStore: V;
-    k: number;
+    vectorStoreRetriever: VectorStoreRetriever<V>;
     exampleKeys?: string[];
     inputKeys?: string[];
-    filter?: V["FilterType"];
     constructor(data: SemanticSimilarityExampleSelectorInput<V>);
     /**
      * Method that adds a new example to the vectorStore. The example is

package/dist/prompts/selectors/SemanticSimilarityExampleSelector.js

@@ -12,18 +12,12 @@ function sortedValues(values) {
 export class SemanticSimilarityExampleSelector extends BaseExampleSelector {
     constructor(data) {
         super(data);
-        Object.defineProperty(this, "vectorStore", {
+        Object.defineProperty(this, "vectorStoreRetriever", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "k", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 4
-        });
         Object.defineProperty(this, "exampleKeys", {
             enumerable: true,
             configurable: true,
@@ -36,17 +30,20 @@ export class SemanticSimilarityExampleSelector extends BaseExampleSelector {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "filter", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.vectorStore = data.vectorStore;
-        this.k = data.k ?? 4;
         this.exampleKeys = data.exampleKeys;
         this.inputKeys = data.inputKeys;
-        this.filter = data.filter;
+        if (data.vectorStore !== undefined) {
+            this.vectorStoreRetriever = data.vectorStore.asRetriever({
+                k: data.k ?? 4,
+                filter: data.filter,
+            });
+        }
+        else if (data.vectorStoreRetriever) {
+            this.vectorStoreRetriever = data.vectorStoreRetriever;
+        }
+        else {
+            throw new Error(`You must specify one of "vectorStore" and "vectorStoreRetriever".`);
+        }
     }
     /**
      * Method that adds a new example to the vectorStore. The example is
@@ -57,7 +54,7 @@ export class SemanticSimilarityExampleSelector extends BaseExampleSelector {
     async addExample(example) {
         const inputKeys = this.inputKeys ?? Object.keys(example);
         const stringExample = sortedValues(inputKeys.reduce((acc, key) => ({ ...acc, [key]: example[key] }), {})).join(" ");
-        await this.vectorStore.addDocuments([
+        await this.vectorStoreRetriever.addDocuments([
             new Document({
                 pageContent: stringExample,
                 metadata: example,
@@ -74,7 +71,7 @@ export class SemanticSimilarityExampleSelector extends BaseExampleSelector {
     async selectExamples(inputVariables) {
         const inputKeys = this.inputKeys ?? Object.keys(inputVariables);
         const query = sortedValues(inputKeys.reduce((acc, key) => ({ ...acc, [key]: inputVariables[key] }), {})).join(" ");
-        const exampleDocs = await this.vectorStore.similaritySearch(query, this.k, this.filter);
+        const exampleDocs = await this.vectorStoreRetriever.invoke(query);
         const examples = exampleDocs.map((doc) => doc.metadata);
         if (this.exampleKeys) {
             // If example keys are provided, filter examples to those keys.

package/dist/storage/file_system.cjs

@@ -1,11 +1,31 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+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_1 = require("fs");
-const path_1 = __importDefault(require("path"));
+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
@@ -35,7 +55,7 @@ class LocalFileStore extends storage_js_1.BaseStore {
      */
     async getParsedFile(key) {
         try {
-            const fileContent = await fs_1.promises.readFile(this.getFullPath(key));
+            const fileContent = await fs.readFile(this.getFullPath(key));
             if (!fileContent) {
                 return undefined;
             }
@@ -57,7 +77,7 @@ class LocalFileStore extends storage_js_1.BaseStore {
      */
     async setFileContent(content, key) {
         try {
-            await fs_1.promises.writeFile(this.getFullPath(key), content);
+            await fs.writeFile(this.getFullPath(key), content);
         }
         catch (error) {
             throw new Error(`Error writing file at path: ${this.getFullPath(key)}.\nError: ${JSON.stringify(error)}`);
@@ -70,7 +90,7 @@ class LocalFileStore extends storage_js_1.BaseStore {
     getFullPath(key) {
         try {
             const keyAsTxtFile = `${key}.txt`;
-            const fullPath = path_1.default.join(this.rootPath, keyAsTxtFile);
+            const fullPath = path.join(this.rootPath, keyAsTxtFile);
             return fullPath;
         }
         catch (e) {
@@ -104,7 +124,7 @@ class LocalFileStore extends storage_js_1.BaseStore {
      * @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))));
+        await Promise.all(keys.map((key) => fs.unlink(this.getFullPath(key))));
     }
     /**
      * Asynchronous generator that yields keys from the store. If a prefix is
@@ -113,7 +133,7 @@ class LocalFileStore extends storage_js_1.BaseStore {
      * @returns AsyncGenerator that yields keys from the store.
      */
     async *yieldKeys(prefix) {
-        const allFiles = await fs_1.promises.readdir(this.rootPath);
+        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)) {
@@ -130,12 +150,12 @@ class LocalFileStore extends storage_js_1.BaseStore {
     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);
+            await fs.access(rootPath, fs.constants.R_OK | fs.constants.W_OK);
         }
         catch (_) {
             try {
                 // Directory does not exist, create it.
-                await fs_1.promises.mkdir(rootPath, { recursive: true });
+                await fs.mkdir(rootPath, { recursive: true });
             }
             catch (error) {
                 throw new Error(`An error occurred creating directory at: ${rootPath}.\nError: ${JSON.stringify(error)}`);

package/dist/storage/file_system.js

@@ -1,5 +1,5 @@
-import { promises as fsPromises } from "fs";
-import nodePath from "path";
+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
@@ -29,7 +29,7 @@ export class LocalFileStore extends BaseStore {
      */
     async getParsedFile(key) {
         try {
-            const fileContent = await fsPromises.readFile(this.getFullPath(key));
+            const fileContent = await fs.readFile(this.getFullPath(key));
             if (!fileContent) {
                 return undefined;
             }
@@ -51,7 +51,7 @@ export class LocalFileStore extends BaseStore {
      */
     async setFileContent(content, key) {
         try {
-            await fsPromises.writeFile(this.getFullPath(key), content);
+            await fs.writeFile(this.getFullPath(key), content);
         }
         catch (error) {
             throw new Error(`Error writing file at path: ${this.getFullPath(key)}.\nError: ${JSON.stringify(error)}`);
@@ -64,7 +64,7 @@ export class LocalFileStore extends BaseStore {
     getFullPath(key) {
         try {
             const keyAsTxtFile = `${key}.txt`;
-            const fullPath = nodePath.join(this.rootPath, keyAsTxtFile);
+            const fullPath = path.join(this.rootPath, keyAsTxtFile);
             return fullPath;
         }
         catch (e) {
@@ -98,7 +98,7 @@ export class LocalFileStore extends BaseStore {
      * @returns Promise that resolves when all keys have been deleted.
      */
     async mdelete(keys) {
-        await Promise.all(keys.map((key) => fsPromises.unlink(this.getFullPath(key))));
+        await Promise.all(keys.map((key) => fs.unlink(this.getFullPath(key))));
     }
     /**
      * Asynchronous generator that yields keys from the store. If a prefix is
@@ -107,7 +107,7 @@ export class LocalFileStore extends BaseStore {
      * @returns AsyncGenerator that yields keys from the store.
      */
     async *yieldKeys(prefix) {
-        const allFiles = await fsPromises.readdir(this.rootPath);
+        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)) {
@@ -124,12 +124,12 @@ export class LocalFileStore extends BaseStore {
     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);
+            await fs.access(rootPath, fs.constants.R_OK | fs.constants.W_OK);
         }
         catch (_) {
             try {
                 // Directory does not exist, create it.
-                await fsPromises.mkdir(rootPath, { recursive: true });
+                await fs.mkdir(rootPath, { recursive: true });
             }
             catch (error) {
                 throw new Error(`An error occurred creating directory at: ${rootPath}.\nError: ${JSON.stringify(error)}`);

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.renderTextDescription = void 0;
+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.
  *
@@ -16,3 +17,20 @@ 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

@@ -11,3 +11,15 @@ import { StructuredTool } from "./base.js";
  * @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

@@ -1,3 +1,4 @@
+import { zodToJsonSchema } from "zod-to-json-schema";
 /**
  * Render the tool name and description in plain text.
  *
@@ -12,3 +13,19 @@
 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");
+}