@langchain/openai 0.3.14 → 0.3.16

package/dist/chat_models.cjs

@@ -18,6 +18,7 @@ const openai_format_fndef_js_1 = require("./utils/openai-format-fndef.cjs");
 const tools_js_1 = require("./utils/tools.cjs");
 function extractGenericMessageCustomRole(message) {
     if (message.role !== "system" &&
+        message.role !== "developer" &&
         message.role !== "assistant" &&
         message.role !== "user" &&
         message.role !== "function" &&
@@ -71,13 +72,15 @@ function openAIResponseToChatMessage(message, rawResponse, includeRawResponse) {
             if (includeRawResponse !== undefined) {
                 additional_kwargs.__raw_response = rawResponse;
             }
-            let response_metadata;
-            if (rawResponse.system_fingerprint) {
-                response_metadata = {
-                    usage: { ...rawResponse.usage },
-                    system_fingerprint: rawResponse.system_fingerprint,
-                };
-            }
+            const response_metadata = {
+                model_name: rawResponse.model,
+                ...(rawResponse.system_fingerprint
+                    ? {
+                        usage: { ...rawResponse.usage },
+                        system_fingerprint: rawResponse.system_fingerprint,
+                    }
+                    : {}),
+            };
             if (message.audio) {
                 additional_kwargs.audio = message.audio;
             }
@@ -150,6 +153,15 @@ delta, rawResponse, defaultRole, includeRawResponse) {
     else if (role === "system") {
         return new messages_1.SystemMessageChunk({ content, response_metadata });
     }
+    else if (role === "developer") {
+        return new messages_1.SystemMessageChunk({
+            content,
+            response_metadata,
+            additional_kwargs: {
+                __openai_role__: "developer",
+            },
+        });
+    }
     else if (role === "function") {
         return new messages_1.FunctionMessageChunk({
             content,
@@ -171,12 +183,16 @@ delta, rawResponse, defaultRole, includeRawResponse) {
     }
 }
 // Used in LangSmith, export is important here
-function _convertMessagesToOpenAIParams(messages) {
+function _convertMessagesToOpenAIParams(messages, model) {
     // TODO: Function messages do not support array content, fix cast
     return messages.flatMap((message) => {
+        let role = messageToOpenAIRole(message);
+        if (role === "system" && model?.startsWith("o1")) {
+            role = "developer";
+        }
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const completionParam = {
-            role: messageToOpenAIRole(message),
+            role,
             content: message.content,
         };
         if (message.name != null) {
@@ -779,6 +795,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             "promptIndex",
             "response_format",
             "seed",
+            "reasoning_effort",
         ];
     }
     get lc_secrets() {
@@ -1018,6 +1035,12 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "reasoningEffort", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.openAIApiKey =
             fields?.apiKey ??
                 fields?.openAIApiKey ??
@@ -1068,6 +1091,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
         this.__includeRawResponse = fields?.__includeRawResponse;
         this.audio = fields?.audio;
         this.modalities = fields?.modalities;
+        this.reasoningEffort = fields?.reasoningEffort;
         if (this.azureOpenAIApiKey || this.azureADTokenProvider) {
             if (!this.azureOpenAIApiInstanceName &&
                 !this.azureOpenAIBasePath &&
@@ -1200,6 +1224,10 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
         if (options?.prediction !== undefined) {
             params.prediction = options.prediction;
         }
+        const reasoningEffort = options?.reasoning_effort ?? this.reasoningEffort;
+        if (reasoningEffort !== undefined) {
+            params.reasoning_effort = reasoningEffort;
+        }
         return params;
     }
     /** @ignore */
@@ -1211,7 +1239,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
         };
     }
     async *_streamResponseChunks(messages, options, runManager) {
-        const messagesMapped = _convertMessagesToOpenAIParams(messages);
+        const messagesMapped = _convertMessagesToOpenAIParams(messages, this.model);
         const params = {
             ...this.invocationParams(options, {
                 streaming: true,
@@ -1251,6 +1279,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
                 // Only include system fingerprint in the last chunk for now
                 // to avoid concatenation issues
                 generationInfo.system_fingerprint = data.system_fingerprint;
+                generationInfo.model_name = data.model;
             }
             if (this.logprobs) {
                 generationInfo.logprobs = choice.logprobs;
@@ -1317,7 +1346,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
     async _generate(messages, options, runManager) {
         const usageMetadata = {};
         const params = this.invocationParams(options);
-        const messagesMapped = _convertMessagesToOpenAIParams(messages);
+        const messagesMapped = _convertMessagesToOpenAIParams(messages, this.model);
         if (params.stream) {
             const stream = this._streamResponseChunks(messages, options, runManager);
             const finalChunks = {};
@@ -1430,9 +1459,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
                 }
                 // Fields are not serialized unless passed to the constructor
                 // Doing this ensures all fields on the message are serialized
-                generation.message = new messages_1.AIMessage({
-                    ...generation.message,
-                });
+                generation.message = new messages_1.AIMessage(Object.fromEntries(Object.entries(generation.message).filter(([key]) => !key.startsWith("lc_"))));
                 generations.push(generation);
             }
             return {

package/dist/chat_models.d.ts

@@ -17,10 +17,10 @@ interface TokenUsage {
 interface OpenAILLMOutput {
     tokenUsage: TokenUsage;
 }
-type OpenAIRoleEnum = "system" | "assistant" | "user" | "function" | "tool";
+type OpenAIRoleEnum = "system" | "developer" | "assistant" | "user" | "function" | "tool";
 type OpenAICompletionParam = OpenAIClient.Chat.Completions.ChatCompletionMessageParam;
 export declare function messageToOpenAIRole(message: BaseMessage): OpenAIRoleEnum;
-export declare function _convertMessagesToOpenAIParams(messages: BaseMessage[]): OpenAICompletionParam[];
+export declare function _convertMessagesToOpenAIParams(messages: BaseMessage[], model?: string): OpenAICompletionParam[];
 type ChatOpenAIToolType = BindToolsInput | OpenAIClient.ChatCompletionTool;
 export interface ChatOpenAIStructuredOutputMethodOptions<IncludeRaw extends boolean> extends StructuredOutputMethodOptions<IncludeRaw> {
     /**
@@ -100,6 +100,11 @@ export interface ChatOpenAICallOptions extends OpenAICallOptions, BaseFunctionCa
      * [Learn more](https://platform.openai.com/docs/guides/latency-optimization#use-predicted-outputs).
      */
     prediction?: OpenAIClient.ChatCompletionPredictionContent;
+    /**
+     * 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.
+     */
+    reasoning_effort?: OpenAIClient.Chat.ChatCompletionReasoningEffort;
 }
 export interface ChatOpenAIFields extends Partial<OpenAIChatInput>, Partial<AzureOpenAIInput>, BaseChatModelParams {
     configuration?: ClientOptions & LegacyOpenAIInput;
@@ -686,6 +691,7 @@ export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = Chat
     supportsStrictToolCalling?: boolean;
     audio?: OpenAIClient.Chat.ChatCompletionAudioParam;
     modalities?: Array<OpenAIClient.Chat.ChatCompletionModality>;
+    reasoningEffort?: OpenAIClient.Chat.ChatCompletionReasoningEffort;
     constructor(fields?: ChatOpenAIFields, 
     /** @deprecated */
     configuration?: ClientOptions & LegacyOpenAIInput);

package/dist/chat_models.js

@@ -15,6 +15,7 @@ import { formatFunctionDefinitions, } from "./utils/openai-format-fndef.js";
 import { _convertToOpenAITool } from "./utils/tools.js";
 function extractGenericMessageCustomRole(message) {
     if (message.role !== "system" &&
+        message.role !== "developer" &&
         message.role !== "assistant" &&
         message.role !== "user" &&
         message.role !== "function" &&
@@ -67,13 +68,15 @@ function openAIResponseToChatMessage(message, rawResponse, includeRawResponse) {
             if (includeRawResponse !== undefined) {
                 additional_kwargs.__raw_response = rawResponse;
             }
-            let response_metadata;
-            if (rawResponse.system_fingerprint) {
-                response_metadata = {
-                    usage: { ...rawResponse.usage },
-                    system_fingerprint: rawResponse.system_fingerprint,
-                };
-            }
+            const response_metadata = {
+                model_name: rawResponse.model,
+                ...(rawResponse.system_fingerprint
+                    ? {
+                        usage: { ...rawResponse.usage },
+                        system_fingerprint: rawResponse.system_fingerprint,
+                    }
+                    : {}),
+            };
             if (message.audio) {
                 additional_kwargs.audio = message.audio;
             }
@@ -146,6 +149,15 @@ delta, rawResponse, defaultRole, includeRawResponse) {
     else if (role === "system") {
         return new SystemMessageChunk({ content, response_metadata });
     }
+    else if (role === "developer") {
+        return new SystemMessageChunk({
+            content,
+            response_metadata,
+            additional_kwargs: {
+                __openai_role__: "developer",
+            },
+        });
+    }
     else if (role === "function") {
         return new FunctionMessageChunk({
             content,
@@ -167,12 +179,16 @@ delta, rawResponse, defaultRole, includeRawResponse) {
     }
 }
 // Used in LangSmith, export is important here
-export function _convertMessagesToOpenAIParams(messages) {
+export function _convertMessagesToOpenAIParams(messages, model) {
     // TODO: Function messages do not support array content, fix cast
     return messages.flatMap((message) => {
+        let role = messageToOpenAIRole(message);
+        if (role === "system" && model?.startsWith("o1")) {
+            role = "developer";
+        }
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const completionParam = {
-            role: messageToOpenAIRole(message),
+            role,
             content: message.content,
         };
         if (message.name != null) {
@@ -774,6 +790,7 @@ export class ChatOpenAI extends BaseChatModel {
             "promptIndex",
             "response_format",
             "seed",
+            "reasoning_effort",
         ];
     }
     get lc_secrets() {
@@ -1013,6 +1030,12 @@ export class ChatOpenAI extends BaseChatModel {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "reasoningEffort", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.openAIApiKey =
             fields?.apiKey ??
                 fields?.openAIApiKey ??
@@ -1063,6 +1086,7 @@ export class ChatOpenAI extends BaseChatModel {
         this.__includeRawResponse = fields?.__includeRawResponse;
         this.audio = fields?.audio;
         this.modalities = fields?.modalities;
+        this.reasoningEffort = fields?.reasoningEffort;
         if (this.azureOpenAIApiKey || this.azureADTokenProvider) {
             if (!this.azureOpenAIApiInstanceName &&
                 !this.azureOpenAIBasePath &&
@@ -1195,6 +1219,10 @@ export class ChatOpenAI extends BaseChatModel {
         if (options?.prediction !== undefined) {
             params.prediction = options.prediction;
         }
+        const reasoningEffort = options?.reasoning_effort ?? this.reasoningEffort;
+        if (reasoningEffort !== undefined) {
+            params.reasoning_effort = reasoningEffort;
+        }
         return params;
     }
     /** @ignore */
@@ -1206,7 +1234,7 @@ export class ChatOpenAI extends BaseChatModel {
         };
     }
     async *_streamResponseChunks(messages, options, runManager) {
-        const messagesMapped = _convertMessagesToOpenAIParams(messages);
+        const messagesMapped = _convertMessagesToOpenAIParams(messages, this.model);
         const params = {
             ...this.invocationParams(options, {
                 streaming: true,
@@ -1246,6 +1274,7 @@ export class ChatOpenAI extends BaseChatModel {
                 // Only include system fingerprint in the last chunk for now
                 // to avoid concatenation issues
                 generationInfo.system_fingerprint = data.system_fingerprint;
+                generationInfo.model_name = data.model;
             }
             if (this.logprobs) {
                 generationInfo.logprobs = choice.logprobs;
@@ -1312,7 +1341,7 @@ export class ChatOpenAI extends BaseChatModel {
     async _generate(messages, options, runManager) {
         const usageMetadata = {};
         const params = this.invocationParams(options);
-        const messagesMapped = _convertMessagesToOpenAIParams(messages);
+        const messagesMapped = _convertMessagesToOpenAIParams(messages, this.model);
         if (params.stream) {
             const stream = this._streamResponseChunks(messages, options, runManager);
             const finalChunks = {};
@@ -1425,9 +1454,7 @@ export class ChatOpenAI extends BaseChatModel {
                 }
                 // Fields are not serialized unless passed to the constructor
                 // Doing this ensures all fields on the message are serialized
-                generation.message = new AIMessage({
-                    ...generation.message,
-                });
+                generation.message = new AIMessage(Object.fromEntries(Object.entries(generation.message).filter(([key]) => !key.startsWith("lc_"))));
                 generations.push(generation);
             }
             return {

package/dist/types.d.ts

@@ -147,6 +147,11 @@ 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.
+     */
+    reasoningEffort?: OpenAIClient.ChatCompletionReasoningEffort;
 }
 export declare interface AzureOpenAIInput {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/openai",
-  "version": "0.3.14",
+  "version": "0.3.16",
   "description": "OpenAI integrations for LangChain.js",
   "type": "module",
   "engines": {
@@ -36,7 +36,7 @@
   "license": "MIT",
   "dependencies": {
     "js-tiktoken": "^1.0.12",
-    "openai": "^4.71.0",
+    "openai": "^4.77.0",
     "zod": "^3.22.4",
     "zod-to-json-schema": "^3.22.3"
   },