@langchain/langgraph 0.0.11 → 0.0.13

package/dist/tests/pregel.validate.test.d.ts

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

package/dist/tests/pregel.validate.test.js

@@ -0,0 +1,198 @@
+import { describe, expect, it } from "@jest/globals";
+import { PregelNode } from "../pregel/read.js";
+import { GraphValidationError, validateGraph } from "../pregel/validate.js";
+import { LastValue } from "../channels/last_value.js";
+describe("validateGraph", () => {
+    it("should throw an error if a node is named __interrupt__", () => {
+        // set up test
+        const nodes = {
+            __interrupt__: new PregelNode({
+                channels: [""],
+                triggers: [],
+            }),
+        };
+        const channels = {
+            "": new LastValue(),
+        };
+        // call method / assertions
+        expect(() => {
+            validateGraph({
+                nodes,
+                channels,
+                inputChannels: "",
+                outputChannels: "",
+                streamChannels: "",
+                interruptAfterNodes: [],
+                interruptBeforeNodes: [],
+            });
+        }).toThrow(GraphValidationError);
+    });
+    it("should throw an error if a node is not the correct type", () => {
+        // set up test
+        class PregelNodeSubclass extends PregelNode {
+        }
+        const nodes = {
+            channelName: new PregelNodeSubclass({
+                channels: [""],
+                triggers: [],
+            }),
+        };
+        const channels = {
+            "": new LastValue(),
+        };
+        // call method / assertions
+        expect(() => {
+            validateGraph({
+                nodes,
+                channels,
+                inputChannels: "",
+                outputChannels: "",
+                streamChannels: "",
+                interruptAfterNodes: [],
+                interruptBeforeNodes: [],
+            });
+        }).toThrow(GraphValidationError);
+    });
+    it("should throw an error if input channel is not subscribed to by any node", () => {
+        // set up test
+        const nodes = {
+            channelName1: new PregelNode({
+                channels: [""],
+                triggers: ["channelName2"],
+            }),
+        };
+        const channels = {
+            "": new LastValue(),
+        };
+        // call method / assertions
+        expect(() => {
+            validateGraph({
+                nodes,
+                channels,
+                // @ts-expect-error - testing invalid input
+                inputChannels: "channelName3",
+                outputChannels: "",
+                streamChannels: "",
+                interruptAfterNodes: [],
+                interruptBeforeNodes: [],
+            });
+        }).toThrow(GraphValidationError);
+    });
+    it("should throw an error if none of the input channels are subscribed to by any node", () => {
+        // set up test
+        const nodes = {
+            channelName1: new PregelNode({
+                channels: [""],
+                triggers: ["channelName2"],
+            }),
+        };
+        const channels = {
+            "": new LastValue(),
+        };
+        // call method / assertions
+        expect(() => {
+            validateGraph({
+                nodes,
+                channels,
+                // @ts-expect-error - testing invalid input
+                inputChannels: ["channelName3", "channelName4", "channelName5"],
+                outputChannels: "",
+                streamChannels: "",
+                interruptAfterNodes: [],
+                interruptBeforeNodes: [],
+            });
+        }).toThrow(GraphValidationError);
+    });
+    it("should throw an error if 'interrupt after' nodes not in nodes map", () => {
+        // set up test
+        const nodes = {
+            channelName1: new PregelNode({
+                channels: [""],
+                triggers: ["channelName2"],
+            }),
+        };
+        const channels = {
+            "": new LastValue(),
+        };
+        // call method / assertions
+        expect(() => {
+            validateGraph({
+                nodes,
+                channels,
+                inputChannels: [""],
+                outputChannels: "",
+                streamChannels: "",
+                interruptAfterNodes: ["channelName3"],
+                interruptBeforeNodes: [],
+            });
+        }).toThrow(GraphValidationError);
+    });
+    it("should throw an error if 'interrupt after' nodes not in nodes map", () => {
+        // set up test
+        const nodes = {
+            channelName1: new PregelNode({
+                channels: [""],
+                triggers: ["channelName2"],
+            }),
+        };
+        const channels = {
+            "": new LastValue(),
+        };
+        // call method / assertions
+        expect(() => {
+            validateGraph({
+                nodes,
+                channels,
+                inputChannels: [""],
+                outputChannels: "",
+                streamChannels: "",
+                interruptAfterNodes: [],
+                interruptBeforeNodes: ["channelName3"],
+            });
+        }).toThrow(GraphValidationError);
+    });
+    it("should thrown on missing channels", () => {
+        // set up test
+        const nodes = {
+            channelName1: new PregelNode({
+                channels: [""],
+                triggers: ["channelName2"],
+            }),
+        };
+        const channels1 = {
+            "": new LastValue(),
+            channelName2: new LastValue(),
+        };
+        // call method / assertions
+        expect(() => validateGraph({
+            nodes,
+            channels: channels1,
+            inputChannels: "channelName2",
+            // @ts-expect-error - testing invalid input
+            outputChannels: "channelName3",
+            interruptAfterNodes: [],
+            interruptBeforeNodes: [],
+        })).toThrow(GraphValidationError);
+        // call method / assertions
+        expect(() => validateGraph({
+            nodes,
+            channels: channels1,
+            // @ts-expect-error - testing invalid input
+            inputChannels: "channelName3",
+            outputChannels: "channelName2",
+            interruptAfterNodes: [],
+            interruptBeforeNodes: [],
+        })).toThrow(GraphValidationError);
+        // call method / assertions
+        expect(() => validateGraph({
+            nodes,
+            channels: channels1,
+            inputChannels: "channelName2",
+            outputChannels: "",
+            // @ts-expect-error - testing invalid input
+            streamChannels: "channelName4",
+            interruptAfterNodes: [],
+            interruptBeforeNodes: [],
+        })).toThrow(GraphValidationError);
+    });
+});

