@langchain/core 0.1.55-rc.0 → 0.1.56

package/dist/messages/base.cjs

@@ -0,0 +1,212 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isBaseMessageChunk = exports.isBaseMessage = exports.BaseMessageChunk = exports._mergeLists = exports._mergeDicts = exports.isOpenAIToolCallArray = exports.BaseMessage = exports.mergeContent = void 0;
+const serializable_js_1 = require("../load/serializable.cjs");
+function mergeContent(firstContent, secondContent) {
+    // If first content is a string
+    if (typeof firstContent === "string") {
+        if (typeof secondContent === "string") {
+            return firstContent + secondContent;
+        }
+        else {
+            return [{ type: "text", text: 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
+    }
+    else {
+        // Otherwise, add the second content as a new element of the list
+        return [...firstContent, { type: "text", text: secondContent }];
+    }
+}
+exports.mergeContent = mergeContent;
+/**
+ * Base class for all types of messages in a conversation. It includes
+ * properties like `content`, `name`, and `additional_kwargs`. It also
+ * includes methods like `toDict()` and `_getType()`.
+ */
+class BaseMessage extends serializable_js_1.Serializable {
+    get lc_aliases() {
+        // exclude snake case conversion to pascal case
+        return {
+            additional_kwargs: "additional_kwargs",
+            response_metadata: "response_metadata",
+        };
+    }
+    /**
+     * @deprecated
+     * Use {@link BaseMessage.content} instead.
+     */
+    get text() {
+        return typeof this.content === "string" ? this.content : "";
+    }
+    constructor(fields, 
+    /** @deprecated */
+    kwargs) {
+        if (typeof fields === "string") {
+            // eslint-disable-next-line no-param-reassign
+            fields = {
+                content: fields,
+                additional_kwargs: kwargs,
+                response_metadata: {},
+            };
+        }
+        // Make sure the default value for additional_kwargs is passed into super() for serialization
+        if (!fields.additional_kwargs) {
+            // eslint-disable-next-line no-param-reassign
+            fields.additional_kwargs = {};
+        }
+        if (!fields.response_metadata) {
+            // eslint-disable-next-line no-param-reassign
+            fields.response_metadata = {};
+        }
+        super(fields);
+        Object.defineProperty(this, "lc_namespace", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ["langchain_core", "messages"]
+        });
+        Object.defineProperty(this, "lc_serializable", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
+        /** The content of the message. */
+        Object.defineProperty(this, "content", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** The name of the message sender in a multi-user chat. */
+        Object.defineProperty(this, "name", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** Additional keyword arguments */
+        Object.defineProperty(this, "additional_kwargs", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** Response metadata. For example: response headers, logprobs, token counts. */
+        Object.defineProperty(this, "response_metadata", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.name = fields.name;
+        this.content = fields.content;
+        this.additional_kwargs = fields.additional_kwargs;
+        this.response_metadata = fields.response_metadata;
+    }
+    toDict() {
+        return {
+            type: this._getType(),
+            data: this.toJSON()
+                .kwargs,
+        };
+    }
+}
+exports.BaseMessage = BaseMessage;
+function isOpenAIToolCallArray(value) {
+    return (Array.isArray(value) &&
+        value.every((v) => typeof v.index === "number"));
+}
+exports.isOpenAIToolCallArray = isOpenAIToolCallArray;
+function _mergeDicts(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+left, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+right
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+) {
+    const merged = { ...left };
+    for (const [key, value] of Object.entries(right)) {
+        if (merged[key] == null) {
+            merged[key] = value;
+        }
+        else if (value == null) {
+            continue;
+        }
+        else if (typeof merged[key] !== typeof value ||
+            Array.isArray(merged[key]) !== Array.isArray(value)) {
+            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;
+        }
+        else if (!Array.isArray(merged[key]) && typeof merged[key] === "object") {
+            merged[key] = _mergeDicts(merged[key], value);
+        }
+        else if (Array.isArray(merged[key])) {
+            merged[key] = _mergeLists(merged[key], value);
+        }
+        else if (merged[key] === value) {
+            continue;
+        }
+        else {
+            console.warn(`field[${key}] already exists in this message chunk and value has unsupported type.`);
+        }
+    }
+    return merged;
+}
+exports._mergeDicts = _mergeDicts;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function _mergeLists(left, right) {
+    if (left === undefined && right === undefined) {
+        return undefined;
+    }
+    else if (left === undefined || right === undefined) {
+        return left || right;
+    }
+    else {
+        const merged = [...left];
+        for (const item of right) {
+            if (typeof item === "object" &&
+                "index" in item &&
+                typeof item.index === "number") {
+                const toMerge = merged.findIndex((leftItem) => leftItem.index === item.index);
+                if (toMerge !== -1) {
+                    merged[toMerge] = _mergeDicts(merged[toMerge], item);
+                }
+                else {
+                    merged.push(item);
+                }
+            }
+            else {
+                merged.push(item);
+            }
+        }
+        return merged;
+    }
+}
+exports._mergeLists = _mergeLists;
+/**
+ * Represents a chunk of a message, which can be concatenated with other
+ * message chunks. It includes a method `_merge_kwargs_dict()` for merging
+ * additional keyword arguments from another `BaseMessageChunk` into this
+ * one. It also overrides the `__add__()` method to support concatenation
+ * of `BaseMessageChunk` instances.
+ */
+class BaseMessageChunk extends BaseMessage {
+}
+exports.BaseMessageChunk = BaseMessageChunk;
+function isBaseMessage(messageLike) {
+    return typeof messageLike?._getType === "function";
+}
+exports.isBaseMessage = isBaseMessage;
+function isBaseMessageChunk(messageLike) {
+    return (isBaseMessage(messageLike) &&
+        typeof messageLike.concat === "function");
+}
+exports.isBaseMessageChunk = isBaseMessageChunk;

package/dist/messages/base.d.ts

@@ -0,0 +1,137 @@
+import { Serializable } from "../load/serializable.js";
+import { StringWithAutocomplete } from "../utils/types/index.js";
+export interface StoredMessageData {
+    content: string;
+    role: string | undefined;
+    name: string | undefined;
+    tool_call_id: string | undefined;
+    additional_kwargs?: Record<string, any>;
+    /** Response metadata. For example: response headers, logprobs, token counts. */
+    response_metadata?: Record<string, any>;
+}
+export interface StoredMessage {
+    type: string;
+    data: StoredMessageData;
+}
+export interface StoredGeneration {
+    text: string;
+    message?: StoredMessage;
+}
+export interface StoredMessageV1 {
+    type: string;
+    role: string | undefined;
+    text: string;
+}
+export type MessageType = "human" | "ai" | "generic" | "system" | "function" | "tool";
+export type ImageDetail = "auto" | "low" | "high";
+export type MessageContentText = {
+    type: "text";
+    text: string;
+};
+export type MessageContentImageUrl = {
+    type: "image_url";
+    image_url: string | {
+        url: string;
+        detail?: ImageDetail;
+    };
+};
+export type MessageContentComplex = MessageContentText | MessageContentImageUrl | (Record<string, any> & {
+    type?: "text" | "image_url" | string;
+}) | (Record<string, any> & {
+    type?: never;
+});
+export type MessageContent = string | MessageContentComplex[];
+export interface FunctionCall {
+    /**
+     * The arguments to call the function with, as generated by the model in JSON
+     * format. Note that the model does not always generate valid JSON, and may
+     * hallucinate parameters not defined by your function schema. Validate the
+     * arguments in your code before calling your function.
+     */
+    arguments: string;
+    /**
+     * The name of the function to call.
+     */
+    name: string;
+}
+/**
+ * @deprecated
+ * Import as "OpenAIToolCall" instead
+ */
+export interface ToolCall {
+    /**
+     * The ID of the tool call.
+     */
+    id: string;
+    /**
+     * The function that the model called.
+     */
+    function: FunctionCall;
+    /**
+     * The type of the tool. Currently, only `function` is supported.
+     */
+    type: "function";
+}
+export type BaseMessageFields = {
+    content: MessageContent;
+    name?: string;
+    additional_kwargs?: {
+        function_call?: FunctionCall;
+        tool_calls?: ToolCall[];
+        [key: string]: unknown;
+    };
+    /** Response metadata. For example: response headers, logprobs, token counts. */
+    response_metadata?: Record<string, any>;
+};
+export declare function mergeContent(firstContent: MessageContent, secondContent: MessageContent): MessageContent;
+/**
+ * Base class for all types of messages in a conversation. It includes
+ * properties like `content`, `name`, and `additional_kwargs`. It also
+ * includes methods like `toDict()` and `_getType()`.
+ */
+export declare abstract class BaseMessage extends Serializable implements BaseMessageFields {
+    lc_namespace: string[];
+    lc_serializable: boolean;
+    get lc_aliases(): Record<string, string>;
+    /**
+     * @deprecated
+     * Use {@link BaseMessage.content} instead.
+     */
+    get text(): string;
+    /** The content of the message. */
+    content: MessageContent;
+    /** The name of the message sender in a multi-user chat. */
+    name?: string;
+    /** Additional keyword arguments */
+    additional_kwargs: NonNullable<BaseMessageFields["additional_kwargs"]>;
+    /** Response metadata. For example: response headers, logprobs, token counts. */
+    response_metadata: NonNullable<BaseMessageFields["response_metadata"]>;
+    /** The type of the message. */
+    abstract _getType(): MessageType;
+    constructor(fields: string | BaseMessageFields, 
+    /** @deprecated */
+    kwargs?: Record<string, unknown>);
+    toDict(): StoredMessage;
+}
+export type OpenAIToolCall = ToolCall & {
+    index: number;
+};
+export declare function isOpenAIToolCallArray(value?: unknown): value is OpenAIToolCall[];
+export declare function _mergeDicts(left: Record<string, any>, right: Record<string, any>): Record<string, any>;
+export declare function _mergeLists(left?: any[], right?: any[]): any[] | undefined;
+/**
+ * Represents a chunk of a message, which can be concatenated with other
+ * message chunks. It includes a method `_merge_kwargs_dict()` for merging
+ * additional keyword arguments from another `BaseMessageChunk` into this
+ * one. It also overrides the `__add__()` method to support concatenation
+ * of `BaseMessageChunk` instances.
+ */
+export declare abstract class BaseMessageChunk extends BaseMessage {
+    abstract concat(chunk: BaseMessageChunk): BaseMessageChunk;
+}
+export type BaseMessageLike = BaseMessage | [
+    StringWithAutocomplete<MessageType | "user" | "assistant" | "placeholder">,
+    MessageContent
+] | string;
+export declare function isBaseMessage(messageLike?: unknown): messageLike is BaseMessage;
+export declare function isBaseMessageChunk(messageLike?: unknown): messageLike is BaseMessageChunk;

package/dist/messages/base.js

@@ -0,0 +1,201 @@
+import { Serializable } from "../load/serializable.js";
+export function mergeContent(firstContent, secondContent) {
+    // If first content is a string
+    if (typeof firstContent === "string") {
+        if (typeof secondContent === "string") {
+            return firstContent + secondContent;
+        }
+        else {
+            return [{ type: "text", text: 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
+    }
+    else {
+        // Otherwise, add the second content as a new element of the list
+        return [...firstContent, { type: "text", text: secondContent }];
+    }
+}
+/**
+ * Base class for all types of messages in a conversation. It includes
+ * properties like `content`, `name`, and `additional_kwargs`. It also
+ * includes methods like `toDict()` and `_getType()`.
+ */
+export class BaseMessage extends Serializable {
+    get lc_aliases() {
+        // exclude snake case conversion to pascal case
+        return {
+            additional_kwargs: "additional_kwargs",
+            response_metadata: "response_metadata",
+        };
+    }
+    /**
+     * @deprecated
+     * Use {@link BaseMessage.content} instead.
+     */
+    get text() {
+        return typeof this.content === "string" ? this.content : "";
+    }
+    constructor(fields, 
+    /** @deprecated */
+    kwargs) {
+        if (typeof fields === "string") {
+            // eslint-disable-next-line no-param-reassign
+            fields = {
+                content: fields,
+                additional_kwargs: kwargs,
+                response_metadata: {},
+            };
+        }
+        // Make sure the default value for additional_kwargs is passed into super() for serialization
+        if (!fields.additional_kwargs) {
+            // eslint-disable-next-line no-param-reassign
+            fields.additional_kwargs = {};
+        }
+        if (!fields.response_metadata) {
+            // eslint-disable-next-line no-param-reassign
+            fields.response_metadata = {};
+        }
+        super(fields);
+        Object.defineProperty(this, "lc_namespace", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ["langchain_core", "messages"]
+        });
+        Object.defineProperty(this, "lc_serializable", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
+        /** The content of the message. */
+        Object.defineProperty(this, "content", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** The name of the message sender in a multi-user chat. */
+        Object.defineProperty(this, "name", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** Additional keyword arguments */
+        Object.defineProperty(this, "additional_kwargs", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** Response metadata. For example: response headers, logprobs, token counts. */
+        Object.defineProperty(this, "response_metadata", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.name = fields.name;
+        this.content = fields.content;
+        this.additional_kwargs = fields.additional_kwargs;
+        this.response_metadata = fields.response_metadata;
+    }
+    toDict() {
+        return {
+            type: this._getType(),
+            data: this.toJSON()
+                .kwargs,
+        };
+    }
+}
+export function isOpenAIToolCallArray(value) {
+    return (Array.isArray(value) &&
+        value.every((v) => typeof v.index === "number"));
+}
+export function _mergeDicts(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+left, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+right
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+) {
+    const merged = { ...left };
+    for (const [key, value] of Object.entries(right)) {
+        if (merged[key] == null) {
+            merged[key] = value;
+        }
+        else if (value == null) {
+            continue;
+        }
+        else if (typeof merged[key] !== typeof value ||
+            Array.isArray(merged[key]) !== Array.isArray(value)) {
+            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;
+        }
+        else if (!Array.isArray(merged[key]) && typeof merged[key] === "object") {
+            merged[key] = _mergeDicts(merged[key], value);
+        }
+        else if (Array.isArray(merged[key])) {
+            merged[key] = _mergeLists(merged[key], value);
+        }
+        else if (merged[key] === value) {
+            continue;
+        }
+        else {
+            console.warn(`field[${key}] already exists in this message chunk and value has unsupported type.`);
+        }
+    }
+    return merged;
+}
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function _mergeLists(left, right) {
+    if (left === undefined && right === undefined) {
+        return undefined;
+    }
+    else if (left === undefined || right === undefined) {
+        return left || right;
+    }
+    else {
+        const merged = [...left];
+        for (const item of right) {
+            if (typeof item === "object" &&
+                "index" in item &&
+                typeof item.index === "number") {
+                const toMerge = merged.findIndex((leftItem) => leftItem.index === item.index);
+                if (toMerge !== -1) {
+                    merged[toMerge] = _mergeDicts(merged[toMerge], item);
+                }
+                else {
+                    merged.push(item);
+                }
+            }
+            else {
+                merged.push(item);
+            }
+        }
+        return merged;
+    }
+}
+/**
+ * Represents a chunk of a message, which can be concatenated with other
+ * message chunks. It includes a method `_merge_kwargs_dict()` for merging
+ * additional keyword arguments from another `BaseMessageChunk` into this
+ * one. It also overrides the `__add__()` method to support concatenation
+ * of `BaseMessageChunk` instances.
+ */
+export class BaseMessageChunk extends BaseMessage {
+}
+export function isBaseMessage(messageLike) {
+    return typeof messageLike?._getType === "function";
+}
+export function isBaseMessageChunk(messageLike) {
+    return (isBaseMessage(messageLike) &&
+        typeof messageLike.concat === "function");
+}

package/dist/messages/chat.cjs

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatMessageChunk = exports.ChatMessage = void 0;
+const base_js_1 = require("./base.cjs");
+/**
+ * Represents a chat message in a conversation.
+ */
+class ChatMessage extends base_js_1.BaseMessage {
+    static lc_name() {
+        return "ChatMessage";
+    }
+    static _chatMessageClass() {
+        return ChatMessage;
+    }
+    constructor(fields, role) {
+        if (typeof fields === "string") {
+            // eslint-disable-next-line no-param-reassign, @typescript-eslint/no-non-null-assertion
+            fields = { content: fields, role: role };
+        }
+        super(fields);
+        Object.defineProperty(this, "role", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.role = fields.role;
+    }
+    _getType() {
+        return "generic";
+    }
+    static isInstance(message) {
+        return message._getType() === "generic";
+    }
+}
+exports.ChatMessage = ChatMessage;
+/**
+ * Represents a chunk of a chat message, which can be concatenated with
+ * other chat message chunks.
+ */
+class ChatMessageChunk extends base_js_1.BaseMessageChunk {
+    static lc_name() {
+        return "ChatMessageChunk";
+    }
+    constructor(fields, role) {
+        if (typeof fields === "string") {
+            // eslint-disable-next-line no-param-reassign, @typescript-eslint/no-non-null-assertion
+            fields = { content: fields, role: role };
+        }
+        super(fields);
+        Object.defineProperty(this, "role", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.role = fields.role;
+    }
+    _getType() {
+        return "generic";
+    }
+    concat(chunk) {
+        return new ChatMessageChunk({
+            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),
+            role: this.role,
+        });
+    }
+}
+exports.ChatMessageChunk = ChatMessageChunk;

package/dist/messages/chat.d.ts

@@ -0,0 +1,28 @@
+import { BaseMessage, BaseMessageChunk, type BaseMessageFields, type MessageType } from "./base.js";
+export interface ChatMessageFieldsWithRole extends BaseMessageFields {
+    role: string;
+}
+/**
+ * Represents a chat message in a conversation.
+ */
+export declare class ChatMessage extends BaseMessage implements ChatMessageFieldsWithRole {
+    static lc_name(): string;
+    role: string;
+    static _chatMessageClass(): typeof ChatMessage;
+    constructor(content: string, role: string);
+    constructor(fields: ChatMessageFieldsWithRole);
+    _getType(): MessageType;
+    static isInstance(message: BaseMessage): message is ChatMessage;
+}
+/**
+ * Represents a chunk of a chat message, which can be concatenated with
+ * other chat message chunks.
+ */
+export declare class ChatMessageChunk extends BaseMessageChunk {
+    static lc_name(): string;
+    role: string;
+    constructor(content: string, role: string);
+    constructor(fields: ChatMessageFieldsWithRole);
+    _getType(): MessageType;
+    concat(chunk: ChatMessageChunk): ChatMessageChunk;
+}