@langchain/openai 0.3.17 → 0.4.0

package/dist/chat_models.js

@@ -242,6 +242,8 @@ function _convertChatOpenAIToolTypeToOpenAITool(tool, fields) {
 /**
  * OpenAI chat model integration.
  *
+ * To use with Azure, import the `AzureChatOpenAI` class.
+ *
  * Setup:
  * Install `@langchain/openai` and set an environment variable named `OPENAI_API_KEY`.
  *
@@ -491,7 +493,7 @@ function _convertChatOpenAIToolTypeToOpenAITool(tool, fields) {
  * const Joke = z.object({
  *   setup: z.string().describe("The setup of the joke"),
  *   punchline: z.string().describe("The punchline to the joke"),
- *   rating: z.number().optional().describe("How funny the joke is, from 1 to 10")
+ *   rating: z.number().nullable().describe("How funny the joke is, from 1 to 10")
  * }).describe('Joke to tell user.');
  *
  * const structuredLlm = llm.withStructuredOutput(Joke, {
@@ -797,7 +799,6 @@ export class ChatOpenAI extends BaseChatModel {
         return {
             openAIApiKey: "OPENAI_API_KEY",
             apiKey: "OPENAI_API_KEY",
-            azureOpenAIApiKey: "AZURE_OPENAI_API_KEY",
             organization: "OPENAI_ORGANIZATION",
         };
     }
@@ -806,15 +807,9 @@ export class ChatOpenAI extends BaseChatModel {
             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) {
+    constructor(fields) {
         super(fields ?? {});
         Object.defineProperty(this, "lc_serializable", {
             enumerable: true,
@@ -826,25 +821,25 @@ export class ChatOpenAI extends BaseChatModel {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: 1
+            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,
@@ -858,11 +853,12 @@ export class ChatOpenAI extends BaseChatModel {
             writable: true,
             value: void 0
         });
+        /** @deprecated Use "model" instead */
         Object.defineProperty(this, "modelName", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: "gpt-3.5-turbo"
+            value: void 0
         });
         Object.defineProperty(this, "model", {
             enumerable: true,
@@ -942,48 +938,6 @@ export class ChatOpenAI extends BaseChatModel {
             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, "azureOpenAIEndpoint", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
         Object.defineProperty(this, "organization", {
             enumerable: true,
             configurable: true,
@@ -1042,33 +996,11 @@ export class ChatOpenAI extends BaseChatModel {
                 fields?.configuration?.apiKey ??
                 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?.azureOpenAIApiDeploymentName ??
-                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.azureOpenAIEndpoint =
-            fields?.azureOpenAIEndpoint ??
-                getEnvironmentVariable("AZURE_OPENAI_ENDPOINT");
-        this.modelName = fields?.model ?? fields?.modelName ?? this.model;
-        this.model = this.modelName;
+        this.model = fields?.model ?? fields?.modelName ?? this.model;
+        this.modelName = this.model;
         this.modelKwargs = fields?.modelKwargs ?? {};
         this.timeout = fields?.timeout;
         this.temperature = fields?.temperature ?? this.temperature;
@@ -1087,29 +1019,6 @@ export class ChatOpenAI extends BaseChatModel {
         this.audio = fields?.audio;
         this.modalities = fields?.modalities;
         this.reasoningEffort = fields?.reasoningEffort;
-        if (this.azureOpenAIApiKey || this.azureADTokenProvider) {
-            if (!this.azureOpenAIApiInstanceName &&
-                !this.azureOpenAIBasePath &&
-                !this.azureOpenAIEndpoint) {
-                throw new Error("Azure OpenAI API instance name not found");
-            }
-            if (!this.azureOpenAIApiDeploymentName && this.azureOpenAIBasePath) {
-                const parts = this.azureOpenAIBasePath.split("/openai/deployments/");
-                if (parts.length === 2) {
-                    const [, deployment] = parts;
-                    this.azureOpenAIApiDeploymentName = deployment;
-                }
-            }
-            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 ?? "";
-            // Streaming usage is not supported by Azure deployments, so default to false
-            this.streamUsage = false;
-        }
         if (this.model === "o1") {
             this.disableStreaming = true;
         }
@@ -1118,13 +1027,7 @@ export class ChatOpenAI extends BaseChatModel {
         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,
         };
         // If `supportsStrictToolCalling` is explicitly set, use that value.
@@ -1603,12 +1506,7 @@ export class ChatOpenAI extends BaseChatModel {
     _getClientOptions(options) {
         if (!this.client) {
             const openAIEndpointConfig = {
-                azureOpenAIApiDeploymentName: this.azureOpenAIApiDeploymentName,
-                azureOpenAIApiInstanceName: this.azureOpenAIApiInstanceName,
-                azureOpenAIApiKey: this.azureOpenAIApiKey,
-                azureOpenAIBasePath: this.azureOpenAIBasePath,
                 baseURL: this.clientConfig.baseURL,
-                azureOpenAIEndpoint: this.azureOpenAIEndpoint,
             };
             const endpoint = getEndpoint(openAIEndpointConfig);
             const params = {
@@ -1626,16 +1524,6 @@ export class ChatOpenAI extends BaseChatModel {
             ...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() {
@@ -1682,6 +1570,16 @@ export class ChatOpenAI extends BaseChatModel {
         if (config?.strict !== undefined && method === "jsonMode") {
             throw new Error("Argument `strict` is only supported for `method` = 'function_calling'");
         }
+        if (!this.model.startsWith("gpt-3") &&
+            !this.model.startsWith("gpt-4-") &&
+            this.model !== "gpt-4") {
+            if (method === undefined) {
+                method = "jsonSchema";
+            }
+        }
+        else if (method === "jsonSchema") {
+            console.warn(`[WARNING]: JSON Schema is not supported for model "${this.model}". Falling back to tool calling.`);
+        }
         if (method === "jsonMode") {
             llm = this.bind({
                 response_format: { type: "json_object" },

package/dist/embeddings.cjs

@@ -8,9 +8,10 @@ const chunk_array_1 = require("@langchain/core/utils/chunk_array");
 const azure_js_1 = require("./utils/azure.cjs");
 const openai_js_1 = require("./utils/openai.cjs");
 /**
- * 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
@@ -23,20 +24,21 @@ const openai_js_1 = require("./utils/openai.cjs");
  * ```
  */
 class OpenAIEmbeddings extends embeddings_1.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,
@@ -67,42 +69,6 @@ class OpenAIEmbeddings extends embeddings_1.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,
@@ -121,62 +87,24 @@ class OpenAIEmbeddings extends embeddings_1.Embeddings {
             writable: true,
             value: void 0
         });
-        let apiKey = fieldsWithDefaults?.apiKey ??
+        const apiKey = fieldsWithDefaults?.apiKey ??
             fieldsWithDefaults?.openAIApiKey ??
             (0, env_1.getEnvironmentVariable)("OPENAI_API_KEY");
-        const azureApiKey = fieldsWithDefaults?.azureOpenAIApiKey ??
-            (0, env_1.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 ??
-            (0, env_1.getEnvironmentVariable)("AZURE_OPENAI_API_INSTANCE_NAME");
-        const azureApiDeploymentName = (fieldsWithDefaults?.azureOpenAIApiEmbeddingsDeploymentName ||
-            fieldsWithDefaults?.azureOpenAIApiDeploymentName) ??
-            ((0, env_1.getEnvironmentVariable)("AZURE_OPENAI_API_EMBEDDINGS_DEPLOYMENT_NAME") ||
-                (0, env_1.getEnvironmentVariable)("AZURE_OPENAI_API_DEPLOYMENT_NAME"));
-        const azureApiVersion = fieldsWithDefaults?.azureOpenAIApiVersion ??
-            (0, env_1.getEnvironmentVariable)("AZURE_OPENAI_API_VERSION");
-        this.azureOpenAIBasePath =
-            fieldsWithDefaults?.azureOpenAIBasePath ??
-                (0, env_1.getEnvironmentVariable)("AZURE_OPENAI_BASE_PATH");
         this.organization =
             fieldsWithDefaults?.configuration?.organization ??
                 (0, env_1.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,
         };
     }
@@ -237,10 +165,6 @@ class OpenAIEmbeddings extends embeddings_1.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 = (0, azure_js_1.getEndpoint)(openAIEndpointConfig);
@@ -256,16 +180,6 @@ class OpenAIEmbeddings extends embeddings_1.Embeddings {
             this.client = new openai_1.OpenAI(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/embeddings.d.ts

@@ -1,6 +1,5 @@
 import { type ClientOptions, OpenAI as OpenAIClient } from "openai";
 import { Embeddings, type EmbeddingsParams } from "@langchain/core/embeddings";
-import { AzureOpenAIInput, LegacyOpenAIInput } from "./types.js";
 /**
  * Interface for OpenAIEmbeddings parameters. Extends EmbeddingsParams and
  * defines additional parameters specific to the OpenAIEmbeddings class.
@@ -9,6 +8,7 @@ export interface OpenAIEmbeddingsParams extends EmbeddingsParams {
     /**
      * Model name to use
      * Alias for `model`
+     * @deprecated Use "model" instead.
      */
     modelName: string;
     /** Model name to use */
@@ -35,9 +35,10 @@ export interface OpenAIEmbeddingsParams extends EmbeddingsParams {
     stripNewLines?: boolean;
 }
 /**
- * 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
@@ -49,9 +50,10 @@ export interface OpenAIEmbeddingsParams extends EmbeddingsParams {
  *
  * ```
  */
-export declare class OpenAIEmbeddings extends Embeddings implements OpenAIEmbeddingsParams, AzureOpenAIInput {
-    modelName: string;
+export declare class OpenAIEmbeddings extends Embeddings implements Partial<OpenAIEmbeddingsParams> {
     model: string;
+    /** @deprecated Use "model" instead */
+    modelName: string;
     batchSize: number;
     stripNewLines: boolean;
     /**
@@ -60,16 +62,10 @@ export declare class OpenAIEmbeddings extends Embeddings implements OpenAIEmbedd
      */
     dimensions?: number;
     timeout?: number;
-    azureOpenAIApiVersion?: string;
-    azureOpenAIApiKey?: string;
-    azureADTokenProvider?: () => Promise<string>;
-    azureOpenAIApiInstanceName?: string;
-    azureOpenAIApiDeploymentName?: string;
-    azureOpenAIBasePath?: string;
     organization?: string;
     protected client: OpenAIClient;
     protected clientConfig: ClientOptions;
-    constructor(fields?: Partial<OpenAIEmbeddingsParams> & Partial<AzureOpenAIInput> & {
+    constructor(fields?: Partial<OpenAIEmbeddingsParams> & {
         verbose?: boolean;
         /**
          * The OpenAI API key to use.
@@ -79,7 +75,7 @@ export declare class OpenAIEmbeddings extends Embeddings implements OpenAIEmbedd
         /** The OpenAI API key to use. */
         apiKey?: string;
         configuration?: ClientOptions;
-    }, configuration?: ClientOptions & LegacyOpenAIInput);
+    });
     /**
      * Method to generate embeddings for an array of documents. Splits the
      * documents into batches and makes requests to the OpenAI API to generate
@@ -103,9 +99,6 @@ export declare class OpenAIEmbeddings extends Embeddings implements OpenAIEmbedd
      * @returns Promise that resolves to the response from the API.
      */
     protected embeddingWithRetry(request: OpenAIClient.EmbeddingCreateParams): Promise<OpenAIClient.Embeddings.CreateEmbeddingResponse & {
-        _request_id?: string | null | undefined; /**
-         * The number of dimensions the resulting output embeddings should have.
-         * Only supported in `text-embedding-3` and later models.
-         */
+        _request_id?: string | null | undefined;
     }>;
 }