package/dist/tests/pregel.write.test.d.ts

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

package/dist/tests/pregel.write.test.js

@@ -0,0 +1,44 @@
+import { describe, expect, it } from "@jest/globals";
+import { RunnablePassthrough } from "@langchain/core/runnables";
+import { ChannelWrite, PASSTHROUGH } from "../pregel/write.js";
+describe("ChannelWrite", () => {
+    describe("_getWriteValues", () => {
+        it("should return the expect object", async () => {
+            // set up test
+            const channelWrite = new ChannelWrite([
+                {
+                    channel: "someChannel1",
+                    value: 1,
+                    skipNone: false,
+                },
+                {
+                    channel: "someChannel2",
+                    value: PASSTHROUGH,
+                    skipNone: false,
+                    mapper: new RunnablePassthrough(),
+                },
+                {
+                    channel: "someChannel3",
+                    value: null,
+                    skipNone: true,
+                },
+                {
+                    channel: "someChannel4",
+                    value: PASSTHROUGH,
+                    skipNone: false,
+                },
+            ]);
+            const input = 2;
+            const config = {};
+            // call method / assertions
+            const writeValues = await channelWrite._getWriteValues(input, config);
+            const expectedWriteValues = {
+                someChannel1: 1,
+                someChannel2: 2, // value is set to input value since PASSTHROUGH value was specified (with mapper)
+                // someChannel3 should be filtered out
+                someChannel4: 2, // value is set to input value since PASSTHROUGH value was specified
+            };
+            expect(writeValues).toEqual(expectedWriteValues);
+        });
+    });
+});

package/dist/tests/tracing.int.test.d.ts

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

package/dist/tests/tracing.int.test.js

