@langchain/core 0.2.15 → 0.2.17

package/dist/runnables/tests/runnable_stream_events_v2.test.js

@@ -7,10 +7,12 @@ import { RunnableLambda, RunnableMap, RunnablePassthrough, RunnablePick, } from
 import { ChatPromptTemplate } from "../../prompts/chat.js";
 import { FakeChatModel, FakeLLM, FakeListChatModel, FakeRetriever, FakeStreamingLLM, } from "../../utils/testing/index.js";
 import { AIMessage, AIMessageChunk, HumanMessage, SystemMessage, } from "../../messages/index.js";
-import { DynamicStructuredTool, DynamicTool, tool } from "../../tools.js";
+import { DynamicStructuredTool, DynamicTool, tool } from "../../tools/index.js";
 import { Document } from "../../documents/document.js";
 import { PromptTemplate } from "../../prompts/prompt.js";
 import { GenerationChunk } from "../../outputs.js";
+// Import from web to avoid side-effects from AsyncLocalStorage
+import { dispatchCustomEvent } from "../../callbacks/dispatch/web.js";
 function reverse(s) {
     // Reverse a string.
     return s.split("").reverse().join("");
@@ -1748,6 +1750,109 @@ test("Runnable streamEvents method with simple tools", async () => {
         },
     ]);
 });
