@langchain/openai 0.4.0-rc.0 → 0.4.1

package/dist/azure/llms.js

@@ -1,26 +1,98 @@
 import { AzureOpenAI as AzureOpenAIClient } from "openai";
+import { getEnvironmentVariable } from "@langchain/core/utils/env";
 import { OpenAI } from "../llms.js";
 import { getEndpoint } from "../utils/azure.js";
 export class AzureOpenAI extends OpenAI {
     get lc_aliases() {
         return {
+            ...super.lc_aliases,
             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",
+        };
+    }
+    get lc_secrets() {
+        return {
+            ...super.lc_secrets,
+            azureOpenAIApiKey: "AZURE_OPENAI_API_KEY",
         };
     }
     constructor(fields) {
-        const newFields = fields ? { ...fields } : fields;
-        if (newFields) {
-            // don't rewrite the fields if they are already set
-            newFields.azureOpenAIApiDeploymentName =
-                newFields.azureOpenAIApiDeploymentName ?? newFields.deploymentName;
-            newFields.azureOpenAIApiKey =
-                newFields.azureOpenAIApiKey ?? newFields.openAIApiKey;
-            newFields.azureOpenAIApiVersion =
-                newFields.azureOpenAIApiVersion ?? newFields.openAIApiVersion;
+        super(fields);
+        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
+        });
+        this.azureOpenAIApiDeploymentName =
+            (fields?.azureOpenAIApiCompletionsDeploymentName ||
+                fields?.azureOpenAIApiDeploymentName) ??
+                (getEnvironmentVariable("AZURE_OPENAI_API_COMPLETIONS_DEPLOYMENT_NAME") ||
+                    getEnvironmentVariable("AZURE_OPENAI_API_DEPLOYMENT_NAME"));
+        this.azureOpenAIApiKey =
+            fields?.azureOpenAIApiKey ??
+                fields?.openAIApiKey ??
+                fields?.apiKey ??
+                getEnvironmentVariable("AZURE_OPENAI_API_KEY");
+        this.azureOpenAIApiInstanceName =
+            fields?.azureOpenAIApiInstanceName ??
+                getEnvironmentVariable("AZURE_OPENAI_API_INSTANCE_NAME");
+        this.azureOpenAIApiVersion =
+            fields?.azureOpenAIApiVersion ??
+                fields?.openAIApiVersion ??
+                getEnvironmentVariable("AZURE_OPENAI_API_VERSION");
+        this.azureOpenAIBasePath =
+            fields?.azureOpenAIBasePath ??
+                getEnvironmentVariable("AZURE_OPENAI_BASE_PATH");
+        this.azureOpenAIEndpoint =
+            fields?.azureOpenAIEndpoint ??
+                getEnvironmentVariable("AZURE_OPENAI_ENDPOINT");
+        this.azureADTokenProvider = fields?.azureADTokenProvider;
+        if (!this.azureOpenAIApiKey && !this.apiKey && !this.azureADTokenProvider) {
+            throw new Error("Azure OpenAI API key or Token Provider not found");
         }
-        super(newFields);
     }
     _getClientOptions(options) {
         if (!this.client) {

package/dist/chat_models.cjs

@@ -247,6 +247,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`.
  *
@@ -496,7 +498,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, {
@@ -802,7 +804,6 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
         return {
             openAIApiKey: "OPENAI_API_KEY",
             apiKey: "OPENAI_API_KEY",
-            azureOpenAIApiKey: "AZURE_OPENAI_API_KEY",
             organization: "OPENAI_ORGANIZATION",
         };
     }
@@ -811,15 +812,9 @@ class ChatOpenAI extends chat_models_1.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,
@@ -831,25 +826,25 @@ class ChatOpenAI extends chat_models_1.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,
@@ -863,11 +858,12 @@ class ChatOpenAI extends chat_models_1.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,
@@ -947,48 +943,6 @@ class ChatOpenAI extends chat_models_1.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,
@@ -1047,21 +1001,11 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
                 fields?.configuration?.apiKey ??
                 (0, env_1.getEnvironmentVariable)("OPENAI_API_KEY");
         this.apiKey = this.openAIApiKey;
-        this.azureOpenAIApiKey = fields?.azureOpenAIApiKey;
-        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;
-        this.azureOpenAIApiDeploymentName = fields?.azureOpenAIApiDeploymentName;
-        this.azureOpenAIApiVersion = fields?.azureOpenAIApiVersion;
-        this.azureOpenAIBasePath = fields?.azureOpenAIBasePath;
-        this.azureOpenAIEndpoint = fields?.azureOpenAIEndpoint;
         this.organization =
             fields?.configuration?.organization ??
                 (0, env_1.getEnvironmentVariable)("OPENAI_ORGANIZATION");
-        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;
@@ -1080,29 +1024,6 @@ class ChatOpenAI extends chat_models_1.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;
         }
@@ -1111,13 +1032,7 @@ class ChatOpenAI extends chat_models_1.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.
@@ -1596,12 +1511,7 @@ class ChatOpenAI extends chat_models_1.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 = (0, azure_js_1.getEndpoint)(openAIEndpointConfig);
             const params = {
@@ -1619,16 +1529,6 @@ class ChatOpenAI extends chat_models_1.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() {
@@ -1675,6 +1575,16 @@ class ChatOpenAI extends chat_models_1.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/chat_models.d.ts

@@ -6,9 +6,9 @@ import { BaseChatModel, BindToolsInput, LangSmithParams, type BaseChatModelParam
 import { type BaseFunctionCallOptions, type BaseLanguageModelInput, type StructuredOutputMethodOptions } from "@langchain/core/language_models/base";
 import { z } from "zod";
 import { Runnable } from "@langchain/core/runnables";
-import type { AzureOpenAIInput, OpenAICallOptions, OpenAIChatInput, OpenAICoreRequestOptions, LegacyOpenAIInput, ChatOpenAIResponseFormat } from "./types.js";
+import type { OpenAICallOptions, OpenAIChatInput, OpenAICoreRequestOptions, ChatOpenAIResponseFormat } from "./types.js";
 import { OpenAIToolChoice } from "./utils/openai.js";
-export type { AzureOpenAIInput, OpenAICallOptions, OpenAIChatInput };
+export type { OpenAICallOptions, OpenAIChatInput };
 interface TokenUsage {
     completionTokens?: number;
     promptTokens?: number;
@@ -106,12 +106,14 @@ export interface ChatOpenAICallOptions extends OpenAICallOptions, BaseFunctionCa
      */
     reasoning_effort?: OpenAIClient.Chat.ChatCompletionReasoningEffort;
 }
-export interface ChatOpenAIFields extends Partial<OpenAIChatInput>, Partial<AzureOpenAIInput>, BaseChatModelParams {
-    configuration?: ClientOptions & LegacyOpenAIInput;
+export interface ChatOpenAIFields extends Partial<OpenAIChatInput>, BaseChatModelParams {
+    configuration?: ClientOptions;
 }
 /**
  * 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`.
  *
@@ -361,7 +363,7 @@ export interface ChatOpenAIFields extends Partial<OpenAIChatInput>, Partial<Azur
  * 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, {
@@ -645,7 +647,7 @@ export interface ChatOpenAIFields extends Partial<OpenAIChatInput>, Partial<Azur
  *
  * <br />
  */
-export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = ChatOpenAICallOptions> extends BaseChatModel<CallOptions, AIMessageChunk> implements OpenAIChatInput, AzureOpenAIInput {
+export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = ChatOpenAICallOptions> extends BaseChatModel<CallOptions, AIMessageChunk> implements Partial<OpenAIChatInput> {
     static lc_name(): string;
     get callKeys(): string[];
     lc_serializable: boolean;
@@ -653,12 +655,13 @@ export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = Chat
         [key: string]: string;
     } | undefined;
     get lc_aliases(): Record<string, string>;
-    temperature: number;
-    topP: number;
-    frequencyPenalty: number;
-    presencePenalty: number;
+    temperature?: number;
+    topP?: number;
+    frequencyPenalty?: number;
+    presencePenalty?: number;
     n: number;
     logitBias?: Record<string, number>;
+    /** @deprecated Use "model" instead */
     modelName: string;
     model: string;
     modelKwargs?: OpenAIChatInput["modelKwargs"];
@@ -673,13 +676,6 @@ export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = Chat
     topLogprobs?: number;
     openAIApiKey?: string;
     apiKey?: string;
-    azureOpenAIApiVersion?: string;
-    azureOpenAIApiKey?: string;
-    azureADTokenProvider?: () => Promise<string>;
-    azureOpenAIApiInstanceName?: string;
-    azureOpenAIApiDeploymentName?: string;
-    azureOpenAIBasePath?: string;
-    azureOpenAIEndpoint?: string;
     organization?: string;
     __includeRawResponse?: boolean;
     protected client: OpenAIClient;
@@ -692,9 +688,7 @@ export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = Chat
     audio?: OpenAIClient.Chat.ChatCompletionAudioParam;
     modalities?: Array<OpenAIClient.Chat.ChatCompletionModality>;
     reasoningEffort?: OpenAIClient.Chat.ChatCompletionReasoningEffort;
-    constructor(fields?: ChatOpenAIFields, 
-    /** @deprecated */
-    configuration?: ClientOptions & LegacyOpenAIInput);
+    constructor(fields?: ChatOpenAIFields);
     getLsParams(options: this["ParsedCallOptions"]): LangSmithParams;
     bindTools(tools: ChatOpenAIToolType[], kwargs?: Partial<CallOptions>): Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions>;
     private createResponseFormat;
@@ -755,4 +749,8 @@ export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = Chat
         raw: BaseMessage;
         parsed: RunOutput;
     }>;
+    withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: z.ZodType<RunOutput> | Record<string, any>, config?: ChatOpenAIStructuredOutputMethodOptions<boolean>): Runnable<BaseLanguageModelInput, RunOutput> | Runnable<BaseLanguageModelInput, {
+        raw: BaseMessage;
+        parsed: RunOutput;
+    }>;
 }