@langchain/openai 0.0.27 → 0.0.29

package/dist/chat_models.js

@@ -1,12 +1,12 @@
 import { OpenAI as OpenAIClient } from "openai";
-import { AIMessage, AIMessageChunk, ChatMessage, ChatMessageChunk, FunctionMessageChunk, HumanMessageChunk, SystemMessageChunk, ToolMessageChunk, } from "@langchain/core/messages";
+import { AIMessage, AIMessageChunk, ChatMessage, ChatMessageChunk, FunctionMessageChunk, HumanMessageChunk, SystemMessageChunk, ToolMessageChunk, isAIMessage, } from "@langchain/core/messages";
 import { ChatGenerationChunk, } from "@langchain/core/outputs";
 import { getEnvironmentVariable } from "@langchain/core/utils/env";
 import { BaseChatModel, } from "@langchain/core/language_models/chat_models";
 import { convertToOpenAITool } from "@langchain/core/utils/function_calling";
 import { RunnablePassthrough, RunnableSequence, } from "@langchain/core/runnables";
 import { JsonOutputParser, StructuredOutputParser, } from "@langchain/core/output_parsers";
-import { JsonOutputKeyToolsParser } from "@langchain/core/output_parsers/openai_tools";
+import { JsonOutputKeyToolsParser, convertLangChainToolCallToOpenAI, makeInvalidToolCall, parseToolCall, } from "@langchain/core/output_parsers/openai_tools";
 import { zodToJsonSchema } from "zod-to-json-schema";
 import { getEndpoint } from "./utils/azure.js";
 import { wrapOpenAIClientError } from "./utils/openai.js";
