@langchain/core 0.2.15 → 0.2.17

package/dist/messages/base.js

@@ -11,14 +11,40 @@ export function mergeContent(firstContent, secondContent) {
         // If both are arrays
     }
     else if (Array.isArray(secondContent)) {
-        return [...firstContent, ...secondContent];
-        // If the first content is a list and second is a string
+        return (_mergeLists(firstContent, secondContent) ?? [
+            ...firstContent,
+            ...secondContent,
+        ]);
     }
     else {
         // Otherwise, add the second content as a new element of the list
         return [...firstContent, { type: "text", text: secondContent }];
     }
 }
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function stringifyWithDepthLimit(obj, depthLimit) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    function helper(obj, currentDepth) {
+        if (typeof obj !== "object" || obj === null || obj === undefined) {
+            return obj;
+        }
+        if (currentDepth >= depthLimit) {
+            if (Array.isArray(obj)) {
+                return "[Array]";
+            }
+            return "[Object]";
+        }
+        if (Array.isArray(obj)) {
+            return obj.map((item) => helper(item, currentDepth + 1));
+        }
+        const result = {};
+        for (const key of Object.keys(obj)) {
+            result[key] = helper(obj[key], currentDepth + 1);
+        }
+        return result;
+    }
+    return JSON.stringify(helper(obj, 0), null, 2);
+}
 /**
  * Base class for all types of messages in a conversation. It includes
  * properties like `content`, `name`, and `additional_kwargs`. It also
@@ -123,6 +149,32 @@ export class BaseMessage extends Serializable {
                 .kwargs,
         };
     }
+    static lc_name() {
+        return "BaseMessage";
+    }
+    // Can't be protected for silly reasons
+    get _printableFields() {
+        return {
+            id: this.id,
+            content: this.content,
+            name: this.name,
+            additional_kwargs: this.additional_kwargs,
+            response_metadata: this.response_metadata,
+        };
+    }
+    get [Symbol.toStringTag]() {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        return this.constructor.lc_name();
+    }
+    // Override the default behavior of console.log
+    [Symbol.for("nodejs.util.inspect.custom")](depth) {
+        if (depth === null) {
+            return this;
+        }
+        const printable = stringifyWithDepthLimit(this._printableFields, Math.max(4, depth));
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        return `${this.constructor.lc_name()} ${printable}`;
+    }
 }
 export function isOpenAIToolCallArray(value) {
     return (Array.isArray(value) &&
@@ -148,9 +200,13 @@ right
             throw new Error(`field[${key}] already exists in the message chunk, but with a different type.`);
         }
         else if (typeof merged[key] === "string") {
-            merged[key] = merged[key] + value;
+            if (key === "type") {
+                // Do not merge 'type' fields
+                continue;
+            }
+            merged[key] += value;
         }
-        else if (!Array.isArray(merged[key]) && typeof merged[key] === "object") {
+        else if (typeof merged[key] === "object" && !Array.isArray(merged[key])) {
             merged[key] = _mergeDicts(merged[key], value);
         }
         else if (Array.isArray(merged[key])) {
@@ -187,6 +243,12 @@ export function _mergeLists(left, right) {
                     merged.push(item);
                 }
             }
+            else if (typeof item === "object" &&
+                "text" in item &&
+                item.text === "") {
+                // No-op - skip empty text blocks
+                continue;
+            }
             else {
                 merged.push(item);
             }
@@ -194,6 +256,33 @@ export function _mergeLists(left, right) {
         return merged;
     }
 }
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function _mergeObj(left, right) {
+    if (!left && !right) {
+        throw new Error("Cannot merge two undefined objects.");
+    }
+    if (!left || !right) {
+        return left || right;
+    }
+    else if (typeof left !== typeof right) {
+        throw new Error(`Cannot merge objects of different types.\nLeft ${typeof left}\nRight ${typeof right}`);
+    }
+    else if (typeof left === "string" && typeof right === "string") {
+        return (left + right);
+    }
+    else if (Array.isArray(left) && Array.isArray(right)) {
+        return _mergeLists(left, right);
+    }
+    else if (typeof left === "object" && typeof right === "object") {
+        return _mergeDicts(left, right);
+    }
+    else if (left === right) {
+        return left;
+    }
+    else {
+        throw new Error(`Can not merge objects of different types.\nLeft ${left}\nRight ${right}`);
+    }
+}
 /**
  * Represents a chunk of a message, which can be concatenated with other
  * message chunks. It includes a method `_merge_kwargs_dict()` for merging

package/dist/messages/chat.cjs

@@ -32,6 +32,12 @@ class ChatMessage extends base_js_1.BaseMessage {
     static isInstance(message) {
         return message._getType() === "generic";
     }
+    get _printableFields() {
+        return {
+            ...super._printableFields,
+            role: this.role,
+        };
+    }
 }
 exports.ChatMessage = ChatMessage;
 /**
@@ -68,5 +74,11 @@ class ChatMessageChunk extends base_js_1.BaseMessageChunk {
             id: this.id ?? chunk.id,
         });
     }
+    get _printableFields() {
+        return {
+            ...super._printableFields,
+            role: this.role,
+        };
+    }
 }
 exports.ChatMessageChunk = ChatMessageChunk;

package/dist/messages/chat.d.ts

@@ -13,6 +13,7 @@ export declare class ChatMessage extends BaseMessage implements ChatMessageField
     constructor(fields: ChatMessageFieldsWithRole);
     _getType(): MessageType;
     static isInstance(message: BaseMessage): message is ChatMessage;
+    get _printableFields(): Record<string, unknown>;
 }
 /**
  * Represents a chunk of a chat message, which can be concatenated with
@@ -25,4 +26,5 @@ export declare class ChatMessageChunk extends BaseMessageChunk {
     constructor(fields: ChatMessageFieldsWithRole);
     _getType(): MessageType;
     concat(chunk: ChatMessageChunk): ChatMessageChunk;
+    get _printableFields(): Record<string, unknown>;
 }

package/dist/messages/chat.js

@@ -29,6 +29,12 @@ export class ChatMessage extends BaseMessage {
     static isInstance(message) {
         return message._getType() === "generic";
     }
+    get _printableFields() {
+        return {
+            ...super._printableFields,
+            role: this.role,
+        };
+    }
 }
 /**
  * Represents a chunk of a chat message, which can be concatenated with
@@ -64,4 +70,10 @@ export class ChatMessageChunk extends BaseMessageChunk {
             id: this.id ?? chunk.id,
         });
     }
+    get _printableFields() {
+        return {
+            ...super._printableFields,
+            role: this.role,
+        };
+    }
 }

package/dist/messages/index.cjs

@@ -23,6 +23,7 @@ __exportStar(require("./human.cjs"), exports);
 __exportStar(require("./system.cjs"), exports);
 __exportStar(require("./utils.cjs"), exports);
 __exportStar(require("./transformers.cjs"), exports);
+__exportStar(require("./modifier.cjs"), exports);
 // TODO: Use a star export when we deprecate the
 // existing "ToolCall" type in "base.js".
 var tool_js_1 = require("./tool.cjs");

package/dist/messages/index.d.ts

@@ -6,4 +6,5 @@ export * from "./human.js";
 export * from "./system.js";
 export * from "./utils.js";
 export * from "./transformers.js";
-export { type ToolMessageFieldsWithToolCallId, ToolMessage, ToolMessageChunk, } from "./tool.js";
+export * from "./modifier.js";
+export { type ToolMessageFieldsWithToolCallId, ToolMessage, ToolMessageChunk, type InvalidToolCall, } from "./tool.js";

package/dist/messages/index.js

@@ -6,6 +6,7 @@ export * from "./human.js";
 export * from "./system.js";
 export * from "./utils.js";
 export * from "./transformers.js";
+export * from "./modifier.js";
 // TODO: Use a star export when we deprecate the
 // existing "ToolCall" type in "base.js".
 export { ToolMessage, ToolMessageChunk, } from "./tool.js";

package/dist/messages/modifier.cjs

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RemoveMessage = void 0;
+const base_js_1 = require("./base.cjs");
+/**
+ * Message responsible for deleting other messages.
+ */
+class RemoveMessage extends base_js_1.BaseMessage {
+    constructor(fields) {
+        super({
+            ...fields,
+            content: "",
+        });
+        /**
+         * The ID of the message to remove.
+         */
+        Object.defineProperty(this, "id", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.id = fields.id;
+    }
+    _getType() {
+        return "remove";
+    }
+    get _printableFields() {
+        return {
+            ...super._printableFields,
+            id: this.id,
+        };
+    }
+}
+exports.RemoveMessage = RemoveMessage;

package/dist/messages/modifier.d.ts

@@ -0,0 +1,19 @@
+import { BaseMessage, BaseMessageFields, MessageType } from "./base.js";
+export interface RemoveMessageFields extends Omit<BaseMessageFields, "content"> {
+    /**
+     * The ID of the message to remove.
+     */
+    id: string;
+}
+/**
+ * Message responsible for deleting other messages.
+ */
+export declare class RemoveMessage extends BaseMessage {
+    /**
+     * The ID of the message to remove.
+     */
+    id: string;
+    constructor(fields: RemoveMessageFields);
+    _getType(): MessageType;
+    get _printableFields(): Record<string, unknown>;
+}

package/dist/messages/modifier.js

@@ -0,0 +1,31 @@
+import { BaseMessage } from "./base.js";
+/**
+ * Message responsible for deleting other messages.
+ */
+export class RemoveMessage extends BaseMessage {
+    constructor(fields) {
+        super({
+            ...fields,
+            content: "",
+        });
+        /**
+         * The ID of the message to remove.
+         */
+        Object.defineProperty(this, "id", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.id = fields.id;
+    }
+    _getType() {
+        return "remove";
+    }
+    get _printableFields() {
+        return {
+            ...super._printableFields,
+            id: this.id,
+        };
+    }
+}

package/dist/messages/tests/base_message.test.js

@@ -1,6 +1,6 @@
-import { test } from "@jest/globals";
+import { test, describe, it, expect } from "@jest/globals";
 import { ChatPromptTemplate } from "../../prompts/chat.js";
-import { HumanMessage, AIMessage, ToolMessage } from "../index.js";
+import { HumanMessage, AIMessage, ToolMessage, ToolMessageChunk, AIMessageChunk, } from "../index.js";
 import { load } from "../../load/index.js";
 test("Test ChatPromptTemplate can format OpenAI content image messages", async () => {
     const message = new HumanMessage({
@@ -111,3 +111,135 @@ test("Deserialisation and serialisation of messages with ID", async () => {
     expect(deserialized).toEqual(message);
     expect(deserialized.id).toBe(messageId);
 });
+test("Can concat artifact (string) of ToolMessageChunk", () => {
+    const rawOutputOne = "Hello";
+    const rawOutputTwo = " world";
+    const chunk1 = new ToolMessageChunk({
+        content: "Hello",
+        tool_call_id: "1",
+        artifact: rawOutputOne,
+    });
+    const chunk2 = new ToolMessageChunk({
+        content: " world",
+        tool_call_id: "1",
+        artifact: rawOutputTwo,
+    });
+    const concated = chunk1.concat(chunk2);
+    expect(concated.artifact).toBe(`${rawOutputOne}${rawOutputTwo}`);
+});
+test("Can concat artifact (array) of ToolMessageChunk", () => {
+    const rawOutputOne = ["Hello", " world"];
+    const rawOutputTwo = ["!!"];
+    const chunk1 = new ToolMessageChunk({
+        content: "Hello",
+        tool_call_id: "1",
+        artifact: rawOutputOne,
+    });
+    const chunk2 = new ToolMessageChunk({
+        content: " world",
+        tool_call_id: "1",
+        artifact: rawOutputTwo,
+    });
+    const concated = chunk1.concat(chunk2);
+    expect(concated.artifact).toEqual(["Hello", " world", "!!"]);
+});
+test("Can concat artifact (object) of ToolMessageChunk", () => {
+    const rawOutputOne = {
+        foo: "bar",
+    };
+    const rawOutputTwo = {
+        bar: "baz",
+    };
+    const chunk1 = new ToolMessageChunk({
+        content: "Hello",
+        tool_call_id: "1",
+        artifact: rawOutputOne,
+    });
+    const chunk2 = new ToolMessageChunk({
+        content: " world",
+        tool_call_id: "1",
+        artifact: rawOutputTwo,
+    });
+    const concated = chunk1.concat(chunk2);
+    expect(concated.artifact).toEqual({
+        foo: "bar",
+        bar: "baz",
+    });
+});
+describe("Complex AIMessageChunk concat", () => {
+    it("concatenates content arrays of strings", () => {
+        expect(new AIMessageChunk({
+            content: [{ type: "text", text: "I am" }],
+            id: "ai4",
+        }).concat(new AIMessageChunk({ content: [{ type: "text", text: " indeed." }] }))).toEqual(new AIMessageChunk({
+            id: "ai4",
+            content: [
+                { type: "text", text: "I am" },
+                { type: "text", text: " indeed." },
+            ],
+        }));
+    });
+    it("concatenates mixed content arrays", () => {
+        expect(new AIMessageChunk({
+            content: [{ index: 0, type: "text", text: "I am" }],
+        }).concat(new AIMessageChunk({ content: [{ type: "text", text: " indeed." }] }))).toEqual(new AIMessageChunk({
+            content: [
+                { index: 0, type: "text", text: "I am" },
+                { type: "text", text: " indeed." },
+            ],
+        }));
+    });
+    it("merges content arrays with same index", () => {
+        expect(new AIMessageChunk({ content: [{ index: 0, text: "I am" }] }).concat(new AIMessageChunk({ content: [{ index: 0, text: " indeed." }] }))).toEqual(new AIMessageChunk({ content: [{ index: 0, text: "I am indeed." }] }));
+    });
+    it("does not merge when one chunk is missing an index", () => {
+        expect(new AIMessageChunk({ content: [{ index: 0, text: "I am" }] }).concat(new AIMessageChunk({ content: [{ text: " indeed." }] }))).toEqual(new AIMessageChunk({
+            content: [{ index: 0, text: "I am" }, { text: " indeed." }],
+        }));
+    });
+    it("does not create a holey array when there's a gap between indexes", () => {
+        expect(new AIMessageChunk({ content: [{ index: 0, text: "I am" }] }).concat(new AIMessageChunk({ content: [{ index: 2, text: " indeed." }] }))).toEqual(new AIMessageChunk({
+            content: [
+                { index: 0, text: "I am" },
+                { index: 2, text: " indeed." },
+            ],
+        }));
+    });
+    it("does not merge content arrays with separate indexes", () => {
+        expect(new AIMessageChunk({ content: [{ index: 0, text: "I am" }] }).concat(new AIMessageChunk({ content: [{ index: 1, text: " indeed." }] }))).toEqual(new AIMessageChunk({
+            content: [
+                { index: 0, text: "I am" },
+                { index: 1, text: " indeed." },
+            ],
+        }));
+    });
+    it("merges content arrays with same index and type", () => {
+        expect(new AIMessageChunk({
+            content: [{ index: 0, text: "I am", type: "text_block" }],
+        }).concat(new AIMessageChunk({
+            content: [{ index: 0, text: " indeed.", type: "text_block" }],
+        }))).toEqual(new AIMessageChunk({
+            content: [{ index: 0, text: "I am indeed.", type: "text_block" }],
+        }));
+    });
+    it("merges content arrays with same index and different types without updating type", () => {
+        expect(new AIMessageChunk({
+            content: [{ index: 0, text: "I am", type: "text_block" }],
+        }).concat(new AIMessageChunk({
+            content: [{ index: 0, text: " indeed.", type: "text_block_delta" }],
+        }))).toEqual(new AIMessageChunk({
+            content: [{ index: 0, text: "I am indeed.", type: "text_block" }],
+        }));
+    });
+    it("concatenates empty string content and merges other fields", () => {
+        expect(new AIMessageChunk({
+            content: [{ index: 0, type: "text", text: "I am" }],
+        }).concat(new AIMessageChunk({
+            content: [{ type: "text", text: "" }],
+            response_metadata: { extra: "value" },
+        }))).toEqual(new AIMessageChunk({
+            content: [{ index: 0, type: "text", text: "I am" }],
+            response_metadata: { extra: "value" },
+        }));
+    });
+});

package/dist/messages/tests/message_utils.test.js

@@ -3,6 +3,7 @@ import { filterMessages, mergeMessageRuns, trimMessages, } from "../transformers
 import { AIMessage } from "../ai.js";
 import { HumanMessage } from "../human.js";
 import { SystemMessage } from "../system.js";
+import { getBufferString } from "../utils.js";
 describe("filterMessage", () => {
     const getMessages = () => [
         new SystemMessage("you're a good assistant."),
@@ -97,8 +98,8 @@ describe("mergeMessageRuns", () => {
                     { type: "text", text: "my favorite dish is lasagna" },
                 ],
                 tool_calls: [
-                    { name: "blah_tool", args: { x: 2 }, id: "123" },
-                    { name: "blah_tool", args: { x: -10 }, id: "456" },
+                    { name: "blah_tool", args: { x: 2 }, id: "123", type: "tool_call" },
+                    { name: "blah_tool", args: { x: -10 }, id: "456", type: "tool_call" },
                 ],
                 id: "baz",
             }),
@@ -380,3 +381,54 @@ describe("trimMessages can trim", () => {
         expect(typeof trimmedMessages.func).toBe("function");
     });
 });
+test("getBufferString can handle complex messages", () => {
+    const messageArr1 = [new HumanMessage("Hello there!")];
+    const messageArr2 = [
+        new AIMessage({
+            content: [
+                {
+                    type: "text",
+                    text: "Hello there!",
+                },
+            ],
+        }),
+    ];
+    const messageArr3 = [
+        new HumanMessage({
+            content: [
+                {
+                    type: "image_url",
+                    image_url: {
+                        url: "https://example.com/image.jpg",
+                    },
+                },
+                {
+                    type: "image_url",
+                    image_url: "https://example.com/image.jpg",
+                },
+            ],
+        }),
+    ];
+    const bufferString1 = getBufferString(messageArr1);
+    expect(bufferString1).toBe("Human: Hello there!");
+    const bufferString2 = getBufferString(messageArr2);
+    expect(bufferString2).toBe(`AI: ${JSON.stringify([
+        {
+            type: "text",
+            text: "Hello there!",
+        },
+    ], null, 2)}`);
+    const bufferString3 = getBufferString(messageArr3);
+    expect(bufferString3).toBe(`Human: ${JSON.stringify([
+        {
+            type: "image_url",
+            image_url: {
+                url: "https://example.com/image.jpg",
+            },
+        },
+        {
+            type: "image_url",
+            image_url: "https://example.com/image.jpg",
+        },
+    ], null, 2)}`);
+});

package/dist/messages/tool.cjs

@@ -25,7 +25,22 @@ class ToolMessage extends base_js_1.BaseMessage {
             writable: true,
             value: void 0
         });
+        /**
+         * Artifact of the Tool execution which is not meant to be sent to the model.
+         *
+         * Should only be specified if it is different from the message content, e.g. if only
+         * a subset of the full tool output is being passed as message content but the full
+         * output is needed in other parts of the code.
+         */
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        Object.defineProperty(this, "artifact", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.tool_call_id = fields.tool_call_id;
+        this.artifact = fields.artifact;
     }
     _getType() {
         return "tool";
@@ -33,6 +48,13 @@ class ToolMessage extends base_js_1.BaseMessage {
     static isInstance(message) {
         return message._getType() === "tool";
     }
+    get _printableFields() {
+        return {
+            ...super._printableFields,
+            tool_call_id: this.tool_call_id,
+            artifact: this.artifact,
+        };
+    }
 }
 exports.ToolMessage = ToolMessage;
 /**
@@ -48,7 +70,22 @@ class ToolMessageChunk extends base_js_1.BaseMessageChunk {
             writable: true,
             value: void 0
         });
+        /**
+         * Artifact of the Tool execution which is not meant to be sent to the model.
+         *
+         * Should only be specified if it is different from the message content, e.g. if only
+         * a subset of the full tool output is being passed as message content but the full
+         * output is needed in other parts of the code.
+         */
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        Object.defineProperty(this, "artifact", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.tool_call_id = fields.tool_call_id;
+        this.artifact = fields.artifact;
     }
     static lc_name() {
         return "ToolMessageChunk";
@@ -61,10 +98,18 @@ class ToolMessageChunk extends base_js_1.BaseMessageChunk {
             content: (0, base_js_1.mergeContent)(this.content, chunk.content),
             additional_kwargs: (0, base_js_1._mergeDicts)(this.additional_kwargs, chunk.additional_kwargs),
             response_metadata: (0, base_js_1._mergeDicts)(this.response_metadata, chunk.response_metadata),
+            artifact: (0, base_js_1._mergeObj)(this.artifact, chunk.artifact),
             tool_call_id: this.tool_call_id,
             id: this.id ?? chunk.id,
         });
     }
+    get _printableFields() {
+        return {
+            ...super._printableFields,
+            tool_call_id: this.tool_call_id,
+            artifact: this.artifact,
+        };
+    }
 }
 exports.ToolMessageChunk = ToolMessageChunk;
 function defaultToolCallParser(