@langchain/openai 0.6.5 → 0.6.6

package/dist/chat_models.cjs

@@ -19,17 +19,8 @@ const openai_js_1 = require("./utils/openai.cjs");
 const openai_format_fndef_js_1 = require("./utils/openai-format-fndef.cjs");
 const tools_js_1 = require("./utils/tools.cjs");
 const _FUNCTION_CALL_IDS_MAP_KEY = "__openai_function_call_ids__";
-function isBuiltInTool(tool) {
-    return "type" in tool && tool.type !== "function";
-}
-function isBuiltInToolChoice(tool_choice) {
-    return (tool_choice != null &&
-        typeof tool_choice === "object" &&
-        "type" in tool_choice &&
-        tool_choice.type !== "function");
-}
 function isReasoningModel(model) {
-    return model && /^o\d/.test(model);
+    return model && (/^o\d/.test(model) || model.startsWith("gpt-5"));
 }
 function isStructuredOutputMethodParams(x
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -327,6 +318,8 @@ class BaseChatOpenAI extends chat_models_1.BaseChatModel {
             "disableStreaming",
             "zdrEnabled",
             "reasoning",
+            "verbosity",
+            "promptCacheKey",
         ];
     }
     getLsParams(options) {
@@ -545,6 +538,17 @@ class BaseChatOpenAI extends chat_models_1.BaseChatModel {
             writable: true,
             value: void 0
         });
