@langchain/openai 0.6.13 → 0.6.15

package/dist/chat_models.cjs

@@ -527,7 +527,7 @@ class BaseChatOpenAI extends chat_models_1.BaseChatModel {
          * OpenAI organization or project. This must be configured directly with OpenAI.
          *
          * See:
-         * https://help.openai.com/en/articles/10503543-data-residency-for-the-openai-api
+         * https://platform.openai.com/docs/guides/your-data
          * https://platform.openai.com/docs/api-reference/responses/create#responses-create-store
          *
          * @default false
@@ -1299,7 +1299,7 @@ class ChatOpenAIResponses extends BaseChatOpenAI {
             content,
             tool_calls,
             invalid_tool_calls,
-            usage_metadata: response.usage,
+            usage_metadata: (0, output_js_1._convertOpenAIResponsesUsageToLangChainUsage)(response.usage),
             additional_kwargs,
             response_metadata,
         });
@@ -1366,7 +1366,7 @@ class ChatOpenAIResponses extends BaseChatOpenAI {
         }
         else if (chunk.type === "response.completed") {
             const msg = this._convertResponsesMessageToBaseMessage(chunk.response);
-            usage_metadata = chunk.response.usage;
+            usage_metadata = (0, output_js_1._convertOpenAIResponsesUsageToLangChainUsage)(chunk.response.usage);
             if (chunk.response.text?.format?.type === "json_schema") {
                 additional_kwargs.parsed ??= JSON.parse(msg.text);
             }
@@ -2217,7 +2217,9 @@ exports.ChatOpenAICompletions = ChatOpenAICompletions;
  *   timeout: undefined,
  *   maxRetries: 2,
  *   // apiKey: "...",
- *   // baseUrl: "...",
+ *   // configuration: {
+ *   //   baseURL: "...",
+ *   // }
  *   // organization: "...",
  *   // other params...
  * });

package/dist/chat_models.d.ts

@@ -166,7 +166,7 @@ export declare abstract class BaseChatOpenAI<CallOptions extends BaseChatOpenAIC
      * OpenAI organization or project. This must be configured directly with OpenAI.
      *
      * See:
-     * https://help.openai.com/en/articles/10503543-data-residency-for-the-openai-api
+     * https://platform.openai.com/docs/guides/your-data
      * https://platform.openai.com/docs/api-reference/responses/create#responses-create-store
      *
      * @default false
@@ -405,7 +405,9 @@ export interface ChatOpenAIFields extends BaseChatOpenAIFields {
  *   timeout: undefined,
  *   maxRetries: 2,
  *   // apiKey: "...",
- *   // baseUrl: "...",
+ *   // configuration: {
+ *   //   baseURL: "...",
+ *   // }
  *   // organization: "...",
  *   // other params...
  * });

package/dist/chat_models.js

@@ -13,7 +13,7 @@ import { getEndpoint } from "./utils/azure.js";
 import { formatToOpenAIToolChoice, interopZodResponseFormat, wrapOpenAIClientError, } from "./utils/openai.js";
 import { formatFunctionDefinitions, } from "./utils/openai-format-fndef.js";
 import { _convertToOpenAITool, convertCompletionsCustomTool, convertResponsesCustomTool, isBuiltInTool, isBuiltInToolChoice, isCustomTool, isCustomToolCall, isOpenAICustomTool, parseCustomToolCall, } from "./utils/tools.js";
