@langchain/openai 0.6.0 → 0.6.2

package/dist/azure/chat_models.cjs

@@ -531,6 +531,7 @@ class AzureChatOpenAI extends chat_models_js_1.ChatOpenAI {
         params.ls_provider = "azure";
         return params;
     }
+    /** @internal */
     _getClientOptions(options) {
         if (!this.client) {
             const openAIEndpointConfig = {

package/dist/azure/chat_models.d.ts

@@ -442,7 +442,8 @@ export declare class AzureChatOpenAI extends ChatOpenAI {
         configuration?: ClientOptions;
     });
     getLsParams(options: this["ParsedCallOptions"]): LangSmithParams;
-    protected _getClientOptions(options: OpenAICoreRequestOptions | undefined): OpenAICoreRequestOptions;
+    /** @internal */
+    _getClientOptions(options: OpenAICoreRequestOptions | undefined): OpenAICoreRequestOptions;
     toJSON(): any;
     withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: InteropZodType<RunOutput> | Record<string, any>, config?: StructuredOutputMethodOptions<false>): Runnable<BaseLanguageModelInput, RunOutput>;
     withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: InteropZodType<RunOutput> | Record<string, any>, config?: StructuredOutputMethodOptions<true>): Runnable<BaseLanguageModelInput, {

package/dist/azure/chat_models.js

@@ -528,6 +528,7 @@ export class AzureChatOpenAI extends ChatOpenAI {
         params.ls_provider = "azure";
         return params;
     }
+    /** @internal */
     _getClientOptions(options) {
         if (!this.client) {
             const openAIEndpointConfig = {

package/dist/chat_models.cjs

@@ -288,7 +288,7 @@ class BaseChatOpenAI extends chat_models_1.BaseChatModel {
     get lc_aliases() {
         return {
             apiKey: "openai_api_key",
-            model: "model_name",
+            modelName: "model",
         };
     }
     get lc_serializable_keys() {
@@ -311,6 +311,7 @@ class BaseChatOpenAI extends chat_models_1.BaseChatModel {
             "streaming",
             "streamUsage",
             "model",
+            "modelName",
             "modelKwargs",
             "stop",
             "stopSequences",
@@ -542,6 +543,12 @@ class BaseChatOpenAI extends chat_models_1.BaseChatModel {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "defaultOptions", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "lc_serializable", {
             enumerable: true,
             configurable: true,
@@ -636,6 +643,13 @@ class BaseChatOpenAI extends chat_models_1.BaseChatModel {
         }
         return resFormat;
     }
+    _combineCallOptions(additionalOptions) {
+        return {
+            ...this.defaultOptions,
+            ...(additionalOptions ?? {}),
+        };
+    }
+    /** @internal */
     _getClientOptions(options) {
         if (!this.client) {
             const openAIEndpointConfig = {
@@ -690,6 +704,12 @@ class BaseChatOpenAI extends chat_models_1.BaseChatModel {
             ...kwargs,
         });
     }
+    async stream(input, options) {
+        return super.stream(input, this._combineCallOptions(options));
+    }
+    async invoke(input, options) {
+        return super.invoke(input, this._combineCallOptions(options));
+    }
     /** @ignore */
     _combineLLMOutput(...llmOutputs) {
         return llmOutputs.reduce((acc, llmOutput) => {
@@ -2615,6 +2635,9 @@ class ChatOpenAI extends BaseChatOpenAI {
         this.useResponsesApi = fields?.useResponsesApi ?? false;
         this.responses = new ChatOpenAIResponses(fields);
         this.completions = new ChatOpenAICompletions(fields);
+        // Override `_getClientOptions` so sub classes of ChatOpenAI use the same client config
+        this.responses._getClientOptions = this._getClientOptions;
+        this.completions._getClientOptions = this._getClientOptions;
     }
     _useResponsesApi(options) {
         const usesBuiltInTools = options?.tools?.some(isBuiltInTool);
@@ -2626,6 +2649,20 @@ class ChatOpenAI extends BaseChatOpenAI {
             this.reasoning?.summary != null;
         return this.useResponsesApi || usesBuiltInTools || hasResponsesOnlyKwargs;
     }
+    getLsParams(options) {
+        const optionsWithDefaults = this._combineCallOptions(options);
+        if (this._useResponsesApi(options)) {
+            return this.responses.getLsParams(optionsWithDefaults);
+        }
+        return this.completions.getLsParams(optionsWithDefaults);
+    }
+    invocationParams(options) {
+        const optionsWithDefaults = this._combineCallOptions(options);
+        if (this._useResponsesApi(options)) {
+            return this.responses.invocationParams(optionsWithDefaults);
+        }
+        return this.completions.invocationParams(optionsWithDefaults);
+    }
     /** @ignore */
     async _generate(messages, options, runManager) {
         if (this._useResponsesApi(options)) {
@@ -2635,33 +2672,14 @@ class ChatOpenAI extends BaseChatOpenAI {
     }
     async *_streamResponseChunks(messages, options, runManager) {
         if (this._useResponsesApi(options)) {
-            yield* this.responses._streamResponseChunks(messages, options);
+            yield* this.responses._streamResponseChunks(messages, this._combineCallOptions(options));
             return;
         }
-        yield* this.completions._streamResponseChunks(messages, options, runManager);
+        yield* this.completions._streamResponseChunks(messages, this._combineCallOptions(options), runManager);
     }
     withConfig(config) {
-        // FIXME: assigning additional config options to the inner chat classes this way
-        // is awkward, but it's the only way to preserve the original object identity
-        // and still thread config options, which is important since this class is a "proxy"
-        // for the inner chat classes. This will be fixed in a later version of langchain
-        // when the core runnable interface is improved (0.4) to support this out of the box.
-        const bindChatOpenAIConfig = (cls, config) => {
-            const oldGenerate = cls._generate;
-            const oldStreamResponseChunks = cls._streamResponseChunks;
-            return Object.assign(cls, {
-                _generate(messages, options, runManager) {
-                    return oldGenerate.call(cls, messages, { ...options, ...config }, runManager);
-                },
-                _streamResponseChunks(messages, options, runManager) {
-                    return oldStreamResponseChunks.call(cls, messages, { ...options, ...config }, runManager);
-                },
-            });
-        };
-        this.responses = bindChatOpenAIConfig(this.responses, config);
-        this.completions = bindChatOpenAIConfig(this.completions, config);
-        // Proxy chat class is also bound for `_useResponsesApi`,
-        return bindChatOpenAIConfig(this, config);
+        this.defaultOptions = { ...this.defaultOptions, ...config };
+        return this;
     }
 }
 exports.ChatOpenAI = ChatOpenAI;

package/dist/chat_models.d.ts

@@ -168,6 +168,7 @@ declare abstract class BaseChatOpenAI<CallOptions extends BaseChatOpenAICallOpti
      * Specifies the service tier for prioritization and latency optimization.
      */
     service_tier?: OpenAIClient.Chat.ChatCompletionCreateParams["service_tier"];
+    protected defaultOptions: CallOptions;
     _llmType(): string;
     static lc_name(): string;
     get callKeys(): string[];
@@ -199,11 +200,15 @@ declare abstract class BaseChatOpenAI<CallOptions extends BaseChatOpenAICallOpti
      * @internal
      */
     protected _getResponseFormat(resFormat?: CallOptions["response_format"]): ResponseFormatText | ResponseFormatJSONObject | ResponseFormatJSONSchema | undefined;
-    protected _getClientOptions(options: OpenAICoreRequestOptions | undefined): OpenAICoreRequestOptions;
+    protected _combineCallOptions(additionalOptions?: this["ParsedCallOptions"]): this["ParsedCallOptions"];
+    /** @internal */
+    _getClientOptions(options: OpenAICoreRequestOptions | undefined): OpenAICoreRequestOptions;
     protected _convertChatOpenAIToolToCompletionsTool(tool: ChatOpenAIToolType, fields?: {
         strict?: boolean;
     }): OpenAIClient.ChatCompletionTool;
     bindTools(tools: ChatOpenAIToolType[], kwargs?: Partial<CallOptions>): Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions>;
+    stream(input: BaseLanguageModelInput, options?: CallOptions): Promise<import("@langchain/core/utils/stream").IterableReadableStream<AIMessageChunk>>;
+    invoke(input: BaseLanguageModelInput, options?: CallOptions): Promise<AIMessageChunk>;
     /** @ignore */
     _combineLLMOutput(...llmOutputs: OpenAILLMOutput[]): OpenAILLMOutput;
     getNumTokensFromMessages(messages: BaseMessage[]): Promise<{
@@ -863,6 +868,8 @@ export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = Chat
     get lc_serializable_keys(): string[];
     constructor(fields?: ChatOpenAIFields);
     protected _useResponsesApi(options: this["ParsedCallOptions"] | undefined): boolean;
+    getLsParams(options: this["ParsedCallOptions"]): LangSmithParams;
+    invocationParams(options?: this["ParsedCallOptions"]): ChatResponsesInvocationParams | ChatCompletionsInvocationParams;
     /** @ignore */
     _generate(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): Promise<ChatResult>;
     _streamResponseChunks(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): AsyncGenerator<ChatGenerationChunk>;

package/dist/chat_models.js

@@ -283,7 +283,7 @@ class BaseChatOpenAI extends BaseChatModel {
     get lc_aliases() {
         return {
             apiKey: "openai_api_key",
-            model: "model_name",
+            modelName: "model",
         };
     }
     get lc_serializable_keys() {
@@ -306,6 +306,7 @@ class BaseChatOpenAI extends BaseChatModel {
             "streaming",
             "streamUsage",
             "model",
+            "modelName",
             "modelKwargs",
             "stop",
             "stopSequences",
@@ -537,6 +538,12 @@ class BaseChatOpenAI extends BaseChatModel {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "defaultOptions", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "lc_serializable", {
             enumerable: true,
             configurable: true,
@@ -631,6 +638,13 @@ class BaseChatOpenAI extends BaseChatModel {
         }
         return resFormat;
     }
+    _combineCallOptions(additionalOptions) {
+        return {
+            ...this.defaultOptions,
+            ...(additionalOptions ?? {}),
+        };
+    }
+    /** @internal */
     _getClientOptions(options) {
         if (!this.client) {
             const openAIEndpointConfig = {
@@ -685,6 +699,12 @@ class BaseChatOpenAI extends BaseChatModel {
             ...kwargs,
         });
     }
+    async stream(input, options) {
+        return super.stream(input, this._combineCallOptions(options));
+    }
+    async invoke(input, options) {
+        return super.invoke(input, this._combineCallOptions(options));
+    }
     /** @ignore */
     _combineLLMOutput(...llmOutputs) {
         return llmOutputs.reduce((acc, llmOutput) => {
@@ -2608,6 +2628,9 @@ export class ChatOpenAI extends BaseChatOpenAI {
         this.useResponsesApi = fields?.useResponsesApi ?? false;
         this.responses = new ChatOpenAIResponses(fields);
         this.completions = new ChatOpenAICompletions(fields);
+        // Override `_getClientOptions` so sub classes of ChatOpenAI use the same client config
+        this.responses._getClientOptions = this._getClientOptions;
+        this.completions._getClientOptions = this._getClientOptions;
     }
     _useResponsesApi(options) {
         const usesBuiltInTools = options?.tools?.some(isBuiltInTool);
@@ -2619,6 +2642,20 @@ export class ChatOpenAI extends BaseChatOpenAI {
             this.reasoning?.summary != null;
         return this.useResponsesApi || usesBuiltInTools || hasResponsesOnlyKwargs;
     }
+    getLsParams(options) {
+        const optionsWithDefaults = this._combineCallOptions(options);
+        if (this._useResponsesApi(options)) {
+            return this.responses.getLsParams(optionsWithDefaults);
+        }
+        return this.completions.getLsParams(optionsWithDefaults);
+    }
+    invocationParams(options) {
+        const optionsWithDefaults = this._combineCallOptions(options);
+        if (this._useResponsesApi(options)) {
+            return this.responses.invocationParams(optionsWithDefaults);
+        }
+        return this.completions.invocationParams(optionsWithDefaults);
+    }
     /** @ignore */
     async _generate(messages, options, runManager) {
         if (this._useResponsesApi(options)) {
@@ -2628,32 +2665,13 @@ export class ChatOpenAI extends BaseChatOpenAI {
     }
     async *_streamResponseChunks(messages, options, runManager) {
         if (this._useResponsesApi(options)) {
-            yield* this.responses._streamResponseChunks(messages, options);
+            yield* this.responses._streamResponseChunks(messages, this._combineCallOptions(options));
             return;
         }
-        yield* this.completions._streamResponseChunks(messages, options, runManager);
+        yield* this.completions._streamResponseChunks(messages, this._combineCallOptions(options), runManager);
     }
     withConfig(config) {
-        // FIXME: assigning additional config options to the inner chat classes this way
-        // is awkward, but it's the only way to preserve the original object identity
-        // and still thread config options, which is important since this class is a "proxy"
-        // for the inner chat classes. This will be fixed in a later version of langchain
-        // when the core runnable interface is improved (0.4) to support this out of the box.
-        const bindChatOpenAIConfig = (cls, config) => {
-            const oldGenerate = cls._generate;
-            const oldStreamResponseChunks = cls._streamResponseChunks;
-            return Object.assign(cls, {
-                _generate(messages, options, runManager) {
-                    return oldGenerate.call(cls, messages, { ...options, ...config }, runManager);
-                },
-                _streamResponseChunks(messages, options, runManager) {
-                    return oldStreamResponseChunks.call(cls, messages, { ...options, ...config }, runManager);
-                },
-            });
-        };
-        this.responses = bindChatOpenAIConfig(this.responses, config);
-        this.completions = bindChatOpenAIConfig(this.completions, config);
-        // Proxy chat class is also bound for `_useResponsesApi`,
-        return bindChatOpenAIConfig(this, config);
+        this.defaultOptions = { ...this.defaultOptions, ...config };
+        return this;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/openai",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "description": "OpenAI integrations for LangChain.js",
   "type": "module",
   "engines": {
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@azure/identity": "^4.2.1",
     "@jest/globals": "^29.5.0",
-    "@langchain/core": "0.3.62",
+    "@langchain/core": "workspace:*",
     "@langchain/scripts": ">=0.1.0 <0.2.0",
     "@langchain/standard-tests": "0.0.0",
     "@swc/core": "^1.3.90",
@@ -102,4 +102,4 @@
     "index.d.ts",
     "index.d.cts"
   ]
-}
+}