@langchain/openai 0.0.19 → 0.0.20

package/dist/chat_models.cjs

@@ -470,10 +470,18 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
                 console.log("[WARNING]: Received non-string content from OpenAI. This is currently not supported.");
                 continue;
             }
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            const generationInfo = { ...newTokenIndices };
+            if (choice.finish_reason !== undefined) {
+                generationInfo.finish_reason = choice.finish_reason;
+            }
+            if (this.logprobs) {
+                generationInfo.logprobs = choice.logprobs;
+            }
             const generationChunk = new outputs_1.ChatGenerationChunk({
                 message: chunk,
                 text: chunk.content,
-                generationInfo: newTokenIndices,
+                generationInfo,
             });
             yield generationChunk;
             // eslint-disable-next-line no-void
@@ -499,6 +507,10 @@ class ChatOpenAI extends chat_models_1.BaseChatModel {
             const stream = this._streamResponseChunks(messages, options, runManager);
             const finalChunks = {};
             for await (const chunk of stream) {
+                chunk.message.response_metadata = {
+                    ...chunk.generationInfo,
+                    ...chunk.message.response_metadata,
+                };
                 const index = chunk.generationInfo?.completion ?? 0;
                 if (finalChunks[index] === undefined) {
                     finalChunks[index] = chunk;

package/dist/chat_models.js

@@ -466,10 +466,18 @@ export class ChatOpenAI extends BaseChatModel {
                 console.log("[WARNING]: Received non-string content from OpenAI. This is currently not supported.");
                 continue;
             }
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            const generationInfo = { ...newTokenIndices };
+            if (choice.finish_reason !== undefined) {
+                generationInfo.finish_reason = choice.finish_reason;
+            }
+            if (this.logprobs) {
+                generationInfo.logprobs = choice.logprobs;
+            }
             const generationChunk = new ChatGenerationChunk({
                 message: chunk,
                 text: chunk.content,
-                generationInfo: newTokenIndices,
+                generationInfo,
             });
             yield generationChunk;
             // eslint-disable-next-line no-void
@@ -495,6 +503,10 @@ export class ChatOpenAI extends BaseChatModel {
             const stream = this._streamResponseChunks(messages, options, runManager);
             const finalChunks = {};
             for await (const chunk of stream) {
+                chunk.message.response_metadata = {
+                    ...chunk.generationInfo,
+                    ...chunk.message.response_metadata,
+                };
                 const index = chunk.generationInfo?.completion ?? 0;
                 if (finalChunks[index] === undefined) {
                     finalChunks[index] = chunk;

package/dist/legacy.cjs

@@ -42,7 +42,7 @@ const openai_js_1 = require("./utils/openai.cjs");
  *   maxTokens: 50,
  * });
  *
- * const res = await model.call(
+ * const res = await model.invoke(
  *   "What would be a good company name for a company that makes colorful socks?"
  * );
  * console.log({ res });

package/dist/legacy.d.ts

@@ -47,7 +47,7 @@ export interface OpenAIChatCallOptions extends OpenAICallOptions {
  *   maxTokens: 50,
  * });
  *
- * const res = await model.call(
+ * const res = await model.invoke(
  *   "What would be a good company name for a company that makes colorful socks?"
  * );
  * console.log({ res });

package/dist/legacy.js

@@ -39,7 +39,7 @@ import { wrapOpenAIClientError } from "./utils/openai.js";
  *   maxTokens: 50,
  * });
  *
- * const res = await model.call(
+ * const res = await model.invoke(
  *   "What would be a good company name for a company that makes colorful socks?"
  * );
  * console.log({ res });

package/dist/llms.cjs

@@ -37,7 +37,7 @@ const openai_js_1 = require("./utils/openai.cjs");
  *   maxRetries: 5,
  * });
  *
- * const res = await model.call(
+ * const res = await model.invoke(
  *   "Question: What would be a good company name for a company that makes colorful socks?\nAnswer:"
  * );
  * console.log({ res });

package/dist/llms.d.ts

@@ -32,7 +32,7 @@ export { OpenAIChat };
  *   maxRetries: 5,
  * });
  *
- * const res = await model.call(
+ * const res = await model.invoke(
  *   "Question: What would be a good company name for a company that makes colorful socks?\nAnswer:"
  * );
  * console.log({ res });

package/dist/llms.js

@@ -34,7 +34,7 @@ export { OpenAIChat };
  *   maxRetries: 5,
  * });
  *
