langchain 0.0.150 → 0.0.152

package/dist/stores/message/cloudflare_d1.cjs

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudflareD1MessageHistory = void 0;
+const uuid_1 = require("uuid");
+const index_js_1 = require("../../schema/index.cjs");
+const utils_js_1 = require("./utils.cjs");
+/**
+ * Class for storing and retrieving chat message history from a
+ * Cloudflare D1 database. Extends the BaseListChatMessageHistory class.
+ */
+class CloudflareD1MessageHistory extends index_js_1.BaseListChatMessageHistory {
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "lc_namespace", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ["langchain", "stores", "message", "cloudflare_d1"]
+        });
+        Object.defineProperty(this, "database", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "tableName", {
+            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, "tableInitialized", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        const { sessionId, database, tableName } = fields;
+        if (database) {
+            this.database = database;
+        }
+        else {
+            throw new Error("Either a client or config must be provided to CloudflareD1MessageHistory");
+        }
+        this.tableName = tableName || "langchain_chat_histories";
+        this.tableInitialized = false;
+        this.sessionId = sessionId;
+    }
+    /**
+     * Private method to ensure that the necessary table exists in the
+     * Cloudflare D1 database before performing any operations. If the table
+     * does not exist, it is created.
+     * @returns Promise that resolves to void.
+     */
+    async ensureTable() {
+        if (this.tableInitialized) {
+            return;
+        }
+        const query = `CREATE TABLE IF NOT EXISTS ${this.tableName} (id TEXT PRIMARY KEY, session_id TEXT, type TEXT, content TEXT, role TEXT, name TEXT, additional_kwargs TEXT);`;
+        await this.database.prepare(query).bind().all();
+        const idIndexQuery = `CREATE INDEX IF NOT EXISTS id_index ON ${this.tableName} (id);`;
+        await this.database.prepare(idIndexQuery).bind().all();
+        const sessionIdIndexQuery = `CREATE INDEX IF NOT EXISTS session_id_index ON ${this.tableName} (session_id);`;
+        await this.database.prepare(sessionIdIndexQuery).bind().all();
+        this.tableInitialized = true;
+    }
+    /**
+     * Method to retrieve all messages from the Cloudflare D1 database for the
+     * current session.
+     * @returns Promise that resolves to an array of BaseMessage objects.
+     */
+    async getMessages() {
+        await this.ensureTable();
+        const query = `SELECT * FROM ${this.tableName} WHERE session_id = ?`;
+        const rawStoredMessages = await this.database
+            .prepare(query)
+            .bind(this.sessionId)
+            .all();
+        const storedMessagesObject = rawStoredMessages.results;
+        const orderedMessages = storedMessagesObject.map((message) => {
+            const data = {
+                content: message.content,
+                additional_kwargs: JSON.parse(message.additional_kwargs),
+            };
+            if (message.role) {
+                data.role = message.role;
+            }
+            if (message.name) {
+                data.name = message.name;
+            }
+            return {
+                type: message.type,
+                data,
+            };
+        });
+        return (0, utils_js_1.mapStoredMessagesToChatMessages)(orderedMessages);
+    }
+    /**
+     * Method to add a new message to the Cloudflare D1 database for the current
+     * session.
+     * @param message The BaseMessage object to be added to the database.
+     * @returns Promise that resolves to void.
+     */
+    async addMessage(message) {
+        await this.ensureTable();
+        const messageToAdd = (0, utils_js_1.mapChatMessagesToStoredMessages)([message]);
+        const query = `INSERT INTO ${this.tableName} (id, session_id, type, content, role, name, additional_kwargs) VALUES(?, ?, ?, ?, ?, ?, ?)`;
+        const id = (0, uuid_1.v4)();
+        await this.database
+            .prepare(query)
+            .bind(id, this.sessionId, messageToAdd[0].type || null, messageToAdd[0].data.content || null, messageToAdd[0].data.role || null, messageToAdd[0].data.name || null, JSON.stringify(messageToAdd[0].data.additional_kwargs))
+            .all();
+    }
+    /**
+     * Method to delete all messages from the Cloudflare D1 database for the
+     * current session.
+     * @returns Promise that resolves to void.
+     */
+    async clear() {
+        await this.ensureTable();
+        const query = `DELETE FROM ? WHERE session_id = ? `;
+        await this.database
+            .prepare(query)
+            .bind(this.tableName, this.sessionId)
+            .all();
+    }
+}
+exports.CloudflareD1MessageHistory = CloudflareD1MessageHistory;

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