+        /**
+         * Used by OpenAI to cache responses for similar requests to optimize your cache
+         * hit rates.
+         * [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
+         */
+        Object.defineProperty(this, "promptCacheKey", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "defaultOptions", {
             enumerable: true,
             configurable: true,
@@ -584,6 +588,7 @@ class BaseChatOpenAI extends chat_models_1.BaseChatModel {
         this.reasoning = fields?.reasoning;
         this.maxTokens = fields?.maxCompletionTokens ?? fields?.maxTokens;
         this.disableStreaming = fields?.disableStreaming ?? this.disableStreaming;
+        this.promptCacheKey = fields?.promptCacheKey ?? this.promptCacheKey;
         this.streaming = fields?.streaming ?? false;
         if (this.disableStreaming)
             this.streaming = false;
@@ -677,6 +682,9 @@ class BaseChatOpenAI extends chat_models_1.BaseChatModel {
     }
     // TODO: move to completions class
     _convertChatOpenAIToolToCompletionsTool(tool, fields) {
+        if ((0, tools_js_1.isCustomTool)(tool)) {
+            return (0, tools_js_1.convertResponsesCustomTool)(tool.metadata.customTool);
+        }
         if ((0, base_1.isOpenAITool)(tool)) {
             if (fields?.strict !== undefined) {
                 return {
@@ -700,7 +708,7 @@ class BaseChatOpenAI extends chat_models_1.BaseChatModel {
             strict = this.supportsStrictToolCalling;
         }
         return this.withConfig({
-            tools: tools.map((tool) => isBuiltInTool(tool)
+            tools: tools.map((tool) => (0, tools_js_1.isBuiltInTool)(tool)
                 ? tool
                 : this._convertChatOpenAIToolToCompletionsTool(tool, { strict })),
             ...kwargs,
@@ -1036,7 +1044,7 @@ class ChatOpenAIResponses extends BaseChatOpenAI {
                     strict,
                 })
                 : undefined,
-            tool_choice: isBuiltInToolChoice(options?.tool_choice)
+            tool_choice: (0, tools_js_1.isBuiltInToolChoice)(options?.tool_choice)
                 ? options?.tool_choice
                 : (() => {
                     const formatted = (0, openai_js_1.formatToOpenAIToolChoice)(options?.tool_choice);
@@ -1082,6 +1090,7 @@ class ChatOpenAIResponses extends BaseChatOpenAI {
             })(),
             parallel_tool_calls: options?.parallel_tool_calls,
             max_output_tokens: this.maxTokens === -1 ? undefined : this.maxTokens,
+            prompt_cache_key: options?.promptCacheKey ?? this.promptCacheKey,
             ...(this.zdrEnabled ? { store: false } : {}),
             ...this.modelKwargs,
         };
@@ -1244,6 +1253,15 @@ class ChatOpenAIResponses extends BaseChatOpenAI {
             else if (item.type === "reasoning") {
                 additional_kwargs.reasoning = item;
             }
+            else if (item.type === "custom_tool_call") {
+                const parsed = (0, tools_js_1.parseCustomToolCall)(item);
+                if (parsed) {
+                    tool_calls.push(parsed);
+                }
+                else {
+                    invalid_tool_calls.push((0, openai_tools_1.makeInvalidToolCall)(item, "Malformed custom tool call"));
+                }
+            }
             else {
                 additional_kwargs.tool_outputs ??= [];
                 additional_kwargs.tool_outputs.push(item);
@@ -1310,6 +1328,7 @@ class ChatOpenAIResponses extends BaseChatOpenAI {
                 "mcp_list_tools",
                 "mcp_approval_request",
                 "image_generation_call",
+                "custom_tool_call",
             ].includes(chunk.item.type)) {
             additional_kwargs.tool_outputs = [chunk.item];
         }
@@ -1451,6 +1470,14 @@ class ChatOpenAIResponses extends BaseChatOpenAI {
                         call_id: toolMessage.tool_call_id,
                     };
                 }
+                // Handle custom tool output
+                if (toolMessage.metadata?.customTool) {
+                    return {
+                        type: "custom_tool_call_output",
+                        call_id: toolMessage.tool_call_id,
+                        output: toolMessage.content,
+                    };
+                }
                 return {
                     type: "function_call_output",
                     call_id: toolMessage.tool_call_id,
@@ -1489,41 +1516,54 @@ class ChatOpenAIResponses extends BaseChatOpenAI {
                         { type: "refusal", refusal: additional_kwargs.refusal },
                     ];
                 }
-                input.push({
-                    type: "message",
-                    role: "assistant",
-                    ...(lcMsg.id && !this.zdrEnabled && lcMsg.id.startsWith("msg_")
-                        ? { id: lcMsg.id }
-                        : {}),
-                    content: typeof content === "string"
-                        ? content
-                        : content.flatMap((item) => {
-                            if (item.type === "text") {
-                                return {
-                                    type: "output_text",
-                                    text: item.text,
-                                    // @ts-expect-error TODO: add types for `annotations`
-                                    annotations: item.annotations ?? [],
-                                };
-                            }
-                            if (item.type === "output_text" ||
-                                item.type === "refusal") {
-                                return item;
-                            }
-                            return [];
-                        }),
-                });
+                if (typeof content === "string" || content.length > 0) {
+                    input.push({
+                        type: "message",
+                        role: "assistant",
+                        ...(lcMsg.id && !this.zdrEnabled && lcMsg.id.startsWith("msg_")
+                            ? { id: lcMsg.id }
+                            : {}),
+                        content: typeof content === "string"
+                            ? content
+                            : content.flatMap((item) => {
+                                if (item.type === "text") {
+                                    return {
+                                        type: "output_text",
+                                        text: item.text,
+                                        // @ts-expect-error TODO: add types for `annotations`
+                                        annotations: item.annotations ?? [],
+                                    };
+                                }
+                                if (item.type === "output_text" ||
+                                    item.type === "refusal") {
+                                    return item;
+                                }
+                                return [];
+                            }),
+                    });
+                }
                 const functionCallIds = additional_kwargs?.[_FUNCTION_CALL_IDS_MAP_KEY];
                 if ((0, messages_1.isAIMessage)(lcMsg) && !!lcMsg.tool_calls?.length) {
-                    input.push(...lcMsg.tool_calls.map((toolCall) => ({
-                        type: "function_call",
-                        name: toolCall.name,
-                        arguments: JSON.stringify(toolCall.args),
-                        call_id: toolCall.id,
-                        ...(this.zdrEnabled
-                            ? { id: functionCallIds?.[toolCall.id] }
-                            : {}),
-                    })));
+                    input.push(...lcMsg.tool_calls.map((toolCall) => {
+                        if ((0, tools_js_1.isCustomToolCall)(toolCall)) {
+                            return {
+                                type: "custom_tool_call",
+                                id: toolCall.call_id,
+                                call_id: toolCall.id ?? "",
+                                input: toolCall.args.input,
+                                name: toolCall.name,
+                            };
+                        }
+                        return {
+                            type: "function_call",
+                            name: toolCall.name,
+                            arguments: JSON.stringify(toolCall.args),
+                            call_id: toolCall.id,
+                            ...(this.zdrEnabled
+                                ? { id: functionCallIds?.[toolCall.id] }
+                                : {}),
+                        };
+                    }));
                 }
                 else if (additional_kwargs?.tool_calls) {
                     input.push(...additional_kwargs.tool_calls.map((toolCall) => ({
@@ -1626,7 +1666,7 @@ class ChatOpenAIResponses extends BaseChatOpenAI {
     _reduceChatOpenAITools(tools, fields) {
         const reducedTools = [];
         for (const tool of tools) {
-            if (isBuiltInTool(tool)) {
+            if ((0, tools_js_1.isBuiltInTool)(tool)) {
                 if (tool.type === "image_generation" && fields?.stream) {
                     // OpenAI sends a 400 error if partial_images is not set and we want to stream.
                     // We also set it to 1 since we don't support partial images yet.
@@ -1643,6 +1683,9 @@ class ChatOpenAIResponses extends BaseChatOpenAI {
                     strict: fields?.strict ?? null,
                 });
             }
+            else if ((0, tools_js_1.isOpenAICustomTool)(tool)) {
+                reducedTools.push((0, tools_js_1.convertCompletionsCustomTool)(tool));
+            }
         }
         return reducedTools;
     }
@@ -1700,6 +1743,7 @@ class ChatOpenAICompletions extends BaseChatOpenAI {
                 ? { modalities: this.modalities || options?.modalities }
                 : {}),
             ...this.modelKwargs,
+            prompt_cache_key: options?.promptCacheKey ?? this.promptCacheKey,
         };
         if (options?.prediction !== undefined) {
             params.prediction = options.prediction;
@@ -1947,6 +1991,7 @@ class ChatOpenAICompletions extends BaseChatOpenAI {
                     return await this.client.chat.completions.parse(request, clientOptions);
                 }
                 else {
+                    console.log("request", request);
                     return await this.client.chat.completions.create(request, clientOptions);
                 }
             }
@@ -2669,14 +2714,18 @@ class ChatOpenAI extends BaseChatOpenAI {
         this.completions = fields?.completions ?? new ChatOpenAICompletions(fields);
     }
     _useResponsesApi(options) {
-        const usesBuiltInTools = options?.tools?.some(isBuiltInTool);
+        const usesBuiltInTools = options?.tools?.some(tools_js_1.isBuiltInTool);
         const hasResponsesOnlyKwargs = options?.previous_response_id != null ||
             options?.text != null ||
             options?.truncation != null ||
             options?.include != null ||
             options?.reasoning?.summary != null ||
             this.reasoning?.summary != null;
-        return this.useResponsesApi || usesBuiltInTools || hasResponsesOnlyKwargs;
+        const hasCustomTools = options?.tools?.some(tools_js_1.isOpenAICustomTool);
+        return (this.useResponsesApi ||
+            usesBuiltInTools ||
+            hasResponsesOnlyKwargs ||
+            hasCustomTools);
     }
     getLsParams(options) {
         const optionsWithDefaults = this._combineCallOptions(options);

package/dist/chat_models.d.ts

@@ -2,16 +2,13 @@ import { type ClientOptions, OpenAI as OpenAIClient } from "openai";
 import { CallbackManagerForLLMRun } from "@langchain/core/callbacks/manager";
 import { AIMessageChunk, type BaseMessage, ChatMessageChunk, FunctionMessageChunk, HumanMessageChunk, SystemMessageChunk, ToolMessageChunk } from "@langchain/core/messages";
 import { ChatGenerationChunk, type ChatGeneration, type ChatResult } from "@langchain/core/outputs";
-import { BaseChatModel, type BindToolsInput, type LangSmithParams, type BaseChatModelParams } from "@langchain/core/language_models/chat_models";
+import { BaseChatModel, type LangSmithParams, type BaseChatModelParams } from "@langchain/core/language_models/chat_models";
 import { type BaseFunctionCallOptions, type BaseLanguageModelInput, type StructuredOutputMethodOptions } from "@langchain/core/language_models/base";
 import { Runnable } from "@langchain/core/runnables";
-import type { ResponseFormatText, ResponseFormatJSONObject, ResponseFormatJSONSchema } from "openai/resources/shared";
 import { InteropZodType } from "@langchain/core/utils/types";
-import { type OpenAICallOptions, type OpenAIChatInput, type OpenAICoreRequestOptions, type ChatOpenAIResponseFormat, ChatOpenAIReasoningSummary } from "./types.js";
+import { type OpenAICallOptions, type OpenAIChatInput, type OpenAICoreRequestOptions, type ChatOpenAIResponseFormat, ChatOpenAIReasoningSummary, ResponseFormatConfiguration } from "./types.js";
 import { OpenAIToolChoice } from "./utils/openai.js";
-type ResponsesTool = NonNullable<OpenAIClient.Responses.ResponseCreateParams["tools"]>[number];
-type ResponsesToolChoice = NonNullable<OpenAIClient.Responses.ResponseCreateParams["tool_choice"]>;
-type ChatOpenAIToolType = BindToolsInput | OpenAIClient.Chat.ChatCompletionTool | ResponsesTool;
+import { ChatOpenAIToolType, ResponsesTool, ResponsesToolChoice } from "./utils/tools.js";
 interface OpenAILLMOutput {
     tokenUsage: {
         completionTokens?: number;
@@ -112,6 +109,12 @@ export interface BaseChatOpenAICallOptions extends OpenAICallOptions, BaseFuncti
      * Specifies the service tier for prioritization and latency optimization.
      */
     service_tier?: OpenAIClient.Chat.ChatCompletionCreateParams["service_tier"];
+    /**
+     * Used by OpenAI to cache responses for similar requests to optimize your cache
+     * hit rates. Replaces the `user` field.
+     * [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
+     */
+    promptCacheKey?: string;
 }
 export interface BaseChatOpenAIFields extends Partial<OpenAIChatInput>, BaseChatModelParams {
     /**
@@ -170,6 +173,12 @@ export declare abstract class BaseChatOpenAI<CallOptions extends BaseChatOpenAIC
      * Specifies the service tier for prioritization and latency optimization.
      */
     service_tier?: OpenAIClient.Chat.ChatCompletionCreateParams["service_tier"];
+    /**
+     * Used by OpenAI to cache responses for similar requests to optimize your cache
+     * hit rates.
+     * [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
+     */
+    promptCacheKey: string;
     protected defaultOptions: CallOptions;
     _llmType(): string;
     static lc_name(): string;
@@ -201,7 +210,7 @@ export declare abstract class BaseChatOpenAI<CallOptions extends BaseChatOpenAIC
      * Returns an openai compatible response format from a set of options
      * @internal
      */
-    protected _getResponseFormat(resFormat?: CallOptions["response_format"]): ResponseFormatText | ResponseFormatJSONObject | ResponseFormatJSONSchema | undefined;
+    protected _getResponseFormat(resFormat?: CallOptions["response_format"]): ResponseFormatConfiguration | undefined;
     protected _combineCallOptions(additionalOptions?: this["ParsedCallOptions"]): this["ParsedCallOptions"];
     /** @internal */
     _getClientOptions(options: OpenAICoreRequestOptions | undefined): OpenAICoreRequestOptions;
@@ -882,7 +891,7 @@ export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = Chat
     protected completions: ChatOpenAICompletions;
     get lc_serializable_keys(): string[];
     constructor(fields?: ChatOpenAIFields | undefined);
-    protected _useResponsesApi(options: this["ParsedCallOptions"] | undefined): boolean;
+    protected _useResponsesApi(options: this["ParsedCallOptions"] | undefined): boolean | undefined;
     getLsParams(options: this["ParsedCallOptions"]): LangSmithParams;
     invocationParams(options?: this["ParsedCallOptions"]): ChatResponsesInvocationParams | ChatCompletionsInvocationParams;
     /** @ignore */

package/dist/chat_models.js

@@ -3,7 +3,7 @@ import { AIMessage, AIMessageChunk, ChatMessage, ChatMessageChunk, FunctionMessa
 import { ChatGenerationChunk, } from "@langchain/core/outputs";
 import { getEnvironmentVariable } from "@langchain/core/utils/env";
 import { BaseChatModel, } from "@langchain/core/language_models/chat_models";
-import { isOpenAITool, } from "@langchain/core/language_models/base";
+import { isOpenAITool as isOpenAIFunctionTool, } from "@langchain/core/language_models/base";
 import { RunnableLambda, RunnablePassthrough, RunnableSequence, } from "@langchain/core/runnables";
 import { JsonOutputParser, StructuredOutputParser, } from "@langchain/core/output_parsers";
 import { JsonOutputKeyToolsParser, convertLangChainToolCallToOpenAI, makeInvalidToolCall, parseToolCall, } from "@langchain/core/output_parsers/openai_tools";
@@ -12,19 +12,10 @@ import { toJsonSchema } from "@langchain/core/utils/json_schema";
 import { getEndpoint } from "./utils/azure.js";
 import { formatToOpenAIToolChoice, interopZodResponseFormat, wrapOpenAIClientError, } from "./utils/openai.js";
 import { formatFunctionDefinitions, } from "./utils/openai-format-fndef.js";
-import { _convertToOpenAITool } from "./utils/tools.js";
+import { _convertToOpenAITool, convertCompletionsCustomTool, convertResponsesCustomTool, isBuiltInTool, isBuiltInToolChoice, isCustomTool, isCustomToolCall, isOpenAICustomTool, parseCustomToolCall, } from "./utils/tools.js";
 const _FUNCTION_CALL_IDS_MAP_KEY = "__openai_function_call_ids__";
-function isBuiltInTool(tool) {
-    return "type" in tool && tool.type !== "function";
-}
-function isBuiltInToolChoice(tool_choice) {
-    return (tool_choice != null &&
-        typeof tool_choice === "object" &&
-        "type" in tool_choice &&
-        tool_choice.type !== "function");
-}
 function isReasoningModel(model) {
-    return model && /^o\d/.test(model);
+    return model && (/^o\d/.test(model) || model.startsWith("gpt-5"));
 }
 function isStructuredOutputMethodParams(x
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -322,6 +313,8 @@ export class BaseChatOpenAI extends BaseChatModel {
             "disableStreaming",
             "zdrEnabled",
             "reasoning",
+            "verbosity",
+            "promptCacheKey",
         ];
     }
     getLsParams(options) {
@@ -540,6 +533,17 @@ export class BaseChatOpenAI extends BaseChatModel {
             writable: true,
             value: void 0
         });
+        /**
+         * Used by OpenAI to cache responses for similar requests to optimize your cache
+         * hit rates.
+         * [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
+         */
+        Object.defineProperty(this, "promptCacheKey", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "defaultOptions", {
             enumerable: true,
             configurable: true,
@@ -579,6 +583,7 @@ export class BaseChatOpenAI extends BaseChatModel {
         this.reasoning = fields?.reasoning;
         this.maxTokens = fields?.maxCompletionTokens ?? fields?.maxTokens;
         this.disableStreaming = fields?.disableStreaming ?? this.disableStreaming;
+        this.promptCacheKey = fields?.promptCacheKey ?? this.promptCacheKey;
         this.streaming = fields?.streaming ?? false;
         if (this.disableStreaming)
             this.streaming = false;
@@ -672,7 +677,10 @@ export class BaseChatOpenAI extends BaseChatModel {
     }
     // TODO: move to completions class
     _convertChatOpenAIToolToCompletionsTool(tool, fields) {
-        if (isOpenAITool(tool)) {
+        if (isCustomTool(tool)) {
+            return convertResponsesCustomTool(tool.metadata.customTool);
+        }
+        if (isOpenAIFunctionTool(tool)) {
             if (fields?.strict !== undefined) {
                 return {
                     ...tool,
@@ -1076,6 +1084,7 @@ export class ChatOpenAIResponses extends BaseChatOpenAI {
             })(),
             parallel_tool_calls: options?.parallel_tool_calls,
             max_output_tokens: this.maxTokens === -1 ? undefined : this.maxTokens,
+            prompt_cache_key: options?.promptCacheKey ?? this.promptCacheKey,
             ...(this.zdrEnabled ? { store: false } : {}),
             ...this.modelKwargs,
         };
@@ -1238,6 +1247,15 @@ export class ChatOpenAIResponses extends BaseChatOpenAI {
             else if (item.type === "reasoning") {
                 additional_kwargs.reasoning = item;
             }
+            else if (item.type === "custom_tool_call") {
+                const parsed = parseCustomToolCall(item);
+                if (parsed) {
+                    tool_calls.push(parsed);
+                }
+                else {
+                    invalid_tool_calls.push(makeInvalidToolCall(item, "Malformed custom tool call"));
+                }
+            }
             else {
                 additional_kwargs.tool_outputs ??= [];
                 additional_kwargs.tool_outputs.push(item);
@@ -1304,6 +1322,7 @@ export class ChatOpenAIResponses extends BaseChatOpenAI {
                 "mcp_list_tools",
                 "mcp_approval_request",
                 "image_generation_call",
+                "custom_tool_call",
             ].includes(chunk.item.type)) {
             additional_kwargs.tool_outputs = [chunk.item];
         }
@@ -1445,6 +1464,14 @@ export class ChatOpenAIResponses extends BaseChatOpenAI {
                         call_id: toolMessage.tool_call_id,
                     };
                 }
+                // Handle custom tool output
+                if (toolMessage.metadata?.customTool) {
+                    return {
+                        type: "custom_tool_call_output",
+                        call_id: toolMessage.tool_call_id,
+                        output: toolMessage.content,
+                    };
+                }
                 return {
                     type: "function_call_output",
                     call_id: toolMessage.tool_call_id,
@@ -1483,41 +1510,54 @@ export class ChatOpenAIResponses extends BaseChatOpenAI {
                         { type: "refusal", refusal: additional_kwargs.refusal },
                     ];
                 }
-                input.push({
-                    type: "message",
-                    role: "assistant",
-                    ...(lcMsg.id && !this.zdrEnabled && lcMsg.id.startsWith("msg_")
-                        ? { id: lcMsg.id }
-                        : {}),
-                    content: typeof content === "string"
-                        ? content
-                        : content.flatMap((item) => {
-                            if (item.type === "text") {
-                                return {
-                                    type: "output_text",
-                                    text: item.text,
-                                    // @ts-expect-error TODO: add types for `annotations`
-                                    annotations: item.annotations ?? [],
-                                };
-                            }
-                            if (item.type === "output_text" ||
-                                item.type === "refusal") {
-                                return item;
-                            }
-                            return [];
-                        }),
-                });
+                if (typeof content === "string" || content.length > 0) {
+                    input.push({
+                        type: "message",
+                        role: "assistant",
+                        ...(lcMsg.id && !this.zdrEnabled && lcMsg.id.startsWith("msg_")
+                            ? { id: lcMsg.id }
+                            : {}),
+                        content: typeof content === "string"
+                            ? content
+                            : content.flatMap((item) => {
+                                if (item.type === "text") {
+                                    return {
+                                        type: "output_text",
+                                        text: item.text,
+                                        // @ts-expect-error TODO: add types for `annotations`
+                                        annotations: item.annotations ?? [],
+                                    };
+                                }
+                                if (item.type === "output_text" ||
+                                    item.type === "refusal") {
+                                    return item;
+                                }
+                                return [];
+                            }),
+                    });
+                }
                 const functionCallIds = additional_kwargs?.[_FUNCTION_CALL_IDS_MAP_KEY];
                 if (isAIMessage(lcMsg) && !!lcMsg.tool_calls?.length) {
-                    input.push(...lcMsg.tool_calls.map((toolCall) => ({
-                        type: "function_call",
-                        name: toolCall.name,
-                        arguments: JSON.stringify(toolCall.args),
-                        call_id: toolCall.id,
-                        ...(this.zdrEnabled
-                            ? { id: functionCallIds?.[toolCall.id] }
-                            : {}),
-                    })));
+                    input.push(...lcMsg.tool_calls.map((toolCall) => {
+                        if (isCustomToolCall(toolCall)) {
+                            return {
+                                type: "custom_tool_call",
+                                id: toolCall.call_id,
+                                call_id: toolCall.id ?? "",
+                                input: toolCall.args.input,
+                                name: toolCall.name,
+                            };
+                        }
+                        return {
+                            type: "function_call",
+                            name: toolCall.name,
+                            arguments: JSON.stringify(toolCall.args),
+                            call_id: toolCall.id,
+                            ...(this.zdrEnabled
+                                ? { id: functionCallIds?.[toolCall.id] }
+                                : {}),
+                        };
+                    }));
                 }
                 else if (additional_kwargs?.tool_calls) {
                     input.push(...additional_kwargs.tool_calls.map((toolCall) => ({
@@ -1628,7 +1668,7 @@ export class ChatOpenAIResponses extends BaseChatOpenAI {
                 }
                 reducedTools.push(tool);
             }
-            else if (isOpenAITool(tool)) {
+            else if (isOpenAIFunctionTool(tool)) {
                 reducedTools.push({
                     type: "function",
                     name: tool.function.name,
@@ -1637,6 +1677,9 @@ export class ChatOpenAIResponses extends BaseChatOpenAI {
                     strict: fields?.strict ?? null,
                 });
             }
+            else if (isOpenAICustomTool(tool)) {
+                reducedTools.push(convertCompletionsCustomTool(tool));
+            }
         }
         return reducedTools;
     }
@@ -1693,6 +1736,7 @@ export class ChatOpenAICompletions extends BaseChatOpenAI {
                 ? { modalities: this.modalities || options?.modalities }
                 : {}),
             ...this.modelKwargs,
+            prompt_cache_key: options?.promptCacheKey ?? this.promptCacheKey,
         };
         if (options?.prediction !== undefined) {
             params.prediction = options.prediction;
@@ -1940,6 +1984,7 @@ export class ChatOpenAICompletions extends BaseChatOpenAI {
                     return await this.client.chat.completions.parse(request, clientOptions);
                 }
                 else {
+                    console.log("request", request);
                     return await this.client.chat.completions.create(request, clientOptions);
                 }
             }
@@ -2668,7 +2713,11 @@ export class ChatOpenAI extends BaseChatOpenAI {
             options?.include != null ||
             options?.reasoning?.summary != null ||
             this.reasoning?.summary != null;
-        return this.useResponsesApi || usesBuiltInTools || hasResponsesOnlyKwargs;
+        const hasCustomTools = options?.tools?.some(isOpenAICustomTool);
+        return (this.useResponsesApi ||
+            usesBuiltInTools ||
+            hasResponsesOnlyKwargs ||
+            hasCustomTools);
     }
     getLsParams(options) {
         const optionsWithDefaults = this._combineCallOptions(options);

package/dist/index.cjs

@@ -14,7 +14,7 @@ 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 });
-exports.convertPromptToOpenAI = exports.toFile = exports.OpenAIClient = void 0;
+exports.customTool = exports.convertPromptToOpenAI = exports.toFile = exports.OpenAIClient = void 0;
 var openai_1 = require("openai");
 Object.defineProperty(exports, "OpenAIClient", { enumerable: true, get: function () { return openai_1.OpenAI; } });
 Object.defineProperty(exports, "toFile", { enumerable: true, get: function () { return openai_1.toFile; } });
@@ -30,3 +30,5 @@ __exportStar(require("./utils/azure.cjs"), exports);
 __exportStar(require("./tools/index.cjs"), exports);
 var prompts_js_1 = require("./utils/prompts.cjs");
 Object.defineProperty(exports, "convertPromptToOpenAI", { enumerable: true, get: function () { return prompts_js_1.convertPromptToOpenAI; } });
+var custom_js_1 = require("./tools/custom.cjs");
+Object.defineProperty(exports, "customTool", { enumerable: true, get: function () { return custom_js_1.customTool; } });

package/dist/index.d.ts

@@ -10,3 +10,4 @@ export * from "./utils/openai.js";
 export * from "./utils/azure.js";
 export * from "./tools/index.js";
 export { convertPromptToOpenAI } from "./utils/prompts.js";
+export { customTool } from "./tools/custom.js";

package/dist/index.js

@@ -10,3 +10,4 @@ export * from "./utils/openai.js";
 export * from "./utils/azure.js";
 export * from "./tools/index.js";
 export { convertPromptToOpenAI } from "./utils/prompts.js";
+export { customTool } from "./tools/custom.js";

package/dist/tools/custom.cjs

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.customTool = customTool;
+const runnables_1 = require("@langchain/core/runnables");
+const singletons_1 = require("@langchain/core/singletons");
+const tools_1 = require("@langchain/core/tools");
+function customTool(func, fields) {
+    return new tools_1.DynamicTool({
+        ...fields,
+        description: "",
+        metadata: {
+            customTool: fields,
+        },
+        func: async (input, runManager, config) => new Promise((resolve, reject) => {
+            const childConfig = (0, runnables_1.patchConfig)(config, {
+                callbacks: runManager?.getChild(),
+            });
+            void singletons_1.AsyncLocalStorageProviderSingleton.runWithConfig((0, runnables_1.pickRunnableConfigKeys)(childConfig), async () => {
+                try {
+                    resolve(func(input, childConfig));
+                }
+                catch (e) {
+                    reject(e);
+                }
+            });
+        }),
+    });
+}

package/dist/tools/custom.d.ts

@@ -0,0 +1,5 @@
+import { RunnableFunc } from "@langchain/core/runnables";
+import { DynamicTool, ToolRunnableConfig } from "@langchain/core/tools";
+import OpenAI from "openai";
+export type CustomToolFields = Omit<OpenAI.Responses.CustomTool, "type">;
+export declare function customTool(func: RunnableFunc<string, string, ToolRunnableConfig>, fields: CustomToolFields): DynamicTool<string>;

package/dist/tools/custom.js

@@ -0,0 +1,25 @@
+import { patchConfig, pickRunnableConfigKeys, } from "@langchain/core/runnables";
+import { AsyncLocalStorageProviderSingleton } from "@langchain/core/singletons";
+import { DynamicTool } from "@langchain/core/tools";
+export function customTool(func, fields) {
+    return new DynamicTool({
+        ...fields,
+        description: "",
+        metadata: {
+            customTool: fields,
+        },
+        func: async (input, runManager, config) => new Promise((resolve, reject) => {
+            const childConfig = patchConfig(config, {
+                callbacks: runManager?.getChild(),
+            });
+            void AsyncLocalStorageProviderSingleton.runWithConfig(pickRunnableConfigKeys(childConfig), async () => {
+                try {
+                    resolve(func(input, childConfig));
+                }
+                catch (e) {
+                    reject(e);
+                }
+            });
+        }),
+    });
+}

package/dist/types.d.ts

@@ -1,5 +1,5 @@
 import type { OpenAI as OpenAIClient } from "openai";
-import type { ResponseFormatText, ResponseFormatJSONObject, ResponseFormatJSONSchema } from "openai/resources/shared";
+import type { ResponseFormatText, ResponseFormatJSONObject, ResponseFormatJSONSchema, ResponseFormatTextPython, ResponseFormatTextGrammar } from "openai/resources/shared";
 import { TiktokenModel } from "js-tiktoken/lite";
 import type { BaseLanguageModelCallOptions } from "@langchain/core/language_models/base";
 import { InteropZodObject } from "@langchain/core/utils/types";
@@ -76,6 +76,8 @@ export declare interface OpenAIBaseInput {
      * `OPENAI_API_KEY` environment variable.
      */
     apiKey?: string;
+    /** The verbosity of the model's response. */
+    verbosity: "low" | "medium" | "high";
 }
 export type OpenAICoreRequestOptions = OpenAIClient.RequestOptions;
 export interface OpenAICallOptions extends BaseLanguageModelCallOptions {
@@ -154,6 +156,12 @@ export interface OpenAIChatInput extends OpenAIBaseInput {
      * Specifies the service tier for prioritization and latency optimization.
      */
     service_tier?: OpenAIClient.Responses.ResponseCreateParams["service_tier"];
+    /**
+     * Used by OpenAI to cache responses for similar requests to optimize your cache
+     * hit rates. Replaces the `user` field.
+     * [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
+     */
+    promptCacheKey?: string;
 }
 export interface AzureOpenAIInput {
     /**
@@ -241,4 +249,5 @@ export type ChatOpenAIReasoningSummary = Omit<OpenAIClient.Responses.ResponseRea
         index?: number;
     }>;
 };
-export type ChatOpenAIResponseFormat = ResponseFormatText | ResponseFormatJSONObject | ChatOpenAIResponseFormatJSONSchema;
+export type ChatOpenAIResponseFormat = ResponseFormatText | ResponseFormatJSONObject | ResponseFormatTextGrammar | ResponseFormatTextPython | ChatOpenAIResponseFormatJSONSchema;
+export type ResponseFormatConfiguration = ResponseFormatText | ResponseFormatJSONObject | ResponseFormatJSONSchema;

package/dist/utils/tools.cjs

@@ -1,6 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports._convertToOpenAITool = _convertToOpenAITool;
+exports.isBuiltInTool = isBuiltInTool;
+exports.isBuiltInToolChoice = isBuiltInToolChoice;
+exports.isCustomTool = isCustomTool;
+exports.isOpenAICustomTool = isOpenAICustomTool;
+exports.parseCustomToolCall = parseCustomToolCall;
+exports.isCustomToolCall = isCustomToolCall;
+exports.convertCompletionsCustomTool = convertCompletionsCustomTool;
+exports.convertResponsesCustomTool = convertResponsesCustomTool;
 const function_calling_1 = require("@langchain/core/utils/function_calling");
 const openai_js_1 = require("./openai.cjs");
 /**
@@ -24,8 +32,113 @@ tool, fields) {
     else {
         toolDef = tool;
     }
-    if (fields?.strict !== undefined) {
+    if (toolDef.type === "function" && fields?.strict !== undefined) {
         toolDef.function.strict = fields.strict;
     }
     return toolDef;
 }
+function isBuiltInTool(tool) {
+    return "type" in tool && tool.type !== "function" && tool.type !== "custom";
+}
+function isBuiltInToolChoice(tool_choice) {
+    return (tool_choice != null &&
+        typeof tool_choice === "object" &&
+        "type" in tool_choice &&
+        tool_choice.type !== "function");
+}
+function isCustomTool(tool) {
+    return (typeof tool === "object" &&
+        tool !== null &&
+        "metadata" in tool &&
+        typeof tool.metadata === "object" &&
+        tool.metadata !== null &&
+        "customTool" in tool.metadata &&
+        typeof tool.metadata.customTool === "object" &&
+        tool.metadata.customTool !== null);
+}
+function isOpenAICustomTool(tool) {
+    return ("type" in tool &&
+        tool.type === "custom" &&
+        "custom" in tool &&
+        typeof tool.custom === "object" &&
+        tool.custom !== null);
+}
+function parseCustomToolCall(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+rawToolCall) {
+    if (rawToolCall.type !== "custom_tool_call") {
+        return undefined;
+    }
+    return {
+        ...rawToolCall,
+        type: "tool_call",
+        call_id: rawToolCall.id,
+        id: rawToolCall.call_id,
+        name: rawToolCall.name,
+        isCustomTool: true,
+        args: {
+            input: rawToolCall.input,
+        },
+    };
+}
+function isCustomToolCall(toolCall) {
+    return (toolCall.type === "tool_call" &&
+        "isCustomTool" in toolCall &&
+        toolCall.isCustomTool === true);
+}
+function convertCompletionsCustomTool(tool) {
+    const getFormat = () => {
+        if (!tool.custom.format) {
+            return undefined;
+        }
+        if (tool.custom.format.type === "grammar") {
+            return {
+                type: "grammar",
+                definition: tool.custom.format.grammar.definition,
+                syntax: tool.custom.format.grammar.syntax,
+            };
+        }
+        if (tool.custom.format.type === "text") {
+            return {
+                type: "text",
+            };
+        }
+        return undefined;
+    };
+    return {
+        type: "custom",
+        name: tool.custom.name,
+        description: tool.custom.description,
+        format: getFormat(),
+    };
+}
+function convertResponsesCustomTool(tool) {
+    const getFormat = () => {
+        if (!tool.format) {
+            return undefined;
+        }
+        if (tool.format.type === "grammar") {
+            return {
+                type: "grammar",
+                grammar: {
+                    definition: tool.format.definition,
+                    syntax: tool.format.syntax,
+                },
+            };
+        }
+        if (tool.format.type === "text") {
+            return {
+                type: "text",
+            };
+        }
+        return undefined;
+    };
+    return {
+        type: "custom",
+        custom: {
+            name: tool.name,
+            description: tool.description,
+            format: getFormat(),
+        },
+    };
+}

package/dist/utils/tools.d.ts

@@ -1,5 +1,11 @@
 import { OpenAI as OpenAIClient } from "openai";
+import { ToolCall } from "@langchain/core/messages/tool";
 import { BindToolsInput } from "@langchain/core/language_models/chat_models";
+import { DynamicTool } from "@langchain/core/tools";
+import { OpenAIToolChoice } from "./openai.js";
+export type ResponsesTool = NonNullable<OpenAIClient.Responses.ResponseCreateParams["tools"]>[number];
+export type ResponsesToolChoice = NonNullable<OpenAIClient.Responses.ResponseCreateParams["tool_choice"]>;
+export type ChatOpenAIToolType = BindToolsInput | OpenAIClient.Chat.ChatCompletionTool | ResponsesTool;
 /**
  * Formats a tool in either OpenAI format, or LangChain structured tool format
  * into an OpenAI tool format. If the tool is already in OpenAI format, return without
@@ -18,3 +24,21 @@ export declare function _convertToOpenAITool(tool: BindToolsInput, fields?: {
      */
     strict?: boolean;
 }): OpenAIClient.ChatCompletionTool;
+export declare function isBuiltInTool(tool: ChatOpenAIToolType): tool is ResponsesTool;
+export declare function isBuiltInToolChoice(tool_choice: OpenAIToolChoice | ResponsesToolChoice | undefined): tool_choice is ResponsesToolChoice;
+export type CustomToolCall = ToolCall & {
+    call_id: string;
+    isCustomTool: true;
+};
+type LangchainCustomTool = DynamicTool<string> & {
+    metadata: {
+        customTool: OpenAIClient.Responses.CustomTool;
+    };
+};
+export declare function isCustomTool(tool: unknown): tool is LangchainCustomTool;
+export declare function isOpenAICustomTool(tool: ChatOpenAIToolType): tool is OpenAIClient.Chat.ChatCompletionCustomTool;
+export declare function parseCustomToolCall(rawToolCall: Record<string, any>): CustomToolCall | undefined;
+export declare function isCustomToolCall(toolCall: ToolCall): toolCall is CustomToolCall;
+export declare function convertCompletionsCustomTool(tool: OpenAIClient.Chat.ChatCompletionCustomTool): OpenAIClient.Responses.CustomTool;
+export declare function convertResponsesCustomTool(tool: OpenAIClient.Responses.CustomTool): OpenAIClient.Chat.ChatCompletionCustomTool;
+export {};

package/dist/utils/tools.js

@@ -21,8 +21,113 @@ tool, fields) {
     else {
         toolDef = tool;
     }
-    if (fields?.strict !== undefined) {
+    if (toolDef.type === "function" && fields?.strict !== undefined) {
         toolDef.function.strict = fields.strict;
     }
     return toolDef;
 }
+export function isBuiltInTool(tool) {
+    return "type" in tool && tool.type !== "function" && tool.type !== "custom";
+}
+export function isBuiltInToolChoice(tool_choice) {
+    return (tool_choice != null &&
+        typeof tool_choice === "object" &&
+        "type" in tool_choice &&
+        tool_choice.type !== "function");
+}
+export function isCustomTool(tool) {
+    return (typeof tool === "object" &&
+        tool !== null &&
+        "metadata" in tool &&
+        typeof tool.metadata === "object" &&
+        tool.metadata !== null &&
+        "customTool" in tool.metadata &&
+        typeof tool.metadata.customTool === "object" &&
+        tool.metadata.customTool !== null);
+}
+export function isOpenAICustomTool(tool) {
+    return ("type" in tool &&
+        tool.type === "custom" &&
+        "custom" in tool &&
+        typeof tool.custom === "object" &&
+        tool.custom !== null);
+}
+export function parseCustomToolCall(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+rawToolCall) {
+    if (rawToolCall.type !== "custom_tool_call") {
+        return undefined;
+    }
+    return {
+        ...rawToolCall,
+        type: "tool_call",
+        call_id: rawToolCall.id,
+        id: rawToolCall.call_id,
+        name: rawToolCall.name,
+        isCustomTool: true,
+        args: {
+            input: rawToolCall.input,
+        },
+    };
+}
+export function isCustomToolCall(toolCall) {
+    return (toolCall.type === "tool_call" &&
+        "isCustomTool" in toolCall &&
+        toolCall.isCustomTool === true);
+}
+export function convertCompletionsCustomTool(tool) {
+    const getFormat = () => {
+        if (!tool.custom.format) {
+            return undefined;
+        }
+        if (tool.custom.format.type === "grammar") {
+            return {
+                type: "grammar",
+                definition: tool.custom.format.grammar.definition,
+                syntax: tool.custom.format.grammar.syntax,
+            };
+        }
+        if (tool.custom.format.type === "text") {
+            return {
+                type: "text",
+            };
+        }
+        return undefined;
+    };
+    return {
+        type: "custom",
+        name: tool.custom.name,
+        description: tool.custom.description,
+        format: getFormat(),
+    };
+}
+export function convertResponsesCustomTool(tool) {
+    const getFormat = () => {
+        if (!tool.format) {
+            return undefined;
+        }
+        if (tool.format.type === "grammar") {
+            return {
+                type: "grammar",
+                grammar: {
+                    definition: tool.format.definition,
+                    syntax: tool.format.syntax,
+                },
+            };
+        }
+        if (tool.format.type === "text") {
+            return {
+                type: "text",
+            };
+        }
+        return undefined;
+    };
+    return {
+        type: "custom",
+        custom: {
+            name: tool.name,
+            description: tool.description,
+            format: getFormat(),
+        },
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/openai",
-  "version": "0.6.5",
+  "version": "0.6.6",
   "description": "OpenAI integrations for LangChain.js",
   "type": "module",
   "engines": {
@@ -40,7 +40,7 @@
     "zod": "^3.25.32"
   },
   "peerDependencies": {
-    "@langchain/core": ">=0.3.58 <0.4.0"
+    "@langchain/core": ">=0.3.68 <0.4.0"
   },
   "devDependencies": {
     "@azure/identity": "^4.2.1",