@langchain/openai 0.0.16 → 0.0.17

package/dist/chat_models.cjs

@@ -718,7 +718,24 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             },
         });
     }
-    withStructuredOutput({ schema, name, method, includeRaw, }) {
+    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") {
@@ -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,8 @@ 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, StructuredOutputMethodParams } 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";
 export type { AzureOpenAIInput, OpenAICallOptions, OpenAIChatInput };
@@ -141,8 +142,8 @@ export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = Chat
     _llmType(): string;
     /** @ignore */
     _combineLLMOutput(...llmOutputs: OpenAILLMOutput[]): OpenAILLMOutput;
-    withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>({ schema, name, method, includeRaw, }: StructuredOutputMethodParams<RunOutput, false>): Runnable<BaseLanguageModelInput, RunOutput>;
-    withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>({ schema, name, method, includeRaw, }: StructuredOutputMethodParams<RunOutput, true>): Runnable<BaseLanguageModelInput, {
+    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;
     }>;

package/dist/chat_models.js

@@ -714,7 +714,24 @@ export class ChatOpenAI extends BaseChatModel {
             },
         });
     }
-    withStructuredOutput({ schema, name, method, includeRaw, }) {
+    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") {
@@ -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.16",
+  "version": "0.0.17",
   "description": "OpenAI integrations for LangChain.js",
   "type": "module",
   "engines": {