@@ -44,12 +44,30 @@ export function messageToOpenAIRole(message) {
     }
 }
 function openAIResponseToChatMessage(message) {
+    const rawToolCalls = message.tool_calls;
     switch (message.role) {
-        case "assistant":
-            return new AIMessage(message.content || "", {
-                function_call: message.function_call,
-                tool_calls: message.tool_calls,
+        case "assistant": {
+            const toolCalls = [];
+            const invalidToolCalls = [];
+            for (const rawToolCall of rawToolCalls ?? []) {
+                try {
+                    toolCalls.push(parseToolCall(rawToolCall, { returnId: true }));
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                }
+                catch (e) {
+                    invalidToolCalls.push(makeInvalidToolCall(rawToolCall, e.message));
+                }
+            }
+            return new AIMessage({
+                content: message.content || "",
+                tool_calls: toolCalls,
+                invalid_tool_calls: invalidToolCalls,
+                additional_kwargs: {
+                    function_call: message.function_call,
+                    tool_calls: rawToolCalls,
+                },
             });
+        }
         default:
             return new ChatMessage(message.content || "", message.role ?? "unknown");
     }
@@ -77,7 +95,22 @@ delta, defaultRole) {
         return new HumanMessageChunk({ content });
     }
     else if (role === "assistant") {
-        return new AIMessageChunk({ content, additional_kwargs });
+        const toolCallChunks = [];
+        if (Array.isArray(delta.tool_calls)) {
+            for (const rawToolCall of delta.tool_calls) {
+                toolCallChunks.push({
+                    name: rawToolCall.function?.name,
+                    args: rawToolCall.function?.arguments,
+                    id: rawToolCall.id,
+                    index: rawToolCall.index,
+                });
+            }
+        }
+        return new AIMessageChunk({
+            content,
+            tool_call_chunks: toolCallChunks,
+            additional_kwargs,
+        });
     }
     else if (role === "system") {
         return new SystemMessageChunk({ content });
@@ -114,11 +147,16 @@ function convertMessagesToOpenAIParams(messages) {
         if (message.additional_kwargs.function_call != null) {
             completionParam.function_call = message.additional_kwargs.function_call;
         }
-        if (message.additional_kwargs.tool_calls != null) {
-            completionParam.tool_calls = message.additional_kwargs.tool_calls;
+        if (isAIMessage(message) && !!message.tool_calls?.length) {
+            completionParam.tool_calls = message.tool_calls.map(convertLangChainToolCallToOpenAI);
         }
-        if (message.tool_call_id != null) {
-            completionParam.tool_call_id = message.tool_call_id;
+        else {
+            if (message.additional_kwargs.tool_calls != null) {
+                completionParam.tool_calls = message.additional_kwargs.tool_calls;
+            }
+            if (message.tool_call_id != null) {
+                completionParam.tool_call_id = message.tool_call_id;
+            }
         }
         return completionParam;
     });
@@ -329,6 +367,12 @@ export class ChatOpenAI extends BaseChatModel {
             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,
@@ -373,8 +417,9 @@ export class ChatOpenAI extends BaseChatModel {
         this.azureOpenAIApiKey =
             fields?.azureOpenAIApiKey ??
                 getEnvironmentVariable("AZURE_OPENAI_API_KEY");
-        if (!this.azureOpenAIApiKey && !this.apiKey) {
-            throw new Error("OpenAI or Azure OpenAI API key not found");
+        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 ??
@@ -408,7 +453,7 @@ export class ChatOpenAI extends BaseChatModel {
         this.stopSequences = this?.stop;
         this.user = fields?.user;
         this.streaming = fields?.streaming ?? false;
-        if (this.azureOpenAIApiKey) {
+        if (this.azureOpenAIApiKey || this.azureADTokenProvider) {
             if (!this.azureOpenAIApiInstanceName && !this.azureOpenAIBasePath) {
                 throw new Error("Azure OpenAI API instance name not found");
             }
@@ -433,6 +478,12 @@ export class ChatOpenAI extends BaseChatModel {
             ...fields?.configuration,
         };
     }
+    bindTools(tools, kwargs) {
+        return this.bind({
+            tools: tools.map(convertToOpenAITool),
+            ...kwargs,
+        });
+    }
     /**
      * Get the parameters used to invoke the model
      */

package/dist/embeddings.cjs

@@ -79,6 +79,12 @@ class OpenAIEmbeddings extends embeddings_1.Embeddings {
             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,
@@ -120,8 +126,9 @@ class OpenAIEmbeddings extends embeddings_1.Embeddings {
             (0, env_1.getEnvironmentVariable)("OPENAI_API_KEY");
         const azureApiKey = fieldsWithDefaults?.azureOpenAIApiKey ??
             (0, env_1.getEnvironmentVariable)("AZURE_OPENAI_API_KEY");
-        if (!azureApiKey && !apiKey) {
-            throw new Error("OpenAI or Azure OpenAI API key not found");
+        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");
@@ -150,7 +157,7 @@ class OpenAIEmbeddings extends embeddings_1.Embeddings {
         this.azureOpenAIApiKey = azureApiKey;
         this.azureOpenAIApiInstanceName = azureApiInstanceName;
         this.azureOpenAIApiDeploymentName = azureApiDeploymentName;
-        if (this.azureOpenAIApiKey) {
+        if (this.azureOpenAIApiKey || this.azureADTokenProvider) {
             if (!this.azureOpenAIApiInstanceName && !this.azureOpenAIBasePath) {
                 throw new Error("Azure OpenAI API instance name not found");
             }

package/dist/embeddings.d.ts

@@ -1,4 +1,4 @@
-import { type ClientOptions } from "openai";
+import { type ClientOptions, OpenAI as OpenAIClient } from "openai";
 import { Embeddings, type EmbeddingsParams } from "@langchain/core/embeddings";
 import { AzureOpenAIInput, LegacyOpenAIInput } from "./types.js";
 /**
@@ -62,12 +62,13 @@ export declare class OpenAIEmbeddings extends Embeddings implements OpenAIEmbedd
     timeout?: number;
     azureOpenAIApiVersion?: string;
     azureOpenAIApiKey?: string;
+    azureADTokenProvider?: () => Promise<string>;
     azureOpenAIApiInstanceName?: string;
     azureOpenAIApiDeploymentName?: string;
     azureOpenAIBasePath?: string;
     organization?: string;
-    private client;
-    private clientConfig;
+    protected client: OpenAIClient;
+    protected clientConfig: ClientOptions;
     constructor(fields?: Partial<OpenAIEmbeddingsParams> & Partial<AzureOpenAIInput> & {
         verbose?: boolean;
         /**
@@ -101,5 +102,5 @@ export declare class OpenAIEmbeddings extends Embeddings implements OpenAIEmbedd
      * @param request Request to send to the OpenAI API.
      * @returns Promise that resolves to the response from the API.
      */
-    private embeddingWithRetry;
+    protected embeddingWithRetry(request: OpenAIClient.EmbeddingCreateParams): Promise<OpenAIClient.Embeddings.CreateEmbeddingResponse>;
 }

package/dist/embeddings.js

@@ -76,6 +76,12 @@ export class OpenAIEmbeddings extends Embeddings {
             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,
@@ -117,8 +123,9 @@ export class OpenAIEmbeddings extends Embeddings {
             getEnvironmentVariable("OPENAI_API_KEY");
         const azureApiKey = fieldsWithDefaults?.azureOpenAIApiKey ??
             getEnvironmentVariable("AZURE_OPENAI_API_KEY");
-        if (!azureApiKey && !apiKey) {
-            throw new Error("OpenAI or Azure OpenAI API key not found");
+        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");
@@ -147,7 +154,7 @@ export class OpenAIEmbeddings extends Embeddings {
         this.azureOpenAIApiKey = azureApiKey;
         this.azureOpenAIApiInstanceName = azureApiInstanceName;
         this.azureOpenAIApiDeploymentName = azureApiDeploymentName;
-        if (this.azureOpenAIApiKey) {
+        if (this.azureOpenAIApiKey || this.azureADTokenProvider) {
             if (!this.azureOpenAIApiInstanceName && !this.azureOpenAIBasePath) {
                 throw new Error("Azure OpenAI API instance name not found");
             }

package/dist/index.cjs

@@ -22,6 +22,7 @@ __exportStar(require("./chat_models.cjs"), exports);
 __exportStar(require("./azure/chat_models.cjs"), exports);
 __exportStar(require("./llms.cjs"), exports);
 __exportStar(require("./azure/llms.cjs"), exports);
+__exportStar(require("./azure/embeddings.cjs"), exports);
 __exportStar(require("./embeddings.cjs"), exports);
 __exportStar(require("./types.cjs"), exports);
 __exportStar(require("./utils/openai.cjs"), exports);

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export * from "./chat_models.js";
 export * from "./azure/chat_models.js";
 export * from "./llms.js";
 export * from "./azure/llms.js";
+export * from "./azure/embeddings.js";
 export * from "./embeddings.js";
 export * from "./types.js";
 export * from "./utils/openai.js";

package/dist/index.js

@@ -3,6 +3,7 @@ export * from "./chat_models.js";
 export * from "./azure/chat_models.js";
 export * from "./llms.js";
 export * from "./azure/llms.js";
+export * from "./azure/embeddings.js";
 export * from "./embeddings.js";
 export * from "./types.js";
 export * from "./utils/openai.js";

package/dist/llms.cjs

@@ -211,6 +211,12 @@ class OpenAI extends llms_1.BaseLLM {
             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,
@@ -256,8 +262,9 @@ class OpenAI extends llms_1.BaseLLM {
         this.azureOpenAIApiKey =
             fields?.azureOpenAIApiKey ??
                 (0, env_1.getEnvironmentVariable)("AZURE_OPENAI_API_KEY");
-        if (!this.azureOpenAIApiKey && !this.apiKey) {
-            throw new Error("OpenAI or Azure OpenAI API key not found");
+        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 ??
@@ -296,7 +303,7 @@ 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) {
+        if (this.azureOpenAIApiKey || this.azureADTokenProvider) {
             if (!this.azureOpenAIApiInstanceName && !this.azureOpenAIBasePath) {
                 throw new Error("Azure OpenAI API instance name not found");
             }

package/dist/llms.d.ts

@@ -67,12 +67,13 @@ export declare class OpenAI<CallOptions extends OpenAICallOptions = OpenAICallOp
     apiKey?: string;
     azureOpenAIApiVersion?: string;
     azureOpenAIApiKey?: string;
+    azureADTokenProvider?: () => Promise<string>;
     azureOpenAIApiInstanceName?: string;
     azureOpenAIApiDeploymentName?: string;
     azureOpenAIBasePath?: string;
     organization?: string;
-    private client;
-    private clientConfig;
+    protected client: OpenAIClient;
+    protected clientConfig: ClientOptions;
     constructor(fields?: Partial<OpenAIInput> & Partial<AzureOpenAIInput> & BaseLLMParams & {
         configuration?: ClientOptions & LegacyOpenAIInput;
     }, 
@@ -124,6 +125,6 @@ export declare class OpenAI<CallOptions extends OpenAICallOptions = OpenAICallOp
      * @param options Optional configuration for the API call.
      * @returns The response from the OpenAI API.
      */
-    private _getClientOptions;
+    protected _getClientOptions(options: OpenAICoreRequestOptions | undefined): OpenAICoreRequestOptions;
     _llmType(): string;
 }

package/dist/llms.js

@@ -208,6 +208,12 @@ export class OpenAI extends BaseLLM {
             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,
@@ -253,8 +259,9 @@ export class OpenAI extends BaseLLM {
         this.azureOpenAIApiKey =
             fields?.azureOpenAIApiKey ??
                 getEnvironmentVariable("AZURE_OPENAI_API_KEY");
-        if (!this.azureOpenAIApiKey && !this.apiKey) {
-            throw new Error("OpenAI or Azure OpenAI API key not found");
+        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 ??
@@ -293,7 +300,7 @@ 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) {
+        if (this.azureOpenAIApiKey || this.azureADTokenProvider) {
             if (!this.azureOpenAIApiInstanceName && !this.azureOpenAIBasePath) {
                 throw new Error("Azure OpenAI API instance name not found");
             }

package/dist/tests/azure/chat_models.int.test.d.ts

@@ -0,0 +1 @@
+export {};