@langchain/openai 0.2.2 → 0.2.4

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 });
     }
@@ -116,7 +130,7 @@ delta, messageId, defaultRole) {
             content,
             tool_call_chunks: toolCallChunks,
             additional_kwargs,
-            id: messageId,
+            id: rawResponse.id,
         });
     }
     else if (role === "system") {
@@ -411,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,
@@ -466,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");
@@ -547,7 +568,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             tools: isStructuredToolArray(options?.tools)
                 ? options?.tools.map(function_calling_1.convertToOpenAITool)
                 : options?.tools,
-            tool_choice: options?.tool_choice,
+            tool_choice: (0, openai_js_1.formatToOpenAIToolChoice)(options?.tool_choice),
             response_format: options?.response_format,
             seed: options?.seed,
             ...streamOptionsConfig,
@@ -588,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,
@@ -602,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;
@@ -698,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

@@ -8,6 +8,7 @@ import type { BaseFunctionCallOptions, BaseLanguageModelInput, StructuredOutputM
 import { z } from "zod";
 import { Runnable, RunnableToolLike } from "@langchain/core/runnables";
 import type { AzureOpenAIInput, OpenAICallOptions, OpenAIChatInput, OpenAICoreRequestOptions, LegacyOpenAIInput } from "./types.js";
+import { OpenAIToolChoice } from "./utils/openai.js";
 export type { AzureOpenAIInput, OpenAICallOptions, OpenAIChatInput };
 interface TokenUsage {
     completionTokens?: number;
@@ -21,7 +22,7 @@ type OpenAIRoleEnum = "system" | "assistant" | "user" | "function" | "tool";
 export declare function messageToOpenAIRole(message: BaseMessage): OpenAIRoleEnum;
 export interface ChatOpenAICallOptions extends OpenAICallOptions, BaseFunctionCallOptions {
     tools?: StructuredToolInterface[] | OpenAIClient.ChatCompletionTool[];
-    tool_choice?: OpenAIClient.ChatCompletionToolChoiceOption;
+    tool_choice?: OpenAIToolChoice;
     promptIndex?: number;
     response_format?: {
         type: "json_object";
@@ -113,6 +114,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 & {

package/dist/chat_models.js

@@ -9,7 +9,7 @@ import { JsonOutputParser, StructuredOutputParser, } from "@langchain/core/outpu
 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";
+import { formatToOpenAIToolChoice, wrapOpenAIClientError, } from "./utils/openai.js";
 import { formatFunctionDefinitions, } from "./utils/openai-format-fndef.js";
 function extractGenericMessageCustomRole(message) {
     if (message.role !== "system" &&
@@ -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 });
     }
@@ -112,7 +126,7 @@ delta, messageId, defaultRole) {
             content,
             tool_call_chunks: toolCallChunks,
             additional_kwargs,
-            id: messageId,
+            id: rawResponse.id,
         });
     }
     else if (role === "system") {
@@ -407,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,
@@ -462,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");
@@ -543,7 +564,7 @@ export class ChatOpenAI extends BaseChatModel {
             tools: isStructuredToolArray(options?.tools)
                 ? options?.tools.map(convertToOpenAITool)
                 : options?.tools,
-            tool_choice: options?.tool_choice,
+            tool_choice: formatToOpenAIToolChoice(options?.tool_choice),
             response_format: options?.response_format,
             seed: options?.seed,
             ...streamOptionsConfig,
@@ -584,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,
@@ -598,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;
@@ -694,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/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/dist/utils/openai.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatToOpenAIAssistantTool = exports.formatToOpenAITool = exports.formatToOpenAIFunction = exports.wrapOpenAIClientError = void 0;
+exports.formatToOpenAIToolChoice = exports.formatToOpenAIAssistantTool = exports.formatToOpenAITool = exports.formatToOpenAIFunction = exports.wrapOpenAIClientError = void 0;
 const openai_1 = require("openai");
 const zod_to_json_schema_1 = require("zod-to-json-schema");
 const function_calling_1 = require("@langchain/core/utils/function_calling");
@@ -34,3 +34,29 @@ function formatToOpenAIAssistantTool(tool) {
     };
 }
 exports.formatToOpenAIAssistantTool = formatToOpenAIAssistantTool;
+function formatToOpenAIToolChoice(toolChoice) {
+    if (!toolChoice) {
+        return undefined;
+    }
+    else if (toolChoice === "any" || toolChoice === "required") {
+        return "required";
+    }
+    else if (toolChoice === "auto") {
+        return "auto";
+    }
+    else if (toolChoice === "none") {
+        return "none";
+    }
+    else if (typeof toolChoice === "string") {
+        return {
+            type: "function",
+            function: {
+                name: toolChoice,
+            },
+        };
+    }
+    else {
+        return toolChoice;
+    }
+}
+exports.formatToOpenAIToolChoice = formatToOpenAIToolChoice;

package/dist/utils/openai.d.ts

@@ -1,3 +1,4 @@
+import { OpenAI as OpenAIClient } from "openai";
 import type { StructuredToolInterface } from "@langchain/core/tools";
 import { convertToOpenAIFunction, convertToOpenAITool } from "@langchain/core/utils/function_calling";
 export declare function wrapOpenAIClientError(e: any): any;
@@ -15,3 +16,5 @@ export declare function formatToOpenAIAssistantTool(tool: StructuredToolInterfac
         };
     };
 };
+export type OpenAIToolChoice = OpenAIClient.ChatCompletionToolChoiceOption | "any" | string;
+export declare function formatToOpenAIToolChoice(toolChoice?: OpenAIToolChoice): OpenAIClient.ChatCompletionToolChoiceOption | undefined;

package/dist/utils/openai.js

@@ -1,4 +1,4 @@
-import { APIConnectionTimeoutError, APIUserAbortError } from "openai";
+import { APIConnectionTimeoutError, APIUserAbortError, } from "openai";
 import { zodToJsonSchema } from "zod-to-json-schema";
 import { convertToOpenAIFunction, convertToOpenAITool, } from "@langchain/core/utils/function_calling";
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -28,3 +28,28 @@ export function formatToOpenAIAssistantTool(tool) {
         },
     };
 }
+export function formatToOpenAIToolChoice(toolChoice) {
+    if (!toolChoice) {
+        return undefined;
+    }
+    else if (toolChoice === "any" || toolChoice === "required") {
+        return "required";
+    }
+    else if (toolChoice === "auto") {
+        return "auto";
+    }
+    else if (toolChoice === "none") {
+        return "none";
+    }
+    else if (typeof toolChoice === "string") {
+        return {
+            type: "function",
+            function: {
+                name: toolChoice,
+            },
+        };
+    }
+    else {
+        return toolChoice;
+    }
+}

package/package.json

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