@@ -0,0 +1,49 @@
+import type { D1Database } from "@cloudflare/workers-types";
+import { BaseMessage, BaseListChatMessageHistory } from "../../schema/index.js";
+/**
+ * Type definition for the input parameters required when instantiating a
+ * CloudflareD1MessageHistory object.
+ */
+export type CloudflareD1MessageHistoryInput = {
+    tableName?: string;
+    sessionId: string;
+    database?: D1Database;
+};
+/**
+ * Class for storing and retrieving chat message history from a
+ * Cloudflare D1 database. Extends the BaseListChatMessageHistory class.
+ */
+export declare class CloudflareD1MessageHistory extends BaseListChatMessageHistory {
+    lc_namespace: string[];
+    database: D1Database;
+    private tableName;
+    private sessionId;
+    private tableInitialized;
+    constructor(fields: CloudflareD1MessageHistoryInput);
+    /**
+     * Private method to ensure that the necessary table exists in the
+     * Cloudflare D1 database before performing any operations. If the table
+     * does not exist, it is created.
+     * @returns Promise that resolves to void.
+     */
+    private ensureTable;
+    /**
+     * Method to retrieve all messages from the Cloudflare D1 database for the
+     * current session.
+     * @returns Promise that resolves to an array of BaseMessage objects.
+     */
+    getMessages(): Promise<BaseMessage[]>;
+    /**
+     * Method to add a new message to the Cloudflare D1 database for the current
+     * session.
+     * @param message The BaseMessage object to be added to the database.
+     * @returns Promise that resolves to void.
+     */
+    addMessage(message: BaseMessage): Promise<void>;
+    /**
+     * Method to delete all messages from the Cloudflare D1 database for the
+     * current session.
+     * @returns Promise that resolves to void.
+     */
+    clear(): Promise<void>;
+}

package/dist/stores/message/cloudflare_d1.js