-import { handleMultiModalOutput } from "./utils/output.js";
+import { _convertOpenAIResponsesUsageToLangChainUsage, handleMultiModalOutput, } from "./utils/output.js";
 const _FUNCTION_CALL_IDS_MAP_KEY = "__openai_function_call_ids__";
 function isReasoningModel(model) {
     if (!model)
@@ -522,7 +522,7 @@ export class BaseChatOpenAI extends BaseChatModel {
          * OpenAI organization or project. This must be configured directly with OpenAI.
          *
          * See:
-         * https://help.openai.com/en/articles/10503543-data-residency-for-the-openai-api
+         * https://platform.openai.com/docs/guides/your-data
          * https://platform.openai.com/docs/api-reference/responses/create#responses-create-store
          *
          * @default false
@@ -1293,7 +1293,7 @@ export class ChatOpenAIResponses extends BaseChatOpenAI {
             content,
             tool_calls,
             invalid_tool_calls,
-            usage_metadata: response.usage,
+            usage_metadata: _convertOpenAIResponsesUsageToLangChainUsage(response.usage),
             additional_kwargs,
             response_metadata,
         });
@@ -1360,7 +1360,7 @@ export class ChatOpenAIResponses extends BaseChatOpenAI {
         }
         else if (chunk.type === "response.completed") {
             const msg = this._convertResponsesMessageToBaseMessage(chunk.response);
-            usage_metadata = chunk.response.usage;
+            usage_metadata = _convertOpenAIResponsesUsageToLangChainUsage(chunk.response.usage);
             if (chunk.response.text?.format?.type === "json_schema") {
                 additional_kwargs.parsed ??= JSON.parse(msg.text);
             }
@@ -2209,7 +2209,9 @@ export class ChatOpenAICompletions extends BaseChatOpenAI {
  *   timeout: undefined,
  *   maxRetries: 2,
  *   // apiKey: "...",
- *   // baseUrl: "...",
+ *   // configuration: {
+ *   //   baseURL: "...",
+ *   // }
  *   // organization: "...",
  *   // other params...
  * });

package/dist/utils/output.cjs

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handleMultiModalOutput = handleMultiModalOutput;
+exports._convertOpenAIResponsesUsageToLangChainUsage = _convertOpenAIResponsesUsageToLangChainUsage;
 /**
  * Handle multi modal response content.
  *
@@ -28,3 +29,25 @@ function handleMultiModalOutput(content, messages) {
     }
     return content;
 }
+function _convertOpenAIResponsesUsageToLangChainUsage(usage) {
+    // TODO: Remove raw OpenAI usage details in v1
+    const inputTokenDetails = {
+        ...(usage?.input_tokens_details?.cached_tokens != null && {
+            ...usage?.input_tokens_details,
+            cache_read: usage?.input_tokens_details?.cached_tokens,
+        }),
+    };
+    const outputTokenDetails = {
+        ...(usage?.output_tokens_details?.reasoning_tokens != null && {
+            ...usage?.output_tokens_details,
+            reasoning: usage?.output_tokens_details?.reasoning_tokens,
+        }),
+    };
+    return {
+        input_tokens: usage?.input_tokens ?? 0,
+        output_tokens: usage?.output_tokens ?? 0,
+        total_tokens: usage?.total_tokens ?? 0,
+        input_token_details: inputTokenDetails,
+        output_token_details: outputTokenDetails,
+    };
+}

package/dist/utils/output.d.ts

@@ -1,4 +1,5 @@
-import { StandardImageBlock, StandardTextBlock } from "@langchain/core/messages";
+import { OpenAI as OpenAIClient } from "openai";
+import { StandardImageBlock, StandardTextBlock, UsageMetadata } from "@langchain/core/messages";
 /**
  * Handle multi modal response content.
  *
@@ -7,3 +8,4 @@ import { StandardImageBlock, StandardTextBlock } from "@langchain/core/messages"
  * @returns The new content of the message.
  */
 export declare function handleMultiModalOutput(content: string, messages: unknown): (StandardImageBlock | StandardTextBlock)[] | string;
+export declare function _convertOpenAIResponsesUsageToLangChainUsage(usage?: OpenAIClient.Responses.ResponseUsage): UsageMetadata;

package/dist/utils/output.js

@@ -25,3 +25,25 @@ export function handleMultiModalOutput(content, messages) {
     }
     return content;
 }
+export function _convertOpenAIResponsesUsageToLangChainUsage(usage) {
+    // TODO: Remove raw OpenAI usage details in v1
+    const inputTokenDetails = {
+        ...(usage?.input_tokens_details?.cached_tokens != null && {
+            ...usage?.input_tokens_details,
+            cache_read: usage?.input_tokens_details?.cached_tokens,
+        }),
+    };
+    const outputTokenDetails = {
+        ...(usage?.output_tokens_details?.reasoning_tokens != null && {
+            ...usage?.output_tokens_details,
+            reasoning: usage?.output_tokens_details?.reasoning_tokens,
+        }),
+    };
+    return {
+        input_tokens: usage?.input_tokens ?? 0,
+        output_tokens: usage?.output_tokens ?? 0,
+        total_tokens: usage?.total_tokens ?? 0,
+        input_token_details: inputTokenDetails,
+        output_token_details: outputTokenDetails,
+    };
+}

package/package.json

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