@langchain/openai 0.3.17 → 0.4.0

package/dist/embeddings.js

@@ -5,9 +5,10 @@ import { chunkArray } from "@langchain/core/utils/chunk_array";
 import { getEndpoint } from "./utils/azure.js";
 import { wrapOpenAIClientError } from "./utils/openai.js";
 /**
- * Class for generating embeddings using the OpenAI API. Extends the
- * Embeddings class and implements OpenAIEmbeddingsParams and
- * AzureOpenAIInput.
+ * Class for generating embeddings using the OpenAI API.
+ *
+ * To use with Azure, import the `AzureOpenAIEmbeddings` class.
+ *
  * @example
  * ```typescript
  * // Embed a query using OpenAIEmbeddings to generate embeddings for a given text
@@ -20,20 +21,21 @@ import { wrapOpenAIClientError } from "./utils/openai.js";
  * ```
  */
 export class OpenAIEmbeddings extends Embeddings {
-    constructor(fields, configuration) {
+    constructor(fields) {
         const fieldsWithDefaults = { maxConcurrency: 2, ...fields };
         super(fieldsWithDefaults);
-        Object.defineProperty(this, "modelName", {
+        Object.defineProperty(this, "model", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: "text-embedding-ada-002"
         });
-        Object.defineProperty(this, "model", {
+        /** @deprecated Use "model" instead */
+        Object.defineProperty(this, "modelName", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: "text-embedding-ada-002"
+            value: void 0
         });
         Object.defineProperty(this, "batchSize", {
             enumerable: true,
@@ -64,42 +66,6 @@ export class OpenAIEmbeddings extends Embeddings {
             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,
@@ -118,62 +84,24 @@ export class OpenAIEmbeddings extends Embeddings {
             writable: true,
             value: void 0
         });
-        let apiKey = fieldsWithDefaults?.apiKey ??
+        const apiKey = fieldsWithDefaults?.apiKey ??
             fieldsWithDefaults?.openAIApiKey ??
             getEnvironmentVariable("OPENAI_API_KEY");
-        const azureApiKey = fieldsWithDefaults?.azureOpenAIApiKey ??
-            getEnvironmentVariable("AZURE_OPENAI_API_KEY");
-        this.azureADTokenProvider = fields?.azureADTokenProvider ?? undefined;
-        if (!azureApiKey && !apiKey && !this.azureADTokenProvider) {
-            throw new Error("OpenAI or Azure OpenAI API key or Token Provider not found");
-        }
-        const azureApiInstanceName = fieldsWithDefaults?.azureOpenAIApiInstanceName ??
-            getEnvironmentVariable("AZURE_OPENAI_API_INSTANCE_NAME");
-        const azureApiDeploymentName = (fieldsWithDefaults?.azureOpenAIApiEmbeddingsDeploymentName ||
-            fieldsWithDefaults?.azureOpenAIApiDeploymentName) ??
-            (getEnvironmentVariable("AZURE_OPENAI_API_EMBEDDINGS_DEPLOYMENT_NAME") ||
-                getEnvironmentVariable("AZURE_OPENAI_API_DEPLOYMENT_NAME"));
-        const azureApiVersion = fieldsWithDefaults?.azureOpenAIApiVersion ??
-            getEnvironmentVariable("AZURE_OPENAI_API_VERSION");
-        this.azureOpenAIBasePath =
-            fieldsWithDefaults?.azureOpenAIBasePath ??
-                getEnvironmentVariable("AZURE_OPENAI_BASE_PATH");
         this.organization =
             fieldsWithDefaults?.configuration?.organization ??
                 getEnvironmentVariable("OPENAI_ORGANIZATION");
-        this.modelName =
+        this.model =
             fieldsWithDefaults?.model ?? fieldsWithDefaults?.modelName ?? this.model;
-        this.model = this.modelName;
-        this.batchSize =
-            fieldsWithDefaults?.batchSize ?? (azureApiKey ? 1 : this.batchSize);
+        this.modelName = this.model;
+        this.batchSize = fieldsWithDefaults?.batchSize ?? this.batchSize;
         this.stripNewLines =
             fieldsWithDefaults?.stripNewLines ?? this.stripNewLines;
         this.timeout = fieldsWithDefaults?.timeout;
         this.dimensions = fieldsWithDefaults?.dimensions;
-        this.azureOpenAIApiVersion = azureApiVersion;
-        this.azureOpenAIApiKey = azureApiKey;
-        this.azureOpenAIApiInstanceName = azureApiInstanceName;
-        this.azureOpenAIApiDeploymentName = azureApiDeploymentName;
-        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");
-            }
-            apiKey = apiKey ?? "";
-        }
         this.clientConfig = {
             apiKey,
             organization: this.organization,
-            baseURL: configuration?.basePath,
             dangerouslyAllowBrowser: true,
-            defaultHeaders: configuration?.baseOptions?.headers,
-            defaultQuery: configuration?.baseOptions?.params,
-            ...configuration,
             ...fields?.configuration,
         };
     }
@@ -234,10 +162,6 @@ export class OpenAIEmbeddings extends Embeddings {
     async embeddingWithRetry(request) {
         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);
@@ -253,16 +177,6 @@ export class OpenAIEmbeddings extends Embeddings {
             this.client = new OpenAIClient(params);
         }
         const requestOptions = {};
-        if (this.azureOpenAIApiKey) {
-            requestOptions.headers = {
-                "api-key": this.azureOpenAIApiKey,
-                ...requestOptions.headers,
-            };
-            requestOptions.query = {
-                "api-version": this.azureOpenAIApiVersion,
-                ...requestOptions.query,
-            };
-        }
         return this.caller.call(async () => {
             try {
                 const res = await this.client.embeddings.create(request, requestOptions);

package/dist/llms.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenAI = exports.OpenAIChat = void 0;
+exports.OpenAI = void 0;
 const openai_1 = require("openai");
 const base_1 = require("@langchain/core/language_models/base");
 const outputs_1 = require("@langchain/core/outputs");
@@ -8,8 +8,6 @@ const env_1 = require("@langchain/core/utils/env");
 const llms_1 = require("@langchain/core/language_models/llms");
 const chunk_array_1 = require("@langchain/core/utils/chunk_array");
 const azure_js_1 = require("./utils/azure.cjs");
-const legacy_js_1 = require("./legacy.cjs");
-Object.defineProperty(exports, "OpenAIChat", { enumerable: true, get: function () { return legacy_js_1.OpenAIChat; } });
 const openai_js_1 = require("./utils/openai.cjs");
 /**
  * Wrapper around OpenAI large language models.
@@ -17,11 +15,7 @@ const openai_js_1 = require("./utils/openai.cjs");
  * 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
@@ -54,7 +48,6 @@ class OpenAI extends llms_1.BaseLLM {
         return {
             openAIApiKey: "OPENAI_API_KEY",
             apiKey: "OPENAI_API_KEY",
-            azureOpenAIApiKey: "AZURE_OPENAI_API_KEY",
             organization: "OPENAI_ORGANIZATION",
         };
     }
@@ -63,30 +56,9 @@ class OpenAI extends llms_1.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 legacy_js_1.OpenAIChat(fields, configuration);
-        }
+    constructor(fields) {
         super(fields ?? {});
         Object.defineProperty(this, "lc_serializable", {
             enumerable: true,
@@ -98,31 +70,31 @@ class OpenAI extends llms_1.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,
@@ -142,17 +114,18 @@ class OpenAI extends llms_1.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,
@@ -208,42 +181,6 @@ class OpenAI extends llms_1.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,
@@ -262,38 +199,30 @@ class OpenAI extends llms_1.BaseLLM {
             writable: true,
             value: void 0
         });
-        model = model ?? this.model;
         this.openAIApiKey =
             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");
-        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 ??
-                (0, env_1.getEnvironmentVariable)("AZURE_OPENAI_API_INSTANCE_NAME");
-        this.azureOpenAIApiDeploymentName =
-            (fields?.azureOpenAIApiCompletionsDeploymentName ||
-                fields?.azureOpenAIApiDeploymentName) ??
-                ((0, env_1.getEnvironmentVariable)("AZURE_OPENAI_API_COMPLETIONS_DEPLOYMENT_NAME") ||
-                    (0, env_1.getEnvironmentVariable)("AZURE_OPENAI_API_DEPLOYMENT_NAME"));
-        this.azureOpenAIApiVersion =
-            fields?.azureOpenAIApiVersion ??
-                (0, env_1.getEnvironmentVariable)("AZURE_OPENAI_API_VERSION");
-        this.azureOpenAIBasePath =
-            fields?.azureOpenAIBasePath ??
-                (0, env_1.getEnvironmentVariable)("AZURE_OPENAI_BASE_PATH");
         this.organization =
             fields?.configuration?.organization ??
                 (0, env_1.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;
@@ -312,28 +241,10 @@ class OpenAI extends llms_1.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,
         };
     }
@@ -532,10 +443,6 @@ class OpenAI extends llms_1.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 = (0, azure_js_1.getEndpoint)(openAIEndpointConfig);
@@ -554,16 +461,6 @@ class OpenAI extends llms_1.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/llms.d.ts

@@ -2,21 +2,15 @@ import { type ClientOptions, OpenAI as OpenAIClient } from "openai";
 import { CallbackManagerForLLMRun } from "@langchain/core/callbacks/manager";
 import { GenerationChunk, type LLMResult } from "@langchain/core/outputs";
 import { BaseLLM, type BaseLLMParams } from "@langchain/core/language_models/llms";
-import type { AzureOpenAIInput, OpenAICallOptions, OpenAICoreRequestOptions, OpenAIInput, LegacyOpenAIInput } from "./types.js";
-import { OpenAIChat, OpenAIChatCallOptions } from "./legacy.js";
-export type { AzureOpenAIInput, OpenAICallOptions, OpenAIInput, OpenAIChatCallOptions, };
-export { OpenAIChat };
+import type { OpenAICallOptions, OpenAICoreRequestOptions, OpenAIInput } from "./types.js";
+export type { OpenAICallOptions, OpenAIInput };
 /**
  * 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
@@ -38,7 +32,7 @@ export { OpenAIChat };
  * console.log({ res });
  * ```
  */
-export declare class OpenAI<CallOptions extends OpenAICallOptions = OpenAICallOptions> extends BaseLLM<CallOptions> implements OpenAIInput, AzureOpenAIInput {
+export declare class OpenAI<CallOptions extends OpenAICallOptions = OpenAICallOptions> extends BaseLLM<CallOptions> implements Partial<OpenAIInput> {
     static lc_name(): string;
     get callKeys(): string[];
     lc_serializable: boolean;
@@ -46,16 +40,17 @@ export declare class OpenAI<CallOptions extends OpenAICallOptions = OpenAICallOp
         [key: string]: string;
     } | undefined;
     get lc_aliases(): Record<string, string>;
-    temperature: number;
-    maxTokens: number;
-    topP: number;
-    frequencyPenalty: number;
-    presencePenalty: number;
+    temperature?: number;
+    maxTokens?: number;
+    topP?: number;
+    frequencyPenalty?: number;
+    presencePenalty?: number;
     n: number;
     bestOf?: number;
     logitBias?: Record<string, number>;
-    modelName: string;
     model: string;
+    /** @deprecated Use "model" instead */
+    modelName: string;
     modelKwargs?: OpenAIInput["modelKwargs"];
     batchSize: number;
     timeout?: number;
@@ -65,20 +60,12 @@ export declare class OpenAI<CallOptions extends OpenAICallOptions = OpenAICallOp
     streaming: boolean;
     openAIApiKey?: string;
     apiKey?: string;
-    azureOpenAIApiVersion?: string;
-    azureOpenAIApiKey?: string;
-    azureADTokenProvider?: () => Promise<string>;
-    azureOpenAIApiInstanceName?: string;
-    azureOpenAIApiDeploymentName?: string;
-    azureOpenAIBasePath?: string;
     organization?: string;
     protected client: OpenAIClient;
     protected clientConfig: ClientOptions;
-    constructor(fields?: Partial<OpenAIInput> & Partial<AzureOpenAIInput> & BaseLLMParams & {
-        configuration?: ClientOptions & LegacyOpenAIInput;
-    }, 
-    /** @deprecated */
-    configuration?: ClientOptions & LegacyOpenAIInput);
+    constructor(fields?: Partial<OpenAIInput> & BaseLLMParams & {
+        configuration?: ClientOptions;
+    });
     /**
      * Get the parameters used to invoke the model
      */