+test("Runnable streamEvents method with a custom event", async () => {
+    const lambda = RunnableLambda.from(async (params, config) => {
+        await dispatchCustomEvent("testEvent", { someval: "test" }, config);
+        await dispatchCustomEvent("testEvent", { someval: "test2" }, config);
+        return JSON.stringify({ x: params.x, y: params.y });
+    });
+    const events = [];
+    const eventStream = await lambda.streamEvents({ x: 1, y: "2" }, { version: "v2" });
+    for await (const event of eventStream) {
+        events.push(event);
+    }
+    expect(events).toEqual([
+        {
+            event: "on_chain_start",
+            data: { input: { x: 1, y: "2" } },
+            name: "RunnableLambda",
+            tags: [],
+            run_id: expect.any(String),
+            metadata: {},
+        },
+        {
+            event: "on_custom_event",
+            run_id: expect.any(String),
+            name: "testEvent",
+            tags: [],
+            metadata: {},
+            data: { someval: "test" },
+        },
+        {
+            event: "on_custom_event",
+            run_id: expect.any(String),
+            name: "testEvent",
+            tags: [],
+            metadata: {},
+            data: { someval: "test2" },
+        },
+        {
+            event: "on_chain_stream",
+            run_id: expect.any(String),
+            name: "RunnableLambda",
+            tags: [],
+            metadata: {},
+            data: { chunk: '{"x":1,"y":"2"}' },
+        },
+        {
+            event: "on_chain_end",
+            data: { output: '{"x":1,"y":"2"}' },
+            run_id: expect.any(String),
+            name: "RunnableLambda",
+            tags: [],
+            metadata: {},
+        },
+    ]);
+});
+test("Custom event inside a custom tool", async () => {
+    const customTool = tool(async (params, config) => {
+        await dispatchCustomEvent("testEvent", { someval: "test" }, config);
+        await dispatchCustomEvent("testEvent", { someval: "test2" }, config);
+        return JSON.stringify({ x: params.x, y: params.y });
+    }, {
+        schema: z.object({ x: z.number(), y: z.string() }),
+        name: "testtool",
+    });
+    const events = [];
+    const eventStream = await customTool.streamEvents({ x: 1, y: "2" }, { version: "v2" });
+    for await (const event of eventStream) {
+        events.push(event);
+    }
+    expect(events).toEqual([
+        {
+            event: "on_tool_start",
+            data: { input: { x: 1, y: "2" } },
+            name: "testtool",
+            tags: [],
+            run_id: expect.any(String),
+            metadata: {},
+        },
+        {
+            event: "on_custom_event",
+            run_id: expect.any(String),
+            name: "testEvent",
+            tags: [],
+            metadata: {},
+            data: { someval: "test" },
+        },
+        {
+            event: "on_custom_event",
+            run_id: expect.any(String),
+            name: "testEvent",
+            tags: [],
+            metadata: {},
+            data: { someval: "test2" },
+        },
+        {
+            event: "on_tool_end",
+            data: { output: '{"x":1,"y":"2"}' },
+            run_id: expect.any(String),
+            name: "testtool",
+            tags: [],
+            metadata: {},
+        },
+    ]);
+});
 test("Runnable streamEvents method with tools that return objects", async () => {
     const adderFunc = (_params) => {
         return JSON.stringify({ sum: 3 });

package/dist/runnables/tests/runnable_tools.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/runnables/tests/runnable_tools.test.js

@@ -0,0 +1,149 @@
+import { z } from "zod";
+import { RunnableLambda, RunnableToolLike } from "../base.js";
+import { FakeRetriever } from "../../utils/testing/index.js";
+import { Document } from "../../documents/document.js";
+test("Runnable asTool works", async () => {
+    const schema = z.object({
+        foo: z.string(),
+    });
+    const runnable = RunnableLambda.from((input, config) => {
+        return `${input.foo}${config?.configurable.foo}`;
+    });
+    const tool = runnable.asTool({
+        schema,
+    });
+    expect(tool).toBeInstanceOf(RunnableToolLike);
+    expect(tool.schema).toBe(schema);
+    expect(tool.name).toBe(runnable.getName());
+});
+test("Runnable asTool works with all populated fields", async () => {
+    const schema = z.object({
+        foo: z.string(),
+    });
+    const runnable = RunnableLambda.from((input, config) => {
+        return `${input.foo}${config?.configurable.foo}`;
+    });
+    const tool = runnable.asTool({
+        schema,
+        name: "test",
+        description: "test",
+    });
+    expect(tool).toBeInstanceOf(RunnableToolLike);
+    expect(tool.schema).toBe(schema);
+    expect(tool.description).toBe("test");
+    expect(tool.name).toBe("test");
+});
+test("Runnable asTool can invoke", async () => {
+    const schema = z.object({
+        foo: z.string(),
+    });
+    const runnable = RunnableLambda.from((input, config) => {
+        return `${input.foo}${config?.configurable.foo}`;
+    });
+    const tool = runnable.asTool({
+        schema,
+    });
+    const toolResponse = await tool.invoke({
+        foo: "bar",
+    }, {
+        configurable: {
+            foo: "bar",
+        },
+    });
+    expect(toolResponse).toBe("barbar");
+});
+test("asTool should type error with mismatched schema", async () => {
+    // asTool infers the type of the Zod schema from the existing runnable's RunInput generic.
+    // If the Zod schema does not match the RunInput, it should throw a type error.
+    const schema = z.object({
+        foo: z.string(),
+    });
+    const runnable = RunnableLambda.from((input, config) => {
+        return `${input.bar}${config?.configurable.foo}`;
+    });
+    runnable.asTool({
+        // @ts-expect-error - Should error. If this does not give a type error, the generics/typing of `asTool` is broken.
+        schema,
+    });
+});
+test("Create a runnable tool directly from RunnableToolLike", async () => {
+    const schema = z.object({
+        foo: z.string(),
+    });
+    const adderFunc = (_) => {
+        return Promise.resolve(true);
+    };
+    const tool = new RunnableToolLike({
+        schema,
+        name: "test",
+        description: "test",
+        bound: RunnableLambda.from(adderFunc),
+    });
+    const result = await tool.invoke({ foo: "bar" });
+    expect(result).toBe(true);
+});
+test("asTool can take a single string input", async () => {
+    const firstRunnable = RunnableLambda.from((input) => {
+        return `${input}a`;
+    });
+    const secondRunnable = RunnableLambda.from((input) => {
+        return `${input}z`;
+    });
+    const runnable = firstRunnable.pipe(secondRunnable);
+    const asTool = runnable.asTool({
+        schema: z.string(),
+    });
+    const result = await asTool.invoke("b");
+    expect(result).toBe("baz");
+});
+test("Runnable asTool uses Zod schema description if not provided", async () => {
+    const description = "Test schema";
+    const schema = z
+        .object({
+        foo: z.string(),
+    })
+        .describe(description);
+    const runnable = RunnableLambda.from((input, config) => {
+        return `${input.foo}${config?.configurable.foo}`;
+    });
+    const tool = runnable.asTool({
+        schema,
+    });
+    expect(tool.description).toBe(description);
+});
+test("Runnable asTool can accept a string zod schema", async () => {
+    const lambda = RunnableLambda.from((input) => {
+        return `${input}a`;
+    }).asTool({
+        name: "string_tool",
+        description: "A tool that appends 'a' to the input string",
+        schema: z.string(),
+    });
+    const result = await lambda.invoke("b");
+    expect(result).toBe("ba");
+});
+test("Runnables which dont accept ToolCalls as inputs can accept ToolCalls", async () => {
+    const pageContent = "Dogs are pretty cool, man!";
+    const retriever = new FakeRetriever({
+        output: [
+            new Document({
+                pageContent,
+            }),
+        ],
+    });
+    const tool = retriever.asTool({
+        name: "pet_info_retriever",
+        description: "Get information about pets.",
+        schema: z.string(),
+    });
+    const result = await tool.invoke({
+        type: "tool_call",
+        name: "pet_info_retriever",
+        args: {
+            input: "dogs",
+        },
+        id: "string",
+    });
+    expect(result).toHaveLength(1);
+    expect(result[0].pageContent).toBe(pageContent);
+});

package/dist/{tools.cjs → tools/index.cjs}

@@ -2,27 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.tool = exports.BaseToolkit = exports.DynamicStructuredTool = exports.DynamicTool = exports.Tool = exports.StructuredTool = exports.ToolInputParsingException = void 0;
 const zod_1 = require("zod");
-const manager_js_1 = require("./callbacks/manager.cjs");
-const base_js_1 = require("./language_models/base.cjs");
-const config_js_1 = require("./runnables/config.cjs");
-/**
- * Custom error class used to handle exceptions related to tool input parsing.
- * It extends the built-in `Error` class and adds an optional `output`
- * property that can hold the output that caused the exception.
- */
-class ToolInputParsingException extends Error {
-    constructor(message, output) {
-        super(message);
-        Object.defineProperty(this, "output", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.output = output;
-    }
-}
-exports.ToolInputParsingException = ToolInputParsingException;
+const manager_js_1 = require("../callbacks/manager.cjs");
+const base_js_1 = require("../language_models/base.cjs");
+const config_js_1 = require("../runnables/config.cjs");
+const tool_js_1 = require("../messages/tool.cjs");
+const index_js_1 = require("../singletons/index.cjs");
+const utils_js_1 = require("./utils.cjs");
+Object.defineProperty(exports, "ToolInputParsingException", { enumerable: true, get: function () { return utils_js_1.ToolInputParsingException; } });
 /**
  * Base class for Tools that accept input of any shape defined by a Zod schema.
  */
@@ -38,6 +24,22 @@ class StructuredTool extends base_js_1.BaseLangChain {
             writable: true,
             value: false
         });
+        /**
+         * The tool response format.
+         *
+         * If "content" then the output of the tool is interpreted as the contents of a
+         * ToolMessage. If "content_and_artifact" then the output is expected to be a
+         * two-tuple corresponding to the (content, artifact) of a ToolMessage.
+         *
+         * @default "content"
+         */
+        Object.defineProperty(this, "responseFormat", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "content"
+        });
+        this.responseFormat = fields?.responseFormat ?? this.responseFormat;
     }
     /**
      * Invokes the tool with the provided input and configuration.
@@ -46,7 +48,23 @@ class StructuredTool extends base_js_1.BaseLangChain {
      * @returns A Promise that resolves with a string.
      */
     async invoke(input, config) {
-        return this.call(input, (0, config_js_1.ensureConfig)(config));
+        let tool_call_id;
+        let toolInput;
+        if ((0, utils_js_1._isToolCall)(input)) {
+            tool_call_id = input.id;
+            toolInput = input.args;
+        }
+        else {
+            toolInput = input;
+        }
+        const ensuredConfig = (0, config_js_1.ensureConfig)(config);
+        return this.call(toolInput, {
+            ...ensuredConfig,
+            configurable: {
+                ...ensuredConfig.configurable,
+                tool_call_id,
+            },
+        });
     }
     /**
      * @deprecated Use .invoke() instead. Will be removed in 0.3.0.
@@ -67,7 +85,7 @@ class StructuredTool extends base_js_1.BaseLangChain {
             parsed = await this.schema.parseAsync(arg);
         }
         catch (e) {
-            throw new ToolInputParsingException(`Received tool input did not match expected schema`, JSON.stringify(arg));
+            throw new utils_js_1.ToolInputParsingException(`Received tool input did not match expected schema`, JSON.stringify(arg));
         }
         const config = (0, manager_js_1.parseCallbackConfigArg)(configArg);
         const callbackManager_ = await manager_js_1.CallbackManager.configure(config.callbacks, this.callbacks, config.tags || tags, this.tags, config.metadata, this.metadata, { verbose: this.verbose });
@@ -81,8 +99,32 @@ class StructuredTool extends base_js_1.BaseLangChain {
             await runManager?.handleToolError(e);
             throw e;
         }
-        await runManager?.handleToolEnd(result);
-        return result;
+        let content;
+        let artifact;
+        if (this.responseFormat === "content_and_artifact") {
+            if (Array.isArray(result) && result.length === 2) {
+                [content, artifact] = result;
+            }
+            else {
+                throw new Error(`Tool response format is "content_and_artifact" but the output was not a two-tuple.\nResult: ${JSON.stringify(result)}`);
+            }
+        }
+        else {
+            content = result;
+        }
+        let toolCallId;
+        if (config && "configurable" in config) {
+            toolCallId = config.configurable
+                .tool_call_id;
+        }
+        const formattedOutput = _formatToolOutput({
+            content,
+            artifact,
+            toolCallId,
+            name: this.name,
+        });
+        await runManager?.handleToolEnd(formattedOutput);
+        return formattedOutput;
     }
 }
 exports.StructuredTool = StructuredTool;
@@ -158,8 +200,8 @@ class DynamicTool extends Tool {
         return super.call(arg, config);
     }
     /** @ignore */
-    async _call(input, runManager, config) {
-        return this.func(input, runManager, config);
+    async _call(input, runManager, parentConfig) {
+        return this.func(input, runManager, parentConfig);
     }
 }
 exports.DynamicTool = DynamicTool;
@@ -217,8 +259,8 @@ class DynamicStructuredTool extends StructuredTool {
         }
         return super.call(arg, config, tags);
     }
