@langchain/core 0.1.34-rc.0 → 0.1.35

package/dist/language_models/base.cjs

@@ -253,5 +253,21 @@ class BaseLanguageModel extends BaseLangChain {
     static async deserialize(_data) {
         throw new Error("Use .toJSON() instead");
     }
+    /**
+     * Return a new runnable which calls an LLM with structured output.
+     * Only available for LLMs that support structured output.
+     *
+     * @template {any} RunInput The input type for the Runnable.
+     * @template {z.ZodObject<any, any, any, any>} RunOutput The output type for the Runnable, expected to be a Zod schema object for structured output validation.
+     *
+     * @param {z.ZodEffects<RunOutput> | Record<string, any>} schema The schema for the structured output. Either as a ZOD class or a valid JSON schema object.
+     * @param {string} name The name of the function to call.
+     * @returns {Runnable<RunInput, RunOutput>} A new runnable that calls the LLM with structured output.
+     */
+    withStructuredOutput(
+    // @ts-expect-error Var is unused in this base method implementation.
+    { schema, name, }) {
+        throw new Error("Method not implemented.");
+    }
 }
 exports.BaseLanguageModel = BaseLanguageModel;

package/dist/language_models/base.d.ts

@@ -1,4 +1,5 @@
 import type { TiktokenModel } from "js-tiktoken/lite";
+import { z } from "zod";
 import { type BaseCache } from "../caches.js";
 import { type BasePromptValueInterface } from "../prompt_values.js";
 import { type BaseMessage, type BaseMessageLike, type MessageContent } from "../messages/index.js";
@@ -176,6 +177,21 @@ export declare abstract class BaseLanguageModel<RunOutput = any, CallOptions ext
      * Load an LLM from a json-like object describing it.
      */
     static deserialize(_data: SerializedLLM): Promise<BaseLanguageModel>;
+    /**
+     * Return a new runnable which calls an LLM with structured output.
+     * Only available for LLMs that support structured output.
+     *
+     * @template {any} RunInput The input type for the Runnable.
+     * @template {z.ZodObject<any, any, any, any>} RunOutput The output type for the Runnable, expected to be a Zod schema object for structured output validation.
+     *
+     * @param {z.ZodEffects<RunOutput> | Record<string, any>} schema The schema for the structured output. Either as a ZOD class or a valid JSON schema object.
+     * @param {string} name The name of the function to call.
+     * @returns {Runnable<RunInput, RunOutput>} A new runnable that calls the LLM with structured output.
+     */
+    withStructuredOutput<RunInput = any, RunOutput extends z.ZodObject<any, any, any, any> = z.ZodObject<any, any, any, any>>({ schema, name, }: {
+        schema: z.ZodEffects<RunOutput> | Record<string, any>;
+        name: string;
+    }): Runnable<RunInput, RunOutput>;
 }
 /**
  * Shared interface for token usage

package/dist/language_models/base.js

@@ -245,4 +245,20 @@ export class BaseLanguageModel extends BaseLangChain {
     static async deserialize(_data) {
         throw new Error("Use .toJSON() instead");
     }
+    /**
+     * Return a new runnable which calls an LLM with structured output.
+     * Only available for LLMs that support structured output.
+     *
+     * @template {any} RunInput The input type for the Runnable.
+     * @template {z.ZodObject<any, any, any, any>} RunOutput The output type for the Runnable, expected to be a Zod schema object for structured output validation.
+     *
+     * @param {z.ZodEffects<RunOutput> | Record<string, any>} schema The schema for the structured output. Either as a ZOD class or a valid JSON schema object.
+     * @param {string} name The name of the function to call.
+     * @returns {Runnable<RunInput, RunOutput>} A new runnable that calls the LLM with structured output.
+     */
+    withStructuredOutput(
+    // @ts-expect-error Var is unused in this base method implementation.
+    { schema, name, }) {
+        throw new Error("Method not implemented.");
+    }
 }

