langchain 0.0.174 → 0.0.175

package/dist/load/import_constants.cjs

@@ -41,6 +41,7 @@ exports.optionalImportEntrypoints = [
     "langchain/prompts/load",
     "langchain/vectorstores/analyticdb",
     "langchain/vectorstores/cassandra",
+    "langchain/vectorstores/convex",
     "langchain/vectorstores/elasticsearch",
     "langchain/vectorstores/cloudflare_vectorize",
     "langchain/vectorstores/closevector/web",
@@ -133,6 +134,7 @@ exports.optionalImportEntrypoints = [
     "langchain/cache/upstash_redis",
     "langchain/stores/doc/gcs",
     "langchain/stores/file/node",
+    "langchain/stores/message/convex",
     "langchain/stores/message/cloudflare_d1",
     "langchain/stores/message/dynamodb",
     "langchain/stores/message/firestore",
@@ -143,12 +145,14 @@ exports.optionalImportEntrypoints = [
     "langchain/stores/message/upstash_redis",
     "langchain/stores/message/planetscale",
     "langchain/stores/message/xata",
+    "langchain/storage/convex",
     "langchain/storage/ioredis",
     "langchain/storage/vercel_kv",
     "langchain/storage/upstash_redis",
     "langchain/storage/file_system",
     "langchain/graphs/neo4j_graph",
     "langchain/hub",
+    "langchain/util/convex",
     "langchain/experimental/multimodal_embeddings/googlevertexai",
     "langchain/experimental/chat_models/anthropic_functions",
     "langchain/experimental/llms/bittensor",

package/dist/load/import_constants.js

@@ -38,6 +38,7 @@ export const optionalImportEntrypoints = [
     "langchain/prompts/load",
     "langchain/vectorstores/analyticdb",
     "langchain/vectorstores/cassandra",
+    "langchain/vectorstores/convex",
     "langchain/vectorstores/elasticsearch",
     "langchain/vectorstores/cloudflare_vectorize",
     "langchain/vectorstores/closevector/web",
@@ -130,6 +131,7 @@ export const optionalImportEntrypoints = [
     "langchain/cache/upstash_redis",
     "langchain/stores/doc/gcs",
     "langchain/stores/file/node",
+    "langchain/stores/message/convex",
     "langchain/stores/message/cloudflare_d1",
     "langchain/stores/message/dynamodb",
     "langchain/stores/message/firestore",
@@ -140,12 +142,14 @@ export const optionalImportEntrypoints = [
     "langchain/stores/message/upstash_redis",
     "langchain/stores/message/planetscale",
     "langchain/stores/message/xata",
+    "langchain/storage/convex",
     "langchain/storage/ioredis",
     "langchain/storage/vercel_kv",
     "langchain/storage/upstash_redis",
     "langchain/storage/file_system",
     "langchain/graphs/neo4j_graph",
     "langchain/hub",
+    "langchain/util/convex",
     "langchain/experimental/multimodal_embeddings/googlevertexai",
     "langchain/experimental/chat_models/anthropic_functions",
     "langchain/experimental/llms/bittensor",

package/dist/storage/convex.cjs

@@ -0,0 +1,145 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConvexKVStore = void 0;
+// eslint-disable-next-line import/no-extraneous-dependencies
+const server_1 = require("convex/server");
+const storage_js_1 = require("../schema/storage.cjs");
+/**
+ * Class that extends the BaseStore class to interact with a Convex
+ * database. It provides methods for getting, setting, and deleting key value pairs,
+ * as well as yielding keys from the database.
+ */
+class ConvexKVStore extends storage_js_1.BaseStore {
+    constructor(config) {
+        super(config);
+        Object.defineProperty(this, "lc_namespace", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ["langchain", "storage", "convex"]
+        });
+        Object.defineProperty(this, "ctx", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "table", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "index", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "keyField", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "valueField", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "upsert", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "lookup", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "deleteMany", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.ctx = config.ctx;
+        this.table = config.table ?? "cache";
+        this.index = config.index ?? "byKey";
+        this.keyField = config.keyField ?? "key";
+        this.valueField = config.valueField ?? "value";
+        this.upsert =
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            config.upsert ?? (0, server_1.makeFunctionReference)("langchain/db:upsert");
+        this.lookup =
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            config.lookup ?? (0, server_1.makeFunctionReference)("langchain/db:lookup");
+        this.deleteMany =
+            config.deleteMany ??
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                (0, server_1.makeFunctionReference)("langchain/db:deleteMany");
+    }
+    /**
+     * Gets multiple keys from the Convex database.
+     * @param keys Array of keys to be retrieved.
+     * @returns An array of retrieved values.
+     */
+    async mget(keys) {
+        return (await Promise.all(keys.map(async (key) => {
+            const found = (await this.ctx.runQuery(this.lookup, {
+                table: this.table,
+                index: this.index,
+                keyField: this.keyField,
+                key,
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            }));
+            return found.length > 0 ? found[0][this.valueField] : undefined;
+        })));
+    }
+    /**
+     * Sets multiple keys in the Convex database.
+     * @param keyValuePairs Array of key-value pairs to be set.
+     * @returns Promise that resolves when all keys have been set.
+     */
+    async mset(keyValuePairs) {
+        // TODO: Remove chunking when Convex handles the concurrent requests correctly
+        const PAGE_SIZE = 16;
+        for (let i = 0; i < keyValuePairs.length; i += PAGE_SIZE) {
+            await Promise.all(keyValuePairs.slice(i, i + PAGE_SIZE).map(([key, value]) => this.ctx.runMutation(this.upsert, {
+                table: this.table,
+                index: this.index,
+                keyField: this.keyField,
+                key,
+                document: { [this.keyField]: key, [this.valueField]: value },
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            })));
+        }
+    }
+    /**
+     * Deletes multiple keys from the Convex database.
+     * @param keys Array of keys to be deleted.
+     * @returns Promise that resolves when all keys have been deleted.
+     */
+    async mdelete(keys) {
+        await Promise.all(keys.map((key) => this.ctx.runMutation(this.deleteMany, {
+            table: this.table,
+            index: this.index,
+            keyField: this.keyField,
+            key,
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        })));
+    }
+    /**
+     * Yields keys from the Convex database.
+     * @param prefix Optional prefix to filter the keys.
+     * @returns An AsyncGenerator that yields keys from the Convex database.
+     */
+    // eslint-disable-next-line require-yield
+    async *yieldKeys(_prefix) {
+        throw new Error("yieldKeys not implemented yet for ConvexKVStore");
+    }
+}
+exports.ConvexKVStore = ConvexKVStore;

package/dist/storage/convex.d.ts

@@ -0,0 +1,85 @@
+import { FieldPaths, FunctionReference, GenericActionCtx, GenericDataModel, NamedTableInfo, TableNamesInDataModel, VectorIndexNames } from "convex/server";
+import { Value } from "convex/values";
+import { BaseStore } from "../schema/storage.js";
+/**
+ * Type that defines the config required to initialize the
+ * ConvexKVStore class. It includes the table name,
+ * index name, field name.
+ */
+export type ConvexKVStoreConfig<DataModel extends GenericDataModel, TableName extends TableNamesInDataModel<DataModel>, IndexName extends VectorIndexNames<NamedTableInfo<DataModel, TableName>>, KeyFieldName extends FieldPaths<NamedTableInfo<DataModel, TableName>>, ValueFieldName extends FieldPaths<NamedTableInfo<DataModel, TableName>>, UpsertMutation extends FunctionReference<"mutation", "internal", {
+    table: string;
+    document: object;
+}>, LookupQuery extends FunctionReference<"query", "internal", {
+    table: string;
+    index: string;
+    keyField: string;
+    key: string;
+}, object[]>, DeleteManyMutation extends FunctionReference<"mutation", "internal", {
+    table: string;
+    index: string;
+    keyField: string;
+    key: string;
+}>> = {
+    readonly ctx: GenericActionCtx<DataModel>;
+    readonly table?: TableName;
+    readonly index?: IndexName;
+    readonly keyField?: KeyFieldName;
+    readonly valueField?: ValueFieldName;
+    readonly upsert?: UpsertMutation;
+    readonly lookup?: LookupQuery;
+    readonly deleteMany?: DeleteManyMutation;
+};
+/**
+ * Class that extends the BaseStore class to interact with a Convex
+ * database. It provides methods for getting, setting, and deleting key value pairs,
+ * as well as yielding keys from the database.
+ */
+export declare class ConvexKVStore<T extends Value, DataModel extends GenericDataModel, TableName extends TableNamesInDataModel<DataModel>, IndexName extends VectorIndexNames<NamedTableInfo<DataModel, TableName>>, KeyFieldName extends FieldPaths<NamedTableInfo<DataModel, TableName>>, ValueFieldName extends FieldPaths<NamedTableInfo<DataModel, TableName>>, UpsertMutation extends FunctionReference<"mutation", "internal", {
+    table: string;
+    document: object;
+}>, LookupQuery extends FunctionReference<"query", "internal", {
+    table: string;
+    index: string;
+    keyField: string;
+    key: string;
+}, object[]>, DeleteManyMutation extends FunctionReference<"mutation", "internal", {
+    table: string;
+    index: string;
+    keyField: string;
+    key: string;
+}>> extends BaseStore<string, T> {
+    lc_namespace: string[];
+    private readonly ctx;
+    private readonly table;
+    private readonly index;
+    private readonly keyField;
+    private readonly valueField;
+    private readonly upsert;
+    private readonly lookup;
+    private readonly deleteMany;
+    constructor(config: ConvexKVStoreConfig<DataModel, TableName, IndexName, KeyFieldName, ValueFieldName, UpsertMutation, LookupQuery, DeleteManyMutation>);
+    /**
+     * Gets multiple keys from the Convex database.
+     * @param keys Array of keys to be retrieved.
+     * @returns An array of retrieved values.
+     */
+    mget(keys: string[]): Promise<(T | undefined)[]>;
+    /**
+     * Sets multiple keys in the Convex database.
+     * @param keyValuePairs Array of key-value pairs to be set.
+     * @returns Promise that resolves when all keys have been set.
+     */
+    mset(keyValuePairs: [string, T][]): Promise<void>;
+    /**
+     * Deletes multiple keys from the Convex database.
+     * @param keys Array of keys to be deleted.
+     * @returns Promise that resolves when all keys have been deleted.
+     */
+    mdelete(keys: string[]): Promise<void>;
+    /**
+     * Yields keys from the Convex database.
+     * @param prefix Optional prefix to filter the keys.
+     * @returns An AsyncGenerator that yields keys from the Convex database.
+     */
+    yieldKeys(_prefix?: string): AsyncGenerator<string>;
+}

package/dist/storage/convex.js

@@ -0,0 +1,141 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { makeFunctionReference, } from "convex/server";
+import { BaseStore } from "../schema/storage.js";
+/**
+ * Class that extends the BaseStore class to interact with a Convex
+ * database. It provides methods for getting, setting, and deleting key value pairs,
+ * as well as yielding keys from the database.
+ */
+export class ConvexKVStore extends BaseStore {
+    constructor(config) {
+        super(config);
+        Object.defineProperty(this, "lc_namespace", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ["langchain", "storage", "convex"]
+        });
+        Object.defineProperty(this, "ctx", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "table", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "index", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "keyField", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "valueField", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "upsert", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "lookup", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "deleteMany", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.ctx = config.ctx;
+        this.table = config.table ?? "cache";
+        this.index = config.index ?? "byKey";
+        this.keyField = config.keyField ?? "key";
+        this.valueField = config.valueField ?? "value";
+        this.upsert =
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            config.upsert ?? makeFunctionReference("langchain/db:upsert");
+        this.lookup =
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            config.lookup ?? makeFunctionReference("langchain/db:lookup");
+        this.deleteMany =
+            config.deleteMany ??
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                makeFunctionReference("langchain/db:deleteMany");
+    }
+    /**
+     * Gets multiple keys from the Convex database.
+     * @param keys Array of keys to be retrieved.
+     * @returns An array of retrieved values.
+     */
+    async mget(keys) {
+        return (await Promise.all(keys.map(async (key) => {
+            const found = (await this.ctx.runQuery(this.lookup, {
+                table: this.table,
+                index: this.index,
+                keyField: this.keyField,
+                key,
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            }));
+            return found.length > 0 ? found[0][this.valueField] : undefined;
+        })));
+    }
+    /**
+     * Sets multiple keys in the Convex database.
+     * @param keyValuePairs Array of key-value pairs to be set.
+     * @returns Promise that resolves when all keys have been set.
+     */
+    async mset(keyValuePairs) {
+        // TODO: Remove chunking when Convex handles the concurrent requests correctly
+        const PAGE_SIZE = 16;
+        for (let i = 0; i < keyValuePairs.length; i += PAGE_SIZE) {
+            await Promise.all(keyValuePairs.slice(i, i + PAGE_SIZE).map(([key, value]) => this.ctx.runMutation(this.upsert, {
+                table: this.table,
+                index: this.index,
+                keyField: this.keyField,
+                key,
+                document: { [this.keyField]: key, [this.valueField]: value },
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            })));
+        }
+    }
+    /**
+     * Deletes multiple keys from the Convex database.
+     * @param keys Array of keys to be deleted.
+     * @returns Promise that resolves when all keys have been deleted.
+     */
+    async mdelete(keys) {
+        await Promise.all(keys.map((key) => this.ctx.runMutation(this.deleteMany, {
+            table: this.table,
+            index: this.index,
+            keyField: this.keyField,
+            key,
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        })));
+    }
+    /**
+     * Yields keys from the Convex database.
+     * @param prefix Optional prefix to filter the keys.
+     * @returns An AsyncGenerator that yields keys from the Convex database.
+     */
+    // eslint-disable-next-line require-yield
+    async *yieldKeys(_prefix) {
+        throw new Error("yieldKeys not implemented yet for ConvexKVStore");
+    }
+}

package/dist/stores/message/convex.cjs

@@ -0,0 +1,120 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-explicit-any */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConvexChatMessageHistory = void 0;
+// eslint-disable-next-line import/no-extraneous-dependencies
+const server_1 = require("convex/server");
+const index_js_1 = require("../../schema/index.cjs");
+const utils_js_1 = require("./utils.cjs");
+class ConvexChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
+    constructor(config) {
+        super();
+        Object.defineProperty(this, "lc_namespace", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ["langchain", "stores", "message", "convex"]
+        });
+        Object.defineProperty(this, "ctx", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "sessionId", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "table", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "index", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "sessionIdField", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "messageTextFieldName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "insert", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "lookup", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "deleteMany", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.ctx = config.ctx;
+        this.sessionId = config.sessionId;
+        this.table = config.table ?? "messages";
+        this.index = config.index ?? "bySessionId";
+        this.sessionIdField =
+            config.sessionIdField ?? "sessionId";
+        this.messageTextFieldName =
+            config.messageTextFieldName ?? "message";
+        this.insert =
+            config.insert ?? (0, server_1.makeFunctionReference)("langchain/db:insert");
+        this.lookup =
+            config.lookup ?? (0, server_1.makeFunctionReference)("langchain/db:lookup");
+        this.deleteMany =
+            config.deleteMany ??
+                (0, server_1.makeFunctionReference)("langchain/db:deleteMany");
+    }
+    async getMessages() {
+        const convexDocuments = await this.ctx.runQuery(this.lookup, {
+            table: this.table,
+            index: this.index,
+            keyField: this.sessionIdField,
+            key: this.sessionId,
+        });
+        return (0, utils_js_1.mapStoredMessagesToChatMessages)(convexDocuments.map((doc) => doc[this.messageTextFieldName]));
+    }
+    async addMessage(message) {
+        const messages = (0, utils_js_1.mapChatMessagesToStoredMessages)([message]);
+        // TODO: Remove chunking when Convex handles the concurrent requests correctly
+        const PAGE_SIZE = 16;
+        for (let i = 0; i < messages.length; i += PAGE_SIZE) {
+            await Promise.all(messages.slice(i, i + PAGE_SIZE).map((message) => this.ctx.runMutation(this.insert, {
+                table: this.table,
+                document: {
+                    [this.sessionIdField]: this.sessionId,
+                    [this.messageTextFieldName]: message,
+                },
+            })));
+        }
+    }
+    async clear() {
+        await this.ctx.runMutation(this.deleteMany, {
+            table: this.table,
+            index: this.index,
+            keyField: this.sessionIdField,
+            key: this.sessionId,
+        });
+    }
+}
+exports.ConvexChatMessageHistory = ConvexChatMessageHistory;

package/dist/stores/message/convex.d.ts

@@ -0,0 +1,60 @@
+import { DocumentByName, FieldPaths, FunctionReference, GenericActionCtx, GenericDataModel, NamedTableInfo, TableNamesInDataModel, VectorIndexNames } from "convex/server";
+import { BaseMessage, BaseListChatMessageHistory } from "../../schema/index.js";
+/**
+ * Type that defines the config required to initialize the
+ * ConvexChatMessageHistory class. At minimum it needs a sessionId
+ * and an ActionCtx.
+ */
+export type ConvexChatMessageHistoryInput<DataModel extends GenericDataModel, TableName extends TableNamesInDataModel<DataModel> = "messages", IndexName extends VectorIndexNames<NamedTableInfo<DataModel, TableName>> = "bySessionId", SessionIdFieldName extends FieldPaths<NamedTableInfo<DataModel, TableName>> = "sessionId", MessageTextFieldName extends FieldPaths<NamedTableInfo<DataModel, TableName>> = "message", InsertMutation extends FunctionReference<"mutation", "internal", {
+    table: string;
+    document: object;
+}> = any, LookupQuery extends FunctionReference<"query", "internal", {
+    table: string;
+    index: string;
+    keyField: string;
+    key: string;
+}, object[]> = any, DeleteManyMutation extends FunctionReference<"mutation", "internal", {
+    table: string;
+    index: string;
+    keyField: string;
+    key: string;
+}> = any> = {
+    readonly ctx: GenericActionCtx<DataModel>;
+    readonly sessionId: DocumentByName<DataModel, TableName>[SessionIdFieldName];
+    readonly table?: TableName;
+    readonly index?: IndexName;
+    readonly sessionIdField?: SessionIdFieldName;
+    readonly messageTextFieldName?: MessageTextFieldName;
+    readonly insert?: InsertMutation;
+    readonly lookup?: LookupQuery;
+    readonly deleteMany?: DeleteManyMutation;
+};
+export declare class ConvexChatMessageHistory<DataModel extends GenericDataModel, SessionIdFieldName extends FieldPaths<NamedTableInfo<DataModel, TableName>> = "sessionId", TableName extends TableNamesInDataModel<DataModel> = "messages", IndexName extends VectorIndexNames<NamedTableInfo<DataModel, TableName>> = "bySessionId", MessageTextFieldName extends FieldPaths<NamedTableInfo<DataModel, TableName>> = "message", InsertMutation extends FunctionReference<"mutation", "internal", {
+    table: string;
+    document: object;
+}> = any, LookupQuery extends FunctionReference<"query", "internal", {
+    table: string;
+    index: string;
+    keyField: string;
+    key: string;
+}, object[]> = any, DeleteManyMutation extends FunctionReference<"mutation", "internal", {
+    table: string;
+    index: string;
+    keyField: string;
+    key: string;
+}> = any> extends BaseListChatMessageHistory {
+    lc_namespace: string[];
+    private readonly ctx;
+    private readonly sessionId;
+    private readonly table;
+    private readonly index;
+    private readonly sessionIdField;
+    private readonly messageTextFieldName;
+    private readonly insert;
+    private readonly lookup;
+    private readonly deleteMany;
+    constructor(config: ConvexChatMessageHistoryInput<DataModel, TableName, IndexName, SessionIdFieldName, MessageTextFieldName, InsertMutation, LookupQuery, DeleteManyMutation>);
+    getMessages(): Promise<BaseMessage[]>;
+    addMessage(message: BaseMessage): Promise<void>;
+    clear(): Promise<void>;
+}