@langchain/openai 0.3.2 → 0.3.3

package/dist/azure/chat_models.cjs

@@ -425,6 +425,11 @@ class AzureChatOpenAI extends chat_models_js_1.ChatOpenAI {
             openAIApiKey: "openai_api_key",
             openAIApiVersion: "openai_api_version",
             openAIBasePath: "openai_api_base",
+            deploymentName: "deployment_name",
+            azureOpenAIEndpoint: "azure_endpoint",
+            azureOpenAIApiVersion: "openai_api_version",
+            azureOpenAIBasePath: "openai_api_base",
+            azureOpenAIApiDeploymentName: "deployment_name",
         };
     }
     constructor(fields) {
@@ -454,6 +459,7 @@ class AzureChatOpenAI extends chat_models_js_1.ChatOpenAI {
                 azureOpenAIBasePath: this.azureOpenAIBasePath,
                 azureADTokenProvider: this.azureADTokenProvider,
                 baseURL: this.clientConfig.baseURL,
+                azureOpenAIEndpoint: this.azureOpenAIEndpoint,
             };
             const endpoint = (0, azure_js_1.getEndpoint)(openAIEndpointConfig);
             const params = {
@@ -509,6 +515,38 @@ class AzureChatOpenAI extends chat_models_js_1.ChatOpenAI {
             delete json.kwargs.azure_openai_api_key;
             delete json.kwargs.azure_openai_api_version;
             delete json.kwargs.azure_open_ai_base_path;
+            if (!json.kwargs.azure_endpoint && this.azureOpenAIEndpoint) {
+                json.kwargs.azure_endpoint = this.azureOpenAIEndpoint;
+            }
+            if (!json.kwargs.azure_endpoint && this.azureOpenAIBasePath) {
+                const parts = this.azureOpenAIBasePath.split("/openai/deployments/");
+                if (parts.length === 2 && parts[0].startsWith("http")) {
+                    const [endpoint] = parts;
+                    json.kwargs.azure_endpoint = endpoint;
+                }
+            }
+            if (!json.kwargs.azure_endpoint && this.azureOpenAIApiInstanceName) {
+                json.kwargs.azure_endpoint = `https://${this.azureOpenAIApiInstanceName}.openai.azure.com/`;
+            }
+            if (!json.kwargs.deployment_name && this.azureOpenAIApiDeploymentName) {
+                json.kwargs.deployment_name = this.azureOpenAIApiDeploymentName;
+            }
+            if (!json.kwargs.deployment_name && this.azureOpenAIBasePath) {
+                const parts = this.azureOpenAIBasePath.split("/openai/deployments/");
+                if (parts.length === 2) {
+                    const [, deployment] = parts;
+                    json.kwargs.deployment_name = deployment;
+                }
+            }
+            if (json.kwargs.azure_endpoint &&
+                json.kwargs.deployment_name &&
+                json.kwargs.openai_api_base) {
+                delete json.kwargs.openai_api_base;
+            }
+            if (json.kwargs.azure_openai_api_instance_name &&
+                json.kwargs.azure_endpoint) {
+                delete json.kwargs.azure_openai_api_instance_name;
+            }
         }
         return json;
     }

package/dist/azure/chat_models.js

@@ -422,6 +422,11 @@ export class AzureChatOpenAI extends ChatOpenAI {
             openAIApiKey: "openai_api_key",
             openAIApiVersion: "openai_api_version",
             openAIBasePath: "openai_api_base",
+            deploymentName: "deployment_name",
+            azureOpenAIEndpoint: "azure_endpoint",
+            azureOpenAIApiVersion: "openai_api_version",
+            azureOpenAIBasePath: "openai_api_base",
+            azureOpenAIApiDeploymentName: "deployment_name",
         };
     }
     constructor(fields) {
@@ -451,6 +456,7 @@ export class AzureChatOpenAI extends ChatOpenAI {
                 azureOpenAIBasePath: this.azureOpenAIBasePath,
                 azureADTokenProvider: this.azureADTokenProvider,
                 baseURL: this.clientConfig.baseURL,
+                azureOpenAIEndpoint: this.azureOpenAIEndpoint,
             };
             const endpoint = getEndpoint(openAIEndpointConfig);
             const params = {
@@ -506,6 +512,38 @@ export class AzureChatOpenAI extends ChatOpenAI {
             delete json.kwargs.azure_openai_api_key;
             delete json.kwargs.azure_openai_api_version;
             delete json.kwargs.azure_open_ai_base_path;
+            if (!json.kwargs.azure_endpoint && this.azureOpenAIEndpoint) {
+                json.kwargs.azure_endpoint = this.azureOpenAIEndpoint;
+            }
+            if (!json.kwargs.azure_endpoint && this.azureOpenAIBasePath) {
+                const parts = this.azureOpenAIBasePath.split("/openai/deployments/");
+                if (parts.length === 2 && parts[0].startsWith("http")) {
+                    const [endpoint] = parts;
+                    json.kwargs.azure_endpoint = endpoint;
+                }
+            }
+            if (!json.kwargs.azure_endpoint && this.azureOpenAIApiInstanceName) {
+                json.kwargs.azure_endpoint = `https://${this.azureOpenAIApiInstanceName}.openai.azure.com/`;
+            }
+            if (!json.kwargs.deployment_name && this.azureOpenAIApiDeploymentName) {
+                json.kwargs.deployment_name = this.azureOpenAIApiDeploymentName;
+            }
+            if (!json.kwargs.deployment_name && this.azureOpenAIBasePath) {
+                const parts = this.azureOpenAIBasePath.split("/openai/deployments/");
+                if (parts.length === 2) {
+                    const [, deployment] = parts;
+                    json.kwargs.deployment_name = deployment;
+                }
+            }
+            if (json.kwargs.azure_endpoint &&
+                json.kwargs.deployment_name &&
+                json.kwargs.openai_api_base) {
+                delete json.kwargs.openai_api_base;
+            }
+            if (json.kwargs.azure_openai_api_instance_name &&
+                json.kwargs.azure_endpoint) {
+                delete json.kwargs.azure_openai_api_instance_name;
+            }
         }
         return json;
     }

package/dist/chat_models.cjs

@@ -864,6 +864,12 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             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,
@@ -926,6 +932,9 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
         this.organization =
             fields?.configuration?.organization ??
                 (0, env_1.getEnvironmentVariable)("OPENAI_ORGANIZATION");
+        this.azureOpenAIEndpoint =
+            fields?.azureOpenAIEndpoint ??
+                (0, env_1.getEnvironmentVariable)("AZURE_OPENAI_ENDPOINT");
         this.modelName = fields?.model ?? fields?.modelName ?? this.model;
         this.model = this.modelName;
         this.modelKwargs = fields?.modelKwargs ?? {};
@@ -944,9 +953,18 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
         this.user = fields?.user;
         this.__includeRawResponse = fields?.__includeRawResponse;
         if (this.azureOpenAIApiKey || this.azureADTokenProvider) {
-            if (!this.azureOpenAIApiInstanceName && !this.azureOpenAIBasePath) {
+            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");
             }
@@ -1399,6 +1417,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
                 azureOpenAIApiKey: this.azureOpenAIApiKey,
                 azureOpenAIBasePath: this.azureOpenAIBasePath,
                 baseURL: this.clientConfig.baseURL,
+                azureOpenAIEndpoint: this.azureOpenAIEndpoint,
             };
             const endpoint = (0, azure_js_1.getEndpoint)(openAIEndpointConfig);
             const params = {

package/dist/chat_models.d.ts

@@ -572,6 +572,7 @@ export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = Chat
     azureOpenAIApiInstanceName?: string;
     azureOpenAIApiDeploymentName?: string;
     azureOpenAIBasePath?: string;
+    azureOpenAIEndpoint?: string;
     organization?: string;
     __includeRawResponse?: boolean;
     protected client: OpenAIClient;

package/dist/chat_models.js

@@ -859,6 +859,12 @@ export class ChatOpenAI extends BaseChatModel {
             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,
@@ -921,6 +927,9 @@ export class ChatOpenAI extends BaseChatModel {
         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.modelKwargs = fields?.modelKwargs ?? {};
@@ -939,9 +948,18 @@ export class ChatOpenAI extends BaseChatModel {
         this.user = fields?.user;
         this.__includeRawResponse = fields?.__includeRawResponse;
         if (this.azureOpenAIApiKey || this.azureADTokenProvider) {
-            if (!this.azureOpenAIApiInstanceName && !this.azureOpenAIBasePath) {
+            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");
             }
@@ -1394,6 +1412,7 @@ export class ChatOpenAI extends BaseChatModel {
                 azureOpenAIApiKey: this.azureOpenAIApiKey,
                 azureOpenAIBasePath: this.azureOpenAIBasePath,
                 baseURL: this.clientConfig.baseURL,
+                azureOpenAIEndpoint: this.azureOpenAIEndpoint,
             };
             const endpoint = getEndpoint(openAIEndpointConfig);
             const params = {

package/dist/types.d.ts

@@ -170,11 +170,17 @@ export declare interface AzureOpenAIInput {
      */
     azureOpenAIApiCompletionsDeploymentName?: string;
     /**
-     * Custom endpoint for Azure OpenAI API. This is useful in case you have a deployment in another region.
+     * Custom base url for Azure OpenAI API. This is useful in case you have a deployment in another region.
      * e.g. setting this value to "https://westeurope.api.cognitive.microsoft.com/openai/deployments"
      * will be result in the endpoint URL: https://westeurope.api.cognitive.microsoft.com/openai/deployments/{DeploymentName}/
      */
     azureOpenAIBasePath?: string;
+    /**
+     * Custom endpoint for Azure OpenAI API. This is useful in case you have a deployment in another region.
+     * e.g. setting this value to "https://westeurope.api.cognitive.microsoft.com/"
+     * will be result in the endpoint URL: https://westeurope.api.cognitive.microsoft.com/openai/deployments/{DeploymentName}/
+     */
+    azureOpenAIEndpoint?: string;
     /**
      * A function that returns an access token for Microsoft Entra (formerly known as Azure Active Directory),
      * which will be invoked on every request.

package/dist/utils/azure.cjs

@@ -8,13 +8,15 @@ exports.getEndpoint = void 0;
  * @param {OpenAIEndpointConfig} config - The configuration object for the (Azure) endpoint.
  *
  * @property {string} config.azureOpenAIApiDeploymentName - The deployment name of Azure OpenAI.
- * @property {string} config.azureOpenAIApiInstanceName - The instance name of Azure OpenAI.
+ * @property {string} config.azureOpenAIApiInstanceName - The instance name of Azure OpenAI, e.g. `example-resource`.
  * @property {string} config.azureOpenAIApiKey - The API Key for Azure OpenAI.
- * @property {string} config.azureOpenAIBasePath - The base path for Azure OpenAI.
+ * @property {string} config.azureOpenAIBasePath - The base path for Azure OpenAI, e.g. `https://example-resource.azure.openai.com/openai/deployments/`.
  * @property {string} config.baseURL - Some other custom base path URL.
+ * @property {string} config.azureOpenAIEndpoint - The endpoint for the Azure OpenAI instance, e.g. `https://example-resource.azure.openai.com/`.
  *
  * The function operates as follows:
  * - If both `azureOpenAIBasePath` and `azureOpenAIApiDeploymentName` (plus `azureOpenAIApiKey`) are provided, it returns an URL combining these two parameters (`${azureOpenAIBasePath}/${azureOpenAIApiDeploymentName}`).
+ * - If both `azureOpenAIEndpoint` and `azureOpenAIApiDeploymentName` (plus `azureOpenAIApiKey`) are provided, it returns an URL combining these two parameters (`${azureOpenAIEndpoint}/openai/deployments/${azureOpenAIApiDeploymentName}`).
  * - If `azureOpenAIApiKey` is provided, it checks for `azureOpenAIApiInstanceName` and `azureOpenAIApiDeploymentName` and throws an error if any of these is missing. If both are provided, it generates an URL incorporating these parameters.
  * - If none of the above conditions are met, return any custom `baseURL`.
  * - The function returns the generated URL as a string, or undefined if no custom paths are specified.
@@ -24,12 +26,17 @@ exports.getEndpoint = void 0;
  * @returns {string | undefined} The generated (Azure) OpenAI endpoint URL.
  */
 function getEndpoint(config) {
-    const { azureOpenAIApiDeploymentName, azureOpenAIApiInstanceName, azureOpenAIApiKey, azureOpenAIBasePath, baseURL, azureADTokenProvider, } = config;
+    const { azureOpenAIApiDeploymentName, azureOpenAIApiInstanceName, azureOpenAIApiKey, azureOpenAIBasePath, baseURL, azureADTokenProvider, azureOpenAIEndpoint, } = config;
     if ((azureOpenAIApiKey || azureADTokenProvider) &&
         azureOpenAIBasePath &&
         azureOpenAIApiDeploymentName) {
         return `${azureOpenAIBasePath}/${azureOpenAIApiDeploymentName}`;
     }
+    if ((azureOpenAIApiKey || azureADTokenProvider) &&
+        azureOpenAIEndpoint &&
+        azureOpenAIApiDeploymentName) {
+        return `${azureOpenAIEndpoint}/openai/deployments/${azureOpenAIApiDeploymentName}`;
+    }
     if (azureOpenAIApiKey || azureADTokenProvider) {
         if (!azureOpenAIApiInstanceName) {
             throw new Error("azureOpenAIApiInstanceName is required when using azureOpenAIApiKey");

package/dist/utils/azure.d.ts

@@ -5,6 +5,7 @@ export interface OpenAIEndpointConfig {
     azureADTokenProvider?: () => Promise<string>;
     azureOpenAIBasePath?: string;
     baseURL?: string | null;
+    azureOpenAIEndpoint?: string;
 }
 /**
  * This function generates an endpoint URL for (Azure) OpenAI
@@ -13,13 +14,15 @@ export interface OpenAIEndpointConfig {
  * @param {OpenAIEndpointConfig} config - The configuration object for the (Azure) endpoint.
  *
  * @property {string} config.azureOpenAIApiDeploymentName - The deployment name of Azure OpenAI.
- * @property {string} config.azureOpenAIApiInstanceName - The instance name of Azure OpenAI.
+ * @property {string} config.azureOpenAIApiInstanceName - The instance name of Azure OpenAI, e.g. `example-resource`.
  * @property {string} config.azureOpenAIApiKey - The API Key for Azure OpenAI.
- * @property {string} config.azureOpenAIBasePath - The base path for Azure OpenAI.
+ * @property {string} config.azureOpenAIBasePath - The base path for Azure OpenAI, e.g. `https://example-resource.azure.openai.com/openai/deployments/`.
  * @property {string} config.baseURL - Some other custom base path URL.
+ * @property {string} config.azureOpenAIEndpoint - The endpoint for the Azure OpenAI instance, e.g. `https://example-resource.azure.openai.com/`.
  *
  * The function operates as follows:
  * - If both `azureOpenAIBasePath` and `azureOpenAIApiDeploymentName` (plus `azureOpenAIApiKey`) are provided, it returns an URL combining these two parameters (`${azureOpenAIBasePath}/${azureOpenAIApiDeploymentName}`).
+ * - If both `azureOpenAIEndpoint` and `azureOpenAIApiDeploymentName` (plus `azureOpenAIApiKey`) are provided, it returns an URL combining these two parameters (`${azureOpenAIEndpoint}/openai/deployments/${azureOpenAIApiDeploymentName}`).
  * - If `azureOpenAIApiKey` is provided, it checks for `azureOpenAIApiInstanceName` and `azureOpenAIApiDeploymentName` and throws an error if any of these is missing. If both are provided, it generates an URL incorporating these parameters.
  * - If none of the above conditions are met, return any custom `baseURL`.
  * - The function returns the generated URL as a string, or undefined if no custom paths are specified.

package/dist/utils/azure.js

@@ -5,13 +5,15 @@
  * @param {OpenAIEndpointConfig} config - The configuration object for the (Azure) endpoint.
  *
  * @property {string} config.azureOpenAIApiDeploymentName - The deployment name of Azure OpenAI.
- * @property {string} config.azureOpenAIApiInstanceName - The instance name of Azure OpenAI.
+ * @property {string} config.azureOpenAIApiInstanceName - The instance name of Azure OpenAI, e.g. `example-resource`.
  * @property {string} config.azureOpenAIApiKey - The API Key for Azure OpenAI.
- * @property {string} config.azureOpenAIBasePath - The base path for Azure OpenAI.
+ * @property {string} config.azureOpenAIBasePath - The base path for Azure OpenAI, e.g. `https://example-resource.azure.openai.com/openai/deployments/`.
  * @property {string} config.baseURL - Some other custom base path URL.
+ * @property {string} config.azureOpenAIEndpoint - The endpoint for the Azure OpenAI instance, e.g. `https://example-resource.azure.openai.com/`.
  *
  * The function operates as follows:
  * - If both `azureOpenAIBasePath` and `azureOpenAIApiDeploymentName` (plus `azureOpenAIApiKey`) are provided, it returns an URL combining these two parameters (`${azureOpenAIBasePath}/${azureOpenAIApiDeploymentName}`).
+ * - If both `azureOpenAIEndpoint` and `azureOpenAIApiDeploymentName` (plus `azureOpenAIApiKey`) are provided, it returns an URL combining these two parameters (`${azureOpenAIEndpoint}/openai/deployments/${azureOpenAIApiDeploymentName}`).
  * - If `azureOpenAIApiKey` is provided, it checks for `azureOpenAIApiInstanceName` and `azureOpenAIApiDeploymentName` and throws an error if any of these is missing. If both are provided, it generates an URL incorporating these parameters.
  * - If none of the above conditions are met, return any custom `baseURL`.
  * - The function returns the generated URL as a string, or undefined if no custom paths are specified.
@@ -21,12 +23,17 @@
  * @returns {string | undefined} The generated (Azure) OpenAI endpoint URL.
  */
 export function getEndpoint(config) {
-    const { azureOpenAIApiDeploymentName, azureOpenAIApiInstanceName, azureOpenAIApiKey, azureOpenAIBasePath, baseURL, azureADTokenProvider, } = config;
+    const { azureOpenAIApiDeploymentName, azureOpenAIApiInstanceName, azureOpenAIApiKey, azureOpenAIBasePath, baseURL, azureADTokenProvider, azureOpenAIEndpoint, } = config;
     if ((azureOpenAIApiKey || azureADTokenProvider) &&
         azureOpenAIBasePath &&
         azureOpenAIApiDeploymentName) {
         return `${azureOpenAIBasePath}/${azureOpenAIApiDeploymentName}`;
     }
+    if ((azureOpenAIApiKey || azureADTokenProvider) &&
+        azureOpenAIEndpoint &&
+        azureOpenAIApiDeploymentName) {
+        return `${azureOpenAIEndpoint}/openai/deployments/${azureOpenAIApiDeploymentName}`;
+    }
     if (azureOpenAIApiKey || azureADTokenProvider) {
         if (!azureOpenAIApiInstanceName) {
             throw new Error("azureOpenAIApiInstanceName is required when using azureOpenAIApiKey");

package/package.json

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