@langchain/core 0.2.10 → 0.2.12

package/README.md

@@ -85,7 +85,7 @@ Rather than having to write multiple implementations for all of those, LCEL allo
 
 For more check out the [LCEL docs](https://js.langchain.com/v0.2/docs/concepts#langchain-expression-language).
 
-![LangChain Stack](../docs/core_docs/static/img/langchain_stack_feb_2024.webp)
+![LangChain Stack](../docs/core_docs/static/svg/langchain_stack_062024.svg)
 
 ## 📕 Releases & Versioning
 

package/dist/documents/document.cjs

@@ -18,9 +18,25 @@ class Document {
             writable: true,
             value: void 0
         });
+        // The ID field is optional at the moment.
+        // It will likely become required in a future major release after
+        // it has been adopted by enough vectorstore implementations.
+        /**
+         * An optional identifier for the document.
+         *
+         * Ideally this should be unique across the document collection and formatted
+         * as a UUID, but this will not be enforced.
+         */
+        Object.defineProperty(this, "id", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.pageContent =
             fields.pageContent !== undefined ? fields.pageContent.toString() : "";
         this.metadata = fields.metadata ?? {};
+        this.id = fields.id;
     }
 }
 exports.Document = Document;

package/dist/documents/document.d.ts

@@ -1,10 +1,24 @@
 export interface DocumentInput<Metadata extends Record<string, any> = Record<string, any>> {
     pageContent: string;
     metadata?: Metadata;
+    /**
+     * An optional identifier for the document.
+     *
+     * Ideally this should be unique across the document collection and formatted
+     * as a UUID, but this will not be enforced.
+     */
+    id?: string;
 }
 export interface DocumentInterface<Metadata extends Record<string, any> = Record<string, any>> {
     pageContent: string;
     metadata: Metadata;
+    /**
+     * An optional identifier for the document.
+     *
+     * Ideally this should be unique across the document collection and formatted
+     * as a UUID, but this will not be enforced.
+     */
+    id?: string;
 }
 /**
  * Interface for interacting with a document.
@@ -12,5 +26,12 @@ export interface DocumentInterface<Metadata extends Record<string, any> = Record
 export declare class Document<Metadata extends Record<string, any> = Record<string, any>> implements DocumentInput, DocumentInterface {
     pageContent: string;
     metadata: Metadata;
+    /**
+     * An optional identifier for the document.
+     *
+     * Ideally this should be unique across the document collection and formatted
+     * as a UUID, but this will not be enforced.
+     */
+    id?: string;
     constructor(fields: DocumentInput<Metadata>);
 }

package/dist/documents/document.js

@@ -15,8 +15,24 @@ export class Document {
             writable: true,
             value: void 0
         });
+        // The ID field is optional at the moment.
+        // It will likely become required in a future major release after
+        // it has been adopted by enough vectorstore implementations.
+        /**
+         * An optional identifier for the document.
+         *
+         * Ideally this should be unique across the document collection and formatted
+         * as a UUID, but this will not be enforced.
+         */
+        Object.defineProperty(this, "id", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.pageContent =
             fields.pageContent !== undefined ? fields.pageContent.toString() : "";
         this.metadata = fields.metadata ?? {};
+        this.id = fields.id;
     }
 }

package/dist/language_models/tests/chat_models.test.js

@@ -3,6 +3,23 @@ import { test } from "@jest/globals";
 import { z } from "zod";
 import { zodToJsonSchema } from "zod-to-json-schema";
 import { FakeChatModel, FakeListChatModel } from "../../utils/testing/index.js";
