@langchain/openai 0.4.2 → 0.4.4

package/dist/azure/chat_models.cjs

@@ -440,6 +440,20 @@ class AzureChatOpenAI extends chat_models_js_1.ChatOpenAI {
             azureOpenAIApiKey: "AZURE_OPENAI_API_KEY",
         };
     }
+    get lc_serializable_keys() {
+        return [
+            ...super.lc_serializable_keys,
+            "azureOpenAIApiKey",
+            "azureOpenAIApiVersion",
+            "azureOpenAIBasePath",
+            "azureOpenAIEndpoint",
+            "azureOpenAIApiInstanceName",
+            "azureOpenAIApiDeploymentName",
+            "deploymentName",
+            "openAIApiKey",
+            "openAIApiVersion",
+        ];
+    }
     constructor(fields) {
         super(fields);
         Object.defineProperty(this, "azureOpenAIApiVersion", {
@@ -540,11 +554,14 @@ class AzureChatOpenAI extends chat_models_js_1.ChatOpenAI {
             if (!params.baseURL) {
                 delete params.baseURL;
             }
+            let env = (0, env_1.getEnv)();
+            if (env === "node" || env === "deno") {
+                env = `(${env}/${process.version}; ${process.platform}; ${process.arch})`;
+            }
+            const specifiedUserAgent = params.defaultHeaders?.["User-Agent"];
             params.defaultHeaders = {
                 ...params.defaultHeaders,
-                "User-Agent": params.defaultHeaders?.["User-Agent"]
-                    ? `${params.defaultHeaders["User-Agent"]}: langchainjs-azure-openai-v2`
-                    : `langchainjs-azure-openai-v2`,
+                "User-Agent": `langchainjs-azure-openai/2.0.0 (${env})${specifiedUserAgent ? ` ${specifiedUserAgent}` : ""}`,
             };
             this.client = new openai_1.AzureOpenAI({
                 apiVersion: this.azureOpenAIApiVersion,

package/dist/azure/chat_models.d.ts

@@ -432,6 +432,7 @@ export declare class AzureChatOpenAI extends ChatOpenAI {
     get lc_secrets(): {
         [key: string]: string;
     } | undefined;
+    get lc_serializable_keys(): string[];
     constructor(fields?: Partial<OpenAIChatInput> & Partial<AzureOpenAIInput> & {
         openAIApiKey?: string;
         openAIApiVersion?: string;

package/dist/azure/chat_models.js

@@ -1,5 +1,5 @@
 import { AzureOpenAI as AzureOpenAIClient } from "openai";
-import { getEnvironmentVariable } from "@langchain/core/utils/env";
+import { getEnv, getEnvironmentVariable } from "@langchain/core/utils/env";
 import { ChatOpenAI, } from "../chat_models.js";
 import { getEndpoint } from "../utils/azure.js";
 /**
@@ -437,6 +437,20 @@ export class AzureChatOpenAI extends ChatOpenAI {
             azureOpenAIApiKey: "AZURE_OPENAI_API_KEY",
         };
     }
+    get lc_serializable_keys() {
+        return [
+            ...super.lc_serializable_keys,
+            "azureOpenAIApiKey",
+            "azureOpenAIApiVersion",
+            "azureOpenAIBasePath",
+            "azureOpenAIEndpoint",
+            "azureOpenAIApiInstanceName",
+            "azureOpenAIApiDeploymentName",
+            "deploymentName",
+            "openAIApiKey",
+            "openAIApiVersion",
+        ];
+    }
     constructor(fields) {
         super(fields);
         Object.defineProperty(this, "azureOpenAIApiVersion", {
@@ -537,11 +551,14 @@ export class AzureChatOpenAI extends ChatOpenAI {
             if (!params.baseURL) {
                 delete params.baseURL;
             }
+            let env = getEnv();
+            if (env === "node" || env === "deno") {
+                env = `(${env}/${process.version}; ${process.platform}; ${process.arch})`;
+            }
+            const specifiedUserAgent = params.defaultHeaders?.["User-Agent"];
             params.defaultHeaders = {
                 ...params.defaultHeaders,
-                "User-Agent": params.defaultHeaders?.["User-Agent"]
-                    ? `${params.defaultHeaders["User-Agent"]}: langchainjs-azure-openai-v2`
-                    : `langchainjs-azure-openai-v2`,
+                "User-Agent": `langchainjs-azure-openai/2.0.0 (${env})${specifiedUserAgent ? ` ${specifiedUserAgent}` : ""}`,
             };
             this.client = new AzureOpenAIClient({
                 apiVersion: this.azureOpenAIApiVersion,

package/dist/chat_models.cjs

@@ -55,7 +55,7 @@ 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")) {
+        if (role === "system" && isReasoningModel(model)) {
             role = "developer";
         }
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -112,6 +112,9 @@ function _convertChatOpenAIToolTypeToOpenAITool(tool, fields) {
     }
     return (0, tools_js_1._convertToOpenAITool)(tool, fields);
 }
+function isReasoningModel(model) {
+    return model?.startsWith("o1") || model?.startsWith("o3");
+}
 /**
  * OpenAI chat model integration.
  *
@@ -682,6 +685,44 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             apiKey: "openai_api_key",
         };
     }
+    get lc_serializable_keys() {
+        return [
+            "configuration",
+            "logprobs",
+            "topLogprobs",
+            "prefixMessages",
+            "supportsStrictToolCalling",
+            "modalities",
+            "audio",
+            "reasoningEffort",
+            "temperature",
+            "maxTokens",
+            "topP",
+            "frequencyPenalty",
+            "presencePenalty",
+            "n",
+            "logitBias",
+            "user",
+            "streaming",
+            "streamUsage",
+            "modelName",
+            "model",
+            "modelKwargs",
+            "stop",
+            "stopSequences",
+            "timeout",
+            "openAIApiKey",
+            "apiKey",
+            "cache",
+            "maxConcurrency",
+            "maxRetries",
+            "verbose",
+            "callbacks",
+            "tags",
+            "metadata",
+            "disableStreaming",
+        ];
+    }
     constructor(fields) {
         super(fields ?? {});
         Object.defineProperty(this, "lc_serializable", {
@@ -880,7 +921,6 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
         this.topP = fields?.topP ?? this.topP;
         this.frequencyPenalty = fields?.frequencyPenalty ?? this.frequencyPenalty;
         this.presencePenalty = fields?.presencePenalty ?? this.presencePenalty;
-        this.maxTokens = fields?.maxTokens;
         this.logprobs = fields?.logprobs;
         this.topLogprobs = fields?.topLogprobs;
         this.n = fields?.n ?? this.n;
@@ -892,6 +932,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
         this.audio = fields?.audio;
         this.modalities = fields?.modalities;
         this.reasoningEffort = fields?.reasoningEffort;
+        this.maxTokens = fields?.maxCompletionTokens ?? fields?.maxTokens;
         if (this.model === "o1") {
             this.disableStreaming = true;
         }
@@ -968,7 +1009,6 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             top_p: this.topP,
             frequency_penalty: this.frequencyPenalty,
             presence_penalty: this.presencePenalty,
-            max_tokens: this.maxTokens === -1 ? undefined : this.maxTokens,
             logprobs: this.logprobs,
             top_logprobs: this.topLogprobs,
             n: this.n,
@@ -1002,6 +1042,13 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
         if (reasoningEffort !== undefined) {
             params.reasoning_effort = reasoningEffort;
         }
+        if (isReasoningModel(params.model)) {
+            params.max_completion_tokens =
+                this.maxTokens === -1 ? undefined : this.maxTokens;
+        }
+        else {
+            params.max_tokens = this.maxTokens === -1 ? undefined : this.maxTokens;
+        }
         return params;
     }
     _convertOpenAIChatCompletionMessageToBaseMessage(message, rawResponse) {

package/dist/chat_models.d.ts

@@ -655,6 +655,7 @@ export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = Chat
         [key: string]: string;
     } | undefined;
     get lc_aliases(): Record<string, string>;
+    get lc_serializable_keys(): string[];
     temperature?: number;
     topP?: number;
     frequencyPenalty?: number;

package/dist/chat_models.js

@@ -51,7 +51,7 @@ 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")) {
+        if (role === "system" && isReasoningModel(model)) {
             role = "developer";
         }
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -107,6 +107,9 @@ function _convertChatOpenAIToolTypeToOpenAITool(tool, fields) {
     }
     return _convertToOpenAITool(tool, fields);
 }
+function isReasoningModel(model) {
+    return model?.startsWith("o1") || model?.startsWith("o3");
+}
 /**
  * OpenAI chat model integration.
  *
@@ -677,6 +680,44 @@ export class ChatOpenAI extends BaseChatModel {
             apiKey: "openai_api_key",
         };
     }
+    get lc_serializable_keys() {
+        return [
+            "configuration",
+            "logprobs",
+            "topLogprobs",
+            "prefixMessages",
+            "supportsStrictToolCalling",
+            "modalities",
+            "audio",
+            "reasoningEffort",
+            "temperature",
+            "maxTokens",
+            "topP",
+            "frequencyPenalty",
+            "presencePenalty",
+            "n",
+            "logitBias",
+            "user",
+            "streaming",
+            "streamUsage",
+            "modelName",
+            "model",
+            "modelKwargs",
+            "stop",
+            "stopSequences",
+            "timeout",
+            "openAIApiKey",
+            "apiKey",
+            "cache",
+            "maxConcurrency",
+            "maxRetries",
+            "verbose",
+            "callbacks",
+            "tags",
+            "metadata",
+            "disableStreaming",
+        ];
+    }
     constructor(fields) {
         super(fields ?? {});
         Object.defineProperty(this, "lc_serializable", {
@@ -875,7 +916,6 @@ export class ChatOpenAI extends BaseChatModel {
         this.topP = fields?.topP ?? this.topP;
         this.frequencyPenalty = fields?.frequencyPenalty ?? this.frequencyPenalty;
         this.presencePenalty = fields?.presencePenalty ?? this.presencePenalty;
-        this.maxTokens = fields?.maxTokens;
         this.logprobs = fields?.logprobs;
         this.topLogprobs = fields?.topLogprobs;
         this.n = fields?.n ?? this.n;
@@ -887,6 +927,7 @@ export class ChatOpenAI extends BaseChatModel {
         this.audio = fields?.audio;
         this.modalities = fields?.modalities;
         this.reasoningEffort = fields?.reasoningEffort;
+        this.maxTokens = fields?.maxCompletionTokens ?? fields?.maxTokens;
         if (this.model === "o1") {
             this.disableStreaming = true;
         }
@@ -963,7 +1004,6 @@ export class ChatOpenAI extends BaseChatModel {
             top_p: this.topP,
             frequency_penalty: this.frequencyPenalty,
             presence_penalty: this.presencePenalty,
-            max_tokens: this.maxTokens === -1 ? undefined : this.maxTokens,
             logprobs: this.logprobs,
             top_logprobs: this.topLogprobs,
             n: this.n,
@@ -997,6 +1037,13 @@ export class ChatOpenAI extends BaseChatModel {
         if (reasoningEffort !== undefined) {
             params.reasoning_effort = reasoningEffort;
         }
+        if (isReasoningModel(params.model)) {
+            params.max_completion_tokens =
+                this.maxTokens === -1 ? undefined : this.maxTokens;
+        }
+        else {
+            params.max_tokens = this.maxTokens === -1 ? undefined : this.maxTokens;
+        }
         return params;
     }
     _convertOpenAIChatCompletionMessageToBaseMessage(message, rawResponse) {

package/dist/types.d.ts

@@ -12,6 +12,12 @@ export declare interface OpenAIBaseInput {
      * tokens as possible given the prompt and the model's maximum context size.
      */
     maxTokens?: number;
+    /**
+     * Maximum number of tokens to generate in the completion. -1 returns as many
+     * tokens as possible given the prompt and the model's maximum context size.
+     * Alias for `maxTokens` for reasoning models.
+     */
+    maxCompletionTokens?: number;
     /** Total probability mass of tokens to consider at each step */
     topP: number;
     /** Penalizes repeated tokens according to frequency */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/openai",
-  "version": "0.4.2",
+  "version": "0.4.4",
   "description": "OpenAI integrations for LangChain.js",
   "type": "module",
   "engines": {
@@ -41,7 +41,7 @@
     "zod-to-json-schema": "^3.22.3"
   },
   "peerDependencies": {
-    "@langchain/core": ">=0.3.29 <0.4.0"
+    "@langchain/core": ">=0.3.39 <0.4.0"
   },
   "devDependencies": {
     "@azure/identity": "^4.2.1",