@langchain/core 0.2.8 → 0.2.9

package/dist/language_models/base.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseLanguageModel = exports.BaseLangChain = exports.calculateMaxTokens = exports.getModelContextSize = exports.getEmbeddingContextSize = exports.getModelNameForTiktoken = void 0;
+exports.BaseLanguageModel = exports.BaseLangChain = exports.calculateMaxTokens = exports.isOpenAITool = exports.getModelContextSize = exports.getEmbeddingContextSize = exports.getModelNameForTiktoken = void 0;
 const caches_js_1 = require("../caches.cjs");
 const prompt_values_js_1 = require("../prompt_values.cjs");
 const utils_js_1 = require("../messages/utils.cjs");
@@ -63,6 +63,26 @@ const getModelContextSize = (modelName) => {
     }
 };
 exports.getModelContextSize = getModelContextSize;
+/**
+ * Whether or not the input matches the OpenAI tool definition.
+ * @param {unknown} tool The input to check.
+ * @returns {boolean} Whether the input is an OpenAI tool definition.
+ */
+function isOpenAITool(tool) {
+    if (typeof tool !== "object" || !tool)
+        return false;
+    if ("type" in tool &&
+        tool.type === "function" &&
+        "function" in tool &&
+        typeof tool.function === "object" &&
+        tool.function &&
+        "name" in tool.function &&
+        "parameters" in tool.function) {
+        return true;
+    }
+    return false;
+}
+exports.isOpenAITool = isOpenAITool;
 const calculateMaxTokens = async ({ prompt, modelName, }) => {
     let numTokens;
     try {

package/dist/language_models/base.d.ts

@@ -11,6 +11,12 @@ import { RunnableConfig } from "../runnables/config.js";
 export declare const getModelNameForTiktoken: (modelName: string) => TiktokenModel;
 export declare const getEmbeddingContextSize: (modelName?: string) => number;
 export declare const getModelContextSize: (modelName: string) => number;
+/**
+ * Whether or not the input matches the OpenAI tool definition.
+ * @param {unknown} tool The input to check.
+ * @returns {boolean} Whether the input is an OpenAI tool definition.
+ */
+export declare function isOpenAITool(tool: unknown): tool is ToolDefinition;
 interface CalculateMaxTokenProps {
     prompt: string;
     modelName: TiktokenModel;

package/dist/language_models/base.js

@@ -57,6 +57,25 @@ export const getModelContextSize = (modelName) => {
             return 4097;
     }
 };
+/**
+ * Whether or not the input matches the OpenAI tool definition.
+ * @param {unknown} tool The input to check.
+ * @returns {boolean} Whether the input is an OpenAI tool definition.
+ */
+export function isOpenAITool(tool) {
+    if (typeof tool !== "object" || !tool)
+        return false;
+    if ("type" in tool &&
+        tool.type === "function" &&
+        "function" in tool &&
+        typeof tool.function === "object" &&
+        tool.function &&
+        "name" in tool.function &&
+        "parameters" in tool.function) {
+        return true;
+    }
+    return false;
+}
 export const calculateMaxTokens = async ({ prompt, modelName, }) => {
     let numTokens;
     try {

package/dist/language_models/chat_models.cjs

@@ -1,13 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SimpleChatModel = exports.BaseChatModel = exports.createChatMessageChunkEncoderStream = void 0;
+const zod_to_json_schema_1 = require("zod-to-json-schema");
 const index_js_1 = require("../messages/index.cjs");
 const outputs_js_1 = require("../outputs.cjs");
 const base_js_1 = require("./base.cjs");
 const manager_js_1 = require("../callbacks/manager.cjs");
+const base_js_2 = require("../runnables/base.cjs");
 const event_stream_js_1 = require("../tracers/event_stream.cjs");
 const log_stream_js_1 = require("../tracers/log_stream.cjs");
 const stream_js_1 = require("../utils/stream.cjs");
+const passthrough_js_1 = require("../runnables/passthrough.cjs");
+const is_zod_schema_js_1 = require("../utils/types/is_zod_schema.cjs");
 /**
  * Creates a transform stream for encoding chat message chunks.
  * @deprecated Use {@link BytesOutputParser} instead
@@ -415,6 +419,83 @@ class BaseChatModel extends base_js_1.BaseLanguageModel {
         }
         return result.content;
     }
+    withStructuredOutput(outputSchema, config) {
+        if (typeof this.bindTools !== "function") {
+            throw new Error(`Chat model must implement ".bindTools()" to use withStructuredOutput.`);
+        }
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const schema = outputSchema;
+        const name = config?.name;
+        const description = schema.description ?? "A function available to call.";
+        const method = config?.method;
+        const includeRaw = config?.includeRaw;
+        if (method === "jsonMode") {
+            throw new Error(`Base withStructuredOutput implementation only supports "functionCalling" as a method.`);
+        }
+        let functionName = name ?? "extract";
+        let tools;
+        if ((0, is_zod_schema_js_1.isZodSchema)(schema)) {
+            tools = [
+                {
+                    type: "function",
+                    function: {
+                        name: functionName,
+                        description,
+                        parameters: (0, zod_to_json_schema_1.zodToJsonSchema)(schema),
+                    },
+                },
+            ];
+        }
+        else {
+            if ("name" in schema) {
+                functionName = schema.name;
+            }
+            tools = [
+                {
+                    type: "function",
+                    function: {
+                        name: functionName,
+                        description,
+                        parameters: schema,
+                    },
+                },
+            ];
+        }
+        const llm = this.bindTools(tools);
+        const outputParser = base_js_2.RunnableLambda.from((input) => {
+            if (!input.tool_calls || input.tool_calls.length === 0) {
+                throw new Error("No tool calls found in the response.");
+            }
+            const toolCall = input.tool_calls.find((tc) => tc.name === functionName);
+            if (!toolCall) {
+                throw new Error(`No tool call found with name ${functionName}.`);
+            }
+            return toolCall.args;
+        });
+        if (!includeRaw) {
+            return llm.pipe(outputParser).withConfig({
+                runName: "StructuredOutput",
+            });
+        }
+        const parserAssign = passthrough_js_1.RunnablePassthrough.assign({
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            parsed: (input, config) => outputParser.invoke(input.raw, config),
+        });
+        const parserNone = passthrough_js_1.RunnablePassthrough.assign({
+            parsed: () => null,
+        });
+        const parsedWithFallback = parserAssign.withFallbacks({
+            fallbacks: [parserNone],
+        });
+        return base_js_2.RunnableSequence.from([
+            {
+                raw: llm,
+            },
+            parsedWithFallback,
+        ]).withConfig({
+            runName: "StructuredOutputRunnable",
+        });
+    }
 }
 exports.BaseChatModel = BaseChatModel;
 /**

package/dist/language_models/chat_models.d.ts

@@ -1,7 +1,8 @@
+import { z } from "zod";
 import { type BaseMessage, BaseMessageChunk, type BaseMessageLike } from "../messages/index.js";
 import type { BasePromptValueInterface } from "../prompt_values.js";
 import { LLMResult, ChatGenerationChunk, type ChatResult, type Generation } from "../outputs.js";
-import { BaseLanguageModel, type BaseLanguageModelCallOptions, type BaseLanguageModelInput, type BaseLanguageModelParams } from "./base.js";
+import { BaseLanguageModel, StructuredOutputMethodOptions, ToolDefinition, type BaseLanguageModelCallOptions, type BaseLanguageModelInput, type BaseLanguageModelParams } from "./base.js";
 import { type CallbackManagerForLLMRun, type Callbacks } from "../callbacks/manager.js";
 import type { RunnableConfig } from "../runnables/config.js";
 import type { BaseCache } from "../caches.js";
@@ -64,11 +65,11 @@ export declare abstract class BaseChatModel<CallOptions extends BaseChatModelCal
      * Bind tool-like objects to this chat model.
      *
      * @param tools A list of tool definitions to bind to this chat model.
-     * Can be a structured tool or an object matching the provider's
-     * specific tool schema.
+     * Can be a structured tool, an OpenAI formatted tool, or an object
+     * matching the provider's specific tool schema.
      * @param kwargs Any additional parameters to bind.
      */
-    bindTools?(tools: (StructuredToolInterface | Record<string, unknown>)[], kwargs?: Partial<CallOptions>): Runnable<BaseLanguageModelInput, OutputMessageType, CallOptions>;
+    bindTools?(tools: (StructuredToolInterface | Record<string, unknown> | ToolDefinition)[], kwargs?: Partial<CallOptions>): Runnable<BaseLanguageModelInput, OutputMessageType, CallOptions>;
     /**
      * Invokes the chat model with a single input.
      * @param input The input for the language model.
@@ -152,6 +153,11 @@ export declare abstract class BaseChatModel<CallOptions extends BaseChatModelCal
      * @returns A Promise that resolves to a string.
      */
     predict(text: string, options?: string[] | CallOptions, callbacks?: Callbacks): Promise<string>;
+    withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: z.ZodType<RunOutput> | Record<string, any>, config?: StructuredOutputMethodOptions<false>): Runnable<BaseLanguageModelInput, RunOutput>;
+    withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: z.ZodType<RunOutput> | Record<string, any>, config?: StructuredOutputMethodOptions<true>): Runnable<BaseLanguageModelInput, {
+        raw: BaseMessage;
+        parsed: RunOutput;
+    }>;
 }
 /**
  * An abstract class that extends BaseChatModel and provides a simple

package/dist/language_models/chat_models.js

@@ -1,10 +1,14 @@
+import { zodToJsonSchema } from "zod-to-json-schema";
 import { AIMessage, HumanMessage, coerceMessageLikeToMessage, } from "../messages/index.js";
 import { RUN_KEY, } from "../outputs.js";
 import { BaseLanguageModel, } from "./base.js";
 import { CallbackManager, } from "../callbacks/manager.js";
+import { RunnableLambda, RunnableSequence, } from "../runnables/base.js";
 import { isStreamEventsHandler } from "../tracers/event_stream.js";
 import { isLogStreamHandler } from "../tracers/log_stream.js";
 import { concat } from "../utils/stream.js";
+import { RunnablePassthrough } from "../runnables/passthrough.js";
+import { isZodSchema } from "../utils/types/is_zod_schema.js";
 /**
  * Creates a transform stream for encoding chat message chunks.
  * @deprecated Use {@link BytesOutputParser} instead
@@ -411,6 +415,83 @@ export class BaseChatModel extends BaseLanguageModel {
         }
         return result.content;
     }
+    withStructuredOutput(outputSchema, config) {
+        if (typeof this.bindTools !== "function") {
+            throw new Error(`Chat model must implement ".bindTools()" to use withStructuredOutput.`);
+        }
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const schema = outputSchema;
+        const name = config?.name;
+        const description = schema.description ?? "A function available to call.";
+        const method = config?.method;
+        const includeRaw = config?.includeRaw;
+        if (method === "jsonMode") {
+            throw new Error(`Base withStructuredOutput implementation only supports "functionCalling" as a method.`);
+        }
+        let functionName = name ?? "extract";
+        let tools;
+        if (isZodSchema(schema)) {
+            tools = [
+                {
+                    type: "function",
+                    function: {
+                        name: functionName,
+                        description,
+                        parameters: zodToJsonSchema(schema),
+                    },
+                },
+            ];
+        }
+        else {
+            if ("name" in schema) {
+                functionName = schema.name;
+            }
+            tools = [
+                {
+                    type: "function",
+                    function: {
+                        name: functionName,
+                        description,
+                        parameters: schema,
+                    },
+                },
+            ];
+        }
+        const llm = this.bindTools(tools);
+        const outputParser = RunnableLambda.from((input) => {
+            if (!input.tool_calls || input.tool_calls.length === 0) {
+                throw new Error("No tool calls found in the response.");
+            }
+            const toolCall = input.tool_calls.find((tc) => tc.name === functionName);
+            if (!toolCall) {
+                throw new Error(`No tool call found with name ${functionName}.`);
+            }
+            return toolCall.args;
+        });
+        if (!includeRaw) {
+            return llm.pipe(outputParser).withConfig({
+                runName: "StructuredOutput",
+            });
+        }
+        const parserAssign = RunnablePassthrough.assign({
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            parsed: (input, config) => outputParser.invoke(input.raw, config),
+        });
+        const parserNone = RunnablePassthrough.assign({
+            parsed: () => null,
+        });
+        const parsedWithFallback = parserAssign.withFallbacks({
+            fallbacks: [parserNone],
+        });
+        return RunnableSequence.from([
+            {
+                raw: llm,
+            },
+            parsedWithFallback,
+        ]).withConfig({
+            runName: "StructuredOutputRunnable",
+        });
+    }
 }
 /**
  * An abstract class that extends BaseChatModel and provides a simple

package/dist/messages/base.d.ts

@@ -8,6 +8,7 @@ export interface StoredMessageData {
     additional_kwargs?: Record<string, any>;
     /** Response metadata. For example: response headers, logprobs, token counts. */
     response_metadata?: Record<string, any>;
+    id?: string;
 }
 export interface StoredMessage {
     type: string;

package/dist/messages/tests/base_message.test.js

@@ -95,3 +95,19 @@ test("Deserialisation and serialisation of tool_call_id", async () => {
     const deserialized = await load(JSON.stringify(message), config);
     expect(deserialized).toEqual(message);
 });
+test("Deserialisation and serialisation of messages with ID", async () => {
+    const config = {
+        importMap: { messages: { AIMessage } },
+        optionalImportEntrypoints: [],
+        optionalImportsMap: {},
+        secretsMap: {},
+    };
+    const messageId = "uuid-1234";
+    const message = new AIMessage({
+        content: "The sky is blue because...",
+        id: messageId,
+    });
+    const deserialized = await load(JSON.stringify(message), config);
+    expect(deserialized).toEqual(message);
+    expect(deserialized.id).toBe(messageId);
+});

package/dist/prompts/template.cjs

@@ -66,7 +66,7 @@ const mustacheTemplateToNodes = (template) => template.map((temp) => {
         const name = temp[1].includes(".") ? temp[1].split(".")[0] : temp[1];
         return { type: "variable", name };
     }
-    else if (["#", "&"].includes(temp[0])) {
+    else if (["#", "&", "^", ">"].includes(temp[0])) {
         // # represents a section, "&" represents an unescaped variable.
         // These should both be considered variables.
         return { type: "variable", name: temp[1] };

package/dist/prompts/template.js

@@ -59,7 +59,7 @@ const mustacheTemplateToNodes = (template) => template.map((temp) => {
         const name = temp[1].includes(".") ? temp[1].split(".")[0] : temp[1];
         return { type: "variable", name };
     }
-    else if (["#", "&"].includes(temp[0])) {
+    else if (["#", "&", "^", ">"].includes(temp[0])) {
         // # represents a section, "&" represents an unescaped variable.
         // These should both be considered variables.
         return { type: "variable", name: temp[1] };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/core",
-  "version": "0.2.8",
+  "version": "0.2.9",
   "description": "Core LangChain.js abstractions and schemas",
   "type": "module",
   "engines": {