@langchain/openai 0.2.3 → 0.2.5

package/dist/chat_models.cjs

@@ -568,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,

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";

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" &&
@@ -564,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,

package/dist/legacy.cjs

@@ -253,7 +253,7 @@ class OpenAIChat extends llms_1.LLM {
         this.organization =
             fields?.configuration?.organization ??
                 (0, env_1.getEnvironmentVariable)("OPENAI_ORGANIZATION");
-        this.modelName = fields?.modelName ?? this.modelName;
+        this.modelName = fields?.model ?? fields?.modelName ?? this.modelName;
         this.prefixMessages = fields?.prefixMessages ?? this.prefixMessages;
         this.modelKwargs = fields?.modelKwargs ?? {};
         this.timeout = fields?.timeout;

package/dist/legacy.js

@@ -250,7 +250,7 @@ export class OpenAIChat extends LLM {
         this.organization =
             fields?.configuration?.organization ??
                 getEnvironmentVariable("OPENAI_ORGANIZATION");
-        this.modelName = fields?.modelName ?? this.modelName;
+        this.modelName = fields?.model ?? fields?.modelName ?? this.modelName;
         this.prefixMessages = fields?.prefixMessages ?? this.prefixMessages;
         this.modelKwargs = fields?.modelKwargs ?? {};
         this.timeout = fields?.timeout;

package/dist/llms.cjs

@@ -75,6 +75,15 @@ class OpenAI extends llms_1.BaseLLM {
         let model = fields?.model ?? fields?.modelName;
         if ((model?.startsWith("gpt-3.5-turbo") || model?.startsWith("gpt-4")) &&
             !model?.includes("-instruct")) {
+            console.warn([
+                `Your chosen OpenAI model, "${model}", is a chat model and not a text-in/text-out LLM.`,
+                `Passing it into the "OpenAI" class is deprecated and only permitted for backwards-compatibility. You may experience odd behavior.`,
+                `Please use the "ChatOpenAI" class instead.`,
+                "",
+                `See this page for more information:`,
+                "|",
+                `└> https://js.langchain.com/v0.2/docs/integrations/chat/openai`,
+            ].join("\n"));
             // eslint-disable-next-line no-constructor-return
             return new legacy_js_1.OpenAIChat(fields, configuration);
         }

package/dist/llms.js

@@ -72,6 +72,15 @@ export class OpenAI extends BaseLLM {
         let model = fields?.model ?? fields?.modelName;
         if ((model?.startsWith("gpt-3.5-turbo") || model?.startsWith("gpt-4")) &&
             !model?.includes("-instruct")) {
+            console.warn([
+                `Your chosen OpenAI model, "${model}", is a chat model and not a text-in/text-out LLM.`,
+                `Passing it into the "OpenAI" class is deprecated and only permitted for backwards-compatibility. You may experience odd behavior.`,
+                `Please use the "ChatOpenAI" class instead.`,
+                "",
+                `See this page for more information:`,
+                "|",
+                `└> https://js.langchain.com/v0.2/docs/integrations/chat/openai`,
+            ].join("\n"));
             // eslint-disable-next-line no-constructor-return
             return new OpenAIChat(fields, configuration);
         }

package/dist/tools/dalle.cjs

@@ -100,18 +100,75 @@ class DallEAPIWrapper extends tools_1.Tool {
             fields?.dallEResponseFormat ?? this.dallEResponseFormat;
         this.user = fields?.user;
     }
+    /**
+     * Processes the API response if multiple images are generated.
+     * Returns a list of MessageContentImageUrl objects. If the response
+     * format is `url`, then the `image_url` field will contain the URL.
+     * If it is `b64_json`, then the `image_url` field will contain an object
+     * with a `url` field with the base64 encoded image.
+     *
+     * @param {OpenAIClient.Images.ImagesResponse[]} response The API response
+     * @returns {MessageContentImageUrl[]}
+     */
+    processMultipleGeneratedUrls(response) {
+        if (this.dallEResponseFormat === "url") {
+            return response.flatMap((res) => {
+                const imageUrlContent = res.data
+                    .flatMap((item) => {
+                    if (!item.url)
+                        return [];
+                    return {
+                        type: "image_url",
+                        image_url: item.url,
+                    };
+                })
+                    .filter((item) => item !== undefined &&
+                    item.type === "image_url" &&
+                    typeof item.image_url === "string" &&
+                    item.image_url !== undefined);
+                return imageUrlContent;
+            });
+        }
+        else {
+            return response.flatMap((res) => {
+                const b64Content = res.data
+                    .flatMap((item) => {
+                    if (!item.b64_json)
+                        return [];
+                    return {
+                        type: "image_url",
+                        image_url: {
+                            url: item.b64_json,
+                        },
+                    };
+                })
+                    .filter((item) => item !== undefined &&
+                    item.type === "image_url" &&
+                    typeof item.image_url === "object" &&
+                    "url" in item.image_url &&
+                    typeof item.image_url.url === "string" &&
+                    item.image_url.url !== undefined);
+                return b64Content;
+            });
+        }
+    }
     /** @ignore */
     async _call(input) {
-        const response = await this.client.images.generate({
+        const generateImageFields = {
             model: this.model,
             prompt: input,
-            n: this.n,
+            n: 1,
             size: this.size,
             response_format: this.dallEResponseFormat,
             style: this.style,
             quality: this.quality,
             user: this.user,
-        });
+        };
+        if (this.n > 1) {
+            const results = await Promise.all(Array.from({ length: this.n }).map(() => this.client.images.generate(generateImageFields)));
+            return this.processMultipleGeneratedUrls(results);
+        }
+        const response = await this.client.images.generate(generateImageFields);
         let data = "";
         if (this.dallEResponseFormat === "url") {
             [data] = response.data

package/dist/tools/dalle.d.ts

@@ -1,5 +1,6 @@
 import { OpenAI as OpenAIClient } from "openai";
 import { Tool, ToolParams } from "@langchain/core/tools";
+import { MessageContentComplex } from "@langchain/core/messages";
 /**
  * An interface for the Dall-E API Wrapper.
  */
@@ -90,6 +91,17 @@ export declare class DallEAPIWrapper extends Tool {
     private dallEResponseFormat;
     private user?;
     constructor(fields?: DallEAPIWrapperParams);
+    /**
+     * Processes the API response if multiple images are generated.
+     * Returns a list of MessageContentImageUrl objects. If the response
+     * format is `url`, then the `image_url` field will contain the URL.
+     * If it is `b64_json`, then the `image_url` field will contain an object
+     * with a `url` field with the base64 encoded image.
+     *
+     * @param {OpenAIClient.Images.ImagesResponse[]} response The API response
+     * @returns {MessageContentImageUrl[]}
+     */
+    private processMultipleGeneratedUrls;
     /** @ignore */
-    _call(input: string): Promise<string>;
+    _call(input: string): Promise<string | MessageContentComplex[]>;
 }

package/dist/tools/dalle.js

@@ -97,18 +97,75 @@ export class DallEAPIWrapper extends Tool {
             fields?.dallEResponseFormat ?? this.dallEResponseFormat;
         this.user = fields?.user;
     }
+    /**
+     * Processes the API response if multiple images are generated.
+     * Returns a list of MessageContentImageUrl objects. If the response
+     * format is `url`, then the `image_url` field will contain the URL.
+     * If it is `b64_json`, then the `image_url` field will contain an object
+     * with a `url` field with the base64 encoded image.
+     *
+     * @param {OpenAIClient.Images.ImagesResponse[]} response The API response
+     * @returns {MessageContentImageUrl[]}
+     */
+    processMultipleGeneratedUrls(response) {
+        if (this.dallEResponseFormat === "url") {
+            return response.flatMap((res) => {
+                const imageUrlContent = res.data
+                    .flatMap((item) => {
+                    if (!item.url)
+                        return [];
+                    return {
+                        type: "image_url",
+                        image_url: item.url,
+                    };
+                })
+                    .filter((item) => item !== undefined &&
+                    item.type === "image_url" &&
+                    typeof item.image_url === "string" &&
+                    item.image_url !== undefined);
+                return imageUrlContent;
+            });
+        }
+        else {
+            return response.flatMap((res) => {
+                const b64Content = res.data
+                    .flatMap((item) => {
+                    if (!item.b64_json)
+                        return [];
+                    return {
+                        type: "image_url",
+                        image_url: {
+                            url: item.b64_json,
+                        },
+                    };
+                })
+                    .filter((item) => item !== undefined &&
+                    item.type === "image_url" &&
+                    typeof item.image_url === "object" &&
+                    "url" in item.image_url &&
+                    typeof item.image_url.url === "string" &&
+                    item.image_url.url !== undefined);
+                return b64Content;
+            });
+        }
+    }
     /** @ignore */
     async _call(input) {
-        const response = await this.client.images.generate({
+        const generateImageFields = {
             model: this.model,
             prompt: input,
-            n: this.n,
+            n: 1,
             size: this.size,
             response_format: this.dallEResponseFormat,
             style: this.style,
             quality: this.quality,
             user: this.user,
-        });
+        };
+        if (this.n > 1) {
+            const results = await Promise.all(Array.from({ length: this.n }).map(() => this.client.images.generate(generateImageFields)));
+            return this.processMultipleGeneratedUrls(results);
+        }
+        const response = await this.client.images.generate(generateImageFields);
         let data = "";
         if (this.dallEResponseFormat === "url") {
             [data] = response.data

package/dist/tools/tests/dalle.int.test.js

@@ -14,3 +14,44 @@ test.skip("Dalle can generate images with base 64 response format", async () =>
     expect(res).toBeDefined();
     expect(res).not.toContain("https://");
 });
+test.skip("Dalle returns multiple image URLs if n > 1", async () => {
+    const dalle = new DallEAPIWrapper({
+        n: 2,
+    });
+    const res = await dalle.invoke("A painting of a cat");
+    expect(res).toBeDefined();
+    expect(res).toBeInstanceOf(Array);
+    if (!Array.isArray(res))
+        return;
+    expect(res).toHaveLength(2);
+    // The types for each should be `image_url` with an `image_url` field containing the URL
+    expect(res[0].type).toBe("image_url");
+    expect(res[1].type).toBe("image_url");
+    expect(res[0]).toHaveProperty("image_url");
+    expect(res[1]).toHaveProperty("image_url");
+    expect(res[0].image_url.startsWith("https://")).toBe(true);
+    expect(res[1].image_url.startsWith("https://")).toBe(true);
+});
+test.skip("Dalle returns multiple base64 image strings if n > 1", async () => {
+    const dalle = new DallEAPIWrapper({
+        n: 2,
+        dallEResponseFormat: "b64_json",
+    });
+    const res = await dalle.invoke("A painting of a cat");
+    expect(res).toBeDefined();
+    expect(res).toBeInstanceOf(Array);
+    if (!Array.isArray(res))
+        return;
+    expect(res).toHaveLength(2);
+    // The types for each should be `b64_json` with an `b64_json` field containing the URL
+    expect(res[0].type).toBe("image_url");
+    expect(res[1].type).toBe("image_url");
+    expect(res[0]).toHaveProperty("image_url");
+    expect(res[1]).toHaveProperty("image_url");
+    expect(res[0].image_url).toHaveProperty("url");
+    expect(res[1].image_url).toHaveProperty("url");
+    expect(res[0].image_url.url).toBeDefined();
+    expect(res[1].image_url.url).toBeDefined();
+    expect(res[0].image_url.url).not.toBe("");
+    expect(res[1].image_url.url).not.toBe("");
+});

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.3",
+  "version": "0.2.5",
   "description": "OpenAI integrations for LangChain.js",
   "type": "module",
   "engines": {