@langchain/openai 0.0.15 → 0.0.17

package/dist/chat_models.cjs

@@ -718,18 +718,24 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             },
         });
     }
-    /**
-     * Model wrapper that returns outputs formatted to match the given schema.
-     *
-     * @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>} schema The schema for the structured output. Either as a Zod schema or a valid JSON schema object.
-     * @param {string} name The name of the function to call.
-     * @param {"functionCalling" | "jsonMode"} method The method to use for getting the structured output. Defaults to "functionCalling".
-     * @param {boolean | undefined} includeRaw Whether to include the raw output in the result. Defaults to false.
-     * @returns {Runnable<RunInput, RunOutput> | Runnable<RunInput, { raw: BaseMessage; parsed: RunOutput }>} A new runnable that calls the LLM with structured output.
-     */
-    withStructuredOutput({ schema, name, method = "functionCalling", includeRaw = false, }) {
+    withStructuredOutput(outputSchema, config) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        let schema;
+        let name;
+        let method;
+        let includeRaw;
+        if (isStructuredOutputMethodParams(outputSchema)) {
+            schema = outputSchema.schema;
+            name = outputSchema.name;
+            method = outputSchema.method;
+            includeRaw = outputSchema.includeRaw;
+        }
+        else {
+            schema = outputSchema;
+            name = config?.name;
+            method = config?.method;
+            includeRaw = config?.includeRaw;
+        }
         let llm;
         let outputParser;
         if (method === "jsonMode") {
@@ -739,6 +745,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             outputParser = new output_parsers_1.JsonOutputParser();
         }
         else {
+            const functionName = name ?? "extract";
             // Is function calling
             if (isZodSchema(schema)) {
                 const asZodSchema = (0, zod_to_json_schema_1.zodToJsonSchema)(schema);
@@ -753,11 +760,16 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
                             },
                         },
                     ],
-                    tool_choice: "auto",
+                    tool_choice: {
+                        type: "function",
+                        function: {
+                            name: functionName,
+                        },
+                    },
                 });
                 outputParser = new openai_tools_1.JsonOutputKeyToolsParser({
                     returnSingle: true,
-                    keyName: name,
+                    keyName: functionName,
                 });
             }
             else {
@@ -772,11 +784,16 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
                             },
                         },
                     ],
-                    tool_choice: "auto",
+                    tool_choice: {
+                        type: "function",
+                        function: {
+                            name,
+                        },
+                    },
                 });
                 outputParser = new openai_tools_1.JsonOutputKeyToolsParser({
                     returnSingle: true,
-                    keyName: name,
+                    keyName: functionName,
                 });
             }
         }
@@ -806,3 +823,11 @@ function isZodSchema(input) {
     // Check for a characteristic method of Zod schemas
     return typeof input?.parse === "function";
 }
+function isStructuredOutputMethodParams(x
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+) {
+    return (x !== undefined &&
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        typeof x.schema ===
+            "object");
+}

package/dist/chat_models.d.ts

@@ -4,7 +4,7 @@ import { type BaseMessage } from "@langchain/core/messages";
 import { ChatGenerationChunk, type ChatResult } from "@langchain/core/outputs";
 import { type StructuredToolInterface } from "@langchain/core/tools";
 import { BaseChatModel, type BaseChatModelParams } from "@langchain/core/language_models/chat_models";
-import type { BaseFunctionCallOptions, BaseLanguageModelInput } from "@langchain/core/language_models/base";
+import type { BaseFunctionCallOptions, BaseLanguageModelInput, StructuredOutputMethodOptions, StructuredOutputMethodParams } from "@langchain/core/language_models/base";
 import { z } from "zod";
 import { Runnable } from "@langchain/core/runnables";
 import type { AzureOpenAIInput, OpenAICallOptions, OpenAIChatInput, OpenAICoreRequestOptions, LegacyOpenAIInput } from "./types.js";
@@ -142,19 +142,9 @@ export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = Chat
     _llmType(): string;
     /** @ignore */
     _combineLLMOutput(...llmOutputs: OpenAILLMOutput[]): OpenAILLMOutput;
-    withStructuredOutput<RunInput = BaseLanguageModelInput, RunOutput extends z.ZodObject<any, any, any, any> = z.ZodObject<any, any, any, any>>({ schema, name, method, includeRaw, }: {
-        schema: z.ZodEffects<RunOutput> | Record<string, any>;
-        name: string;
-        method?: "functionCalling" | "jsonMode";
-        includeRaw: true;
-    }): Runnable<RunInput, {
+    withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: StructuredOutputMethodParams<RunOutput, false> | z.ZodType<RunOutput> | Record<string, any>, config?: StructuredOutputMethodOptions<false>): Runnable<BaseLanguageModelInput, RunOutput>;
+    withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: StructuredOutputMethodParams<RunOutput, true> | z.ZodType<RunOutput> | Record<string, any>, config?: StructuredOutputMethodOptions<true>): Runnable<BaseLanguageModelInput, {
         raw: BaseMessage;
         parsed: RunOutput;
     }>;
-    withStructuredOutput<RunInput = BaseLanguageModelInput, RunOutput extends z.ZodObject<any, any, any, any> = z.ZodObject<any, any, any, any>>({ schema, name, method, includeRaw, }: {
-        schema: z.ZodEffects<RunOutput> | Record<string, any>;
-        name: string;
-        method?: "functionCalling" | "jsonMode";
-        includeRaw?: false;
-    }): Runnable<RunInput, RunOutput>;
 }

