@langchain/openai 0.3.0-rc.0 → 0.3.1-rc.0

package/README.md

@@ -5,7 +5,7 @@ This package contains the LangChain.js integrations for OpenAI through their SDK
 ## Installation
 
 ```bash npm2yarn
-npm install @langchain/openai
+npm install @langchain/openai @langchain/core
 ```
 
 This package, along with the main LangChain package, depends on [`@langchain/core`](https://npmjs.com/package/@langchain/core/).

package/dist/chat_models.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChatOpenAI = exports.messageToOpenAIRole = void 0;
+exports.ChatOpenAI = exports._convertMessagesToOpenAIParams = exports.messageToOpenAIRole = void 0;
 const openai_1 = require("openai");
 const messages_1 = require("@langchain/core/messages");
 const outputs_1 = require("@langchain/core/outputs");
@@ -156,7 +156,8 @@ delta, rawResponse, defaultRole, includeRawResponse) {
         return new messages_1.ChatMessageChunk({ content, role });
     }
 }
-function convertMessagesToOpenAIParams(messages) {
+// Used in LangSmith, export is important here
+function _convertMessagesToOpenAIParams(messages) {
     // TODO: Function messages do not support array content, fix cast
     return messages.map((message) => {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -186,6 +187,7 @@ function convertMessagesToOpenAIParams(messages) {
         return completionParam;
     });
 }
+exports._convertMessagesToOpenAIParams = _convertMessagesToOpenAIParams;
 function _convertChatOpenAIToolTypeToOpenAITool(tool, fields) {
     if ((0, base_1.isOpenAITool)(tool)) {
         if (fields?.strict !== undefined) {
@@ -1066,7 +1068,17 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
         };
     }
     async *_streamResponseChunks(messages, options, runManager) {
-        const messagesMapped = convertMessagesToOpenAIParams(messages);
+        if (this.model.includes("o1-")) {
+            console.warn("[WARNING]: OpenAI o1 models do not yet support token-level streaming. Streaming will yield single chunk.");
+            const result = await this._generate(messages, options, runManager);
+            const messageChunk = (0, messages_1.convertToChunk)(result.generations[0].message);
+            yield new outputs_1.ChatGenerationChunk({
+                message: messageChunk,
+                text: typeof messageChunk.content === "string" ? messageChunk.content : "",
+            });
+            return;
+        }
+        const messagesMapped = _convertMessagesToOpenAIParams(messages);
         const params = {
             ...this.invocationParams(options, {
                 streaming: true,
@@ -1161,7 +1173,7 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
     async _generate(messages, options, runManager) {
         const tokenUsage = {};
         const params = this.invocationParams(options);
-        const messagesMapped = convertMessagesToOpenAIParams(messages);
+        const messagesMapped = _convertMessagesToOpenAIParams(messages);
         if (params.stream) {
             const stream = this._streamResponseChunks(messages, options, runManager);
             const finalChunks = {};

package/dist/chat_models.d.ts

@@ -19,6 +19,7 @@ interface OpenAILLMOutput {
 }
 type OpenAIRoleEnum = "system" | "assistant" | "user" | "function" | "tool";
 export declare function messageToOpenAIRole(message: BaseMessage): OpenAIRoleEnum;
+export declare function _convertMessagesToOpenAIParams(messages: BaseMessage[]): OpenAIClient.Chat.Completions.ChatCompletionMessageParam[];
 type ChatOpenAIToolType = BindToolsInput | OpenAIClient.ChatCompletionTool;
 export interface ChatOpenAIStructuredOutputMethodOptions<IncludeRaw extends boolean> extends StructuredOutputMethodOptions<IncludeRaw> {
     /**

package/dist/chat_models.js

@@ -1,5 +1,5 @@
 import { OpenAI as OpenAIClient } from "openai";
-import { AIMessage, AIMessageChunk, ChatMessage, ChatMessageChunk, FunctionMessageChunk, HumanMessageChunk, SystemMessageChunk, ToolMessageChunk, isAIMessage, } from "@langchain/core/messages";
+import { AIMessage, AIMessageChunk, ChatMessage, ChatMessageChunk, FunctionMessageChunk, HumanMessageChunk, SystemMessageChunk, ToolMessageChunk, isAIMessage, convertToChunk, } from "@langchain/core/messages";
 import { ChatGenerationChunk, } from "@langchain/core/outputs";
 import { getEnvironmentVariable } from "@langchain/core/utils/env";
 import { BaseChatModel, } from "@langchain/core/language_models/chat_models";
@@ -152,7 +152,8 @@ delta, rawResponse, defaultRole, includeRawResponse) {
         return new ChatMessageChunk({ content, role });
     }
 }
-function convertMessagesToOpenAIParams(messages) {
+// Used in LangSmith, export is important here
+export function _convertMessagesToOpenAIParams(messages) {
     // TODO: Function messages do not support array content, fix cast
     return messages.map((message) => {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -1062,7 +1063,17 @@ export class ChatOpenAI extends BaseChatModel {
         };
     }
     async *_streamResponseChunks(messages, options, runManager) {
-        const messagesMapped = convertMessagesToOpenAIParams(messages);
+        if (this.model.includes("o1-")) {
+            console.warn("[WARNING]: OpenAI o1 models do not yet support token-level streaming. Streaming will yield single chunk.");
+            const result = await this._generate(messages, options, runManager);
+            const messageChunk = convertToChunk(result.generations[0].message);
+            yield new ChatGenerationChunk({
+                message: messageChunk,
+                text: typeof messageChunk.content === "string" ? messageChunk.content : "",
+            });
+            return;
+        }
+        const messagesMapped = _convertMessagesToOpenAIParams(messages);
         const params = {
             ...this.invocationParams(options, {
                 streaming: true,
@@ -1157,7 +1168,7 @@ export class ChatOpenAI extends BaseChatModel {
     async _generate(messages, options, runManager) {
         const tokenUsage = {};
         const params = this.invocationParams(options);
-        const messagesMapped = convertMessagesToOpenAIParams(messages);
+        const messagesMapped = _convertMessagesToOpenAIParams(messages);
         if (params.stream) {
             const stream = this._streamResponseChunks(messages, options, runManager);
             const finalChunks = {};

package/dist/llms.cjs

@@ -82,7 +82,7 @@ class OpenAI extends llms_1.BaseLLM {
                 "",
                 `See this page for more information:`,
                 "|",
-                `└> https://js.langchain.com/v0.2/docs/integrations/chat/openai`,
+                `└> https://js.langchain.com/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

@@ -79,7 +79,7 @@ export class OpenAI extends BaseLLM {
                 "",
                 `See this page for more information:`,
                 "|",
-                `└> https://js.langchain.com/v0.2/docs/integrations/chat/openai`,
+                `└> https://js.langchain.com/docs/integrations/chat/openai`,
             ].join("\n"));
             // eslint-disable-next-line no-constructor-return
             return new OpenAIChat(fields, configuration);

package/dist/utils/tools.d.ts

@@ -1,4 +1,4 @@
-import { ToolDefinition } from "@langchain/core/language_models/base";
+import { OpenAI as OpenAIClient } from "openai";
 import { BindToolsInput } from "@langchain/core/language_models/chat_models";
 /**
  * Formats a tool in either OpenAI format, or LangChain structured tool format
@@ -17,4 +17,4 @@ export declare function _convertToOpenAITool(tool: BindToolsInput, fields?: {
      * provided in the function definition.
      */
     strict?: boolean;
-}): ToolDefinition;
+}): OpenAIClient.ChatCompletionTool;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/openai",
-  "version": "0.3.0-rc.0",
+  "version": "0.3.1-rc.0",
   "description": "OpenAI integrations for LangChain.js",
   "type": "module",
   "engines": {
@@ -41,7 +41,7 @@
     "zod-to-json-schema": "^3.22.3"
   },
   "peerDependencies": {
-    "@langchain/core": ">=0.2.26 <0.4.0 || 0.3.0-rc.0"
+    "@langchain/core": ">=0.2.26 <0.4.0"
   },
   "devDependencies": {
     "@azure/identity": "^4.2.1",