@@ -0,0 +1,130 @@
+import { v4 } from "uuid";
+import { BaseListChatMessageHistory, } from "../../schema/index.js";
+import { mapChatMessagesToStoredMessages, mapStoredMessagesToChatMessages, } from "./utils.js";
+/**
+ * Class for storing and retrieving chat message history from a
+ * Cloudflare D1 database. Extends the BaseListChatMessageHistory class.
+ */
+export class CloudflareD1MessageHistory extends BaseListChatMessageHistory {
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "lc_namespace", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ["langchain", "stores", "message", "cloudflare_d1"]
+        });
+        Object.defineProperty(this, "database", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "tableName", {
+            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, "tableInitialized", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        const { sessionId, database, tableName } = fields;
+        if (database) {
+            this.database = database;
+        }
+        else {
+            throw new Error("Either a client or config must be provided to CloudflareD1MessageHistory");
+        }
+        this.tableName = tableName || "langchain_chat_histories";
+        this.tableInitialized = false;
+        this.sessionId = sessionId;
+    }
+    /**
+     * Private method to ensure that the necessary table exists in the
+     * Cloudflare D1 database before performing any operations. If the table
+     * does not exist, it is created.
+     * @returns Promise that resolves to void.
+     */
+    async ensureTable() {
+        if (this.tableInitialized) {
+            return;
+        }
+        const query = `CREATE TABLE IF NOT EXISTS ${this.tableName} (id TEXT PRIMARY KEY, session_id TEXT, type TEXT, content TEXT, role TEXT, name TEXT, additional_kwargs TEXT);`;
+        await this.database.prepare(query).bind().all();
+        const idIndexQuery = `CREATE INDEX IF NOT EXISTS id_index ON ${this.tableName} (id);`;
+        await this.database.prepare(idIndexQuery).bind().all();
+        const sessionIdIndexQuery = `CREATE INDEX IF NOT EXISTS session_id_index ON ${this.tableName} (session_id);`;
+        await this.database.prepare(sessionIdIndexQuery).bind().all();
+        this.tableInitialized = true;
+    }
+    /**
+     * Method to retrieve all messages from the Cloudflare D1 database for the
+     * current session.
+     * @returns Promise that resolves to an array of BaseMessage objects.
+     */
+    async getMessages() {
+        await this.ensureTable();
+        const query = `SELECT * FROM ${this.tableName} WHERE session_id = ?`;
+        const rawStoredMessages = await this.database
+            .prepare(query)
+            .bind(this.sessionId)
+            .all();
+        const storedMessagesObject = rawStoredMessages.results;
+        const orderedMessages = storedMessagesObject.map((message) => {
+            const data = {
+                content: message.content,
+                additional_kwargs: JSON.parse(message.additional_kwargs),
+            };
+            if (message.role) {
+                data.role = message.role;
+            }
+            if (message.name) {
+                data.name = message.name;
+            }
+            return {
+                type: message.type,
+                data,
+            };
+        });
+        return mapStoredMessagesToChatMessages(orderedMessages);
+    }
+    /**
+     * Method to add a new message to the Cloudflare D1 database for the current
+     * session.
+     * @param message The BaseMessage object to be added to the database.
+     * @returns Promise that resolves to void.
+     */
+    async addMessage(message) {
+        await this.ensureTable();
+        const messageToAdd = mapChatMessagesToStoredMessages([message]);
+        const query = `INSERT INTO ${this.tableName} (id, session_id, type, content, role, name, additional_kwargs) VALUES(?, ?, ?, ?, ?, ?, ?)`;
+        const id = v4();
+        await this.database
+            .prepare(query)
+            .bind(id, this.sessionId, messageToAdd[0].type || null, messageToAdd[0].data.content || null, messageToAdd[0].data.role || null, messageToAdd[0].data.name || null, JSON.stringify(messageToAdd[0].data.additional_kwargs))
+            .all();
+    }
+    /**
+     * Method to delete all messages from the Cloudflare D1 database for the
+     * current session.
+     * @returns Promise that resolves to void.
+     */
+    async clear() {
+        await this.ensureTable();
+        const query = `DELETE FROM ? WHERE session_id = ? `;
+        await this.database
+            .prepare(query)
+            .bind(this.tableName, this.sessionId)
+            .all();
+    }
+}

package/dist/types/openai-types.d.ts

@@ -1,5 +1,7 @@
 import type { OpenAI as OpenAIClient } from "openai";
+import { TiktokenModel } from "js-tiktoken/lite";
 import { BaseLanguageModelCallOptions } from "../base_language/index.js";
