@langchain/openai 0.2.1 → 0.2.3

package/dist/chat_models.cjs

@@ -47,7 +47,7 @@ function messageToOpenAIRole(message) {
     }
 }
 exports.messageToOpenAIRole = messageToOpenAIRole;
-function openAIResponseToChatMessage(message, messageId) {
+function openAIResponseToChatMessage(message, rawResponse, includeRawResponse) {
     const rawToolCalls = message.tool_calls;
     switch (message.role) {
         case "assistant": {
@@ -62,15 +62,26 @@ function openAIResponseToChatMessage(message, messageId) {
                     invalidToolCalls.push((0, openai_tools_1.makeInvalidToolCall)(rawToolCall, e.message));
                 }
             }
+            const additional_kwargs = {
+                function_call: message.function_call,
+                tool_calls: rawToolCalls,
+            };
+            if (includeRawResponse !== undefined) {
+                additional_kwargs.__raw_response = rawResponse;
+            }
+            let response_metadata;
+            if (rawResponse.system_fingerprint) {
+                response_metadata = {
+                    system_fingerprint: rawResponse.system_fingerprint,
+                };
+            }
             return new messages_1.AIMessage({
                 content: message.content || "",
                 tool_calls: toolCalls,
                 invalid_tool_calls: invalidToolCalls,
-                additional_kwargs: {
-                    function_call: message.function_call,
-                    tool_calls: rawToolCalls,
-                },
-                id: messageId,
+                additional_kwargs,
+                response_metadata,
+                id: rawResponse.id,
             });
         }
         default:
@@ -79,7 +90,7 @@ function openAIResponseToChatMessage(message, messageId) {
 }
 function _convertDeltaToMessageChunk(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-delta, messageId, defaultRole) {
+delta, rawResponse, defaultRole, includeRawResponse) {
     const role = delta.role ?? defaultRole;
     const content = delta.content ?? "";
     let additional_kwargs;
@@ -96,6 +107,9 @@ delta, messageId, defaultRole) {
     else {
         additional_kwargs = {};
     }
+    if (includeRawResponse) {
+        additional_kwargs.__raw_response = rawResponse;
+    }
     if (role === "user") {
         return new messages_1.HumanMessageChunk({ content });
     }
@@ -108,6 +122,7 @@ delta, messageId, defaultRole) {
                     args: rawToolCall.function?.arguments,
                     id: rawToolCall.id,
                     index: rawToolCall.index,
+                    type: "tool_call_chunk",
                 });
             }
         }
