@langchain/openai 0.3.17 → 0.4.0

package/dist/llms.js

@@ -5,20 +5,14 @@ import { getEnvironmentVariable } from "@langchain/core/utils/env";
 import { BaseLLM, } from "@langchain/core/language_models/llms";
 import { chunkArray } from "@langchain/core/utils/chunk_array";
 import { getEndpoint } from "./utils/azure.js";
-import { OpenAIChat } from "./legacy.js";
 import { wrapOpenAIClientError } from "./utils/openai.js";
-export { OpenAIChat };
 /**
  * Wrapper around OpenAI large language models.
  *
  * To use you should have the `openai` package installed, with the
  * `OPENAI_API_KEY` environment variable set.
  *
- * To use with Azure you should have the `openai` package installed, with the
- * `AZURE_OPENAI_API_KEY`,
- * `AZURE_OPENAI_API_INSTANCE_NAME`,
- * `AZURE_OPENAI_API_DEPLOYMENT_NAME`
- * and `AZURE_OPENAI_API_VERSION` environment variable set.
+ * To use with Azure, import the `AzureOpenAI` class.
  *
  * @remarks
  * Any parameters that are valid to be passed to {@link
@@ -51,7 +45,6 @@ export class OpenAI extends BaseLLM {
         return {
             openAIApiKey: "OPENAI_API_KEY",
             apiKey: "OPENAI_API_KEY",
-            azureOpenAIApiKey: "AZURE_OPENAI_API_KEY",
             organization: "OPENAI_ORGANIZATION",
         };
     }
@@ -60,30 +53,9 @@ export class OpenAI extends BaseLLM {
             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",
-            azureOpenAIApiDeploymentName: "azure_openai_api_deployment_name",
         };
     }
-    constructor(fields, 
-    /** @deprecated */
-    configuration) {
-        let model = fields?.model ?? fields?.modelName;
-        if ((model?.startsWith("gpt-3.5-turbo") || model?.startsWith("gpt-4")) &&
-            !model?.includes("-instruct")) {
-            console.warn([
-                `Your chosen OpenAI model, "${model}", is a chat model and not a text-in/text-out LLM.`,
-                `Passing it into the "OpenAI" class is deprecated and only permitted for backwards-compatibility. You may experience odd behavior.`,
-                `Please use the "ChatOpenAI" class instead.`,
-                "",
-                `See this page for more information:`,
-                "|",
-                `└> https://js.langchain.com/docs/integrations/chat/openai`,
-            ].join("\n"));
-            // eslint-disable-next-line no-constructor-return
-            return new OpenAIChat(fields, configuration);
-        }
+    constructor(fields) {
         super(fields ?? {});
         Object.defineProperty(this, "lc_serializable", {
             enumerable: true,
@@ -95,31 +67,31 @@ export class OpenAI extends BaseLLM {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: 0.7
+            value: void 0
         });
         Object.defineProperty(this, "maxTokens", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: 256
+            value: void 0
         });
         Object.defineProperty(this, "topP", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: 1
+            value: void 0
         });
         Object.defineProperty(this, "frequencyPenalty", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: 0
+            value: void 0
         });
         Object.defineProperty(this, "presencePenalty", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: 0
+            value: void 0
         });
         Object.defineProperty(this, "n", {
             enumerable: true,
@@ -139,17 +111,18 @@ export class OpenAI extends BaseLLM {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "modelName", {
+        Object.defineProperty(this, "model", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: "gpt-3.5-turbo-instruct"
         });
-        Object.defineProperty(this, "model", {
+        /** @deprecated Use "model" instead */
+        Object.defineProperty(this, "modelName", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: "gpt-3.5-turbo-instruct"
+            value: void 0
         });
         Object.defineProperty(this, "modelKwargs", {
             enumerable: true,
@@ -205,42 +178,6 @@ export class OpenAI extends BaseLLM {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "azureOpenAIApiVersion", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "azureOpenAIApiKey", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "azureADTokenProvider", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "azureOpenAIApiInstanceName", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "azureOpenAIApiDeploymentName", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "azureOpenAIBasePath", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
         Object.defineProperty(this, "organization", {
             enumerable: true,
             configurable: true,
@@ -259,38 +196,30 @@ export class OpenAI extends BaseLLM {
             writable: true,
             value: void 0
         });
-        model = model ?? this.model;
         this.openAIApiKey =
             fields?.apiKey ??
                 fields?.openAIApiKey ??
                 getEnvironmentVariable("OPENAI_API_KEY");
         this.apiKey = this.openAIApiKey;
-        this.azureOpenAIApiKey =
-            fields?.azureOpenAIApiKey ??
-                getEnvironmentVariable("AZURE_OPENAI_API_KEY");
-        this.azureADTokenProvider = fields?.azureADTokenProvider ?? undefined;
-        if (!this.azureOpenAIApiKey && !this.apiKey && !this.azureADTokenProvider) {
-            throw new Error("OpenAI or Azure OpenAI API key or Token Provider not found");
-        }
-        this.azureOpenAIApiInstanceName =
-            fields?.azureOpenAIApiInstanceName ??
-                getEnvironmentVariable("AZURE_OPENAI_API_INSTANCE_NAME");
-        this.azureOpenAIApiDeploymentName =
-            (fields?.azureOpenAIApiCompletionsDeploymentName ||
-                fields?.azureOpenAIApiDeploymentName) ??
-                (getEnvironmentVariable("AZURE_OPENAI_API_COMPLETIONS_DEPLOYMENT_NAME") ||
-                    getEnvironmentVariable("AZURE_OPENAI_API_DEPLOYMENT_NAME"));
-        this.azureOpenAIApiVersion =
-            fields?.azureOpenAIApiVersion ??
-                getEnvironmentVariable("AZURE_OPENAI_API_VERSION");
-        this.azureOpenAIBasePath =
-            fields?.azureOpenAIBasePath ??
-                getEnvironmentVariable("AZURE_OPENAI_BASE_PATH");
         this.organization =
             fields?.configuration?.organization ??
                 getEnvironmentVariable("OPENAI_ORGANIZATION");
-        this.modelName = model;
-        this.model = model;
+        this.model = fields?.model ?? fields?.modelName ?? this.model;
+        if ((this.model?.startsWith("gpt-3.5-turbo") ||
+            this.model?.startsWith("gpt-4") ||
+            this.model?.startsWith("o1")) &&
+            !this.model?.includes("-instruct")) {
+            throw new Error([
+                `Your chosen OpenAI model, "${this.model}", is a chat model and not a text-in/text-out LLM.`,
+                `Passing it into the "OpenAI" class is no longer supported.`,
+                `Please use the "ChatOpenAI" class instead.`,
+                "",
+                `See this page for more information:`,
+                "|",
+                `└> https://js.langchain.com/docs/integrations/chat/openai`,
+            ].join("\n"));
+        }
+        this.modelName = this.model;
         this.modelKwargs = fields?.modelKwargs ?? {};
         this.batchSize = fields?.batchSize ?? this.batchSize;
         this.timeout = fields?.timeout;
@@ -309,28 +238,10 @@ export class OpenAI extends BaseLLM {
         if (this.streaming && this.bestOf && this.bestOf > 1) {
             throw new Error("Cannot stream results when bestOf > 1");
         }
-        if (this.azureOpenAIApiKey || this.azureADTokenProvider) {
-            if (!this.azureOpenAIApiInstanceName && !this.azureOpenAIBasePath) {
-                throw new Error("Azure OpenAI API instance name not found");
-            }
-            if (!this.azureOpenAIApiDeploymentName) {
-                throw new Error("Azure OpenAI API deployment name not found");
-            }
-            if (!this.azureOpenAIApiVersion) {
-                throw new Error("Azure OpenAI API version not found");
-            }
-            this.apiKey = this.apiKey ?? "";
-        }
         this.clientConfig = {
             apiKey: this.apiKey,
             organization: this.organization,
-            baseURL: configuration?.basePath ?? fields?.configuration?.basePath,
             dangerouslyAllowBrowser: true,
-            defaultHeaders: configuration?.baseOptions?.headers ??
-                fields?.configuration?.baseOptions?.headers,
-            defaultQuery: configuration?.baseOptions?.params ??
-                fields?.configuration?.baseOptions?.params,
-            ...configuration,
             ...fields?.configuration,
         };
     }
@@ -529,10 +440,6 @@ export class OpenAI extends BaseLLM {
     _getClientOptions(options) {
         if (!this.client) {
             const openAIEndpointConfig = {
-                azureOpenAIApiDeploymentName: this.azureOpenAIApiDeploymentName,
-                azureOpenAIApiInstanceName: this.azureOpenAIApiInstanceName,
-                azureOpenAIApiKey: this.azureOpenAIApiKey,
-                azureOpenAIBasePath: this.azureOpenAIBasePath,
                 baseURL: this.clientConfig.baseURL,
             };
             const endpoint = getEndpoint(openAIEndpointConfig);
@@ -551,16 +458,6 @@ export class OpenAI extends BaseLLM {
             ...this.clientConfig,
             ...options,
         };
-        if (this.azureOpenAIApiKey) {
-            requestOptions.headers = {
-                "api-key": this.azureOpenAIApiKey,
-                ...requestOptions.headers,
-            };
-            requestOptions.query = {
-                "api-version": this.azureOpenAIApiVersion,
-                ...requestOptions.query,
-            };
-        }
         return requestOptions;
     }
     _llmType() {

package/dist/types.d.ts

@@ -34,6 +34,7 @@ export declare interface OpenAIBaseInput {
     /**
      * Model name to use
      * Alias for `model`
+     * @deprecated Use "model" instead.
      */
     modelName: string;
     /** Model name to use */
@@ -93,18 +94,6 @@ export declare interface OpenAIInput extends OpenAIBaseInput {
     /** Batch size to use when passing multiple documents to generate */
     batchSize: number;
 }
-/**
- * @deprecated Use "baseURL", "defaultHeaders", and "defaultParams" instead.
- */
-export interface LegacyOpenAIInput {
-    /** @deprecated Use baseURL instead */
-    basePath?: string;
-    /** @deprecated Use defaultHeaders and defaultQuery instead */
-    baseOptions?: {
-        headers?: Record<string, string>;
-        params?: Record<string, string>;
-    };
-}
 export interface OpenAIChatInput extends OpenAIBaseInput {
     /**
      * Whether to return log probabilities of the output tokens or not.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/openai",
-  "version": "0.3.17",
+  "version": "0.4.0",
   "description": "OpenAI integrations for LangChain.js",
   "type": "module",
   "engines": {