@langchain/openai 0.6.10 → 0.6.12

package/dist/chat_models.cjs

@@ -18,6 +18,7 @@ const azure_js_1 = require("./utils/azure.cjs");
 const openai_js_1 = require("./utils/openai.cjs");
 const openai_format_fndef_js_1 = require("./utils/openai-format-fndef.cjs");
 const tools_js_1 = require("./utils/tools.cjs");
+const output_js_1 = require("./utils/output.cjs");
 const _FUNCTION_CALL_IDS_MAP_KEY = "__openai_function_call_ids__";
 function isReasoningModel(model) {
     if (!model)
@@ -273,7 +274,7 @@ class BaseChatOpenAI extends chat_models_1.BaseChatModel {
             "response_format",
             "seed",
             "reasoning",
-            "reasoning_effort",
+            "reasoningEffort",
             "service_tier",
         ];
     }
@@ -287,6 +288,7 @@ class BaseChatOpenAI extends chat_models_1.BaseChatModel {
         return {
             apiKey: "openai_api_key",
             modelName: "model",
+            reasoningEffort: "reasoning_effort",
         };
     }
     get lc_serializable_keys() {
@@ -325,7 +327,7 @@ class BaseChatOpenAI extends chat_models_1.BaseChatModel {
             "disableStreaming",
             "zdrEnabled",
             "reasoning",
-            "reasoning_effort",
+            "reasoningEffort",
             "promptCacheKey",
             "verbosity",
         ];
@@ -603,18 +605,18 @@ class BaseChatOpenAI extends chat_models_1.BaseChatModel {
         this.audio = fields?.audio;
         this.modalities = fields?.modalities;
         this.reasoning =
-            fields?.reasoning ?? fields?.reasoning_effort
-                ? { effort: fields.reasoning_effort }
+            fields?.reasoning ?? fields?.reasoningEffort
+                ? { effort: fields.reasoningEffort }
                 : undefined;
         this.maxTokens = fields?.maxCompletionTokens ?? fields?.maxTokens;
-        this.disableStreaming = fields?.disableStreaming ?? this.disableStreaming;
+        this.disableStreaming = fields?.disableStreaming === true;
+        this.streaming = fields?.streaming === true;
         this.promptCacheKey = fields?.promptCacheKey ?? this.promptCacheKey;
         this.verbosity = fields?.verbosity ?? this.verbosity;
-        this.streaming = fields?.streaming ?? false;
         // disable streaming in BaseChatModel if explicitly disabled
         if (this.streaming === false)
             this.disableStreaming = true;
-        if (this.disableStreaming)
+        if (this.disableStreaming === true)
             this.streaming = false;
         this.streamUsage = fields?.streamUsage ?? this.streamUsage;
         if (this.disableStreaming)
@@ -1373,7 +1375,8 @@ class ChatOpenAIResponses extends BaseChatOpenAI {
                     response_metadata[key] = value;
             }
         }
-        else if (chunk.type === "response.function_call_arguments.delta") {
+        else if (chunk.type === "response.function_call_arguments.delta" ||
+            chunk.type === "response.custom_tool_call_input.delta") {
             tool_call_chunks.push({
                 type: "tool_call_chunk",
                 args: chunk.delta,
@@ -2061,8 +2064,9 @@ class ChatOpenAICompletions extends BaseChatOpenAI {
                 if (message.audio) {
                     additional_kwargs.audio = message.audio;
                 }
+                const content = (0, output_js_1.handleMultiModalOutput)(message.content || "", rawResponse.choices?.[0]?.message);
                 return new messages_1.AIMessage({
-                    content: message.content || "",
+                    content,
                     tool_calls: toolCalls,
                     invalid_tool_calls: invalidToolCalls,
                     additional_kwargs,

package/dist/chat_models.js

@@ -13,6 +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";
 const _FUNCTION_CALL_IDS_MAP_KEY = "__openai_function_call_ids__";
 function isReasoningModel(model) {
     if (!model)
@@ -268,7 +269,7 @@ export class BaseChatOpenAI extends BaseChatModel {
             "response_format",
             "seed",
             "reasoning",
-            "reasoning_effort",
+            "reasoningEffort",
             "service_tier",
         ];
     }
@@ -282,6 +283,7 @@ export class BaseChatOpenAI extends BaseChatModel {
         return {
             apiKey: "openai_api_key",
             modelName: "model",
+            reasoningEffort: "reasoning_effort",
         };
     }
     get lc_serializable_keys() {
@@ -320,7 +322,7 @@ export class BaseChatOpenAI extends BaseChatModel {
             "disableStreaming",
             "zdrEnabled",
             "reasoning",
-            "reasoning_effort",
+            "reasoningEffort",
             "promptCacheKey",
             "verbosity",
         ];
@@ -598,18 +600,18 @@ export class BaseChatOpenAI extends BaseChatModel {
         this.audio = fields?.audio;
         this.modalities = fields?.modalities;
         this.reasoning =
-            fields?.reasoning ?? fields?.reasoning_effort
-                ? { effort: fields.reasoning_effort }
+            fields?.reasoning ?? fields?.reasoningEffort
+                ? { effort: fields.reasoningEffort }
                 : undefined;
         this.maxTokens = fields?.maxCompletionTokens ?? fields?.maxTokens;
-        this.disableStreaming = fields?.disableStreaming ?? this.disableStreaming;
+        this.disableStreaming = fields?.disableStreaming === true;
+        this.streaming = fields?.streaming === true;
         this.promptCacheKey = fields?.promptCacheKey ?? this.promptCacheKey;
         this.verbosity = fields?.verbosity ?? this.verbosity;
-        this.streaming = fields?.streaming ?? false;
         // disable streaming in BaseChatModel if explicitly disabled
         if (this.streaming === false)
             this.disableStreaming = true;
-        if (this.disableStreaming)
+        if (this.disableStreaming === true)
             this.streaming = false;
         this.streamUsage = fields?.streamUsage ?? this.streamUsage;
         if (this.disableStreaming)
@@ -1367,7 +1369,8 @@ export class ChatOpenAIResponses extends BaseChatOpenAI {
                     response_metadata[key] = value;
             }
         }
-        else if (chunk.type === "response.function_call_arguments.delta") {
+        else if (chunk.type === "response.function_call_arguments.delta" ||
+            chunk.type === "response.custom_tool_call_input.delta") {
             tool_call_chunks.push({
                 type: "tool_call_chunk",
                 args: chunk.delta,
@@ -2054,8 +2057,9 @@ export class ChatOpenAICompletions extends BaseChatOpenAI {
                 if (message.audio) {
                     additional_kwargs.audio = message.audio;
                 }
+                const content = handleMultiModalOutput(message.content || "", rawResponse.choices?.[0]?.message);
                 return new AIMessage({
-                    content: message.content || "",
+                    content,
                     tool_calls: toolCalls,
                     invalid_tool_calls: invalidToolCalls,
                     additional_kwargs,

package/dist/embeddings.cjs

@@ -75,6 +75,12 @@ class OpenAIEmbeddings extends embeddings_1.Embeddings {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "encodingFormat", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "client", {
             enumerable: true,
             configurable: true,
@@ -101,6 +107,7 @@ class OpenAIEmbeddings extends embeddings_1.Embeddings {
             fieldsWithDefaults?.stripNewLines ?? this.stripNewLines;
         this.timeout = fieldsWithDefaults?.timeout;
         this.dimensions = fieldsWithDefaults?.dimensions;
+        this.encodingFormat = fieldsWithDefaults?.encodingFormat;
         this.clientConfig = {
             apiKey,
             organization: this.organization,
@@ -125,6 +132,9 @@ class OpenAIEmbeddings extends embeddings_1.Embeddings {
             if (this.dimensions) {
                 params.dimensions = this.dimensions;
             }
+            if (this.encodingFormat) {
+                params.encoding_format = this.encodingFormat;
+            }
             return this.embeddingWithRetry(params);
         });
         const batchResponses = await Promise.all(batchRequests);
@@ -152,6 +162,9 @@ class OpenAIEmbeddings extends embeddings_1.Embeddings {
         if (this.dimensions) {
             params.dimensions = this.dimensions;
         }
+        if (this.encodingFormat) {
+            params.encoding_format = this.encodingFormat;
+        }
         const { data } = await this.embeddingWithRetry(params);
         return data[0].embedding;
     }

package/dist/embeddings.d.ts

@@ -37,6 +37,10 @@ export interface OpenAIEmbeddingsParams extends EmbeddingsParams {
      * See: https://github.com/openai/openai-python/issues/418#issuecomment-1525939500
      */
     stripNewLines?: boolean;
+    /**
+     * The format to return the embeddings in. Can be either 'float' or 'base64'.
+     */
+    encodingFormat?: "float" | "base64";
 }
 /**
  * Class for generating embeddings using the OpenAI API.
@@ -54,7 +58,7 @@ export interface OpenAIEmbeddingsParams extends EmbeddingsParams {
  *
  * ```
  */
-export declare class OpenAIEmbeddings extends Embeddings implements Partial<OpenAIEmbeddingsParams> {
+export declare class OpenAIEmbeddings<TOutput = number[]> extends Embeddings<TOutput> implements Partial<OpenAIEmbeddingsParams> {
     model: string;
     /** @deprecated Use "model" instead */
     modelName: string;
@@ -67,6 +71,7 @@ export declare class OpenAIEmbeddings extends Embeddings implements Partial<Open
     dimensions?: number;
     timeout?: number;
     organization?: string;
+    encodingFormat?: "float" | "base64";
     protected client: OpenAIClient;
     protected clientConfig: ClientOptions;
     constructor(fields?: Partial<OpenAIEmbeddingsParams> & {
@@ -87,14 +92,14 @@ export declare class OpenAIEmbeddings extends Embeddings implements Partial<Open
      * @param texts Array of documents to generate embeddings for.
      * @returns Promise that resolves to a 2D array of embeddings for each document.
      */
-    embedDocuments(texts: string[]): Promise<number[][]>;
+    embedDocuments(texts: string[]): Promise<TOutput[]>;
     /**
      * Method to generate an embedding for a single document. Calls the
      * embeddingWithRetry method with the document as the input.
      * @param text Document to generate an embedding for.
      * @returns Promise that resolves to an embedding for the document.
      */
-    embedQuery(text: string): Promise<number[]>;
+    embedQuery(text: string): Promise<TOutput>;
     /**
      * Private method to make a request to the OpenAI API to generate
      * embeddings. Handles the retry logic and returns the response from the

package/dist/embeddings.js

@@ -72,6 +72,12 @@ export class OpenAIEmbeddings extends Embeddings {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "encodingFormat", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "client", {
             enumerable: true,
             configurable: true,
@@ -98,6 +104,7 @@ export class OpenAIEmbeddings extends Embeddings {
             fieldsWithDefaults?.stripNewLines ?? this.stripNewLines;
         this.timeout = fieldsWithDefaults?.timeout;
         this.dimensions = fieldsWithDefaults?.dimensions;
+        this.encodingFormat = fieldsWithDefaults?.encodingFormat;
         this.clientConfig = {
             apiKey,
             organization: this.organization,
@@ -122,6 +129,9 @@ export class OpenAIEmbeddings extends Embeddings {
             if (this.dimensions) {
                 params.dimensions = this.dimensions;
             }
+            if (this.encodingFormat) {
+                params.encoding_format = this.encodingFormat;
+            }
             return this.embeddingWithRetry(params);
         });
         const batchResponses = await Promise.all(batchRequests);
@@ -149,6 +159,9 @@ export class OpenAIEmbeddings extends Embeddings {
         if (this.dimensions) {
             params.dimensions = this.dimensions;
         }
+        if (this.encodingFormat) {
+            params.encoding_format = this.encodingFormat;
+        }
         const { data } = await this.embeddingWithRetry(params);
         return data[0].embedding;
     }

package/dist/types.d.ts

@@ -155,7 +155,7 @@ export interface OpenAIChatInput extends OpenAIBaseInput {
      *
      * @deprecated Use `reasoning` instead.
      */
-    reasoning_effort?: OpenAIClient.ReasoningEffort;
+    reasoningEffort?: OpenAIClient.ReasoningEffort;
     /**
      * Should be set to `true` in tenancies with Zero Data Retention
      * @see https://platform.openai.com/docs/guides/your-data

package/dist/utils/output.cjs

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleMultiModalOutput = handleMultiModalOutput;
+/**
+ * Handle multi modal response content.
+ *
+ * @param content The content of the message.
+ * @param messages The messages of the response.
+ * @returns The new content of the message.
+ */
+function handleMultiModalOutput(content, messages) {
+    /**
+     * Handle OpenRouter image responses
+     * @see https://openrouter.ai/docs/features/multimodal/image-generation#api-usage
+     */
+    if (messages &&
+        typeof messages === "object" &&
+        "images" in messages &&
+        Array.isArray(messages.images)) {
+        const images = messages.images
+            .filter((image) => typeof image?.image_url?.url === "string")
+            .map((image) => ({
+            type: "image",
+            url: image.image_url.url,
+            source_type: "url",
+        }));
+        return [{ type: "text", text: content, source_type: "text" }, ...images];
+    }
+    return content;
+}

package/dist/utils/output.d.ts

@@ -0,0 +1,9 @@
+import { StandardImageBlock, StandardTextBlock } from "@langchain/core/messages";
+/**
+ * Handle multi modal response content.
+ *
+ * @param content The content of the message.
+ * @param messages The messages of the response.
+ * @returns The new content of the message.
+ */
+export declare function handleMultiModalOutput(content: string, messages: unknown): (StandardImageBlock | StandardTextBlock)[] | string;

package/dist/utils/output.js

@@ -0,0 +1,27 @@
+/**
+ * Handle multi modal response content.
+ *
+ * @param content The content of the message.
+ * @param messages The messages of the response.
+ * @returns The new content of the message.
+ */
+export function handleMultiModalOutput(content, messages) {
+    /**
+     * Handle OpenRouter image responses
+     * @see https://openrouter.ai/docs/features/multimodal/image-generation#api-usage
+     */
+    if (messages &&
+        typeof messages === "object" &&
+        "images" in messages &&
+        Array.isArray(messages.images)) {
+        const images = messages.images
+            .filter((image) => typeof image?.image_url?.url === "string")
+            .map((image) => ({
+            type: "image",
+            url: image.image_url.url,
+            source_type: "url",
+        }));
+        return [{ type: "text", text: content, source_type: "text" }, ...images];
+    }
+    return content;
+}

package/package.json

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