@langchain/openai 0.5.16 → 0.5.17

package/dist/types.d.ts

@@ -135,13 +135,6 @@ export interface OpenAIChatInput extends OpenAIBaseInput {
      * [Learn more](https://platform.openai.com/docs/guides/audio).
      */
     audio?: OpenAIClient.Chat.ChatCompletionAudioParam;
-    /**
-     * Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high.
-     * Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
-     *
-     * @deprecated Use the {@link reasoning} object instead.
-     */
-    reasoningEffort?: OpenAIClient.Chat.ChatCompletionReasoningEffort;
     /**
      * Options for reasoning models.
      *

package/dist/utils/openai.cjs

@@ -4,12 +4,15 @@ exports.formatToOpenAITool = exports.formatToOpenAIFunction = void 0;
 exports.wrapOpenAIClientError = wrapOpenAIClientError;
 exports.formatToOpenAIAssistantTool = formatToOpenAIAssistantTool;
 exports.formatToOpenAIToolChoice = formatToOpenAIToolChoice;
+exports.interopZodResponseFormat = interopZodResponseFormat;
 const openai_1 = require("openai");
 const function_calling_1 = require("@langchain/core/utils/function_calling");
 Object.defineProperty(exports, "formatToOpenAIFunction", { enumerable: true, get: function () { return function_calling_1.convertToOpenAIFunction; } });
 Object.defineProperty(exports, "formatToOpenAITool", { enumerable: true, get: function () { return function_calling_1.convertToOpenAITool; } });
 const types_1 = require("@langchain/core/utils/types");
 const json_schema_1 = require("@langchain/core/utils/json_schema");
+const core_1 = require("zod/v4/core");
+const zod_1 = require("openai/helpers/zod");
 const errors_js_1 = require("./errors.cjs");
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function wrapOpenAIClientError(e) {
@@ -76,3 +79,49 @@ function formatToOpenAIToolChoice(toolChoice) {
         return toolChoice;
     }
 }
+// inlined from openai/lib/parser.ts
+function makeParseableResponseFormat(response_format, parser) {
+    const obj = { ...response_format };
+    Object.defineProperties(obj, {
+        $brand: {
+            value: "auto-parseable-response-format",
+            enumerable: false,
+        },
+        $parseRaw: {
+            value: parser,
+            enumerable: false,
+        },
+    });
+    return obj;
+}
+function interopZodResponseFormat(zodSchema, name, props) {
+    if ((0, types_1.isZodSchemaV3)(zodSchema)) {
+        return (0, zod_1.zodResponseFormat)(zodSchema, name, props);
+    }
+    if ((0, types_1.isZodSchemaV4)(zodSchema)) {
+        return makeParseableResponseFormat({
+            type: "json_schema",
+            json_schema: {
+                ...props,
+                name,
+                strict: true,
+                schema: (0, core_1.toJSONSchema)(zodSchema, {
+                    cycles: "ref", // equivalent to nameStrategy: 'duplicate-ref'
+                    reused: "ref", // equivalent to $refStrategy: 'extract-to-root'
+                    override(ctx) {
+                        ctx.jsonSchema.title = name; // equivalent to `name` property
+                        // TODO: implement `nullableStrategy` patch-fix (zod doesn't support openApi3 json schema target)
+                        // TODO: implement `openaiStrictMode` patch-fix (where optional properties without `nullable` are not supported)
+                    },
+                    /// property equivalents from native `zodResponseFormat` fn
+                    // openaiStrictMode: true,
+                    // name,
+                    // nameStrategy: 'duplicate-ref',
+                    // $refStrategy: 'extract-to-root',
+                    // nullableStrategy: 'property',
+                }),
+            },
+        }, (content) => (0, core_1.parse)(zodSchema, JSON.parse(content)));
+    }
+    throw new Error("Unsupported schema response format");
+}

package/dist/utils/openai.d.ts

@@ -2,8 +2,14 @@ import { OpenAI as OpenAIClient } from "openai";
 import type { StructuredToolInterface } from "@langchain/core/tools";
 import { convertToOpenAIFunction, convertToOpenAITool } from "@langchain/core/utils/function_calling";
 import { ToolDefinition } from "@langchain/core/language_models/base";
+import { InteropZodType } from "@langchain/core/utils/types";
+import { ResponseFormatJSONSchema } from "openai/resources";
 export declare function wrapOpenAIClientError(e: any): any;
 export { convertToOpenAIFunction as formatToOpenAIFunction, convertToOpenAITool as formatToOpenAITool, };
 export declare function formatToOpenAIAssistantTool(tool: StructuredToolInterface): ToolDefinition;
 export type OpenAIToolChoice = OpenAIClient.ChatCompletionToolChoiceOption | "any" | string;
 export declare function formatToOpenAIToolChoice(toolChoice?: OpenAIToolChoice): OpenAIClient.ChatCompletionToolChoiceOption | undefined;
+export declare function interopZodResponseFormat(zodSchema: InteropZodType, name: string, props: Omit<ResponseFormatJSONSchema.JSONSchema, "schema" | "strict" | "name">): {
+    json_schema: ResponseFormatJSONSchema.JSONSchema;
+    type: "json_schema";
+};

package/dist/utils/openai.js

@@ -1,7 +1,9 @@
 import { APIConnectionTimeoutError, APIUserAbortError, } from "openai";
 import { convertToOpenAIFunction, convertToOpenAITool, } from "@langchain/core/utils/function_calling";
-import { isInteropZodSchema } from "@langchain/core/utils/types";
+import { isInteropZodSchema, isZodSchemaV3, isZodSchemaV4, } from "@langchain/core/utils/types";
 import { toJsonSchema } from "@langchain/core/utils/json_schema";
+import { toJSONSchema as toJSONSchemaV4, parse as parseV4 } from "zod/v4/core";
+import { zodResponseFormat } from "openai/helpers/zod";
 import { addLangChainErrorFields } from "./errors.js";
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function wrapOpenAIClientError(e) {
@@ -69,3 +71,49 @@ export function formatToOpenAIToolChoice(toolChoice) {
         return toolChoice;
     }
 }
+// inlined from openai/lib/parser.ts
+function makeParseableResponseFormat(response_format, parser) {
+    const obj = { ...response_format };
+    Object.defineProperties(obj, {
+        $brand: {
+            value: "auto-parseable-response-format",
+            enumerable: false,
+        },
+        $parseRaw: {
+            value: parser,
+            enumerable: false,
+        },
+    });
+    return obj;
+}
+export function interopZodResponseFormat(zodSchema, name, props) {
+    if (isZodSchemaV3(zodSchema)) {
+        return zodResponseFormat(zodSchema, name, props);
+    }
+    if (isZodSchemaV4(zodSchema)) {
+        return makeParseableResponseFormat({
+            type: "json_schema",
+            json_schema: {
+                ...props,
+                name,
+                strict: true,
+                schema: toJSONSchemaV4(zodSchema, {
+                    cycles: "ref", // equivalent to nameStrategy: 'duplicate-ref'
+                    reused: "ref", // equivalent to $refStrategy: 'extract-to-root'
+                    override(ctx) {
+                        ctx.jsonSchema.title = name; // equivalent to `name` property
+                        // TODO: implement `nullableStrategy` patch-fix (zod doesn't support openApi3 json schema target)
+                        // TODO: implement `openaiStrictMode` patch-fix (where optional properties without `nullable` are not supported)
+                    },
+                    /// property equivalents from native `zodResponseFormat` fn
+                    // openaiStrictMode: true,
+                    // name,
+                    // nameStrategy: 'duplicate-ref',
+                    // $refStrategy: 'extract-to-root',
+                    // nullableStrategy: 'property',
+                }),
+            },
+        }, (content) => parseV4(zodSchema, JSON.parse(content)));
+    }
+    throw new Error("Unsupported schema response format");
+}

package/dist/utils/prompts.cjs

@@ -26,7 +26,7 @@ const chat_models_js_1 = require("../chat_models.cjs");
  * const openAIClient = new OpenAI();
  *
  * const openaiResponse = await openAIClient.chat.completions.create({
- *   model: "gpt-4o",
+ *   model: "gpt-4o-mini",
  *   messages,
  * });
  * ```

package/dist/utils/prompts.d.ts

@@ -24,7 +24,7 @@ import type { OpenAI } from "openai";
  * const openAIClient = new OpenAI();
  *
  * const openaiResponse = await openAIClient.chat.completions.create({
- *   model: "gpt-4o",
+ *   model: "gpt-4o-mini",
  *   messages,
  * });
  * ```

package/dist/utils/prompts.js

@@ -23,7 +23,7 @@ import { _convertMessagesToOpenAIParams } from "../chat_models.js";
  * const openAIClient = new OpenAI();
  *
  * const openaiResponse = await openAIClient.chat.completions.create({
- *   model: "gpt-4o",
+ *   model: "gpt-4o-mini",
  *   messages,
  * });
  * ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/openai",
-  "version": "0.5.16",
+  "version": "0.5.17",
   "description": "OpenAI integrations for LangChain.js",
   "type": "module",
   "engines": {