@@ -115,7 +130,7 @@ delta, messageId, defaultRole) {
             content,
             tool_call_chunks: toolCallChunks,
             additional_kwargs,
-            id: messageId,
+            id: rawResponse.id,
         });
     }
     else if (role === "system") {
@@ -410,6 +425,12 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "__includeRawResponse", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "client", {
             enumerable: true,
             configurable: true,
@@ -465,6 +486,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
         this.stop = fields?.stopSequences ?? fields?.stop;
         this.stopSequences = this?.stop;
         this.user = fields?.user;
+        this.__includeRawResponse = fields?.__includeRawResponse;
         if (this.azureOpenAIApiKey || this.azureADTokenProvider) {
             if (!this.azureOpenAIApiInstanceName && !this.azureOpenAIBasePath) {
                 throw new Error("Azure OpenAI API instance name not found");
@@ -514,7 +536,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
     /**
      * Get the parameters used to invoke the model
      */
-    invocationParams(options) {
+    invocationParams(options, extra) {
         function isStructuredToolArray(tools) {
             return (tools !== undefined &&
                 tools.every((tool) => Array.isArray(tool.lc_namespace)));
@@ -523,7 +545,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
         if (options?.stream_options !== undefined) {
             streamOptionsConfig = { stream_options: options.stream_options };
         }
-        else if (this.streamUsage && this.streaming) {
+        else if (this.streamUsage && (this.streaming || extra?.streaming)) {
             streamOptionsConfig = { stream_options: { include_usage: true } };
         }
         const params = {
@@ -566,7 +588,9 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
     async *_streamResponseChunks(messages, options, runManager) {
         const messagesMapped = convertMessagesToOpenAIParams(messages);
         const params = {
-            ...this.invocationParams(options),
+            ...this.invocationParams(options, {
+                streaming: true,
+            }),
             messages: messagesMapped,
             stream: true,
         };
@@ -585,7 +609,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             if (!delta) {
                 continue;
             }
-            const chunk = _convertDeltaToMessageChunk(delta, data.id, defaultRole);
+            const chunk = _convertDeltaToMessageChunk(delta, data, defaultRole, this.__includeRawResponse);
             defaultRole = delta.role ?? defaultRole;
             const newTokenIndices = {
                 prompt: options.promptIndex ?? 0,
@@ -599,6 +623,9 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             const generationInfo = { ...newTokenIndices };
             if (choice.finish_reason !== undefined) {
                 generationInfo.finish_reason = choice.finish_reason;
+                // Only include system fingerprint in the last chunk for now
+                // to avoid concatenation issues
+                generationInfo.system_fingerprint = data.system_fingerprint;
             }
             if (this.logprobs) {
                 generationInfo.logprobs = choice.logprobs;
@@ -609,8 +636,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
                 generationInfo,
             });
             yield generationChunk;
-            // eslint-disable-next-line no-void
-            void runManager?.handleLLMNewToken(generationChunk.text ?? "", newTokenIndices, undefined, undefined, undefined, { chunk: generationChunk });
+            await runManager?.handleLLMNewToken(generationChunk.text ?? "", newTokenIndices, undefined, undefined, undefined, { chunk: generationChunk });
         }
         if (usage) {
             const generationChunk = new outputs_1.ChatGenerationChunk({
@@ -696,7 +722,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
                 const text = part.message?.content ?? "";
                 const generation = {
                     text,
-                    message: openAIResponseToChatMessage(part.message ?? { role: "assistant" }, data.id),
+                    message: openAIResponseToChatMessage(part.message ?? { role: "assistant" }, data, this.__includeRawResponse),
                 };
                 generation.generationInfo = {
                     ...(part.finish_reason ? { finish_reason: part.finish_reason } : {}),

package/dist/chat_models.d.ts

@@ -6,7 +6,7 @@ import { type StructuredToolInterface } from "@langchain/core/tools";
 import { BaseChatModel, LangSmithParams, type BaseChatModelParams } from "@langchain/core/language_models/chat_models";
 import type { BaseFunctionCallOptions, BaseLanguageModelInput, StructuredOutputMethodOptions, StructuredOutputMethodParams } from "@langchain/core/language_models/base";
 import { z } from "zod";
-import { Runnable } from "@langchain/core/runnables";
+import { Runnable, RunnableToolLike } from "@langchain/core/runnables";
 import type { AzureOpenAIInput, OpenAICallOptions, OpenAIChatInput, OpenAICoreRequestOptions, LegacyOpenAIInput } from "./types.js";
 export type { AzureOpenAIInput, OpenAICallOptions, OpenAIChatInput };
 interface TokenUsage {
@@ -113,6 +113,7 @@ export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = Chat
     azureOpenAIApiDeploymentName?: string;
     azureOpenAIBasePath?: string;
     organization?: string;
+    __includeRawResponse?: boolean;
     protected client: OpenAIClient;
     protected clientConfig: ClientOptions;
     constructor(fields?: Partial<OpenAIChatInput> & Partial<AzureOpenAIInput> & BaseChatModelParams & {
@@ -121,11 +122,13 @@ export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = Chat
     /** @deprecated */
     configuration?: ClientOptions & LegacyOpenAIInput);
     getLsParams(options: this["ParsedCallOptions"]): LangSmithParams;
-    bindTools(tools: (Record<string, unknown> | StructuredToolInterface)[], kwargs?: Partial<CallOptions>): Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions>;
+    bindTools(tools: (Record<string, unknown> | StructuredToolInterface | RunnableToolLike)[], kwargs?: Partial<CallOptions>): Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions>;
     /**
      * Get the parameters used to invoke the model
      */
-    invocationParams(options?: this["ParsedCallOptions"]): Omit<OpenAIClient.Chat.ChatCompletionCreateParams, "messages">;
+    invocationParams(options?: this["ParsedCallOptions"], extra?: {
+        streaming?: boolean;
+    }): Omit<OpenAIClient.Chat.ChatCompletionCreateParams, "messages">;
     /** @ignore */
     _identifyingParams(): Omit<OpenAIClient.Chat.ChatCompletionCreateParams, "messages"> & {
         model_name: string;

package/dist/chat_models.js

@@ -43,7 +43,7 @@ export function messageToOpenAIRole(message) {
             throw new Error(`Unknown message type: ${type}`);
     }
 }
-function openAIResponseToChatMessage(message, messageId) {
+function openAIResponseToChatMessage(message, rawResponse, includeRawResponse) {
     const rawToolCalls = message.tool_calls;
     switch (message.role) {
         case "assistant": {
@@ -58,15 +58,26 @@ function openAIResponseToChatMessage(message, messageId) {
                     invalidToolCalls.push(makeInvalidToolCall(rawToolCall, e.message));
                 }
             }
+            const additional_kwargs = {
+                function_call: message.function_call,
+                tool_calls: rawToolCalls,
+            };
+            if (includeRawResponse !== undefined) {
+                additional_kwargs.__raw_response = rawResponse;
+            }
+            let response_metadata;
+            if (rawResponse.system_fingerprint) {
+                response_metadata = {
+                    system_fingerprint: rawResponse.system_fingerprint,
+                };
+            }
             return new AIMessage({
                 content: message.content || "",
                 tool_calls: toolCalls,
                 invalid_tool_calls: invalidToolCalls,
-                additional_kwargs: {
-                    function_call: message.function_call,
-                    tool_calls: rawToolCalls,
-                },
-                id: messageId,
+                additional_kwargs,
+                response_metadata,
+                id: rawResponse.id,
             });
         }
         default:
@@ -75,7 +86,7 @@ function openAIResponseToChatMessage(message, messageId) {
 }
 function _convertDeltaToMessageChunk(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-delta, messageId, defaultRole) {
+delta, rawResponse, defaultRole, includeRawResponse) {
     const role = delta.role ?? defaultRole;
     const content = delta.content ?? "";
     let additional_kwargs;
@@ -92,6 +103,9 @@ delta, messageId, defaultRole) {
     else {
         additional_kwargs = {};
     }
+    if (includeRawResponse) {
+        additional_kwargs.__raw_response = rawResponse;
+    }
     if (role === "user") {
         return new HumanMessageChunk({ content });
     }
@@ -104,6 +118,7 @@ delta, messageId, defaultRole) {
                     args: rawToolCall.function?.arguments,
                     id: rawToolCall.id,
                     index: rawToolCall.index,
+                    type: "tool_call_chunk",
                 });
             }
         }
@@ -111,7 +126,7 @@ delta, messageId, defaultRole) {
             content,
             tool_call_chunks: toolCallChunks,
             additional_kwargs,
-            id: messageId,
+            id: rawResponse.id,
         });
     }
     else if (role === "system") {
@@ -406,6 +421,12 @@ export class ChatOpenAI extends BaseChatModel {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "__includeRawResponse", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "client", {
             enumerable: true,
             configurable: true,
@@ -461,6 +482,7 @@ export class ChatOpenAI extends BaseChatModel {
         this.stop = fields?.stopSequences ?? fields?.stop;
         this.stopSequences = this?.stop;
         this.user = fields?.user;
+        this.__includeRawResponse = fields?.__includeRawResponse;
         if (this.azureOpenAIApiKey || this.azureADTokenProvider) {
             if (!this.azureOpenAIApiInstanceName && !this.azureOpenAIBasePath) {
                 throw new Error("Azure OpenAI API instance name not found");
@@ -510,7 +532,7 @@ export class ChatOpenAI extends BaseChatModel {
     /**
      * Get the parameters used to invoke the model
      */
-    invocationParams(options) {
+    invocationParams(options, extra) {
         function isStructuredToolArray(tools) {
             return (tools !== undefined &&
                 tools.every((tool) => Array.isArray(tool.lc_namespace)));
@@ -519,7 +541,7 @@ export class ChatOpenAI extends BaseChatModel {
         if (options?.stream_options !== undefined) {
             streamOptionsConfig = { stream_options: options.stream_options };
         }
-        else if (this.streamUsage && this.streaming) {
+        else if (this.streamUsage && (this.streaming || extra?.streaming)) {
             streamOptionsConfig = { stream_options: { include_usage: true } };
         }
         const params = {
@@ -562,7 +584,9 @@ export class ChatOpenAI extends BaseChatModel {
     async *_streamResponseChunks(messages, options, runManager) {
         const messagesMapped = convertMessagesToOpenAIParams(messages);
         const params = {
-            ...this.invocationParams(options),
+            ...this.invocationParams(options, {
+                streaming: true,
+            }),
             messages: messagesMapped,
             stream: true,
         };
@@ -581,7 +605,7 @@ export class ChatOpenAI extends BaseChatModel {
             if (!delta) {
                 continue;
             }
-            const chunk = _convertDeltaToMessageChunk(delta, data.id, defaultRole);
+            const chunk = _convertDeltaToMessageChunk(delta, data, defaultRole, this.__includeRawResponse);
             defaultRole = delta.role ?? defaultRole;
             const newTokenIndices = {
                 prompt: options.promptIndex ?? 0,
@@ -595,6 +619,9 @@ export class ChatOpenAI extends BaseChatModel {
             const generationInfo = { ...newTokenIndices };
             if (choice.finish_reason !== undefined) {
                 generationInfo.finish_reason = choice.finish_reason;
+                // Only include system fingerprint in the last chunk for now
+                // to avoid concatenation issues
+                generationInfo.system_fingerprint = data.system_fingerprint;
             }
             if (this.logprobs) {
                 generationInfo.logprobs = choice.logprobs;
@@ -605,8 +632,7 @@ export class ChatOpenAI extends BaseChatModel {
                 generationInfo,
             });
             yield generationChunk;
-            // eslint-disable-next-line no-void
-            void runManager?.handleLLMNewToken(generationChunk.text ?? "", newTokenIndices, undefined, undefined, undefined, { chunk: generationChunk });
+            await runManager?.handleLLMNewToken(generationChunk.text ?? "", newTokenIndices, undefined, undefined, undefined, { chunk: generationChunk });
         }
         if (usage) {
             const generationChunk = new ChatGenerationChunk({
@@ -692,7 +718,7 @@ export class ChatOpenAI extends BaseChatModel {
                 const text = part.message?.content ?? "";
                 const generation = {
                     text,
-                    message: openAIResponseToChatMessage(part.message ?? { role: "assistant" }, data.id),
+                    message: openAIResponseToChatMessage(part.message ?? { role: "assistant" }, data, this.__includeRawResponse),
                 };
                 generation.generationInfo = {
                     ...(part.finish_reason ? { finish_reason: part.finish_reason } : {}),

package/dist/tools/dalle.cjs

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DallEAPIWrapper = void 0;
+/* eslint-disable no-param-reassign */
 const env_1 = require("@langchain/core/utils/env");
 const openai_1 = require("openai");
 const tools_1 = require("@langchain/core/tools");
@@ -12,6 +13,13 @@ class DallEAPIWrapper extends tools_1.Tool {
         return "DallEAPIWrapper";
     }
     constructor(fields) {
+        // Shim for new base tool param name
+        if (fields?.responseFormat !== undefined &&
+            ["url", "b64_json"].includes(fields.responseFormat)) {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            fields.dallEResponseFormat = fields.responseFormat;
+            fields.responseFormat = "content";
+        }
         super(fields);
         Object.defineProperty(this, "name", {
             enumerable: true,
@@ -61,7 +69,7 @@ class DallEAPIWrapper extends tools_1.Tool {
             writable: true,
             value: "1024x1024"
         });
-        Object.defineProperty(this, "responseFormat", {
+        Object.defineProperty(this, "dallEResponseFormat", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -88,7 +96,8 @@ class DallEAPIWrapper extends tools_1.Tool {
         this.quality = fields?.quality ?? this.quality;
         this.n = fields?.n ?? this.n;
         this.size = fields?.size ?? this.size;
-        this.responseFormat = fields?.responseFormat ?? this.responseFormat;
+        this.dallEResponseFormat =
+            fields?.dallEResponseFormat ?? this.dallEResponseFormat;
         this.user = fields?.user;
     }
     /** @ignore */
@@ -98,13 +107,13 @@ class DallEAPIWrapper extends tools_1.Tool {
             prompt: input,
             n: this.n,
             size: this.size,
-            response_format: this.responseFormat,
+            response_format: this.dallEResponseFormat,
             style: this.style,
             quality: this.quality,
             user: this.user,
         });
         let data = "";
-        if (this.responseFormat === "url") {
+        if (this.dallEResponseFormat === "url") {
             [data] = response.data
                 .map((item) => item.url)
                 .filter((url) => url !== "undefined");

package/dist/tools/dalle.d.ts

@@ -58,7 +58,11 @@ export interface DallEAPIWrapperParams extends ToolParams {
      * Must be one of "url" or "b64_json".
      * @default "url"
      */
-    responseFormat?: "url" | "b64_json";
+    dallEResponseFormat?: "url" | "b64_json";
+    /**
+     * @deprecated Use dallEResponseFormat instead for the Dall-E response type.
+     */
+    responseFormat?: any;
     /**
      * A unique identifier representing your end-user, which will help
      * OpenAI to monitor and detect abuse.
@@ -83,7 +87,7 @@ export declare class DallEAPIWrapper extends Tool {
     private quality;
     private n;
     private size;
-    private responseFormat;
+    private dallEResponseFormat;
     private user?;
     constructor(fields?: DallEAPIWrapperParams);
     /** @ignore */

package/dist/tools/dalle.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-param-reassign */
 import { getEnvironmentVariable } from "@langchain/core/utils/env";
 import { OpenAI as OpenAIClient } from "openai";
 import { Tool } from "@langchain/core/tools";
@@ -9,6 +10,13 @@ export class DallEAPIWrapper extends Tool {
         return "DallEAPIWrapper";
     }
     constructor(fields) {
+        // Shim for new base tool param name
+        if (fields?.responseFormat !== undefined &&
+            ["url", "b64_json"].includes(fields.responseFormat)) {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            fields.dallEResponseFormat = fields.responseFormat;
+            fields.responseFormat = "content";
+        }
         super(fields);
         Object.defineProperty(this, "name", {
             enumerable: true,
@@ -58,7 +66,7 @@ export class DallEAPIWrapper extends Tool {
             writable: true,
             value: "1024x1024"
         });
-        Object.defineProperty(this, "responseFormat", {
+        Object.defineProperty(this, "dallEResponseFormat", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -85,7 +93,8 @@ export class DallEAPIWrapper extends Tool {
         this.quality = fields?.quality ?? this.quality;
         this.n = fields?.n ?? this.n;
         this.size = fields?.size ?? this.size;
-        this.responseFormat = fields?.responseFormat ?? this.responseFormat;
+        this.dallEResponseFormat =
+            fields?.dallEResponseFormat ?? this.dallEResponseFormat;
         this.user = fields?.user;
     }
     /** @ignore */
@@ -95,13 +104,13 @@ export class DallEAPIWrapper extends Tool {
             prompt: input,
             n: this.n,
             size: this.size,
-            response_format: this.responseFormat,
+            response_format: this.dallEResponseFormat,
             style: this.style,
             quality: this.quality,
             user: this.user,
         });
         let data = "";
-        if (this.responseFormat === "url") {
+        if (this.dallEResponseFormat === "url") {
             [data] = response.data
                 .map((item) => item.url)
                 .filter((url) => url !== "undefined");

package/dist/types.d.ts

@@ -115,7 +115,12 @@ export interface OpenAIChatInput extends OpenAIBaseInput {
      */
     topLogprobs?: number;
     /** ChatGPT messages to pass as a prefix to the prompt */
-    prefixMessages?: OpenAIClient.Chat.CreateChatCompletionRequestMessage[];
+    prefixMessages?: OpenAIClient.Chat.ChatCompletionMessageParam[];
+    /**
+     * Whether to include the raw OpenAI response in the output message's "additional_kwargs" field.
+     * Currently in experimental beta.
+     */
+    __includeRawResponse?: boolean;
 }
 export declare interface AzureOpenAIInput {
     /**

package/package.json

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