-    _call(arg, runManager, config) {
-        return this.func(arg, runManager, config);
+    _call(arg, runManager, parentConfig) {
+        return this.func(arg, runManager, parentConfig);
     }
 }
 exports.DynamicStructuredTool = DynamicStructuredTool;
@@ -233,28 +275,74 @@ class BaseToolkit {
     }
 }
 exports.BaseToolkit = BaseToolkit;
-/**
- * Creates a new StructuredTool instance with the provided function, name, description, and schema.
- * @function
- * @template {ZodAny} RunInput The input schema for the tool.
- *
- * @param {RunnableFunc<RunInput, string>} func - The function to invoke when the tool is called.
- * @param fields - An object containing the following properties:
- * @param {string} fields.name The name of the tool.
- * @param {string | undefined} fields.description The description of the tool. Defaults to either the description on the Zod schema, or `${fields.name} tool`.
- * @param {z.ZodObject<any, any, any, any>} fields.schema The Zod schema defining the input for the tool.
- *
- * @returns {StructuredTool<RunInput, string>} A new StructuredTool instance.
- */
 function tool(func, fields) {
-    const schema = fields.schema ??
-        zod_1.z.object({ input: zod_1.z.string().optional() }).transform((obj) => obj.input);
-    const description = fields.description ?? schema.description ?? `${fields.name} tool`;
+    // If the schema is not provided, or it's a string schema, create a DynamicTool
+    if (!fields.schema || !("shape" in fields.schema) || !fields.schema.shape) {
+        return new DynamicTool({
+            name: fields.name,
+            description: fields.description ??
+                fields.schema?.description ??
+                `${fields.name} tool`,
+            responseFormat: fields.responseFormat,
+            func,
+        });
+    }
+    const description = fields.description ?? fields.schema.description ?? `${fields.name} tool`;
     return new DynamicStructuredTool({
         name: fields.name,
         description,
-        schema: schema,
-        func: async (input, _runManager, config) => func(input, config),
+        schema: fields.schema,
+        // TODO: Consider moving into DynamicStructuredTool constructor
+        func: async (input, runManager, config) => {
+            return new Promise((resolve, reject) => {
+                const childConfig = (0, config_js_1.patchConfig)(config, {
+                    callbacks: runManager?.getChild(),
+                });
+                void index_js_1.AsyncLocalStorageProviderSingleton.getInstance().run(childConfig, async () => {
+                    try {
+                        resolve(func(input, childConfig));
+                    }
+                    catch (e) {
+                        reject(e);
+                    }
+                });
+            });
+        },
+        responseFormat: fields.responseFormat,
     });
 }
 exports.tool = tool;
+function _formatToolOutput(params) {
+    const { content, artifact, toolCallId } = params;
+    if (toolCallId) {
+        if (typeof content === "string" ||
+            (Array.isArray(content) &&
+                content.every((item) => typeof item === "object"))) {
+            return new tool_js_1.ToolMessage({
+                content,
+                artifact,
+                tool_call_id: toolCallId,
+                name: params.name,
+            });
+        }
+        else {
+            return new tool_js_1.ToolMessage({
+                content: _stringify(content),
+                artifact,
+                tool_call_id: toolCallId,
+                name: params.name,
+            });
+        }
+    }
+    else {
+        return content;
+    }
+}
+function _stringify(content) {
+    try {
+        return JSON.stringify(content, null, 2);
+    }
+    catch (_noOp) {
+        return `${content}`;
+    }
+}