@langchain/openai 0.0.26 → 0.0.28

package/dist/chat_models.cjs

@@ -48,12 +48,30 @@ function messageToOpenAIRole(message) {
 }
 exports.messageToOpenAIRole = messageToOpenAIRole;
 function openAIResponseToChatMessage(message) {
+    const rawToolCalls = message.tool_calls;
     switch (message.role) {
-        case "assistant":
-            return new messages_1.AIMessage(message.content || "", {
-                function_call: message.function_call,
-                tool_calls: message.tool_calls,
+        case "assistant": {
+            const toolCalls = [];
+            const invalidToolCalls = [];
+            for (const rawToolCall of rawToolCalls ?? []) {
+                try {
+                    toolCalls.push((0, openai_tools_1.parseToolCall)(rawToolCall, { returnId: true }));
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                }
+                catch (e) {
+                    invalidToolCalls.push((0, openai_tools_1.makeInvalidToolCall)(rawToolCall, e.message));
+                }
+            }
+            return new messages_1.AIMessage({
+                content: message.content || "",
+                tool_calls: toolCalls,
+                invalid_tool_calls: invalidToolCalls,
+                additional_kwargs: {
+                    function_call: message.function_call,
+                    tool_calls: rawToolCalls,
+                },
             });
+        }
         default:
             return new messages_1.ChatMessage(message.content || "", message.role ?? "unknown");
     }
@@ -81,7 +99,22 @@ delta, defaultRole) {
         return new messages_1.HumanMessageChunk({ content });
     }
     else if (role === "assistant") {
-        return new messages_1.AIMessageChunk({ content, additional_kwargs });
+        const toolCallChunks = [];
+        if (Array.isArray(delta.tool_calls)) {
+            for (const rawToolCall of delta.tool_calls) {
+                toolCallChunks.push({
+                    name: rawToolCall.function?.name,
+                    args: rawToolCall.function?.arguments,
+                    id: rawToolCall.id,
+                    index: rawToolCall.index,
+                });
+            }
+        }
+        return new messages_1.AIMessageChunk({
+            content,
+            tool_call_chunks: toolCallChunks,
+            additional_kwargs,
+        });
     }
     else if (role === "system") {
         return new messages_1.SystemMessageChunk({ content });
@@ -118,11 +151,16 @@ function convertMessagesToOpenAIParams(messages) {
         if (message.additional_kwargs.function_call != null) {
             completionParam.function_call = message.additional_kwargs.function_call;
         }
-        if (message.additional_kwargs.tool_calls != null) {
-            completionParam.tool_calls = message.additional_kwargs.tool_calls;
+        if ((0, messages_1.isAIMessage)(message) && !!message.tool_calls?.length) {
+            completionParam.tool_calls = message.tool_calls.map(openai_tools_1.convertLangChainToolCallToOpenAI);
         }
-        if (message.tool_call_id != null) {
-            completionParam.tool_call_id = message.tool_call_id;
+        else {
+            if (message.additional_kwargs.tool_calls != null) {
+                completionParam.tool_calls = message.additional_kwargs.tool_calls;
+            }
+            if (message.tool_call_id != null) {
+                completionParam.tool_call_id = message.tool_call_id;
+            }
         }
         return completionParam;
     });
@@ -150,7 +188,7 @@ function convertMessagesToOpenAIParams(messages) {
  * // Create a new instance of ChatOpenAI with specific temperature and model name settings
  * const model = new ChatOpenAI({
  *   temperature: 0.9,
- *   modelName: "ft:gpt-3.5-turbo-0613:{ORG_NAME}::{MODEL_ID}",
+ *   model: "ft:gpt-3.5-turbo-0613:{ORG_NAME}::{MODEL_ID}",
  * });
  *
  * // Invoke the model with a message and await the response
@@ -181,6 +219,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
     get lc_secrets() {
         return {
             openAIApiKey: "OPENAI_API_KEY",
+            apiKey: "OPENAI_API_KEY",
             azureOpenAIApiKey: "AZURE_OPENAI_API_KEY",
             organization: "OPENAI_ORGANIZATION",
         };
@@ -189,6 +228,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
         return {
             modelName: "model",
             openAIApiKey: "openai_api_key",
+            apiKey: "openai_api_key",
             azureOpenAIApiVersion: "azure_openai_api_version",
             azureOpenAIApiKey: "azure_openai_api_key",
             azureOpenAIApiInstanceName: "azure_openai_api_instance_name",
@@ -247,6 +287,12 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             writable: true,
             value: "gpt-3.5-turbo"
         });
+        Object.defineProperty(this, "model", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "gpt-3.5-turbo"
+        });
         Object.defineProperty(this, "modelKwargs", {
             enumerable: true,
             configurable: true,
@@ -259,6 +305,12 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "stopSequences", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "user", {
             enumerable: true,
             configurable: true,
@@ -301,6 +353,12 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "apiKey", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "azureOpenAIApiVersion", {
             enumerable: true,
             configurable: true,
@@ -350,11 +408,14 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             value: void 0
         });
         this.openAIApiKey =
-            fields?.openAIApiKey ?? (0, env_1.getEnvironmentVariable)("OPENAI_API_KEY");
+            fields?.apiKey ??
+                fields?.openAIApiKey ??
+                (0, env_1.getEnvironmentVariable)("OPENAI_API_KEY");
+        this.apiKey = this.openAIApiKey;
         this.azureOpenAIApiKey =
             fields?.azureOpenAIApiKey ??
                 (0, env_1.getEnvironmentVariable)("AZURE_OPENAI_API_KEY");
-        if (!this.azureOpenAIApiKey && !this.openAIApiKey) {
+        if (!this.azureOpenAIApiKey && !this.apiKey) {
             throw new Error("OpenAI or Azure OpenAI API key not found");
         }
         this.azureOpenAIApiInstanceName =
@@ -372,7 +433,8 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
         this.organization =
             fields?.configuration?.organization ??
                 (0, env_1.getEnvironmentVariable)("OPENAI_ORGANIZATION");
-        this.modelName = fields?.modelName ?? this.modelName;
+        this.modelName = fields?.model ?? fields?.modelName ?? this.model;
+        this.model = this.modelName;
         this.modelKwargs = fields?.modelKwargs ?? {};
         this.timeout = fields?.timeout;
         this.temperature = fields?.temperature ?? this.temperature;
@@ -384,7 +446,8 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
         this.topLogprobs = fields?.topLogprobs;
         this.n = fields?.n ?? this.n;
         this.logitBias = fields?.logitBias;
-        this.stop = fields?.stop;
+        this.stop = fields?.stopSequences ?? fields?.stop;
+        this.stopSequences = this?.stop;
         this.user = fields?.user;
         this.streaming = fields?.streaming ?? false;
         if (this.azureOpenAIApiKey) {
@@ -397,10 +460,10 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             if (!this.azureOpenAIApiVersion) {
                 throw new Error("Azure OpenAI API version not found");
             }
-            this.openAIApiKey = this.openAIApiKey ?? "";
+            this.apiKey = this.apiKey ?? "";
         }
         this.clientConfig = {
-            apiKey: this.openAIApiKey,
+            apiKey: this.apiKey,
             organization: this.organization,
             baseURL: configuration?.basePath ?? fields?.configuration?.basePath,
             dangerouslyAllowBrowser: true,
@@ -412,6 +475,12 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             ...fields?.configuration,
         };
     }
+    bindTools(tools, kwargs) {
+        return this.bind({
+            tools: tools.map(function_calling_1.convertToOpenAITool),
+            ...kwargs,
+        });
+    }
     /**
      * Get the parameters used to invoke the model
      */
@@ -421,7 +490,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
                 tools.every((tool) => Array.isArray(tool.lc_namespace)));
         }
         const params = {
-            model: this.modelName,
+            model: this.model,
             temperature: this.temperature,
             top_p: this.topP,
             frequency_penalty: this.frequencyPenalty,
@@ -431,7 +500,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             top_logprobs: this.topLogprobs,
             n: this.n,
             logit_bias: this.logitBias,
-            stop: options?.stop ?? this.stop,
+            stop: options?.stop ?? this.stopSequences,
             user: this.user,
             stream: this.streaming,
             functions: options?.functions,
@@ -449,7 +518,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
     /** @ignore */
     _identifyingParams() {
         return {
-            model_name: this.modelName,
+            model_name: this.model,
             ...this.invocationParams(),
             ...this.clientConfig,
         };
@@ -634,7 +703,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
         let tokensPerMessage = 0;
         let tokensPerName = 0;
         // From: https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb
-        if (this.modelName === "gpt-3.5-turbo-0301") {
+        if (this.model === "gpt-3.5-turbo-0301") {
             tokensPerMessage = 4;
             tokensPerName = -1;
         }

package/dist/chat_models.d.ts

@@ -1,12 +1,12 @@
 import { type ClientOptions, OpenAI as OpenAIClient } from "openai";
 import { CallbackManagerForLLMRun } from "@langchain/core/callbacks/manager";
-import { type BaseMessage } from "@langchain/core/messages";
+import { AIMessageChunk, type BaseMessage } from "@langchain/core/messages";
 import { ChatGenerationChunk, type ChatResult } from "@langchain/core/outputs";
 import { type StructuredToolInterface } from "@langchain/core/tools";
 import { BaseChatModel, type BaseChatModelParams } from "@langchain/core/language_models/chat_models";
 import type { BaseFunctionCallOptions, BaseLanguageModelInput, StructuredOutputMethodOptions, StructuredOutputMethodParams } from "@langchain/core/language_models/base";
 import { z } from "zod";
-import { Runnable } from "@langchain/core/runnables";
+import { Runnable, RunnableInterface } from "@langchain/core/runnables";
 import type { AzureOpenAIInput, OpenAICallOptions, OpenAIChatInput, OpenAICoreRequestOptions, LegacyOpenAIInput } from "./types.js";
 export type { AzureOpenAIInput, OpenAICallOptions, OpenAIChatInput };
 interface TokenUsage {
@@ -51,7 +51,7 @@ export interface ChatOpenAICallOptions extends OpenAICallOptions, BaseFunctionCa
  * // Create a new instance of ChatOpenAI with specific temperature and model name settings
  * const model = new ChatOpenAI({
  *   temperature: 0.9,
- *   modelName: "ft:gpt-3.5-turbo-0613:{ORG_NAME}::{MODEL_ID}",
+ *   model: "ft:gpt-3.5-turbo-0613:{ORG_NAME}::{MODEL_ID}",
  * });
  *
  * // Invoke the model with a message and await the response
@@ -62,7 +62,7 @@ export interface ChatOpenAICallOptions extends OpenAICallOptions, BaseFunctionCa
  *
  * ```
  */
-export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = ChatOpenAICallOptions> extends BaseChatModel<CallOptions> implements OpenAIChatInput, AzureOpenAIInput {
+export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = ChatOpenAICallOptions> extends BaseChatModel<CallOptions, AIMessageChunk> implements OpenAIChatInput, AzureOpenAIInput {
     static lc_name(): string;
     get callKeys(): string[];
     lc_serializable: boolean;
@@ -77,8 +77,10 @@ export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = Chat
     n: number;
     logitBias?: Record<string, number>;
     modelName: string;
+    model: string;
     modelKwargs?: OpenAIChatInput["modelKwargs"];
     stop?: string[];
+    stopSequences?: string[];
     user?: string;
     timeout?: number;
     streaming: boolean;
@@ -86,6 +88,7 @@ export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = Chat
     logprobs?: boolean;
     topLogprobs?: number;
     openAIApiKey?: string;
+    apiKey?: string;
     azureOpenAIApiVersion?: string;
     azureOpenAIApiKey?: string;
     azureOpenAIApiInstanceName?: string;
@@ -99,6 +102,7 @@ export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = Chat
     }, 
     /** @deprecated */
     configuration?: ClientOptions & LegacyOpenAIInput);
+    bindTools(tools: (Record<string, unknown> | StructuredToolInterface)[], kwargs?: Partial<CallOptions>): RunnableInterface<BaseLanguageModelInput, AIMessageChunk, CallOptions>;
     /**
      * Get the parameters used to invoke the model
      */

package/dist/chat_models.js

@@ -1,12 +1,12 @@
 import { OpenAI as OpenAIClient } from "openai";
-import { AIMessage, AIMessageChunk, ChatMessage, ChatMessageChunk, FunctionMessageChunk, HumanMessageChunk, SystemMessageChunk, ToolMessageChunk, } from "@langchain/core/messages";
+import { AIMessage, AIMessageChunk, ChatMessage, ChatMessageChunk, FunctionMessageChunk, HumanMessageChunk, SystemMessageChunk, ToolMessageChunk, isAIMessage, } from "@langchain/core/messages";
 import { ChatGenerationChunk, } from "@langchain/core/outputs";
 import { getEnvironmentVariable } from "@langchain/core/utils/env";
 import { BaseChatModel, } from "@langchain/core/language_models/chat_models";
 import { convertToOpenAITool } from "@langchain/core/utils/function_calling";
 import { RunnablePassthrough, RunnableSequence, } from "@langchain/core/runnables";
 import { JsonOutputParser, StructuredOutputParser, } from "@langchain/core/output_parsers";
-import { JsonOutputKeyToolsParser } from "@langchain/core/output_parsers/openai_tools";
+import { JsonOutputKeyToolsParser, convertLangChainToolCallToOpenAI, makeInvalidToolCall, parseToolCall, } from "@langchain/core/output_parsers/openai_tools";
 import { zodToJsonSchema } from "zod-to-json-schema";
 import { getEndpoint } from "./utils/azure.js";
 import { wrapOpenAIClientError } from "./utils/openai.js";
@@ -44,12 +44,30 @@ export function messageToOpenAIRole(message) {
     }
 }
 function openAIResponseToChatMessage(message) {
+    const rawToolCalls = message.tool_calls;
     switch (message.role) {
-        case "assistant":
-            return new AIMessage(message.content || "", {
-                function_call: message.function_call,
-                tool_calls: message.tool_calls,
+        case "assistant": {
+            const toolCalls = [];
+            const invalidToolCalls = [];
+            for (const rawToolCall of rawToolCalls ?? []) {
+                try {
+                    toolCalls.push(parseToolCall(rawToolCall, { returnId: true }));
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                }
+                catch (e) {
+                    invalidToolCalls.push(makeInvalidToolCall(rawToolCall, e.message));
+                }
+            }
+            return new AIMessage({
+                content: message.content || "",
+                tool_calls: toolCalls,
+                invalid_tool_calls: invalidToolCalls,
+                additional_kwargs: {
+                    function_call: message.function_call,
+                    tool_calls: rawToolCalls,
+                },
             });
+        }
         default:
             return new ChatMessage(message.content || "", message.role ?? "unknown");
     }
@@ -77,7 +95,22 @@ delta, defaultRole) {
         return new HumanMessageChunk({ content });
     }
     else if (role === "assistant") {
-        return new AIMessageChunk({ content, additional_kwargs });
+        const toolCallChunks = [];
+        if (Array.isArray(delta.tool_calls)) {
+            for (const rawToolCall of delta.tool_calls) {
+                toolCallChunks.push({
+                    name: rawToolCall.function?.name,
+                    args: rawToolCall.function?.arguments,
+                    id: rawToolCall.id,
+                    index: rawToolCall.index,
+                });
+            }
+        }
+        return new AIMessageChunk({
+            content,
+            tool_call_chunks: toolCallChunks,
+            additional_kwargs,
+        });
     }
     else if (role === "system") {
         return new SystemMessageChunk({ content });
@@ -114,11 +147,16 @@ function convertMessagesToOpenAIParams(messages) {
         if (message.additional_kwargs.function_call != null) {
             completionParam.function_call = message.additional_kwargs.function_call;
         }
-        if (message.additional_kwargs.tool_calls != null) {
-            completionParam.tool_calls = message.additional_kwargs.tool_calls;
+        if (isAIMessage(message) && !!message.tool_calls?.length) {
+            completionParam.tool_calls = message.tool_calls.map(convertLangChainToolCallToOpenAI);
         }
-        if (message.tool_call_id != null) {
-            completionParam.tool_call_id = message.tool_call_id;
+        else {
+            if (message.additional_kwargs.tool_calls != null) {
+                completionParam.tool_calls = message.additional_kwargs.tool_calls;
+            }
+            if (message.tool_call_id != null) {
+                completionParam.tool_call_id = message.tool_call_id;
+            }
         }
         return completionParam;
     });
@@ -146,7 +184,7 @@ function convertMessagesToOpenAIParams(messages) {
  * // Create a new instance of ChatOpenAI with specific temperature and model name settings
  * const model = new ChatOpenAI({
  *   temperature: 0.9,
- *   modelName: "ft:gpt-3.5-turbo-0613:{ORG_NAME}::{MODEL_ID}",
+ *   model: "ft:gpt-3.5-turbo-0613:{ORG_NAME}::{MODEL_ID}",
  * });
  *
  * // Invoke the model with a message and await the response
@@ -177,6 +215,7 @@ export class ChatOpenAI extends BaseChatModel {
     get lc_secrets() {
         return {
             openAIApiKey: "OPENAI_API_KEY",
+            apiKey: "OPENAI_API_KEY",
             azureOpenAIApiKey: "AZURE_OPENAI_API_KEY",
             organization: "OPENAI_ORGANIZATION",
         };
@@ -185,6 +224,7 @@ export class ChatOpenAI extends BaseChatModel {
         return {
             modelName: "model",
             openAIApiKey: "openai_api_key",
+            apiKey: "openai_api_key",
             azureOpenAIApiVersion: "azure_openai_api_version",
             azureOpenAIApiKey: "azure_openai_api_key",
             azureOpenAIApiInstanceName: "azure_openai_api_instance_name",
@@ -243,6 +283,12 @@ export class ChatOpenAI extends BaseChatModel {
             writable: true,
             value: "gpt-3.5-turbo"
         });
+        Object.defineProperty(this, "model", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "gpt-3.5-turbo"
+        });
         Object.defineProperty(this, "modelKwargs", {
             enumerable: true,
             configurable: true,
@@ -255,6 +301,12 @@ export class ChatOpenAI extends BaseChatModel {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "stopSequences", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "user", {
             enumerable: true,
             configurable: true,
@@ -297,6 +349,12 @@ export class ChatOpenAI extends BaseChatModel {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "apiKey", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "azureOpenAIApiVersion", {
             enumerable: true,
             configurable: true,
@@ -346,11 +404,14 @@ export class ChatOpenAI extends BaseChatModel {
             value: void 0
         });
         this.openAIApiKey =
-            fields?.openAIApiKey ?? getEnvironmentVariable("OPENAI_API_KEY");
+            fields?.apiKey ??
+                fields?.openAIApiKey ??
+                getEnvironmentVariable("OPENAI_API_KEY");
+        this.apiKey = this.openAIApiKey;
         this.azureOpenAIApiKey =
             fields?.azureOpenAIApiKey ??
                 getEnvironmentVariable("AZURE_OPENAI_API_KEY");
-        if (!this.azureOpenAIApiKey && !this.openAIApiKey) {
+        if (!this.azureOpenAIApiKey && !this.apiKey) {
             throw new Error("OpenAI or Azure OpenAI API key not found");
         }
         this.azureOpenAIApiInstanceName =
@@ -368,7 +429,8 @@ export class ChatOpenAI extends BaseChatModel {
         this.organization =
             fields?.configuration?.organization ??
                 getEnvironmentVariable("OPENAI_ORGANIZATION");
-        this.modelName = fields?.modelName ?? this.modelName;
+        this.modelName = fields?.model ?? fields?.modelName ?? this.model;
+        this.model = this.modelName;
         this.modelKwargs = fields?.modelKwargs ?? {};
         this.timeout = fields?.timeout;
         this.temperature = fields?.temperature ?? this.temperature;
@@ -380,7 +442,8 @@ export class ChatOpenAI extends BaseChatModel {
         this.topLogprobs = fields?.topLogprobs;
         this.n = fields?.n ?? this.n;
         this.logitBias = fields?.logitBias;
-        this.stop = fields?.stop;
+        this.stop = fields?.stopSequences ?? fields?.stop;
+        this.stopSequences = this?.stop;
         this.user = fields?.user;
         this.streaming = fields?.streaming ?? false;
         if (this.azureOpenAIApiKey) {
@@ -393,10 +456,10 @@ export class ChatOpenAI extends BaseChatModel {
             if (!this.azureOpenAIApiVersion) {
                 throw new Error("Azure OpenAI API version not found");
             }
-            this.openAIApiKey = this.openAIApiKey ?? "";
+            this.apiKey = this.apiKey ?? "";
         }
         this.clientConfig = {
-            apiKey: this.openAIApiKey,
+            apiKey: this.apiKey,
             organization: this.organization,
             baseURL: configuration?.basePath ?? fields?.configuration?.basePath,
             dangerouslyAllowBrowser: true,
@@ -408,6 +471,12 @@ export class ChatOpenAI extends BaseChatModel {
             ...fields?.configuration,
         };
     }
+    bindTools(tools, kwargs) {
+        return this.bind({
+            tools: tools.map(convertToOpenAITool),
+            ...kwargs,
+        });
+    }
     /**
      * Get the parameters used to invoke the model
      */
@@ -417,7 +486,7 @@ export class ChatOpenAI extends BaseChatModel {
                 tools.every((tool) => Array.isArray(tool.lc_namespace)));
         }
         const params = {
-            model: this.modelName,
+            model: this.model,
             temperature: this.temperature,
             top_p: this.topP,
             frequency_penalty: this.frequencyPenalty,
@@ -427,7 +496,7 @@ export class ChatOpenAI extends BaseChatModel {
             top_logprobs: this.topLogprobs,
             n: this.n,
             logit_bias: this.logitBias,
-            stop: options?.stop ?? this.stop,
+            stop: options?.stop ?? this.stopSequences,
             user: this.user,
             stream: this.streaming,
             functions: options?.functions,
@@ -445,7 +514,7 @@ export class ChatOpenAI extends BaseChatModel {
     /** @ignore */
     _identifyingParams() {
         return {
-            model_name: this.modelName,
+            model_name: this.model,
             ...this.invocationParams(),
             ...this.clientConfig,
         };
@@ -630,7 +699,7 @@ export class ChatOpenAI extends BaseChatModel {
         let tokensPerMessage = 0;
         let tokensPerName = 0;
         // From: https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb
-        if (this.modelName === "gpt-3.5-turbo-0301") {
+        if (this.model === "gpt-3.5-turbo-0301") {
             tokensPerMessage = 4;
             tokensPerName = -1;
         }

package/dist/embeddings.cjs

@@ -32,6 +32,12 @@ class OpenAIEmbeddings extends embeddings_1.Embeddings {
             writable: true,
             value: "text-embedding-ada-002"
         });
+        Object.defineProperty(this, "model", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "text-embedding-ada-002"
+        });
         Object.defineProperty(this, "batchSize", {
             enumerable: true,
             configurable: true,
@@ -109,7 +115,8 @@ class OpenAIEmbeddings extends embeddings_1.Embeddings {
             writable: true,
             value: void 0
         });
-        let apiKey = fieldsWithDefaults?.openAIApiKey ??
+        let apiKey = fieldsWithDefaults?.apiKey ??
+            fieldsWithDefaults?.openAIApiKey ??
             (0, env_1.getEnvironmentVariable)("OPENAI_API_KEY");
         const azureApiKey = fieldsWithDefaults?.azureOpenAIApiKey ??
             (0, env_1.getEnvironmentVariable)("AZURE_OPENAI_API_KEY");
@@ -130,7 +137,9 @@ class OpenAIEmbeddings extends embeddings_1.Embeddings {
         this.organization =
             fieldsWithDefaults?.configuration?.organization ??
                 (0, env_1.getEnvironmentVariable)("OPENAI_ORGANIZATION");
-        this.modelName = fieldsWithDefaults?.modelName ?? this.modelName;
+        this.modelName =
+            fieldsWithDefaults?.model ?? fieldsWithDefaults?.modelName ?? this.model;
+        this.model = this.modelName;
         this.batchSize =
             fieldsWithDefaults?.batchSize ?? (azureApiKey ? 1 : this.batchSize);
         this.stripNewLines =
@@ -175,7 +184,7 @@ class OpenAIEmbeddings extends embeddings_1.Embeddings {
         const batches = (0, chunk_array_1.chunkArray)(this.stripNewLines ? texts.map((t) => t.replace(/\n/g, " ")) : texts, this.batchSize);
         const batchRequests = batches.map((batch) => {
             const params = {
-                model: this.modelName,
+                model: this.model,
                 input: batch,
             };
             if (this.dimensions) {
@@ -202,7 +211,7 @@ class OpenAIEmbeddings extends embeddings_1.Embeddings {
      */
     async embedQuery(text) {
         const params = {
-            model: this.modelName,
+            model: this.model,
             input: this.stripNewLines ? text.replace(/\n/g, " ") : text,
         };
         if (this.dimensions) {

package/dist/embeddings.d.ts

@@ -6,8 +6,13 @@ import { AzureOpenAIInput, LegacyOpenAIInput } from "./types.js";
  * defines additional parameters specific to the OpenAIEmbeddings class.
  */
 export interface OpenAIEmbeddingsParams extends EmbeddingsParams {
-    /** Model name to use */
+    /**
+     * Model name to use
+     * Alias for `model`
+     */
     modelName: string;
+    /** Model name to use */
+    model: string;
     /**
      * The number of dimensions the resulting output embeddings should have.
      * Only supported in `text-embedding-3` and later models.
@@ -46,6 +51,7 @@ export interface OpenAIEmbeddingsParams extends EmbeddingsParams {
  */
 export declare class OpenAIEmbeddings extends Embeddings implements OpenAIEmbeddingsParams, AzureOpenAIInput {
     modelName: string;
+    model: string;
     batchSize: number;
     stripNewLines: boolean;
     /**
@@ -64,7 +70,13 @@ export declare class OpenAIEmbeddings extends Embeddings implements OpenAIEmbedd
     private clientConfig;
     constructor(fields?: Partial<OpenAIEmbeddingsParams> & Partial<AzureOpenAIInput> & {
         verbose?: boolean;
+        /**
+         * The OpenAI API key to use.
+         * Alias for `apiKey`.
+         */
         openAIApiKey?: string;
+        /** The OpenAI API key to use. */
+        apiKey?: string;
         configuration?: ClientOptions;
     }, configuration?: ClientOptions & LegacyOpenAIInput);
     /**

package/dist/embeddings.js

@@ -29,6 +29,12 @@ export class OpenAIEmbeddings extends Embeddings {
             writable: true,
             value: "text-embedding-ada-002"
         });
+        Object.defineProperty(this, "model", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "text-embedding-ada-002"
+        });
         Object.defineProperty(this, "batchSize", {
             enumerable: true,
             configurable: true,
@@ -106,7 +112,8 @@ export class OpenAIEmbeddings extends Embeddings {
             writable: true,
             value: void 0
         });
-        let apiKey = fieldsWithDefaults?.openAIApiKey ??
+        let apiKey = fieldsWithDefaults?.apiKey ??
+            fieldsWithDefaults?.openAIApiKey ??
             getEnvironmentVariable("OPENAI_API_KEY");
         const azureApiKey = fieldsWithDefaults?.azureOpenAIApiKey ??
             getEnvironmentVariable("AZURE_OPENAI_API_KEY");
@@ -127,7 +134,9 @@ export class OpenAIEmbeddings extends Embeddings {
         this.organization =
             fieldsWithDefaults?.configuration?.organization ??
                 getEnvironmentVariable("OPENAI_ORGANIZATION");
-        this.modelName = fieldsWithDefaults?.modelName ?? this.modelName;
+        this.modelName =
+            fieldsWithDefaults?.model ?? fieldsWithDefaults?.modelName ?? this.model;
+        this.model = this.modelName;
         this.batchSize =
             fieldsWithDefaults?.batchSize ?? (azureApiKey ? 1 : this.batchSize);
         this.stripNewLines =
@@ -172,7 +181,7 @@ export class OpenAIEmbeddings extends Embeddings {
         const batches = chunkArray(this.stripNewLines ? texts.map((t) => t.replace(/\n/g, " ")) : texts, this.batchSize);
         const batchRequests = batches.map((batch) => {
             const params = {
-                model: this.modelName,
+                model: this.model,
                 input: batch,
             };
             if (this.dimensions) {
@@ -199,7 +208,7 @@ export class OpenAIEmbeddings extends Embeddings {
      */
     async embedQuery(text) {
         const params = {
-            model: this.modelName,
+            model: this.model,
             input: this.stripNewLines ? text.replace(/\n/g, " ") : text,
         };
         if (this.dimensions) {

package/dist/legacy.cjs

@@ -130,6 +130,12 @@ class OpenAIChat extends llms_1.LLM {
             writable: true,
             value: "gpt-3.5-turbo"
         });
+        Object.defineProperty(this, "model", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "gpt-3.5-turbo"
+        });
         Object.defineProperty(this, "prefixMessages", {
             enumerable: true,
             configurable: true,

package/dist/legacy.d.ts

@@ -69,6 +69,7 @@ export declare class OpenAIChat extends LLM<OpenAIChatCallOptions> implements Op
     logitBias?: Record<string, number>;
     maxTokens?: number;
     modelName: string;
+    model: string;
     prefixMessages?: OpenAIClient.Chat.ChatCompletionMessageParam[];
     modelKwargs?: OpenAIChatInput["modelKwargs"];
     timeout?: number;

package/dist/legacy.js

@@ -127,6 +127,12 @@ export class OpenAIChat extends LLM {
             writable: true,
             value: "gpt-3.5-turbo"
         });
+        Object.defineProperty(this, "model", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "gpt-3.5-turbo"
+        });
         Object.defineProperty(this, "prefixMessages", {
             enumerable: true,
             configurable: true,

package/dist/llms.cjs

@@ -53,6 +53,7 @@ class OpenAI extends llms_1.BaseLLM {
     get lc_secrets() {
         return {
             openAIApiKey: "OPENAI_API_KEY",
+            apiKey: "OPENAI_API_KEY",
             azureOpenAIApiKey: "AZURE_OPENAI_API_KEY",
             organization: "OPENAI_ORGANIZATION",
         };
@@ -61,6 +62,7 @@ class OpenAI extends llms_1.BaseLLM {
         return {
             modelName: "model",
             openAIApiKey: "openai_api_key",
+            apiKey: "openai_api_key",
             azureOpenAIApiVersion: "azure_openai_api_version",
             azureOpenAIApiKey: "azure_openai_api_key",
             azureOpenAIApiInstanceName: "azure_openai_api_instance_name",
@@ -70,9 +72,9 @@ class OpenAI extends llms_1.BaseLLM {
     constructor(fields, 
     /** @deprecated */
     configuration) {
-        if ((fields?.modelName?.startsWith("gpt-3.5-turbo") ||
-            fields?.modelName?.startsWith("gpt-4")) &&
-            !fields?.modelName?.includes("-instruct")) {
+        let model = fields?.model ?? fields?.modelName;
+        if ((model?.startsWith("gpt-3.5-turbo") || model?.startsWith("gpt-4")) &&
+            !model?.includes("-instruct")) {
             // eslint-disable-next-line no-constructor-return
             return new legacy_js_1.OpenAIChat(fields, configuration);
         }
@@ -137,6 +139,12 @@ class OpenAI extends llms_1.BaseLLM {
             writable: true,
             value: "gpt-3.5-turbo-instruct"
         });
+        Object.defineProperty(this, "model", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "gpt-3.5-turbo-instruct"
+        });
         Object.defineProperty(this, "modelKwargs", {
             enumerable: true,
             configurable: true,
@@ -161,6 +169,12 @@ class OpenAI extends llms_1.BaseLLM {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "stopSequences", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "user", {
             enumerable: true,
             configurable: true,
@@ -179,6 +193,12 @@ class OpenAI extends llms_1.BaseLLM {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "apiKey", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "azureOpenAIApiVersion", {
             enumerable: true,
             configurable: true,
@@ -227,12 +247,16 @@ class OpenAI extends llms_1.BaseLLM {
             writable: true,
             value: void 0
         });
+        model = model ?? this.model;
         this.openAIApiKey =
-            fields?.openAIApiKey ?? (0, env_1.getEnvironmentVariable)("OPENAI_API_KEY");
+            fields?.apiKey ??
+                fields?.openAIApiKey ??
+                (0, env_1.getEnvironmentVariable)("OPENAI_API_KEY");
+        this.apiKey = this.openAIApiKey;
         this.azureOpenAIApiKey =
             fields?.azureOpenAIApiKey ??
                 (0, env_1.getEnvironmentVariable)("AZURE_OPENAI_API_KEY");
-        if (!this.azureOpenAIApiKey && !this.openAIApiKey) {
+        if (!this.azureOpenAIApiKey && !this.apiKey) {
             throw new Error("OpenAI or Azure OpenAI API key not found");
         }
         this.azureOpenAIApiInstanceName =
@@ -252,7 +276,8 @@ class OpenAI extends llms_1.BaseLLM {
         this.organization =
             fields?.configuration?.organization ??
                 (0, env_1.getEnvironmentVariable)("OPENAI_ORGANIZATION");
-        this.modelName = fields?.modelName ?? this.modelName;
+        this.modelName = model;
+        this.model = model;
         this.modelKwargs = fields?.modelKwargs ?? {};
         this.batchSize = fields?.batchSize ?? this.batchSize;
         this.timeout = fields?.timeout;
@@ -264,7 +289,8 @@ class OpenAI extends llms_1.BaseLLM {
         this.n = fields?.n ?? this.n;
         this.bestOf = fields?.bestOf ?? this.bestOf;
         this.logitBias = fields?.logitBias;
-        this.stop = fields?.stop;
+        this.stop = fields?.stopSequences ?? fields?.stop;
+        this.stopSequences = fields?.stopSequences;
         this.user = fields?.user;
         this.streaming = fields?.streaming ?? false;
         if (this.streaming && this.bestOf && this.bestOf > 1) {
@@ -280,10 +306,10 @@ class OpenAI extends llms_1.BaseLLM {
             if (!this.azureOpenAIApiVersion) {
                 throw new Error("Azure OpenAI API version not found");
             }
-            this.openAIApiKey = this.openAIApiKey ?? "";
+            this.apiKey = this.apiKey ?? "";
         }
         this.clientConfig = {
-            apiKey: this.openAIApiKey,
+            apiKey: this.apiKey,
             organization: this.organization,
             baseURL: configuration?.basePath ?? fields?.configuration?.basePath,
             dangerouslyAllowBrowser: true,
@@ -300,7 +326,7 @@ class OpenAI extends llms_1.BaseLLM {
      */
     invocationParams(options) {
         return {
-            model: this.modelName,
+            model: this.model,
             temperature: this.temperature,
             max_tokens: this.maxTokens,
             top_p: this.topP,
@@ -309,7 +335,7 @@ class OpenAI extends llms_1.BaseLLM {
             n: this.n,
             best_of: this.bestOf,
             logit_bias: this.logitBias,
-            stop: options?.stop ?? this.stop,
+            stop: options?.stop ?? this.stopSequences,
             user: this.user,
             stream: this.streaming,
             ...this.modelKwargs,
@@ -318,7 +344,7 @@ class OpenAI extends llms_1.BaseLLM {
     /** @ignore */
     _identifyingParams() {
         return {
-            model_name: this.modelName,
+            model_name: this.model,
             ...this.invocationParams(),
             ...this.clientConfig,
         };
@@ -357,7 +383,7 @@ class OpenAI extends llms_1.BaseLLM {
             params.max_tokens = await (0, base_1.calculateMaxTokens)({
                 prompt: prompts[0],
                 // Cast here to allow for other models that may not fit the union
-                modelName: this.modelName,
+                modelName: this.model,
             });
         }
         for (let i = 0; i < subPrompts.length; i += 1) {

package/dist/llms.d.ts

@@ -55,13 +55,16 @@ export declare class OpenAI<CallOptions extends OpenAICallOptions = OpenAICallOp
     bestOf?: number;
     logitBias?: Record<string, number>;
     modelName: string;
+    model: string;
     modelKwargs?: OpenAIInput["modelKwargs"];
     batchSize: number;
     timeout?: number;
     stop?: string[];
+    stopSequences?: string[];
     user?: string;
     streaming: boolean;
     openAIApiKey?: string;
+    apiKey?: string;
     azureOpenAIApiVersion?: string;
     azureOpenAIApiKey?: string;
     azureOpenAIApiInstanceName?: string;

package/dist/llms.js

@@ -50,6 +50,7 @@ export class OpenAI extends BaseLLM {
     get lc_secrets() {
         return {
             openAIApiKey: "OPENAI_API_KEY",
+            apiKey: "OPENAI_API_KEY",
             azureOpenAIApiKey: "AZURE_OPENAI_API_KEY",
             organization: "OPENAI_ORGANIZATION",
         };
@@ -58,6 +59,7 @@ export class OpenAI extends BaseLLM {
         return {
             modelName: "model",
             openAIApiKey: "openai_api_key",
+            apiKey: "openai_api_key",
             azureOpenAIApiVersion: "azure_openai_api_version",
             azureOpenAIApiKey: "azure_openai_api_key",
             azureOpenAIApiInstanceName: "azure_openai_api_instance_name",
@@ -67,9 +69,9 @@ export class OpenAI extends BaseLLM {
     constructor(fields, 
     /** @deprecated */
     configuration) {
-        if ((fields?.modelName?.startsWith("gpt-3.5-turbo") ||
-            fields?.modelName?.startsWith("gpt-4")) &&
-            !fields?.modelName?.includes("-instruct")) {
+        let model = fields?.model ?? fields?.modelName;
+        if ((model?.startsWith("gpt-3.5-turbo") || model?.startsWith("gpt-4")) &&
+            !model?.includes("-instruct")) {
             // eslint-disable-next-line no-constructor-return
             return new OpenAIChat(fields, configuration);
         }
@@ -134,6 +136,12 @@ export class OpenAI extends BaseLLM {
             writable: true,
             value: "gpt-3.5-turbo-instruct"
         });
+        Object.defineProperty(this, "model", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "gpt-3.5-turbo-instruct"
+        });
         Object.defineProperty(this, "modelKwargs", {
             enumerable: true,
             configurable: true,
@@ -158,6 +166,12 @@ export class OpenAI extends BaseLLM {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "stopSequences", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "user", {
             enumerable: true,
             configurable: true,
@@ -176,6 +190,12 @@ export class OpenAI extends BaseLLM {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "apiKey", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "azureOpenAIApiVersion", {
             enumerable: true,
             configurable: true,
@@ -224,12 +244,16 @@ export class OpenAI extends BaseLLM {
             writable: true,
             value: void 0
         });
+        model = model ?? this.model;
         this.openAIApiKey =
-            fields?.openAIApiKey ?? getEnvironmentVariable("OPENAI_API_KEY");
+            fields?.apiKey ??
+                fields?.openAIApiKey ??
+                getEnvironmentVariable("OPENAI_API_KEY");
+        this.apiKey = this.openAIApiKey;
         this.azureOpenAIApiKey =
             fields?.azureOpenAIApiKey ??
                 getEnvironmentVariable("AZURE_OPENAI_API_KEY");
-        if (!this.azureOpenAIApiKey && !this.openAIApiKey) {
+        if (!this.azureOpenAIApiKey && !this.apiKey) {
             throw new Error("OpenAI or Azure OpenAI API key not found");
         }
         this.azureOpenAIApiInstanceName =
@@ -249,7 +273,8 @@ export class OpenAI extends BaseLLM {
         this.organization =
             fields?.configuration?.organization ??
                 getEnvironmentVariable("OPENAI_ORGANIZATION");
-        this.modelName = fields?.modelName ?? this.modelName;
+        this.modelName = model;
+        this.model = model;
         this.modelKwargs = fields?.modelKwargs ?? {};
         this.batchSize = fields?.batchSize ?? this.batchSize;
         this.timeout = fields?.timeout;
@@ -261,7 +286,8 @@ export class OpenAI extends BaseLLM {
         this.n = fields?.n ?? this.n;
         this.bestOf = fields?.bestOf ?? this.bestOf;
         this.logitBias = fields?.logitBias;
-        this.stop = fields?.stop;
+        this.stop = fields?.stopSequences ?? fields?.stop;
+        this.stopSequences = fields?.stopSequences;
         this.user = fields?.user;
         this.streaming = fields?.streaming ?? false;
         if (this.streaming && this.bestOf && this.bestOf > 1) {
@@ -277,10 +303,10 @@ export class OpenAI extends BaseLLM {
             if (!this.azureOpenAIApiVersion) {
                 throw new Error("Azure OpenAI API version not found");
             }
-            this.openAIApiKey = this.openAIApiKey ?? "";
+            this.apiKey = this.apiKey ?? "";
         }
         this.clientConfig = {
-            apiKey: this.openAIApiKey,
+            apiKey: this.apiKey,
             organization: this.organization,
             baseURL: configuration?.basePath ?? fields?.configuration?.basePath,
             dangerouslyAllowBrowser: true,
@@ -297,7 +323,7 @@ export class OpenAI extends BaseLLM {
      */
     invocationParams(options) {
         return {
-            model: this.modelName,
+            model: this.model,
             temperature: this.temperature,
             max_tokens: this.maxTokens,
             top_p: this.topP,
@@ -306,7 +332,7 @@ export class OpenAI extends BaseLLM {
             n: this.n,
             best_of: this.bestOf,
             logit_bias: this.logitBias,
-            stop: options?.stop ?? this.stop,
+            stop: options?.stop ?? this.stopSequences,
             user: this.user,
             stream: this.streaming,
             ...this.modelKwargs,
@@ -315,7 +341,7 @@ export class OpenAI extends BaseLLM {
     /** @ignore */
     _identifyingParams() {
         return {
-            model_name: this.modelName,
+            model_name: this.model,
             ...this.invocationParams(),
             ...this.clientConfig,
         };
@@ -354,7 +380,7 @@ export class OpenAI extends BaseLLM {
             params.max_tokens = await calculateMaxTokens({
                 prompt: prompts[0],
                 // Cast here to allow for other models that may not fit the union
-                modelName: this.modelName,
+                modelName: this.model,
             });
         }
         for (let i = 0; i < subPrompts.length; i += 1) {

package/dist/tests/chat_models-extended.int.test.js

@@ -1,5 +1,5 @@
 import { test, expect, jest } from "@jest/globals";
-import { HumanMessage, ToolMessage } from "@langchain/core/messages";
+import { AIMessage, HumanMessage, ToolMessage } from "@langchain/core/messages";
 import { InMemoryCache } from "@langchain/core/caches";
 import { ChatOpenAI } from "../chat_models.js";
 test("Test ChatOpenAI JSON mode", async () => {
@@ -60,7 +60,10 @@ test("Test ChatOpenAI tool calling", async () => {
         ["human", "What's the weather like in San Francisco, Tokyo, and Paris?"],
     ]);
     console.log(JSON.stringify(res));
-    expect(res.additional_kwargs.tool_calls?.length).toBeGreaterThan(1);
+    expect(res.additional_kwargs.tool_calls?.length).toEqual(3);
+    expect(res.tool_calls?.[0].args).toEqual(JSON.parse(res.additional_kwargs.tool_calls?.[0].function.arguments ?? "{}"));
+    expect(res.tool_calls?.[1].args).toEqual(JSON.parse(res.additional_kwargs.tool_calls?.[1].function.arguments ?? "{}"));
+    expect(res.tool_calls?.[2].args).toEqual(JSON.parse(res.additional_kwargs.tool_calls?.[2].function.arguments ?? "{}"));
 });
 test("Test ChatOpenAI streaming logprobs", async () => {
     const model = new ChatOpenAI({
@@ -203,3 +206,54 @@ test("ChatOpenAI in JSON mode can cache generations", async () => {
     lookupSpy.mockRestore();
     updateSpy.mockRestore();
 });
+test("Few shotting with tool calls", async () => {
+    const chat = new ChatOpenAI({
+        modelName: "gpt-3.5-turbo-1106",
+        temperature: 1,
+    }).bind({
+        tools: [
+            {
+                type: "function",
+                function: {
+                    name: "get_current_weather",
+                    description: "Get the current weather in a given location",
+                    parameters: {
+                        type: "object",
+                        properties: {
+                            location: {
+                                type: "string",
+                                description: "The city and state, e.g. San Francisco, CA",
+                            },
+                            unit: { type: "string", enum: ["celsius", "fahrenheit"] },
+                        },
+                        required: ["location"],
+                    },
+                },
+            },
+        ],
+        tool_choice: "auto",
+    });
+    const res = await chat.invoke([
+        new HumanMessage("What is the weather in SF?"),
+        new AIMessage({
+            content: "",
+            tool_calls: [
+                {
+                    id: "12345",
+                    name: "get_current_weather",
+                    args: {
+                        location: "SF",
+                    },
+                },
+            ],
+        }),
+        new ToolMessage({
+            tool_call_id: "12345",
+            content: "It is currently 24 degrees with hail in SF.",
+        }),
+        new AIMessage("It is currently 24 degrees in SF with hail in SF."),
+        new HumanMessage("What did you say the weather was?"),
+    ]);
+    console.log(res);
+    expect(res.content).toContain("24");
+});

package/dist/tools/dalle.cjs

@@ -31,7 +31,7 @@ class DallEAPIWrapper extends tools_1.Tool {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "modelName", {
+        Object.defineProperty(this, "model", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -73,7 +73,9 @@ class DallEAPIWrapper extends tools_1.Tool {
             writable: true,
             value: void 0
         });
-        const openAIApiKey = fields?.openAIApiKey ?? (0, env_1.getEnvironmentVariable)("OPENAI_API_KEY");
+        const openAIApiKey = fields?.apiKey ??
+            fields?.openAIApiKey ??
+            (0, env_1.getEnvironmentVariable)("OPENAI_API_KEY");
         const organization = fields?.organization ?? (0, env_1.getEnvironmentVariable)("OPENAI_ORGANIZATION");
         const clientConfig = {
             apiKey: openAIApiKey,
@@ -81,7 +83,7 @@ class DallEAPIWrapper extends tools_1.Tool {
             dangerouslyAllowBrowser: true,
         };
         this.client = new openai_1.OpenAI(clientConfig);
-        this.modelName = fields?.modelName ?? this.modelName;
+        this.model = fields?.model ?? fields?.modelName ?? this.model;
         this.style = fields?.style ?? this.style;
         this.quality = fields?.quality ?? this.quality;
         this.n = fields?.n ?? this.n;
@@ -92,7 +94,7 @@ class DallEAPIWrapper extends tools_1.Tool {
     /** @ignore */
     async _call(input) {
         const response = await this.client.images.generate({
-            model: this.modelName,
+            model: this.model,
             prompt: input,
             n: this.n,
             size: this.size,

package/dist/tools/dalle.d.ts

@@ -6,14 +6,26 @@ import { Tool, ToolParams } from "@langchain/core/tools";
 export interface DallEAPIWrapperParams extends ToolParams {
     /**
      * The OpenAI API key
+     * Alias for `apiKey`
      */
     openAIApiKey?: string;
+    /**
+     * The OpenAI API key
+     */
+    apiKey?: string;
     /**
      * The model to use.
+     * Alias for `model`
      * @params "dall-e-2" | "dall-e-3"
      * @default "dall-e-3"
      */
     modelName?: string;
+    /**
+     * The model to use.
+     * @params "dall-e-2" | "dall-e-3"
+     * @default "dall-e-3"
+     */
+    model?: string;
     /**
      * The style of the generated images. Must be one of vivid or natural.
      * Vivid causes the model to lean towards generating hyper-real and dramatic images.
@@ -66,7 +78,7 @@ export declare class DallEAPIWrapper extends Tool {
     description: string;
     protected client: OpenAIClient;
     static readonly toolName = "dalle_api_wrapper";
-    private modelName;
+    private model;
     private style;
     private quality;
     private n;

package/dist/tools/dalle.js

@@ -28,7 +28,7 @@ export class DallEAPIWrapper extends Tool {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "modelName", {
+        Object.defineProperty(this, "model", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -70,7 +70,9 @@ export class DallEAPIWrapper extends Tool {
             writable: true,
             value: void 0
         });
-        const openAIApiKey = fields?.openAIApiKey ?? getEnvironmentVariable("OPENAI_API_KEY");
+        const openAIApiKey = fields?.apiKey ??
+            fields?.openAIApiKey ??
+            getEnvironmentVariable("OPENAI_API_KEY");
         const organization = fields?.organization ?? getEnvironmentVariable("OPENAI_ORGANIZATION");
         const clientConfig = {
             apiKey: openAIApiKey,
@@ -78,7 +80,7 @@ export class DallEAPIWrapper extends Tool {
             dangerouslyAllowBrowser: true,
         };
         this.client = new OpenAIClient(clientConfig);
-        this.modelName = fields?.modelName ?? this.modelName;
+        this.model = fields?.model ?? fields?.modelName ?? this.model;
         this.style = fields?.style ?? this.style;
         this.quality = fields?.quality ?? this.quality;
         this.n = fields?.n ?? this.n;
@@ -89,7 +91,7 @@ export class DallEAPIWrapper extends Tool {
     /** @ignore */
     async _call(input) {
         const response = await this.client.images.generate({
-            model: this.modelName,
+            model: this.model,
             prompt: input,
             n: this.n,
             size: this.size,

package/dist/types.d.ts

@@ -24,15 +24,25 @@ export declare interface OpenAIBaseInput {
     user?: string;
     /** Whether to stream the results or not. Enabling disables tokenUsage reporting */
     streaming: boolean;
-    /** Model name to use */
+    /**
+     * Model name to use
+     * Alias for `model`
+     */
     modelName: string;
+    /** Model name to use */
+    model: string;
     /** Holds any additional parameters that are valid to pass to {@link
      * https://platform.openai.com/docs/api-reference/completions/create |
      * `openai.createCompletion`} that are not explicitly specified on this class.
      */
     modelKwargs?: Record<string, any>;
-    /** List of stop words to use when generating */
+    /**
+     * List of stop words to use when generating
+     * Alias for `stopSequences`
+     */
     stop?: string[];
+    /** List of stop words to use when generating */
+    stopSequences?: string[];
     /**
      * Timeout to use when making requests to OpenAI.
      */
@@ -40,8 +50,14 @@ export declare interface OpenAIBaseInput {
     /**
      * API key to use when making requests to OpenAI. Defaults to the value of
      * `OPENAI_API_KEY` environment variable.
+     * Alias for `apiKey`
      */
     openAIApiKey?: string;
+    /**
+     * API key to use when making requests to OpenAI. Defaults to the value of
+     * `OPENAI_API_KEY` environment variable.
+     */
+    apiKey?: string;
 }
 export type OpenAICoreRequestOptions<Req extends object = Record<string, unknown>> = {
     path?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/openai",
-  "version": "0.0.26",
+  "version": "0.0.28",
   "description": "OpenAI integrations for LangChain.js",
   "type": "module",
   "engines": {
@@ -39,7 +39,7 @@
   "author": "LangChain",
   "license": "MIT",
   "dependencies": {
-    "@langchain/core": "~0.1.45",
+    "@langchain/core": "~0.1.56",
     "js-tiktoken": "^1.0.7",
     "openai": "^4.32.1",
     "zod": "^3.22.4",