- * const res = await model.call(
+ * const res = await model.invoke(
  *   "Question: What would be a good company name for a company that makes colorful socks?\nAnswer:"
  * );
  * console.log({ res });

package/dist/tests/chat_models-extended.int.test.js

@@ -62,6 +62,17 @@ test("Test ChatOpenAI tool calling", async () => {
     console.log(JSON.stringify(res));
     expect(res.additional_kwargs.tool_calls?.length).toBeGreaterThan(1);
 });
+test("Test ChatOpenAI streaming logprobs", async () => {
+    const model = new ChatOpenAI({
+        maxTokens: 50,
+        modelName: "gpt-3.5-turbo",
+        streaming: true,
+        logprobs: true,
+    });
+    const res = await model.invoke("Print hello world.");
+    console.log(res.response_metadata.logprobs.content);
+    expect(res.response_metadata.logprobs.content.length).toBeGreaterThan(0);
+});
 test("Test ChatOpenAI tool calling with ToolMessages", async () => {
     function getCurrentWeather(location) {
         if (location.toLowerCase().includes("tokyo")) {

package/dist/tests/legacy.int.test.js

@@ -3,7 +3,7 @@ import { CallbackManager } from "@langchain/core/callbacks/manager";
 import { OpenAIChat } from "../legacy.js";
 test("Test OpenAI", async () => {
     const model = new OpenAIChat({ modelName: "gpt-3.5-turbo", maxTokens: 10 });
-    const res = await model.call("Print hello world");
+    const res = await model.invoke("Print hello world");
     console.log({ res });
 });
 test("Test OpenAI with prefix messages", async () => {
@@ -14,7 +14,7 @@ test("Test OpenAI with prefix messages", async () => {
         ],
         maxTokens: 10,
     });
-    const res = await model.call("What is my name");
+    const res = await model.invoke("What is my name");
     console.log({ res });
 });
 test("Test OpenAI in streaming mode", async () => {
@@ -31,7 +31,7 @@ test("Test OpenAI in streaming mode", async () => {
             },
         }),
     });
-    const res = await model.call("Print hello world");
+    const res = await model.invoke("Print hello world");
     console.log({ res });
     expect(nrNewTokens > 0).toBe(true);
     expect(res).toBe(streamedCompletion);
@@ -43,18 +43,18 @@ test("Test OpenAI with stop", async () => {
 });
 test("Test OpenAI with stop in object", async () => {
     const model = new OpenAIChat({ maxTokens: 5 });
-    const res = await model.call("Print hello world", { stop: ["world"] });
+    const res = await model.invoke("Print hello world", { stop: ["world"] });
     console.log({ res });
 });
 test("Test OpenAI with timeout in call options", async () => {
     const model = new OpenAIChat({ maxTokens: 5 });
-    await expect(() => model.call("Print hello world", {
+    await expect(() => model.invoke("Print hello world", {
         timeout: 10,
     })).rejects.toThrow();
 }, 5000);
 test("Test OpenAI with timeout in call options and node adapter", async () => {
     const model = new OpenAIChat({ maxTokens: 5 });
-    await expect(() => model.call("Print hello world", {
+    await expect(() => model.invoke("Print hello world", {
         timeout: 10,
     })).rejects.toThrow();
 }, 5000);
@@ -62,7 +62,7 @@ test("Test OpenAI with signal in call options", async () => {
     const model = new OpenAIChat({ maxTokens: 5 });
     const controller = new AbortController();
     await expect(() => {
-        const ret = model.call("Print hello world", {
+        const ret = model.invoke("Print hello world", {
             signal: controller.signal,
         });
         controller.abort();
@@ -73,7 +73,7 @@ test("Test OpenAI with signal in call options and node adapter", async () => {
     const model = new OpenAIChat({ maxTokens: 5 });
     const controller = new AbortController();
     await expect(() => {
-        const ret = model.call("Print hello world", {
+        const ret = model.invoke("Print hello world", {
             signal: controller.signal,
         });
         controller.abort();

package/dist/tests/llms.int.test.js

@@ -8,7 +8,7 @@ test("Test OpenAI", async () => {
         maxTokens: 5,
         modelName: "gpt-3.5-turbo-instruct",
     });
-    const res = await model.call("Print hello world");
+    const res = await model.invoke("Print hello world");
     console.log({ res });
 });
 test("Test OpenAI with stop", async () => {
@@ -24,7 +24,7 @@ test("Test OpenAI with stop in object", async () => {
         maxTokens: 5,
         modelName: "gpt-3.5-turbo-instruct",
     });
-    const res = await model.call("Print hello world", { stop: ["world"] });
+    const res = await model.invoke("Print hello world", { stop: ["world"] });
     console.log({ res });
 });
 test("Test OpenAI with timeout in call options", async () => {
@@ -33,7 +33,7 @@ test("Test OpenAI with timeout in call options", async () => {
         maxRetries: 0,
         modelName: "gpt-3.5-turbo-instruct",
     });
-    await expect(() => model.call("Print hello world", {
+    await expect(() => model.invoke("Print hello world", {
         timeout: 10,
     })).rejects.toThrow();
 }, 5000);
@@ -43,7 +43,7 @@ test("Test OpenAI with timeout in call options and node adapter", async () => {
         maxRetries: 0,
         modelName: "gpt-3.5-turbo-instruct",
     });
-    await expect(() => model.call("Print hello world", {
+    await expect(() => model.invoke("Print hello world", {
         timeout: 10,
     })).rejects.toThrow();
 }, 5000);
@@ -54,7 +54,7 @@ test("Test OpenAI with signal in call options", async () => {
     });
     const controller = new AbortController();
     await expect(() => {
-        const ret = model.call("Print hello world", {
+        const ret = model.invoke("Print hello world", {
             signal: controller.signal,
         });
         controller.abort();
@@ -68,7 +68,7 @@ test("Test OpenAI with signal in call options and node adapter", async () => {
     });
     const controller = new AbortController();
     await expect(() => {
-        const ret = model.call("Print hello world", {
+        const ret = model.invoke("Print hello world", {
             signal: controller.signal,
         });
         controller.abort();
@@ -82,8 +82,8 @@ test("Test OpenAI with concurrency == 1", async () => {
         maxConcurrency: 1,
     });
     const res = await Promise.all([
-        model.call("Print hello world"),
-        model.call("Print hello world"),
+        model.invoke("Print hello world"),
+        model.invoke("Print hello world"),
     ]);
     console.log({ res });
 });
@@ -98,21 +98,21 @@ test("Test OpenAI with maxTokens -1", async () => {
 test("Test OpenAI with chat model returns OpenAIChat", async () => {
     const model = new OpenAI({ modelName: "gpt-3.5-turbo" });
     expect(model).toBeInstanceOf(OpenAIChat);
-    const res = await model.call("Print hello world");
+    const res = await model.invoke("Print hello world");
     console.log({ res });
     expect(typeof res).toBe("string");
 });
 test("Test OpenAI with instruct model returns OpenAI", async () => {
     const model = new OpenAI({ modelName: "gpt-3.5-turbo-instruct" });
     expect(model).toBeInstanceOf(OpenAI);
-    const res = await model.call("Print hello world");
+    const res = await model.invoke("Print hello world");
     console.log({ res });
     expect(typeof res).toBe("string");
 });
 test("Test OpenAI with versioned instruct model returns OpenAI", async () => {
     const model = new OpenAI({ modelName: "gpt-3.5-turbo-instruct-0914" });
     expect(model).toBeInstanceOf(OpenAI);
-    const res = await model.call("Print hello world");
+    const res = await model.invoke("Print hello world");
     console.log({ res });
     expect(typeof res).toBe("string");
 });
@@ -131,7 +131,7 @@ test("Test ChatOpenAI tokenUsage", async () => {
             },
         }),
     });
-    const res = await model.call("Hello");
+    const res = await model.invoke("Hello");
     console.log({ res });
     expect(tokenUsage.promptTokens).toBe(1);
 });
@@ -149,7 +149,7 @@ test("Test OpenAI in streaming mode", async () => {
             },
         }),
     });
-    const res = await model.call("Print hello world");
+    const res = await model.invoke("Print hello world");
     console.log({ res });
     expect(nrNewTokens > 0).toBe(true);
     expect(res).toBe(streamedCompletion);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/openai",
-  "version": "0.0.19",
+  "version": "0.0.20",
   "description": "OpenAI integrations for LangChain.js",
   "type": "module",
   "engines": {
@@ -39,7 +39,7 @@
   "author": "LangChain",
   "license": "MIT",
   "dependencies": {
-    "@langchain/core": "~0.1.44",
+    "@langchain/core": "~0.1.45",
     "js-tiktoken": "^1.0.7",
     "openai": "^4.26.0",
     "zod": "^3.22.4",