package/dist/chat_models.js

@@ -714,18 +714,24 @@ export class ChatOpenAI extends BaseChatModel {
             },
         });
     }
-    /**
-     * Model wrapper that returns outputs formatted to match the given schema.
-     *
-     * @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>} schema The schema for the structured output. Either as a Zod schema or a valid JSON schema object.
-     * @param {string} name The name of the function to call.
-     * @param {"functionCalling" | "jsonMode"} method The method to use for getting the structured output. Defaults to "functionCalling".
-     * @param {boolean | undefined} includeRaw Whether to include the raw output in the result. Defaults to false.
-     * @returns {Runnable<RunInput, RunOutput> | Runnable<RunInput, { raw: BaseMessage; parsed: RunOutput }>} A new runnable that calls the LLM with structured output.
-     */
-    withStructuredOutput({ schema, name, method = "functionCalling", includeRaw = false, }) {
+    withStructuredOutput(outputSchema, config) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        let schema;
+        let name;
+        let method;
+        let includeRaw;
+        if (isStructuredOutputMethodParams(outputSchema)) {
+            schema = outputSchema.schema;
+            name = outputSchema.name;
+            method = outputSchema.method;
+            includeRaw = outputSchema.includeRaw;
+        }
+        else {
+            schema = outputSchema;
+            name = config?.name;
+            method = config?.method;
+            includeRaw = config?.includeRaw;
+        }
         let llm;
         let outputParser;
         if (method === "jsonMode") {
@@ -735,6 +741,7 @@ export class ChatOpenAI extends BaseChatModel {
             outputParser = new JsonOutputParser();
         }
         else {
+            const functionName = name ?? "extract";
             // Is function calling
             if (isZodSchema(schema)) {
                 const asZodSchema = zodToJsonSchema(schema);
@@ -749,11 +756,16 @@ export class ChatOpenAI extends BaseChatModel {
                             },
                         },
                     ],
-                    tool_choice: "auto",
+                    tool_choice: {
+                        type: "function",
+                        function: {
+                            name: functionName,
+                        },
+                    },
                 });
                 outputParser = new JsonOutputKeyToolsParser({
                     returnSingle: true,
-                    keyName: name,
+                    keyName: functionName,
                 });
             }
             else {
@@ -768,11 +780,16 @@ export class ChatOpenAI extends BaseChatModel {
                             },
                         },
                     ],
-                    tool_choice: "auto",
+                    tool_choice: {
+                        type: "function",
+                        function: {
+                            name,
+                        },
+                    },
                 });
                 outputParser = new JsonOutputKeyToolsParser({
                     returnSingle: true,
-                    keyName: name,
+                    keyName: functionName,
                 });
             }
         }
@@ -801,3 +818,11 @@ function isZodSchema(input) {
     // Check for a characteristic method of Zod schemas
     return typeof input?.parse === "function";
 }
+function isStructuredOutputMethodParams(x
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+) {
+    return (x !== undefined &&
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        typeof x.schema ===
+            "object");
+}

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

@@ -641,8 +641,7 @@ describe("ChatOpenAI withStructuredOutput", () => {
             number1: z.number(),
             number2: z.number(),
         });
-        const modelWithStructuredOutput = model.withStructuredOutput({
-            schema: calculatorSchema,
+        const modelWithStructuredOutput = model.withStructuredOutput(calculatorSchema, {
             name: "calculator",
         });
         const prompt = ChatPromptTemplate.fromMessages([
@@ -668,8 +667,7 @@ describe("ChatOpenAI withStructuredOutput", () => {
             number1: z.number(),
             number2: z.number(),
         });
-        const modelWithStructuredOutput = model.withStructuredOutput({
-            schema: calculatorSchema,
+        const modelWithStructuredOutput = model.withStructuredOutput(calculatorSchema, {
             name: "calculator",
             method: "jsonMode",
         });
@@ -728,8 +726,7 @@ describe("ChatOpenAI withStructuredOutput", () => {
             number1: z.number(),
             number2: z.number(),
         });
-        const modelWithStructuredOutput = model.withStructuredOutput({
-            schema: zodToJsonSchema(calculatorSchema),
+        const modelWithStructuredOutput = model.withStructuredOutput(zodToJsonSchema(calculatorSchema), {
             name: "calculator",
             method: "jsonMode",
         });
@@ -761,8 +758,7 @@ describe("ChatOpenAI withStructuredOutput", () => {
             number1: z.number(),
             number2: z.number(),
         });
-        const modelWithStructuredOutput = model.withStructuredOutput({
-            schema: calculatorSchema,
+        const modelWithStructuredOutput = model.withStructuredOutput(calculatorSchema, {
             name: "calculator",
             includeRaw: true,
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/openai",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "description": "OpenAI integrations for LangChain.js",
   "type": "module",
   "engines": {
@@ -39,7 +39,7 @@
   "author": "LangChain",
   "license": "MIT",
   "dependencies": {
-    "@langchain/core": "~0.1.39",
+    "@langchain/core": "~0.1.41",
     "js-tiktoken": "^1.0.7",
     "openai": "^4.26.0",
     "zod": "^3.22.4",