+test("Test ChatModel accepts array shorthand for messages", async () => {
+    const model = new FakeChatModel({});
+    const response = await model.invoke([["human", "Hello there!"]]);
+    expect(response.content).toEqual("Hello there!");
+});
+test("Test ChatModel accepts object shorthand for messages", async () => {
+    const model = new FakeChatModel({});
+    const response = await model.invoke([
+        {
+            type: "human",
+            content: "Hello there!",
+            additional_kwargs: {},
+            example: true,
+        },
+    ]);
+    expect(response.content).toEqual("Hello there!");
+});
 test("Test ChatModel uses callbacks", async () => {
     const model = new FakeChatModel({});
     let acc = "";

package/dist/messages/base.d.ts

@@ -140,7 +140,9 @@ export declare function _mergeLists(left?: any[], right?: any[]): any[] | undefi
 export declare abstract class BaseMessageChunk extends BaseMessage {
     abstract concat(chunk: BaseMessageChunk): BaseMessageChunk;
 }
-export type BaseMessageLike = BaseMessage | [
+export type BaseMessageLike = BaseMessage | ({
+    type: MessageType | "user" | "assistant" | "placeholder";
+} & BaseMessageFields & Record<string, unknown>) | [
     StringWithAutocomplete<MessageType | "user" | "assistant" | "placeholder">,
     MessageContent
 ] | string;

package/dist/messages/utils.cjs

@@ -8,6 +8,21 @@ const function_js_1 = require("./function.cjs");
 const human_js_1 = require("./human.cjs");
 const system_js_1 = require("./system.cjs");
 const tool_js_1 = require("./tool.cjs");
+function _constructMessageFromParams(params) {
+    const { type, ...rest } = params;
+    if (type === "human" || type === "user") {
+        return new human_js_1.HumanMessage(rest);
+    }
+    else if (type === "ai" || type === "assistant") {
+        return new ai_js_1.AIMessage(rest);
+    }
+    else if (type === "system") {
+        return new system_js_1.SystemMessage(rest);
+    }
+    else {
+        throw new Error(`Unable to coerce message from array: only human, AI, or system message coercion is currently supported.`);
+    }
+}
 function coerceMessageLikeToMessage(messageLike) {
     if (typeof messageLike === "string") {
         return new human_js_1.HumanMessage(messageLike);
@@ -15,18 +30,12 @@ function coerceMessageLikeToMessage(messageLike) {
     else if ((0, base_js_1.isBaseMessage)(messageLike)) {
         return messageLike;
     }
-    const [type, content] = messageLike;
-    if (type === "human" || type === "user") {
-        return new human_js_1.HumanMessage({ content });
-    }
-    else if (type === "ai" || type === "assistant") {
-        return new ai_js_1.AIMessage({ content });
-    }
-    else if (type === "system") {
-        return new system_js_1.SystemMessage({ content });
+    if (Array.isArray(messageLike)) {
+        const [type, content] = messageLike;
+        return _constructMessageFromParams({ type, content });
     }
     else {
-        throw new Error(`Unable to coerce message from array: only human, AI, or system message coercion is currently supported.`);
+        return _constructMessageFromParams(messageLike);
     }
 }
 exports.coerceMessageLikeToMessage = coerceMessageLikeToMessage;

package/dist/messages/utils.js

@@ -5,6 +5,21 @@ import { FunctionMessage, FunctionMessageChunk, } from "./function.js";
 import { HumanMessage, HumanMessageChunk } from "./human.js";
 import { SystemMessage, SystemMessageChunk } from "./system.js";
 import { ToolMessage } from "./tool.js";
+function _constructMessageFromParams(params) {
+    const { type, ...rest } = params;
+    if (type === "human" || type === "user") {
+        return new HumanMessage(rest);
+    }
+    else if (type === "ai" || type === "assistant") {
+        return new AIMessage(rest);
+    }
+    else if (type === "system") {
+        return new SystemMessage(rest);
+    }
+    else {
+        throw new Error(`Unable to coerce message from array: only human, AI, or system message coercion is currently supported.`);
+    }
+}
 export function coerceMessageLikeToMessage(messageLike) {
     if (typeof messageLike === "string") {
         return new HumanMessage(messageLike);
@@ -12,18 +27,12 @@ export function coerceMessageLikeToMessage(messageLike) {
     else if (isBaseMessage(messageLike)) {
         return messageLike;
     }
-    const [type, content] = messageLike;
-    if (type === "human" || type === "user") {
-        return new HumanMessage({ content });
-    }
-    else if (type === "ai" || type === "assistant") {
-        return new AIMessage({ content });
-    }
-    else if (type === "system") {
-        return new SystemMessage({ content });
+    if (Array.isArray(messageLike)) {
+        const [type, content] = messageLike;
+        return _constructMessageFromParams({ type, content });
     }
     else {
-        throw new Error(`Unable to coerce message from array: only human, AI, or system message coercion is currently supported.`);
+        return _constructMessageFromParams(messageLike);
     }
 }
 /**

package/dist/prompts/chat.cjs

@@ -75,33 +75,37 @@ class MessagesPlaceholder extends BaseMessagePromptTemplate {
     get inputVariables() {
         return [this.variableName];
     }
-    validateInputOrThrow(input, variableName) {
+    async formatMessages(values) {
+        const input = values[this.variableName];
         if (this.optional && !input) {
-            return false;
+            return [];
         }
         else if (!input) {
-            const error = new Error(`Error: Field "${variableName}" in prompt uses a MessagesPlaceholder, which expects an array of BaseMessages as an input value. Received: undefined`);
+            const error = new Error(`Field "${this.variableName}" in prompt uses a MessagesPlaceholder, which expects an array of BaseMessages as an input value. Received: undefined`);
             error.name = "InputFormatError";
             throw error;
         }
-        let isInputBaseMessage = false;
-        if (Array.isArray(input)) {
-            isInputBaseMessage = input.every((message) => (0, index_js_1.isBaseMessage)(message));
-        }
-        else {
-            isInputBaseMessage = (0, index_js_1.isBaseMessage)(input);
+        let formattedMessages;
+        try {
+            if (Array.isArray(input)) {
+                formattedMessages = input.map(index_js_1.coerceMessageLikeToMessage);
+            }
+            else {
+                formattedMessages = [(0, index_js_1.coerceMessageLikeToMessage)(input)];
+            }
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
         }
-        if (!isInputBaseMessage) {
+        catch (e) {
             const readableInput = typeof input === "string" ? input : JSON.stringify(input, null, 2);
-            const error = new Error(`Error: Field "${variableName}" in prompt uses a MessagesPlaceholder, which expects an array of BaseMessages as an input value. Received: ${readableInput}`);
+            const error = new Error([
+                `Field "${this.variableName}" in prompt uses a MessagesPlaceholder, which expects an array of BaseMessages or coerceable values as input.`,
+                `Received value: ${readableInput}`,
+                `Additional message: ${e.message}`,
+            ].join("\n\n"));
             error.name = "InputFormatError";
             throw error;
         }
-        return true;
-    }
-    async formatMessages(values) {
-        this.validateInputOrThrow(values[this.variableName], this.variableName);
-        return values[this.variableName] ?? [];
+        return formattedMessages;
     }
 }
 exports.MessagesPlaceholder = MessagesPlaceholder;
@@ -329,6 +333,7 @@ class _StringImageMessagePromptTemplate extends BaseMessagePromptTemplate {
                     imgTemplateObject = new image_js_1.ImagePromptTemplate({
                         template: imgTemplate,
                         inputVariables,
+                        templateFormat: additionalOptions?.templateFormat,
                     });
                 }
                 else if (typeof imgTemplate === "object") {
@@ -348,6 +353,7 @@ class _StringImageMessagePromptTemplate extends BaseMessagePromptTemplate {
                     imgTemplateObject = new image_js_1.ImagePromptTemplate({
                         template: imgTemplate,
                         inputVariables,
+                        templateFormat: additionalOptions?.templateFormat,
                     });
                 }
                 else {

package/dist/prompts/chat.d.ts

@@ -50,7 +50,6 @@ export declare class MessagesPlaceholder<RunInput extends InputValues = any> ext
     constructor(variableName: Extract<keyof RunInput, string>);
     constructor(fields: MessagesPlaceholderFields<Extract<keyof RunInput, string>>);
     get inputVariables(): Extract<keyof RunInput, string>[];
-    validateInputOrThrow(input: Array<unknown> | undefined, variableName: Extract<keyof RunInput, string>): input is BaseMessage[];
     formatMessages(values: TypedPromptInputValues<RunInput>): Promise<BaseMessage[]>;
 }
 /**

package/dist/prompts/chat.js

@@ -71,33 +71,37 @@ export class MessagesPlaceholder extends BaseMessagePromptTemplate {
     get inputVariables() {
         return [this.variableName];
     }
-    validateInputOrThrow(input, variableName) {
+    async formatMessages(values) {
+        const input = values[this.variableName];
         if (this.optional && !input) {
-            return false;
+            return [];
         }
         else if (!input) {
-            const error = new Error(`Error: Field "${variableName}" in prompt uses a MessagesPlaceholder, which expects an array of BaseMessages as an input value. Received: undefined`);
+            const error = new Error(`Field "${this.variableName}" in prompt uses a MessagesPlaceholder, which expects an array of BaseMessages as an input value. Received: undefined`);
             error.name = "InputFormatError";
             throw error;
         }
-        let isInputBaseMessage = false;
-        if (Array.isArray(input)) {
-            isInputBaseMessage = input.every((message) => isBaseMessage(message));
-        }
-        else {
-            isInputBaseMessage = isBaseMessage(input);
+        let formattedMessages;
+        try {
+            if (Array.isArray(input)) {
+                formattedMessages = input.map(coerceMessageLikeToMessage);
+            }
+            else {
+                formattedMessages = [coerceMessageLikeToMessage(input)];
+            }
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
         }
-        if (!isInputBaseMessage) {
+        catch (e) {
             const readableInput = typeof input === "string" ? input : JSON.stringify(input, null, 2);
-            const error = new Error(`Error: Field "${variableName}" in prompt uses a MessagesPlaceholder, which expects an array of BaseMessages as an input value. Received: ${readableInput}`);
+            const error = new Error([
+                `Field "${this.variableName}" in prompt uses a MessagesPlaceholder, which expects an array of BaseMessages or coerceable values as input.`,
+                `Received value: ${readableInput}`,
+                `Additional message: ${e.message}`,
+            ].join("\n\n"));
             error.name = "InputFormatError";
             throw error;
         }
-        return true;
-    }
-    async formatMessages(values) {
-        this.validateInputOrThrow(values[this.variableName], this.variableName);
-        return values[this.variableName] ?? [];
+        return formattedMessages;
     }
 }
 /**
@@ -321,6 +325,7 @@ class _StringImageMessagePromptTemplate extends BaseMessagePromptTemplate {
                     imgTemplateObject = new ImagePromptTemplate({
                         template: imgTemplate,
                         inputVariables,
+                        templateFormat: additionalOptions?.templateFormat,
                     });
                 }
                 else if (typeof imgTemplate === "object") {
@@ -340,6 +345,7 @@ class _StringImageMessagePromptTemplate extends BaseMessagePromptTemplate {
                     imgTemplateObject = new ImagePromptTemplate({
                         template: imgTemplate,
                         inputVariables,
+                        templateFormat: additionalOptions?.templateFormat,
                     });
                 }
                 else {

package/dist/prompts/image.cjs

@@ -81,13 +81,7 @@ class ImagePromptTemplate extends base_js_1.BasePromptTemplate {
         const formatted = {};
         for (const [key, value] of Object.entries(this.template)) {
             if (typeof value === "string") {
-                formatted[key] = value.replace(/{([^{}]*)}/g, (match, group) => {
-                    const replacement = values[group];
-                    return typeof replacement === "string" ||
-                        typeof replacement === "number"
-                        ? String(replacement)
-                        : match;
-                });
+                formatted[key] = (0, template_js_1.renderTemplate)(value, this.templateFormat, values);
             }
             else {
                 formatted[key] = value;

package/dist/prompts/image.js

@@ -1,6 +1,6 @@
 import { ImagePromptValue } from "../prompt_values.js";
 import { BasePromptTemplate, } from "./base.js";
-import { checkValidTemplate } from "./template.js";
+import { checkValidTemplate, renderTemplate, } from "./template.js";
 /**
  * An image prompt template for a multimodal model.
  */
@@ -78,13 +78,7 @@ export class ImagePromptTemplate extends BasePromptTemplate {
         const formatted = {};
         for (const [key, value] of Object.entries(this.template)) {
             if (typeof value === "string") {
-                formatted[key] = value.replace(/{([^{}]*)}/g, (match, group) => {
-                    const replacement = values[group];
-                    return typeof replacement === "string" ||
-                        typeof replacement === "number"
-                        ? String(replacement)
-                        : match;
-                });
+                formatted[key] = renderTemplate(value, this.templateFormat, values);
             }
             else {
                 formatted[key] = value;

package/dist/prompts/template.cjs

@@ -5,6 +5,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.checkValidTemplate = exports.parseTemplate = exports.renderTemplate = exports.DEFAULT_PARSER_MAPPING = exports.DEFAULT_FORMATTER_MAPPING = exports.interpolateMustache = exports.interpolateFString = exports.parseMustache = exports.parseFString = void 0;
 const mustache_1 = __importDefault(require("mustache"));
+function configureMustache() {
+    // Use unescaped HTML
+    // https://github.com/janl/mustache.js?tab=readme-ov-file#variables
+    mustache_1.default.escape = (text) => text;
+}
 const parseFString = (template) => {
     // Core logic replicated from internals of pythons built in Formatter class.
     // https://github.com/python/cpython/blob/135ec7cefbaffd516b77362ad2b2ad1025af462e/Objects/stringlib/unicode_format.h#L700-L706
@@ -76,6 +81,7 @@ const mustacheTemplateToNodes = (template) => template.map((temp) => {
     }
 });
 const parseMustache = (template) => {
+    configureMustache();
     const parsed = mustache_1.default.parse(template);
     return mustacheTemplateToNodes(parsed);
 };
@@ -90,7 +96,10 @@ const interpolateFString = (template, values) => (0, exports.parseFString)(templ
     return res + node.text;
 }, "");
 exports.interpolateFString = interpolateFString;
-const interpolateMustache = (template, values) => mustache_1.default.render(template, values);
+const interpolateMustache = (template, values) => {
+    configureMustache();
+    return mustache_1.default.render(template, values);
+};
 exports.interpolateMustache = interpolateMustache;
 exports.DEFAULT_FORMATTER_MAPPING = {
     "f-string": exports.interpolateFString,

package/dist/prompts/template.js

@@ -1,4 +1,9 @@
 import mustache from "mustache";
+function configureMustache() {
+    // Use unescaped HTML
+    // https://github.com/janl/mustache.js?tab=readme-ov-file#variables
+    mustache.escape = (text) => text;
+}
 export const parseFString = (template) => {
     // Core logic replicated from internals of pythons built in Formatter class.
     // https://github.com/python/cpython/blob/135ec7cefbaffd516b77362ad2b2ad1025af462e/Objects/stringlib/unicode_format.h#L700-L706
@@ -69,6 +74,7 @@ const mustacheTemplateToNodes = (template) => template.map((temp) => {
     }
 });
 export const parseMustache = (template) => {
+    configureMustache();
     const parsed = mustache.parse(template);
     return mustacheTemplateToNodes(parsed);
 };
@@ -81,7 +87,10 @@ export const interpolateFString = (template, values) => parseFString(template).r
     }
     return res + node.text;
 }, "");
-export const interpolateMustache = (template, values) => mustache.render(template, values);
+export const interpolateMustache = (template, values) => {
+    configureMustache();
+    return mustache.render(template, values);
+};
 export const DEFAULT_FORMATTER_MAPPING = {
     "f-string": interpolateFString,
     mustache: interpolateMustache,

package/dist/prompts/tests/chat.mustache.test.js

@@ -78,6 +78,22 @@ test("Mustache template with image and chat prompts inside one template (fromMes
     ], {
         templateFormat: "mustache",
     });
+    const messages = await template.formatMessages({
+        name: "Bob",
+        image_url: "https://foo.com/bar.png",
+        other_var: "bar",
+    });
+    expect(messages).toEqual([
+        new HumanMessage({
+            content: [
+                { type: "image_url", image_url: { url: "https://foo.com/bar.png" } },
+                { type: "text", text: "bar" },
+            ],
+        }),
+        new HumanMessage({
+            content: "hello Bob",
+        }),
+    ]);
     expect(template.inputVariables.sort()).toEqual([
         "image_url",
         "name",
@@ -97,5 +113,17 @@ test("Mustache image template with nested URL and chat prompts HumanMessagePromp
     ], {
         templateFormat: "mustache",
     });
+    const messages = await template.formatMessages({
+        name: "Bob",
+        image_url: "https://foo.com/bar.png",
+    });
+    expect(messages).toEqual([
+        new HumanMessage({
+            content: [
+                { type: "text", text: "Bob" },
+                { type: "image_url", image_url: { url: "https://foo.com/bar.png" } },
+            ],
+        }),
+    ]);
     expect(template.inputVariables.sort()).toEqual(["image_url", "name"]);
 });

package/dist/prompts/tests/chat.test.js

@@ -258,7 +258,7 @@ test("Test MessagesPlaceholder not optional", async () => {
         variableName: "foo",
     });
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    await expect(prompt.formatMessages({})).rejects.toThrow('Error: Field "foo" in prompt uses a MessagesPlaceholder, which expects an array of BaseMessages as an input value. Received: undefined');
+    await expect(prompt.formatMessages({})).rejects.toThrow('Field "foo" in prompt uses a MessagesPlaceholder, which expects an array of BaseMessages as an input value. Received: undefined');
 });
 test("Test MessagesPlaceholder shorthand in a chat prompt template should throw for invalid syntax", async () => {
     expect(() => ChatPromptTemplate.fromMessages([["placeholder", "foo"]])).toThrow();
@@ -273,6 +273,56 @@ test("Test MessagesPlaceholder shorthand in a chat prompt template", async () =>
         new AIMessage("how r u"),
     ]);
 });
+test("Test MessagesPlaceholder shorthand in a chat prompt template with object format", async () => {
+    const prompt = ChatPromptTemplate.fromMessages([["placeholder", "{foo}"]]);
+    const messages = await prompt.formatMessages({
+        foo: [
+            {
+                type: "system",
+                content: "some initial content",
+            },
+            {
+                type: "human",
+                content: [
+                    {
+                        text: "page: 1\ndescription: One Purchase Flow\ntimestamp: '2024-06-04T14:46:46.062Z'\ntype: navigate\nscreenshot_present: true\n",
+                        type: "text",
+                    },
+                    {
+                        text: "page: 3\ndescription: intent_str=buy,mode_str=redirect,screenName_str=order-completed,\ntimestamp: '2024-06-04T14:46:58.846Z'\ntype: Screen View\nscreenshot_present: false\n",
+                        type: "text",
+                    },
+                ],
+            },
+            {
+                type: "assistant",
+                content: "some captivating response",
+            },
+        ],
+    });
+    expect(messages).toEqual([
+        new SystemMessage("some initial content"),
+        new HumanMessage({
+            content: [
+                {
+                    text: "page: 1\ndescription: One Purchase Flow\ntimestamp: '2024-06-04T14:46:46.062Z'\ntype: navigate\nscreenshot_present: true\n",
+                    type: "text",
+                },
+                {
+                    text: "page: 3\ndescription: intent_str=buy,mode_str=redirect,screenName_str=order-completed,\ntimestamp: '2024-06-04T14:46:58.846Z'\ntype: Screen View\nscreenshot_present: false\n",
+                    type: "text",
+                },
+            ],
+        }),
+        new AIMessage("some captivating response"),
+    ]);
+});
+test("Test MessagesPlaceholder with invalid shorthand should throw", async () => {
+    const prompt = ChatPromptTemplate.fromMessages([["placeholder", "{foo}"]]);
+    await expect(() => prompt.formatMessages({
+        foo: [{ badFormatting: true }],
+    })).rejects.toThrow();
+});
 test("Test using partial", async () => {
     const userPrompt = new PromptTemplate({
         template: "{foo}{bar}",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/core",
-  "version": "0.2.10",
+  "version": "0.2.12",
   "description": "Core LangChain.js abstractions and schemas",
   "type": "module",
   "engines": {