@langchain/openai 0.2.0 → 0.2.2

package/dist/chat_models.cjs

@@ -108,6 +108,7 @@ delta, messageId, defaultRole) {
                     args: rawToolCall.function?.arguments,
                     id: rawToolCall.id,
                     index: rawToolCall.index,
+                    type: "tool_call_chunk",
                 });
             }
         }
@@ -465,8 +466,6 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
         this.stop = fields?.stopSequences ?? fields?.stop;
         this.stopSequences = this?.stop;
         this.user = fields?.user;
-        this.streaming = fields?.streaming ?? false;
-        this.streamUsage = fields?.streamUsage ?? this.streamUsage;
         if (this.azureOpenAIApiKey || this.azureADTokenProvider) {
             if (!this.azureOpenAIApiInstanceName && !this.azureOpenAIBasePath) {
                 throw new Error("Azure OpenAI API instance name not found");
@@ -478,7 +477,11 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
                 throw new Error("Azure OpenAI API version not found");
             }
             this.apiKey = this.apiKey ?? "";
+            // Streaming usage is not supported by Azure deployments, so default to false
+            this.streamUsage = false;
         }
+        this.streaming = fields?.streaming ?? false;
+        this.streamUsage = fields?.streamUsage ?? this.streamUsage;
         this.clientConfig = {
             apiKey: this.apiKey,
             organization: this.organization,
@@ -512,7 +515,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)));
@@ -521,7 +524,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 = {
@@ -564,7 +567,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,
         };
@@ -607,8 +612,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({

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 {
@@ -121,11 +121,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

@@ -104,6 +104,7 @@ delta, messageId, defaultRole) {
                     args: rawToolCall.function?.arguments,
                     id: rawToolCall.id,
                     index: rawToolCall.index,
+                    type: "tool_call_chunk",
                 });
             }
         }
@@ -461,8 +462,6 @@ export class ChatOpenAI extends BaseChatModel {
         this.stop = fields?.stopSequences ?? fields?.stop;
         this.stopSequences = this?.stop;
         this.user = fields?.user;
-        this.streaming = fields?.streaming ?? false;
-        this.streamUsage = fields?.streamUsage ?? this.streamUsage;
         if (this.azureOpenAIApiKey || this.azureADTokenProvider) {
             if (!this.azureOpenAIApiInstanceName && !this.azureOpenAIBasePath) {
                 throw new Error("Azure OpenAI API instance name not found");
@@ -474,7 +473,11 @@ export class ChatOpenAI extends BaseChatModel {
                 throw new Error("Azure OpenAI API version not found");
             }
             this.apiKey = this.apiKey ?? "";
+            // Streaming usage is not supported by Azure deployments, so default to false
+            this.streamUsage = false;
         }
+        this.streaming = fields?.streaming ?? false;
+        this.streamUsage = fields?.streamUsage ?? this.streamUsage;
         this.clientConfig = {
             apiKey: this.apiKey,
             organization: this.organization,
@@ -508,7 +511,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)));
@@ -517,7 +520,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 = {
@@ -560,7 +563,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,
         };
@@ -603,8 +608,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({

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/openai",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "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",