package/dist/output_parsers/openai_tools/index.cjs

@@ -0,0 +1,17 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./json_output_tools_parsers.cjs"), exports);

package/dist/output_parsers/openai_tools/index.d.ts

@@ -0,0 +1 @@
+export * from "./json_output_tools_parsers.js";

package/dist/output_parsers/openai_tools/index.js

@@ -0,0 +1 @@
+export * from "./json_output_tools_parsers.js";

package/dist/output_parsers/openai_tools/json_output_tools_parsers.cjs

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JsonOutputKeyToolsParser = exports.JsonOutputToolsParser = void 0;
+const base_js_1 = require("../base.cjs");
+/**
+ * Class for parsing the output of a tool-calling LLM into a JSON object.
+ */
+class JsonOutputToolsParser extends base_js_1.BaseLLMOutputParser {
+    static lc_name() {
+        return "JsonOutputToolsParser";
+    }
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "returnId", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "lc_namespace", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ["langchain", "output_parsers", "openai_tools"]
+        });
+        Object.defineProperty(this, "lc_serializable", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
+        this.returnId = fields?.returnId ?? this.returnId;
+    }
+    /**
+     * Parses the output and returns a JSON object. If `argsOnly` is true,
+     * only the arguments of the function call are returned.
+     * @param generations The output of the LLM to parse.
+     * @returns A JSON object representation of the function call or its arguments.
+     */
+    async parseResult(generations) {
+        const toolCalls = generations[0].message.additional_kwargs.tool_calls;
+        if (!toolCalls) {
+            throw new Error(`No tools_call in message ${JSON.stringify(generations)}`);
+        }
+        const clonedToolCalls = JSON.parse(JSON.stringify(toolCalls));
+        const parsedToolCalls = [];
+        for (const toolCall of clonedToolCalls) {
+            if (toolCall.function !== undefined) {
+                // @ts-expect-error name and arguemnts are defined by Object.defineProperty
+                const parsedToolCall = {
+                    type: toolCall.function.name,
+                    args: JSON.parse(toolCall.function.arguments),
+                };
+                if (this.returnId) {
+                    parsedToolCall.id = toolCall.id;
+                }
+                // backward-compatibility with previous
+                // versions of Langchain JS, which uses `name` and `arguments`
+                Object.defineProperty(parsedToolCall, "name", {
+                    get() {
+                        return this.type;
+                    },
+                });
+                Object.defineProperty(parsedToolCall, "arguments", {
+                    get() {
+                        return this.args;
+                    },
+                });
+                parsedToolCalls.push(parsedToolCall);
+            }
+        }
+        return parsedToolCalls;
+    }
+}
+exports.JsonOutputToolsParser = JsonOutputToolsParser;
+/**
+ * Class for parsing the output of a tool-calling LLM into a JSON object if you are
+ * expecting only a single tool to be called.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+class JsonOutputKeyToolsParser extends base_js_1.BaseLLMOutputParser {
+    static lc_name() {
+        return "JsonOutputKeyToolsParser";
+    }
+    constructor(params) {
+        super(params);
+        Object.defineProperty(this, "lc_namespace", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ["langchain", "output_parsers", "openai_tools"]
+        });
+        Object.defineProperty(this, "lc_serializable", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
+        Object.defineProperty(this, "returnId", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        /** The type of tool calls to return. */
+        Object.defineProperty(this, "keyName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** Whether to return only the first tool call. */
+        Object.defineProperty(this, "returnSingle", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "initialParser", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.keyName = params.keyName;
+        this.returnSingle = params.returnSingle ?? this.returnSingle;
+        this.initialParser = new JsonOutputToolsParser(params);
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    async parseResult(generations) {
+        const results = await this.initialParser.parseResult(generations);
+        const matchingResults = results.filter((result) => result.type === this.keyName);
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        let returnedValues = matchingResults;
+        if (!this.returnId) {
+            returnedValues = matchingResults.map((result) => result.args);
+        }
+        if (this.returnSingle) {
+            return returnedValues[0];
+        }
+        return returnedValues;
+    }
+}
+exports.JsonOutputKeyToolsParser = JsonOutputKeyToolsParser;

package/dist/output_parsers/openai_tools/json_output_tools_parsers.d.ts

@@ -0,0 +1,55 @@
+import { ChatGeneration } from "../../outputs.js";
+import { BaseLLMOutputParser } from "../base.js";
+export type ParsedToolCall = {
+    id?: string;
+    type: string;
+    args: Record<string, any>;
+    /** @deprecated Use `type` instead. Will be removed in 0.2.0. */
+    name: string;
+    /** @deprecated Use `args` instead. Will be removed in 0.2.0. */
+    arguments: Record<string, any>;
+};
+export type JsonOutputToolsParserParams = {
+    /** Whether to return the tool call id. */
+    returnId?: boolean;
+};
+/**
+ * Class for parsing the output of a tool-calling LLM into a JSON object.
+ */
+export declare class JsonOutputToolsParser extends BaseLLMOutputParser<ParsedToolCall[]> {
+    static lc_name(): string;
+    returnId: boolean;
+    lc_namespace: string[];
+    lc_serializable: boolean;
+    constructor(fields?: JsonOutputToolsParserParams);
+    /**
+     * Parses the output and returns a JSON object. If `argsOnly` is true,
+     * only the arguments of the function call are returned.
+     * @param generations The output of the LLM to parse.
+     * @returns A JSON object representation of the function call or its arguments.
+     */
+    parseResult(generations: ChatGeneration[]): Promise<ParsedToolCall[]>;
+}
+export type JsonOutputKeyToolsParserParams = {
+    keyName: string;
+    returnSingle?: boolean;
+    /** Whether to return the tool call id. */
+    returnId?: boolean;
+};
+/**
+ * Class for parsing the output of a tool-calling LLM into a JSON object if you are
+ * expecting only a single tool to be called.
+ */
+export declare class JsonOutputKeyToolsParser extends BaseLLMOutputParser<any> {
+    static lc_name(): string;
+    lc_namespace: string[];
+    lc_serializable: boolean;
+    returnId: boolean;
+    /** The type of tool calls to return. */
+    keyName: string;
+    /** Whether to return only the first tool call. */
+    returnSingle: boolean;
+    initialParser: JsonOutputToolsParser;
+    constructor(params: JsonOutputKeyToolsParserParams);
+    parseResult(generations: ChatGeneration[]): Promise<any>;
+}

package/dist/output_parsers/openai_tools/json_output_tools_parsers.js

@@ -0,0 +1,139 @@
+import { BaseLLMOutputParser } from "../base.js";
+/**
+ * Class for parsing the output of a tool-calling LLM into a JSON object.
+ */
+export class JsonOutputToolsParser extends BaseLLMOutputParser {
+    static lc_name() {
+        return "JsonOutputToolsParser";
+    }
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "returnId", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "lc_namespace", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ["langchain", "output_parsers", "openai_tools"]
+        });
+        Object.defineProperty(this, "lc_serializable", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
+        this.returnId = fields?.returnId ?? this.returnId;
+    }
+    /**
+     * Parses the output and returns a JSON object. If `argsOnly` is true,
+     * only the arguments of the function call are returned.
+     * @param generations The output of the LLM to parse.
+     * @returns A JSON object representation of the function call or its arguments.
+     */
+    async parseResult(generations) {
+        const toolCalls = generations[0].message.additional_kwargs.tool_calls;
+        if (!toolCalls) {
+            throw new Error(`No tools_call in message ${JSON.stringify(generations)}`);
+        }
+        const clonedToolCalls = JSON.parse(JSON.stringify(toolCalls));
+        const parsedToolCalls = [];
+        for (const toolCall of clonedToolCalls) {
+            if (toolCall.function !== undefined) {
+                // @ts-expect-error name and arguemnts are defined by Object.defineProperty
+                const parsedToolCall = {
+                    type: toolCall.function.name,
+                    args: JSON.parse(toolCall.function.arguments),
+                };
+                if (this.returnId) {
+                    parsedToolCall.id = toolCall.id;
+                }
+                // backward-compatibility with previous
+                // versions of Langchain JS, which uses `name` and `arguments`
+                Object.defineProperty(parsedToolCall, "name", {
+                    get() {
+                        return this.type;
+                    },
+                });
+                Object.defineProperty(parsedToolCall, "arguments", {
+                    get() {
+                        return this.args;
+                    },
+                });
+                parsedToolCalls.push(parsedToolCall);
+            }
+        }
+        return parsedToolCalls;
+    }
+}
+/**
+ * Class for parsing the output of a tool-calling LLM into a JSON object if you are
+ * expecting only a single tool to be called.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export class JsonOutputKeyToolsParser extends BaseLLMOutputParser {
+    static lc_name() {
+        return "JsonOutputKeyToolsParser";
+    }
+    constructor(params) {
+        super(params);
+        Object.defineProperty(this, "lc_namespace", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ["langchain", "output_parsers", "openai_tools"]
+        });
+        Object.defineProperty(this, "lc_serializable", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
+        Object.defineProperty(this, "returnId", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        /** The type of tool calls to return. */
+        Object.defineProperty(this, "keyName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** Whether to return only the first tool call. */
+        Object.defineProperty(this, "returnSingle", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "initialParser", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.keyName = params.keyName;
+        this.returnSingle = params.returnSingle ?? this.returnSingle;
+        this.initialParser = new JsonOutputToolsParser(params);
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    async parseResult(generations) {
+        const results = await this.initialParser.parseResult(generations);
+        const matchingResults = results.filter((result) => result.type === this.keyName);
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        let returnedValues = matchingResults;
+        if (!this.returnId) {
+            returnedValues = matchingResults.map((result) => result.args);
+        }
+        if (this.returnSingle) {
+            return returnedValues[0];
+        }
+        return returnedValues;
+    }
+}

package/output_parsers/openai_tools.cjs

@@ -0,0 +1 @@
+module.exports = require('../dist/output_parsers/openai_tools/index.cjs');

package/output_parsers/openai_tools.d.cts

@@ -0,0 +1 @@
+export * from '../dist/output_parsers/openai_tools/index.js'

package/output_parsers/openai_tools.d.ts

@@ -0,0 +1 @@
+export * from '../dist/output_parsers/openai_tools/index.js'

package/output_parsers/openai_tools.js

@@ -0,0 +1 @@
+export * from '../dist/output_parsers/openai_tools/index.js'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/core",
-  "version": "0.1.34-rc.0",
+  "version": "0.1.35",
   "description": "Core LangChain.js abstractions and schemas",
   "type": "module",
   "engines": {
@@ -245,6 +245,15 @@
       "import": "./output_parsers.js",
       "require": "./output_parsers.cjs"
     },
+    "./output_parsers/openai_tools": {
+      "types": {
+        "import": "./output_parsers/openai_tools.d.ts",
+        "require": "./output_parsers/openai_tools.d.cts",
+        "default": "./output_parsers/openai_tools.d.ts"
+      },
+      "import": "./output_parsers/openai_tools.js",
+      "require": "./output_parsers/openai_tools.cjs"
+    },
     "./outputs": {
       "types": {
         "import": "./outputs.d.ts",
@@ -587,6 +596,10 @@
     "output_parsers.js",
     "output_parsers.d.ts",
     "output_parsers.d.cts",
+    "output_parsers/openai_tools.cjs",
+    "output_parsers/openai_tools.js",
+    "output_parsers/openai_tools.d.ts",
+    "output_parsers/openai_tools.d.cts",
     "outputs.cjs",
     "outputs.js",
     "outputs.d.ts",