@langchain/openai 0.1.3 → 0.2.1

package/dist/chat_models.cjs

@@ -47,7 +47,7 @@ function messageToOpenAIRole(message) {
     }
 }
 exports.messageToOpenAIRole = messageToOpenAIRole;
-function openAIResponseToChatMessage(message) {
+function openAIResponseToChatMessage(message, messageId) {
     const rawToolCalls = message.tool_calls;
     switch (message.role) {
         case "assistant": {
@@ -70,6 +70,7 @@ function openAIResponseToChatMessage(message) {
                     function_call: message.function_call,
                     tool_calls: rawToolCalls,
                 },
+                id: messageId,
             });
         }
         default:
@@ -78,7 +79,7 @@ function openAIResponseToChatMessage(message) {
 }
 function _convertDeltaToMessageChunk(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-delta, defaultRole) {
+delta, messageId, defaultRole) {
     const role = delta.role ?? defaultRole;
     const content = delta.content ?? "";
     let additional_kwargs;
@@ -114,6 +115,7 @@ delta, defaultRole) {
             content,
             tool_call_chunks: toolCallChunks,
             additional_kwargs,
+            id: messageId,
         });
     }
     else if (role === "system") {
@@ -150,9 +152,11 @@ function convertMessagesToOpenAIParams(messages) {
         }
         if (message.additional_kwargs.function_call != null) {
             completionParam.function_call = message.additional_kwargs.function_call;
+            completionParam.content = null;
         }
         if ((0, messages_1.isAIMessage)(message) && !!message.tool_calls?.length) {
             completionParam.tool_calls = message.tool_calls.map(openai_tools_1.convertLangChainToolCallToOpenAI);
+            completionParam.content = null;
         }
         else {
             if (message.additional_kwargs.tool_calls != null) {
@@ -168,14 +172,13 @@ function convertMessagesToOpenAIParams(messages) {
 /**
  * Wrapper around OpenAI large language models that use the Chat endpoint.
  *
- * To use you should have the `openai` package installed, with the
- * `OPENAI_API_KEY` environment variable set.
+ * To use you should have the `OPENAI_API_KEY` environment variable set.
  *
- * To use with Azure you should have the `openai` package installed, with the
+ * To use with Azure you should have the:
  * `AZURE_OPENAI_API_KEY`,
  * `AZURE_OPENAI_API_INSTANCE_NAME`,
  * `AZURE_OPENAI_API_DEPLOYMENT_NAME`
- * and `AZURE_OPENAI_API_VERSION` environment variable set.
+ * and `AZURE_OPENAI_API_VERSION` environment variables set.
  * `AZURE_OPENAI_BASE_PATH` is optional and will override `AZURE_OPENAI_API_INSTANCE_NAME` if you need to use a custom endpoint.
  *
  * @remarks
@@ -329,6 +332,12 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             writable: true,
             value: false
         });
+        Object.defineProperty(this, "streamUsage", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
         Object.defineProperty(this, "maxTokens", {
             enumerable: true,
             configurable: true,
@@ -456,7 +465,6 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
         this.stop = fields?.stopSequences ?? fields?.stop;
         this.stopSequences = this?.stop;
         this.user = fields?.user;
-        this.streaming = fields?.streaming ?? false;
         if (this.azureOpenAIApiKey || this.azureADTokenProvider) {
             if (!this.azureOpenAIApiInstanceName && !this.azureOpenAIBasePath) {
                 throw new Error("Azure OpenAI API instance name not found");
@@ -468,7 +476,11 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
                 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;
         }
+        this.streaming = fields?.streaming ?? false;
+        this.streamUsage = fields?.streamUsage ?? this.streamUsage;
         this.clientConfig = {
             apiKey: this.apiKey,
             organization: this.organization,
@@ -507,6 +519,13 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             return (tools !== undefined &&
                 tools.every((tool) => Array.isArray(tool.lc_namespace)));
         }
+        let streamOptionsConfig = {};
+        if (options?.stream_options !== undefined) {
+            streamOptionsConfig = { stream_options: options.stream_options };
+        }
+        else if (this.streamUsage && this.streaming) {
+            streamOptionsConfig = { stream_options: { include_usage: true } };
+        }
         const params = {
             model: this.model,
             temperature: this.temperature,
@@ -520,6 +539,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             logit_bias: this.logitBias,
             stop: options?.stop ?? this.stopSequences,
             user: this.user,
+            // if include_usage is set or streamUsage then stream must be set to true.
             stream: this.streaming,
             functions: options?.functions,
             function_call: options?.function_call,
@@ -529,9 +549,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             tool_choice: options?.tool_choice,
             response_format: options?.response_format,
             seed: options?.seed,
-            ...(options?.stream_options !== undefined
-                ? { stream_options: options.stream_options }
-                : {}),
+            ...streamOptionsConfig,
             parallel_tool_calls: options?.parallel_tool_calls,
             ...this.modelKwargs,
         };
@@ -567,7 +585,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             if (!delta) {
                 continue;
             }
-            const chunk = _convertDeltaToMessageChunk(delta, defaultRole);
+            const chunk = _convertDeltaToMessageChunk(delta, data.id, defaultRole);
             defaultRole = delta.role ?? defaultRole;
             const newTokenIndices = {
                 prompt: options.promptIndex ?? 0,
@@ -678,7 +696,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
                 const text = part.message?.content ?? "";
                 const generation = {
                     text,
-                    message: openAIResponseToChatMessage(part.message ?? { role: "assistant" }),
+                    message: openAIResponseToChatMessage(part.message ?? { role: "assistant" }, data.id),
                 };
                 generation.generationInfo = {
                     ...(part.finish_reason ? { finish_reason: part.finish_reason } : {}),

package/dist/chat_models.d.ts

@@ -29,6 +29,7 @@ export interface ChatOpenAICallOptions extends OpenAICallOptions, BaseFunctionCa
     seed?: number;
     /**
      * Additional options to pass to streamed completions.
+     * If provided takes precedence over "streamUsage" set at initialization time.
      */
     stream_options?: {
         /**
@@ -47,14 +48,13 @@ export interface ChatOpenAICallOptions extends OpenAICallOptions, BaseFunctionCa
 /**
  * Wrapper around OpenAI large language models that use the Chat endpoint.
  *
- * To use you should have the `openai` package installed, with the
- * `OPENAI_API_KEY` environment variable set.
+ * To use you should have the `OPENAI_API_KEY` environment variable set.
  *
- * To use with Azure you should have the `openai` package installed, with the
+ * To use with Azure you should have the:
  * `AZURE_OPENAI_API_KEY`,
  * `AZURE_OPENAI_API_INSTANCE_NAME`,
  * `AZURE_OPENAI_API_DEPLOYMENT_NAME`
- * and `AZURE_OPENAI_API_VERSION` environment variable set.
+ * and `AZURE_OPENAI_API_VERSION` environment variables set.
  * `AZURE_OPENAI_BASE_PATH` is optional and will override `AZURE_OPENAI_API_INSTANCE_NAME` if you need to use a custom endpoint.
  *
  * @remarks
@@ -100,6 +100,7 @@ export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = Chat
     user?: string;
     timeout?: number;
     streaming: boolean;
+    streamUsage: boolean;
     maxTokens?: number;
     logprobs?: boolean;
     topLogprobs?: number;

package/dist/chat_models.js

@@ -43,7 +43,7 @@ export function messageToOpenAIRole(message) {
             throw new Error(`Unknown message type: ${type}`);
     }
 }
-function openAIResponseToChatMessage(message) {
+function openAIResponseToChatMessage(message, messageId) {
     const rawToolCalls = message.tool_calls;
     switch (message.role) {
         case "assistant": {
@@ -66,6 +66,7 @@ function openAIResponseToChatMessage(message) {
                     function_call: message.function_call,
                     tool_calls: rawToolCalls,
                 },
+                id: messageId,
             });
         }
         default:
@@ -74,7 +75,7 @@ function openAIResponseToChatMessage(message) {
 }
 function _convertDeltaToMessageChunk(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-delta, defaultRole) {
+delta, messageId, defaultRole) {
     const role = delta.role ?? defaultRole;
     const content = delta.content ?? "";
     let additional_kwargs;
@@ -110,6 +111,7 @@ delta, defaultRole) {
             content,
             tool_call_chunks: toolCallChunks,
             additional_kwargs,
+            id: messageId,
         });
     }
     else if (role === "system") {
@@ -146,9 +148,11 @@ function convertMessagesToOpenAIParams(messages) {
         }
         if (message.additional_kwargs.function_call != null) {
             completionParam.function_call = message.additional_kwargs.function_call;
+            completionParam.content = null;
         }
         if (isAIMessage(message) && !!message.tool_calls?.length) {
             completionParam.tool_calls = message.tool_calls.map(convertLangChainToolCallToOpenAI);
+            completionParam.content = null;
         }
         else {
             if (message.additional_kwargs.tool_calls != null) {
@@ -164,14 +168,13 @@ function convertMessagesToOpenAIParams(messages) {
 /**
  * Wrapper around OpenAI large language models that use the Chat endpoint.
  *
- * To use you should have the `openai` package installed, with the
- * `OPENAI_API_KEY` environment variable set.
+ * To use you should have the `OPENAI_API_KEY` environment variable set.
  *
- * To use with Azure you should have the `openai` package installed, with the
+ * To use with Azure you should have the:
  * `AZURE_OPENAI_API_KEY`,
  * `AZURE_OPENAI_API_INSTANCE_NAME`,
  * `AZURE_OPENAI_API_DEPLOYMENT_NAME`
- * and `AZURE_OPENAI_API_VERSION` environment variable set.
+ * and `AZURE_OPENAI_API_VERSION` environment variables set.
  * `AZURE_OPENAI_BASE_PATH` is optional and will override `AZURE_OPENAI_API_INSTANCE_NAME` if you need to use a custom endpoint.
  *
  * @remarks
@@ -325,6 +328,12 @@ export class ChatOpenAI extends BaseChatModel {
             writable: true,
             value: false
         });
+        Object.defineProperty(this, "streamUsage", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
         Object.defineProperty(this, "maxTokens", {
             enumerable: true,
             configurable: true,
@@ -452,7 +461,6 @@ export class ChatOpenAI extends BaseChatModel {
         this.stop = fields?.stopSequences ?? fields?.stop;
         this.stopSequences = this?.stop;
         this.user = fields?.user;
-        this.streaming = fields?.streaming ?? false;
         if (this.azureOpenAIApiKey || this.azureADTokenProvider) {
             if (!this.azureOpenAIApiInstanceName && !this.azureOpenAIBasePath) {
                 throw new Error("Azure OpenAI API instance name not found");
@@ -464,7 +472,11 @@ export class ChatOpenAI extends BaseChatModel {
                 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;
         }
+        this.streaming = fields?.streaming ?? false;
+        this.streamUsage = fields?.streamUsage ?? this.streamUsage;
         this.clientConfig = {
             apiKey: this.apiKey,
             organization: this.organization,
@@ -503,6 +515,13 @@ export class ChatOpenAI extends BaseChatModel {
             return (tools !== undefined &&
                 tools.every((tool) => Array.isArray(tool.lc_namespace)));
         }
+        let streamOptionsConfig = {};
+        if (options?.stream_options !== undefined) {
+            streamOptionsConfig = { stream_options: options.stream_options };
+        }
+        else if (this.streamUsage && this.streaming) {
+            streamOptionsConfig = { stream_options: { include_usage: true } };
+        }
         const params = {
             model: this.model,
             temperature: this.temperature,
@@ -516,6 +535,7 @@ export class ChatOpenAI extends BaseChatModel {
             logit_bias: this.logitBias,
             stop: options?.stop ?? this.stopSequences,
             user: this.user,
+            // if include_usage is set or streamUsage then stream must be set to true.
             stream: this.streaming,
             functions: options?.functions,
             function_call: options?.function_call,
@@ -525,9 +545,7 @@ export class ChatOpenAI extends BaseChatModel {
             tool_choice: options?.tool_choice,
             response_format: options?.response_format,
             seed: options?.seed,
-            ...(options?.stream_options !== undefined
-                ? { stream_options: options.stream_options }
-                : {}),
+            ...streamOptionsConfig,
             parallel_tool_calls: options?.parallel_tool_calls,
             ...this.modelKwargs,
         };
@@ -563,7 +581,7 @@ export class ChatOpenAI extends BaseChatModel {
             if (!delta) {
                 continue;
             }
-            const chunk = _convertDeltaToMessageChunk(delta, defaultRole);
+            const chunk = _convertDeltaToMessageChunk(delta, data.id, defaultRole);
             defaultRole = delta.role ?? defaultRole;
             const newTokenIndices = {
                 prompt: options.promptIndex ?? 0,
@@ -674,7 +692,7 @@ export class ChatOpenAI extends BaseChatModel {
                 const text = part.message?.content ?? "";
                 const generation = {
                     text,
-                    message: openAIResponseToChatMessage(part.message ?? { role: "assistant" }),
+                    message: openAIResponseToChatMessage(part.message ?? { role: "assistant" }, data.id),
                 };
                 generation.generationInfo = {
                     ...(part.finish_reason ? { finish_reason: part.finish_reason } : {}),

package/dist/types.d.ts

@@ -24,6 +24,11 @@ export declare interface OpenAIBaseInput {
     user?: string;
     /** Whether to stream the results or not. Enabling disables tokenUsage reporting */
     streaming: boolean;
+    /**
+     * Whether or not to include token usage data in streamed chunks.
+     * @default true
+     */
+    streamUsage?: boolean;
     /**
      * Model name to use
      * Alias for `model`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/openai",
-  "version": "0.1.3",
+  "version": "0.2.1",
   "description": "OpenAI integrations for LangChain.js",
   "type": "module",
   "engines": {
@@ -35,7 +35,7 @@
   "author": "LangChain",
   "license": "MIT",
   "dependencies": {
-    "@langchain/core": ">=0.2.5 <0.3.0",
+    "@langchain/core": ">=0.2.8 <0.3.0",
     "js-tiktoken": "^1.0.12",
     "openai": "^4.49.1",
     "zod": "^3.22.4",