@@ -0,0 +1,449 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable no-process-env */
+import { test } from "@jest/globals";
+import { pull } from "langchain/hub";
+import { ChatOpenAI } from "@langchain/openai";
+import { TavilySearchResults } from "@langchain/community/tools/tavily_search";
+import { ChatPromptTemplate, MessagesPlaceholder, } from "@langchain/core/prompts";
+import { HumanMessage } from "@langchain/core/messages";
+import { RunnableLambda } from "@langchain/core/runnables";
+import { AgentExecutor, createOpenAIFunctionsAgent, createOpenAIToolsAgent, } from "langchain/agents";
+import { JsonOutputFunctionsParser, JsonOutputToolsParser, } from "langchain/output_parsers";
+import { createOpenAIFnRunnable } from "langchain/chains/openai_functions";
+import { zodToJsonSchema } from "zod-to-json-schema";
+import { z } from "zod";
+import { StateGraph, END } from "../index.js";
+import { ToolExecutor } from "../prebuilt/tool_executor.js";
+import { createAgentExecutor } from "../prebuilt/agent_executor.js";
+test.skip("Can invoke with tracing", async () => {
+    const tools = [new TavilySearchResults({ maxResults: 1 })];
+    // Get the prompt to use - you can modify this!
+    const prompt = await pull("hwchase17/openai-functions-agent");
+    // Choose the LLM that will drive the agent
+    const llm = new ChatOpenAI({
+        modelName: "gpt-4-1106-preview",
+        temperature: 0,
+    });
+    // Construct the OpenAI Functions agent
+    const agentRunnable = await createOpenAIFunctionsAgent({
+        llm,
+        tools,
+        prompt,
+    });
+    const toolExecutor = new ToolExecutor({
+        tools,
+    });
+    // Define logic that will be used to determine which conditional edge to go down
+    const shouldContinue = (data) => {
+        if (data.agentOutcome && "returnValues" in data.agentOutcome) {
+            return "end";
+        }
+        return "continue";
+    };
+    const runAgent = async (data) => {
+        const agentOutcome = await agentRunnable.invoke(data);
+        return {
+            agentOutcome,
+        };
+    };
+    const executeTools = async (data) => {
+        const agentAction = data.agentOutcome;
+        if (!agentAction || "returnValues" in agentAction) {
+            throw new Error("Agent has not been run yet");
+        }
+        const output = await toolExecutor.invoke(agentAction);
+        return {
+            steps: [{ action: agentAction, observation: JSON.stringify(output) }],
+        };
+    };
+    // Define a new graph
+    const workflow = new StateGraph({
+        channels: {
+            input: null,
+            steps: {
+                value: (x, y) => x.concat(y),
+                default: () => [],
+            },
+            agentOutcome: null,
+        },
+    })
+        // Define the two nodes we will cycle between
+        .addNode("agent", new RunnableLambda({ func: runAgent }))
+        .addNode("action", new RunnableLambda({ func: executeTools }))
+        // Set the entrypoint as `agent`
+        // This means that this node is the first one called
+        .setEntryPoint("agent")
+        // We now add a conditional edge
+        .addConditionalEdges(
+    // First, we define the start node. We use `agent`.
+    // This means these are the edges taken after the `agent` node is called.
+    "agent", 
+    // Next, we pass in the function that will determine which node is called next.
+    shouldContinue, 
+    // Finally we pass in a mapping.
+    // The keys are strings, and the values are other nodes.
+    // END is a special node marking that the graph should finish.
+    // What will happen is we will call `should_continue`, and then the output of that
+    // will be matched against the keys in this mapping.
+    // Based on which one it matches, that node will then be called.
+    {
+        // If `tools`, then we call the tool node.
+        continue: "action",
+        // Otherwise we finish.
+        end: END,
+    })
+        // We now add a normal edge from `tools` to `agent`.
+        // This means that after `tools` is called, `agent` node is called next.
+        .addEdge("action", "agent");
+    const app = workflow.compile();
+    const inputs = { input: "what is the weather in sf" };
+    for await (const s of await app.stream(inputs)) {
+        console.log(s);
+        console.log("----\n");
+    }
+});
+test.skip("Can nest an agent executor", async () => {
+    const tools = [new TavilySearchResults({ maxResults: 3 })];
+    const llm = new ChatOpenAI({
+        modelName: "gpt-4-1106-preview",
+        temperature: 0,
+    });
+    const systemPrompt = `You are a web researcher. You may use the Tavily search engine to search the web for important information.`;
+    // Each worker node will be given a name and some tools.
+    const prompt = ChatPromptTemplate.fromMessages([
+        ["system", systemPrompt],
+        new MessagesPlaceholder("messages"),
+        new MessagesPlaceholder("agent_scratchpad"),
+    ]);
+    const agent = await createOpenAIToolsAgent({ llm, tools, prompt });
+    const executor = new AgentExecutor({ agent, tools });
+    const researcherNode = async (state) => {
+        console.log("STATE", state);
+        const result = await executor.invoke(state);
+        return {
+            messages: [
+                new HumanMessage({ content: result.output, name: "researcher" }),
+            ],
+        };
+    };
+    // Define the routing function
+    const functionDef = {
+        name: "route",
+        description: "Select the next role.",
+        parameters: {
+            title: "routeSchema",
+            type: "object",
+            properties: {
+                next: {
+                    title: "Next",
+                    anyOf: [{ enum: ["FINISH", "researcher"] }],
+                },
+            },
+            required: ["next"],
+        },
+    };
+    const toolDef = {
+        type: "function",
+        function: functionDef,
+    };
+    const supervisorPrompt = ChatPromptTemplate.fromMessages([
+        ["system", systemPrompt],
+        new MessagesPlaceholder("messages"),
+        [
+            "system",
+            "Given the conversation above, who should act next? Or should we FINISH? Select one of: {options}",
+        ],
+    ]);
+    const formattedPrompt = await supervisorPrompt.partial({
+        options: ["FINISH", "researcher"].join(", "),
+    });
+    const supervisorChain = formattedPrompt
+        .pipe(llm.bind({
+        tools: [toolDef],
+        tool_choice: { type: "function", function: { name: "route" } },
+    }))
+        .pipe(new JsonOutputToolsParser())
+        // select the first one
+        .pipe((x) => x[0].args);
+    // 1. Create the graph
+    const workflow = new StateGraph({
+        channels: {
+            messages: {
+                value: (x, y) => x.concat(y),
+                default: () => [],
+            },
+            next: null,
+        },
+    })
+        // 2. Add the nodes; these will do the work
+        .addNode("researcher", researcherNode)
+        .addNode("supervisor", supervisorChain)
+        // 3. Define the edges. We will define both regular and conditional ones
+        // After a worker completes, report to supervisor
+        .addEdge("researcher", "supervisor")
+        // When the supervisor returns, route to the agent identified in the supervisor's output
+        .addConditionalEdges("supervisor", (x) => x.next, {
+        researcher: "researcher",
+        // Or end work if done
+        FINISH: END,
+    })
+        .setEntryPoint("supervisor");
+    const graph = workflow.compile();
+    const streamResults = graph.stream({
+        messages: [
+            new HumanMessage({
+                content: "Who is the current prime minister of malaysia?",
+            }),
+        ],
+    }, { tags: ["outer_tag"], recursionLimit: 100 });
+    for await (const output of await streamResults) {
+        if (!output?.__end__) {
+            console.log(output);
+            console.log("----");
+        }
+    }
+});
+test.skip("Can nest a graph within a graph", async () => {
+    const tools = [new TavilySearchResults({ maxResults: 3 })];
+    const llm = new ChatOpenAI({
+        modelName: "gpt-4-1106-preview",
+        temperature: 0,
+    });
+    const systemPrompt = `You are a web researcher. You may use the Tavily search engine to search the web for important information.`;
+    // Each worker node will be given a name and some tools.
+    const prompt = ChatPromptTemplate.fromMessages([
+        ["system", systemPrompt],
+        new MessagesPlaceholder("messages"),
+        new MessagesPlaceholder("agent_scratchpad"),
+    ]);
+    const agent = await createOpenAIToolsAgent({ llm, tools, prompt });
+    const executor = new AgentExecutor({ agent, tools });
+    const researcherNode = async (state) => {
+        const result = await executor.invoke(state);
+        return {
+            messages: [
+                new HumanMessage({ content: result.output, name: "researcher" }),
+            ],
+        };
+    };
+    // Define the routing function
+    const functionDef = {
+        name: "route",
+        description: "Select the next role.",
+        parameters: {
+            title: "routeSchema",
+            type: "object",
+            properties: {
+                next: {
+                    title: "Next",
+                    anyOf: [{ enum: ["FINISH", "researcher"] }],
+                },
+            },
+            required: ["next"],
+        },
+    };
+    const toolDef = {
+        type: "function",
+        function: functionDef,
+    };
+    const supervisorPrompt = ChatPromptTemplate.fromMessages([
+        ["system", systemPrompt],
+        new MessagesPlaceholder("messages"),
+        [
+            "system",
+            "Given the conversation above, who should act next? Or should we FINISH? Select one of: {options}",
+        ],
+    ]);
+    const formattedPrompt = await supervisorPrompt.partial({
+        options: ["FINISH", "researcher"].join(", "),
+    });
+    const supervisorChain = formattedPrompt
+        .pipe(llm.bind({
+        tools: [toolDef],
+        tool_choice: { type: "function", function: { name: "route" } },
+    }))
+        .pipe(new JsonOutputToolsParser())
+        // select the first one
+        .pipe((x) => x[0].args);
+    // 1. Create the graph
+    const workflow = new StateGraph({
+        channels: {
+            messages: {
+                value: (x, y) => x.concat(y),
+                default: () => [],
+            },
+            next: null,
+        },
+    })
+        // 2. Add the nodes; these will do the work
+        .addNode("researcher", researcherNode)
+        .addNode("supervisor", supervisorChain)
+        // 3. Define the edges. We will define both regular and conditional ones
+        // After a worker completes, report to supervisor
+        .addEdge("researcher", "supervisor")
+        // When the supervisor returns, route to the agent identified in the supervisor's output
+        .addConditionalEdges("supervisor", (x) => x.next, {
+        researcher: "researcher",
+        FINISH: END,
+    })
+        .setEntryPoint("supervisor");
+    const graph = workflow.compile();
+    const streamResults = graph.stream({
+        messages: [
+            new HumanMessage({
+                content: "Who is the current prime minister of malaysia?",
+            }),
+        ],
+    }, { tags: ["outer_tag"], recursionLimit: 100 });
+    for await (const output of await streamResults) {
+        if (!output?.__end__) {
+            console.log(output);
+            console.log("----");
+        }
+    }
+});
+test.skip("Should trace plan and execute flow", async () => {
+    const tools = [new TavilySearchResults({ maxResults: 3 })];
+    // Get the prompt to use - you can modify this!
+    const prompt = await pull("hwchase17/openai-functions-agent");
+    // Choose the LLM that will drive the agent
+    const llm = new ChatOpenAI({ modelName: "gpt-4-0125-preview" });
+    // Construct the OpenAI Functions agent
+    const agentRunnable = await createOpenAIFunctionsAgent({
+        llm,
+        tools,
+        prompt,
+    });
+    const agentExecutor = createAgentExecutor({
+        agentRunnable,
+        tools,
+    });
+    const plan = zodToJsonSchema(z.object({
+        steps: z
+            .array(z.string())
+            .describe("different steps to follow, should be in sorted order"),
+    }));
+    const planFunction = {
+        name: "plan",
+        description: "This tool is used to plan the steps to follow",
+        parameters: plan,
+    };
+    const plannerPrompt = ChatPromptTemplate.fromTemplate(`For the given objective, come up with a simple step by step plan. \
+This plan should involve individual tasks, that if executed correctly will yield the correct answer. Do not add any superfluous steps. \
+The result of the final step should be the final answer. Make sure that each step has all the information needed - do not skip steps.
+
+{objective}`);
+    const model = new ChatOpenAI({
+        modelName: "gpt-4-0125-preview",
+    }).bind({
+        functions: [planFunction],
+        function_call: planFunction,
+    });
+    const parserSingle = new JsonOutputFunctionsParser({
+        argsOnly: true,
+    });
+    const planner = plannerPrompt.pipe(model).pipe(parserSingle);
+    const response = zodToJsonSchema(z.object({
+        response: z.string().describe("Response to user."),
+    }));
+    const responseFunction = {
+        name: "response",
+        description: "Response to user.",
+        parameters: response,
+    };
+    const replannerPrompt = ChatPromptTemplate.fromTemplate(`For the given objective, come up with a simple step by step plan.
+This plan should involve individual tasks, that if executed correctly will yield the correct answer. Do not add any superfluous steps.
+The result of the final step should be the final answer. Make sure that each step has all the information needed - do not skip steps.
+
+Your objective was this:
+{input}
+
+Your original plan was this:
+{plan}
+
+You have currently done the follow steps:
+{pastSteps}
+
+Update your plan accordingly. If no more steps are needed and you can return to the user, then respond with that and use the 'response' function.
+Otherwise, fill out the plan.
+Only add steps to the plan that still NEED to be done. Do not return previously done steps as part of the plan.`);
+    const parser = new JsonOutputFunctionsParser();
+    const replanner = createOpenAIFnRunnable({
+        functions: [planFunction, responseFunction],
+        outputParser: parser,
+        llm: new ChatOpenAI({
+            modelName: "gpt-4-0125-preview",
+        }),
+        prompt: replannerPrompt,
+    });
+    async function executeStep(state) {
+        const task = state.input;
+        const agentResponse = await agentExecutor.invoke({ input: task });
+        return {
+            pastSteps: [task, agentResponse.agentOutcome.returnValues.output],
+        };
+    }
+    async function planStep(state) {
+        if (!state.input) {
+            throw new Error("No input.");
+        }
+        const plan = await planner.invoke({ objective: state.input });
+        return { plan: plan.steps };
+    }
+    async function replanStep(state) {
+        const output = await replanner.invoke({
+            input: state.input,
+            plan: state.plan ? state.plan.join("\n") : "",
+            pastSteps: state.pastSteps.join("\n"),
+        });
+        if (output.response !== undefined) {
+            return { response: output.response };
+        }
+        return { plan: output.steps };
+    }
+    function shouldEnd(state) {
+        if (state.response) {
+            return "true";
+        }
+        return "false";
+    }
+    const workflow = new StateGraph({
+        channels: {
+            input: null,
+            plan: null,
+            pastSteps: {
+                reducer: (x, y) => x.concat(y),
+                default: () => [],
+            },
+            response: null,
+        },
+    })
+        // Add the plan node
+        .addNode("planner", planStep)
+        // Add the execution step
+        .addNode("agent", executeStep)
+        // Add a replan node
+        .addNode("replan", replanStep)
+        .setEntryPoint("planner")
+        // From plan we go to agent
+        .addEdge("planner", "agent")
+        // From agent, we replan
+        .addEdge("agent", "replan")
+        .addConditionalEdges("replan", 
+    // Next, we pass in the function that will determine which node is called next.
+    shouldEnd, {
+        true: END,
+        false: "planner",
+    });
+    // Finally, we compile it!
+    // This compiles it into a LangChain Runnable,
+    // meaning you can use it as you would any other runnable
+    const app = workflow.compile();
+    const config = { recursionLimit: 50 };
+    const inputs = {
+        input: "what is the hometown of the 2024 Australia open winner?",
+    };
+    for await (const event of await app.stream(inputs, config)) {
+        console.log(event);
+    }
+});