+export type { TiktokenModel };
 export declare interface OpenAIBaseInput {
     /** Sampling temperature to use */
     temperature: number;

package/dist/vectorstores/pgvector.cjs

@@ -0,0 +1,277 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PGVectorStore = void 0;
+const pg_1 = __importDefault(require("pg"));
+const base_js_1 = require("./base.cjs");
+const document_js_1 = require("../document.cjs");
+const env_js_1 = require("../util/env.cjs");
+/**
+ * Class that provides an interface to a Postgres vector database. It
+ * extends the `VectorStore` base class and implements methods for adding
+ * documents and vectors, performing similarity searches, and ensuring the
+ * existence of a table in the database.
+ */
+class PGVectorStore extends base_js_1.VectorStore {
+    _vectorstoreType() {
+        return "pgvector";
+    }
+    constructor(embeddings, config) {
+        super(embeddings, config);
+        Object.defineProperty(this, "tableName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "idColumnName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "vectorColumnName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "contentColumnName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "metadataColumnName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "filter", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "_verbose", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "pool", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "client", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.tableName = config.tableName;
+        this.filter = config.filter;
+        this.vectorColumnName = config.columns?.vectorColumnName ?? "embedding";
+        this.contentColumnName = config.columns?.contentColumnName ?? "text";
+        this.idColumnName = config.columns?.idColumnName ?? "id";
+        this.metadataColumnName = config.columns?.metadataColumnName ?? "metadata";
+        const pool = new pg_1.default.Pool(config.postgresConnectionOptions);
+        this.pool = pool;
+        this._verbose =
+            (0, env_js_1.getEnvironmentVariable)("LANGCHAIN_VERBOSE") === "true" ??
+                !!config.verbose;
+    }
+    /**
+     * Static method to create a new `PGVectorStore` instance from a
+     * connection. It creates a table if one does not exist, and calls
+     * `connect` to return a new instance of `PGVectorStore`.
+     *
+     * @param embeddings - Embeddings instance.
+     * @param fields - `PGVectorStoreArgs` instance.
+     * @returns A new instance of `PGVectorStore`.
+     */
+    static async initialize(embeddings, config) {
+        const postgresqlVectorStore = new PGVectorStore(embeddings, config);
+        await postgresqlVectorStore._initializeClient();
+        await postgresqlVectorStore.ensureTableInDatabase();
+        return postgresqlVectorStore;
+    }
+    async _initializeClient() {
+        this.client = await this.pool.connect();
+    }
+    /**
+     * Method to add documents to the vector store. It converts the documents into
+     * vectors, and adds them to the store.
+     *
+     * @param documents - Array of `Document` instances.
+     * @returns Promise that resolves when the documents have been added.
+     */
+    async addDocuments(documents) {
+        const texts = documents.map(({ pageContent }) => pageContent);
+        return this.addVectors(await this.embeddings.embedDocuments(texts), documents);
+    }
+    /**
+     * Generates the SQL placeholders for a specific row at the provided index.
+     *
+     * @param index - The index of the row for which placeholders need to be generated.
+     * @returns The SQL placeholders for the row values.
+     */
+    generatePlaceholderForRowAt(index) {
+        const base = index * 3;
+        return `($${base + 1}, $${base + 2}, $${base + 3})`;
+    }
+    /**
+     * Constructs the SQL query for inserting rows into the specified table.
+     *
+     * @param rows - The rows of data to be inserted, consisting of values and records.
+     * @param chunkIndex - The starting index for generating query placeholders based on chunk positioning.
+     * @returns The complete SQL INSERT INTO query string.
+     */
+    buildInsertQuery(rows, chunkIndex) {
+        const valuesPlaceholders = rows
+            .map((_, j) => this.generatePlaceholderForRowAt(chunkIndex + j))
+            .join(", ");
+        const text = `
+      INSERT INTO ${this.tableName}(
+        ${this.contentColumnName},
+        ${this.vectorColumnName},
+        ${this.metadataColumnName}
+      )
+      VALUES ${valuesPlaceholders}
+    `;
+        return text;
+    }
+    /**
+     * Method to add vectors to the vector store. It converts the vectors into
+     * rows and inserts them into the database.
+     *
+     * @param vectors - Array of vectors.
+     * @param documents - Array of `Document` instances.
+     * @returns Promise that resolves when the vectors have been added.
+     */
+    async addVectors(vectors, documents) {
+        const rows = vectors.map((embedding, idx) => {
+            const embeddingString = `[${embedding.join(",")}]`;
+            return [
+                documents[idx].pageContent,
+                embeddingString,
+                documents[idx].metadata,
+            ];
+        });
+        const chunkSize = 500;
+        for (let i = 0; i < rows.length; i += chunkSize) {
+            const chunk = rows.slice(i, i + chunkSize);
+            const insertQuery = this.buildInsertQuery(chunk, i);
+            const flatValues = chunk.flat();
+            try {
+                await this.pool.query(insertQuery, flatValues);
+            }
+            catch (e) {
+                console.error(e);
+                throw new Error(`Error inserting: ${chunk[1]}`);
+            }
+        }
+    }
+    /**
+     * Method to perform a similarity search in the vector store. It returns
+     * the `k` most similar documents to the query vector, along with their
+     * similarity scores.
+     *
+     * @param query - Query vector.
+     * @param k - Number of most similar documents to return.
+     * @param filter - Optional filter to apply to the search.
+     * @returns Promise that resolves with an array of tuples, each containing a `Document` and its similarity score.
+     */
+    async similaritySearchVectorWithScore(query, k, filter) {
+        const embeddingString = `[${query.join(",")}]`;
+        const _filter = filter ?? "{}";
+        const queryString = `
+      SELECT *, ${this.vectorColumnName} <=> $1 as "_distance"
+      FROM ${this.tableName}
+      WHERE ${this.metadataColumnName} @> $2
+      ORDER BY "_distance" ASC
+      LIMIT $3;`;
+        const documents = (await this.pool.query(queryString, [embeddingString, _filter, k])).rows;
+        const results = [];
+        for (const doc of documents) {
+            if (doc._distance != null && doc[this.contentColumnName] != null) {
+                const document = new document_js_1.Document({
+                    pageContent: doc[this.contentColumnName],
+                    metadata: doc[this.metadataColumnName],
+                });
+                results.push([document, doc._distance]);
+            }
+        }
+        return results;
+    }
+    /**
+     * Method to ensure the existence of the table in the database. It creates
+     * the table if it does not already exist.
+     *
+     * @returns Promise that resolves when the table has been ensured.
+     */
+    async ensureTableInDatabase() {
+        await this.pool.query("CREATE EXTENSION IF NOT EXISTS vector;");
+        await this.pool.query('CREATE EXTENSION IF NOT EXISTS "uuid-ossp";');
+        await this.pool.query(`
+      CREATE TABLE IF NOT EXISTS ${this.tableName} (
+        "${this.idColumnName}" uuid NOT NULL DEFAULT uuid_generate_v4() PRIMARY KEY,
+        "${this.contentColumnName}" text,
+        "${this.metadataColumnName}" jsonb,
+        "${this.vectorColumnName}" vector
+      );
+    `);
+    }
+    /**
+     * Static method to create a new `PGVectorStore` instance from an
+     * array of texts and their metadata. It converts the texts into
+     * `Document` instances and adds them to the store.
+     *
+     * @param texts - Array of texts.
+     * @param metadatas - Array of metadata objects or a single metadata object.
+     * @param embeddings - Embeddings instance.
+     * @param dbConfig - `PGVectorStoreArgs` instance.
+     * @returns Promise that resolves with a new instance of `PGVectorStore`.
+     */
+    static async fromTexts(texts, metadatas, embeddings, dbConfig) {
+        const docs = [];
+        for (let i = 0; i < texts.length; i += 1) {
+            const metadata = Array.isArray(metadatas) ? metadatas[i] : metadatas;
+            const newDoc = new document_js_1.Document({
+                pageContent: texts[i],
+                metadata,
+            });
+            docs.push(newDoc);
+        }
+        return PGVectorStore.fromDocuments(docs, embeddings, dbConfig);
+    }
+    /**
+     * Static method to create a new `PGVectorStore` instance from an
+     * array of `Document` instances. It adds the documents to the store.
+     *
+     * @param docs - Array of `Document` instances.
+     * @param embeddings - Embeddings instance.
+     * @param dbConfig - `PGVectorStoreArgs` instance.
+     * @returns Promise that resolves with a new instance of `PGVectorStore`.
+     */
+    static async fromDocuments(docs, embeddings, dbConfig) {
+        const instance = await PGVectorStore.initialize(embeddings, dbConfig);
+        await instance.addDocuments(docs);
+        return instance;
+    }
+    /**
+     * Closes all the clients in the pool and terminates the pool.
+     *
+     * @returns Promise that resolves when all clients are closed and the pool is terminated.
+     */
+    async end() {
+        await this.client?.release();
+        return this.pool.end();
+    }
+}
+exports.PGVectorStore = PGVectorStore;