langchain 0.0.167 → 0.0.169

package/dist/retrievers/zep.d.ts

@@ -4,12 +4,23 @@ import { Document } from "../document.js";
 /**
  * Configuration interface for the ZepRetriever class. Extends the
  * BaseRetrieverInput interface.
+ *
+ * @argument {string} sessionId - The ID of the Zep session.
+ * @argument {string} url - The URL of the Zep API.
+ * @argument {number} [topK] - The number of results to return.
+ * @argument {string} [apiKey] - The API key for the Zep API.
+ * @argument [searchType] [searchType] - The type of search to perform: "similarity" or "mmr".
+ * @argument {number} [mmrLambda] - The lambda value for the MMR search.
+ * @argument {Record<string, unknown>} [filter] - The metadata filter to apply to the search.
  */
 export interface ZepRetrieverConfig extends BaseRetrieverInput {
     sessionId: string;
     url: string;
     topK?: number;
     apiKey?: string;
+    searchType?: "similarity" | "mmr";
+    mmrLambda?: number;
+    filter?: Record<string, unknown>;
 }
 /**
  * Class for retrieving information from a Zep long-term memory store.
@@ -27,6 +38,9 @@ export declare class ZepRetriever extends BaseRetriever {
     zepClientPromise: Promise<ZepClient>;
     private sessionId;
     private topK?;
+    private searchType?;
+    private mmrLambda?;
+    private filter?;
     constructor(config: ZepRetrieverConfig);
     /**
      *  Converts an array of search results to an array of Document objects.

package/dist/retrievers/zep.js

@@ -44,8 +44,29 @@ export class ZepRetriever extends BaseRetriever {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "searchType", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "mmrLambda", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "filter", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.sessionId = config.sessionId;
         this.topK = config.topK;
+        this.searchType = config.searchType;
+        this.mmrLambda = config.mmrLambda;
+        this.filter = config.filter;
         this.zepClientPromise = ZepClient.init(config.url, config.apiKey);
     }
     /**
@@ -56,9 +77,9 @@ export class ZepRetriever extends BaseRetriever {
     searchResultToDoc(results) {
         return results
             .filter((r) => r.message)
-            .map(({ message: { content } = {}, ...metadata }, dist) => new Document({
+            .map(({ message: { content, metadata: messageMetadata } = {}, dist, ...rest }) => new Document({
             pageContent: content ?? "",
-            metadata: { score: dist, ...metadata },
+            metadata: { score: dist, ...messageMetadata, ...rest },
         }));
     }
     /**
@@ -67,7 +88,12 @@ export class ZepRetriever extends BaseRetriever {
      *  @returns {Promise<Document[]>} A promise that resolves to an array of relevant Document objects.
      */
     async _getRelevantDocuments(query) {
-        const payload = { text: query, metadata: {} };
+        const payload = {
+            text: query,
+            metadata: this.filter,
+            search_type: this.searchType,
+            mmr_lambda: this.mmrLambda,
+        };
         // Wait for ZepClient to be initialized
         const zepClient = await this.zepClientPromise;
         if (!zepClient) {

package/dist/util/axios-fetch-adapter.cjs

@@ -293,7 +293,7 @@ function createRequest(config) {
     }
     // Some `fetch` implementations will override the Content-Type to text/plain
     // when body is a string.
-    // See https://github.com/hwchase17/langchainjs/issues/1010
+    // See https://github.com/langchain-ai/langchainjs/issues/1010
     if (typeof options.body === "string") {
         options.body = new TextEncoder().encode(options.body);
     }

package/dist/util/axios-fetch-adapter.js

@@ -287,7 +287,7 @@ function createRequest(config) {
     }
     // Some `fetch` implementations will override the Content-Type to text/plain
     // when body is a string.
-    // See https://github.com/hwchase17/langchainjs/issues/1010
+    // See https://github.com/langchain-ai/langchainjs/issues/1010
     if (typeof options.body === "string") {
         options.body = new TextEncoder().encode(options.body);
     }

package/dist/util/env.cjs

@@ -59,7 +59,7 @@ async function getRuntimeEnvironment() {
 exports.getRuntimeEnvironment = getRuntimeEnvironment;
 function getEnvironmentVariable(name) {
     // Certain Deno setups will throw an error if you try to access environment variables
-    // https://github.com/hwchase17/langchainjs/issues/1412
+    // https://github.com/langchain-ai/langchainjs/issues/1412
     try {
         return typeof process !== "undefined"
             ? // eslint-disable-next-line no-process-env

package/dist/util/env.js

@@ -49,7 +49,7 @@ export async function getRuntimeEnvironment() {
 }
 export function getEnvironmentVariable(name) {
     // Certain Deno setups will throw an error if you try to access environment variables
-    // https://github.com/hwchase17/langchainjs/issues/1412
+    // https://github.com/langchain-ai/langchainjs/issues/1412
     try {
         return typeof process !== "undefined"
             ? // eslint-disable-next-line no-process-env

package/dist/util/event-source-parse.cjs

@@ -36,7 +36,7 @@ async function getBytes(stream, onChunk) {
     //          This change is essential to ensure that we capture every last piece of information from streams,
     //          such as those from Azure OpenAI, which may not terminate with a blank line. Without this
     //          mechanism, we risk ignoring a possibly significant last message.
-    //          See https://github.com/hwchase17/langchainjs/issues/1299 for details.
+    //          See https://github.com/langchain-ai/langchainjs/issues/1299 for details.
     // eslint-disable-next-line no-constant-condition
     while (true) {
         const result = await reader.read();

package/dist/util/event-source-parse.js

@@ -33,7 +33,7 @@ export async function getBytes(stream, onChunk) {
     //          This change is essential to ensure that we capture every last piece of information from streams,
     //          such as those from Azure OpenAI, which may not terminate with a blank line. Without this
     //          mechanism, we risk ignoring a possibly significant last message.
-    //          See https://github.com/hwchase17/langchainjs/issues/1299 for details.
+    //          See https://github.com/langchain-ai/langchainjs/issues/1299 for details.
     // eslint-disable-next-line no-constant-condition
     while (true) {
         const result = await reader.read();

package/dist/vectorstores/closevector/common.cjs

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloseVector = void 0;
+const document_js_1 = require("../../document.cjs");
+const base_js_1 = require("../base.cjs");
+/**
+ * package closevector is largely based on hnswlib.ts in the current folder with the following exceptions:
+ * 1. It uses a modified version of hnswlib-node to ensure the generated index can be loaded by closevector_web.ts.
+ * 2. It adds features to upload and download the index to/from the CDN provided by CloseVector.
+ *
+ * For more information, check out https://closevector-docs.getmegaportal.com/
+ */
+/**
+ * Class that implements a vector store using Hierarchical Navigable Small
+ * World (HNSW) graphs. It extends the SaveableVectorStore class and
+ * provides methods for adding documents and vectors, performing
+ * similarity searches, and saving and loading the vector store.
+ */
+class CloseVector extends base_js_1.SaveableVectorStore {
+    _vectorstoreType() {
+        return "closevector";
+    }
+    constructor(embeddings, args, credentials) {
+        super(embeddings, args);
+        Object.defineProperty(this, "_instance", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        // credentials will not be saved to disk
+        Object.defineProperty(this, "credentials", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.credentials = credentials;
+    }
+    get instance() {
+        if (!this._instance) {
+            throw new Error("Vector store not initialised yet. Try calling `addTexts` first.");
+        }
+        return this._instance;
+    }
+    set instance(instance) {
+        this._instance = instance;
+    }
+    /**
+     * Method to add documents to the vector store. It first converts the
+     * documents to vectors using the embeddings, then adds the vectors to the
+     * vector store.
+     * @param documents The documents to be added to the vector store.
+     * @returns A Promise that resolves when the documents have been added.
+     */
+    async addDocuments(documents) {
+        await this.instance.addDocuments(documents);
+    }
+    /**
+     * Method to save the vector store to a directory. It saves the HNSW
+     * index, the arguments, and the document store to the directory.
+     * @param directory The directory to which to save the vector store. In CloseVector, we use IndexedDB to mock the file system. Therefore, this parameter is can be treated as a key to the contents stored.
+     * @returns A Promise that resolves when the vector store has been saved.
+     */
+    async save(directory) {
+        await this.instance.save(directory);
+    }
+    /**
+     * Method to add vectors to the vector store. It first initializes the
+     * index if it hasn't been initialized yet, then adds the vectors to the
+     * index and the documents to the document store.
+     * @param vectors The vectors to be added to the vector store.
+     * @param documents The documents corresponding to the vectors.
+     * @returns A Promise that resolves when the vectors and documents have been added.
+     */
+    async addVectors(vectors, documents) {
+        await this.instance.addVectors(vectors, documents);
+    }
+    /**
+     * Method to perform a similarity search in the vector store using a query
+     * vector. It returns the k most similar documents along with their
+     * similarity scores. An optional filter function can be provided to
+     * filter the documents.
+     * @param query The query vector.
+     * @param k The number of most similar documents to return.
+     * @param filter An optional filter function to filter the documents.
+     * @returns A Promise that resolves to an array of tuples, where each tuple contains a document and its similarity score.
+     */
+    async similaritySearchVectorWithScore(query, k, filter) {
+        const resp = await this.instance.similaritySearchVectorWithScore(query, k, filter
+            ? (x) => filter?.({
+                pageContent: x.pageContent,
+                metadata: x.metadata || {},
+            }) || false
+            : undefined);
+        const mapped = resp.map((x) => [
+            new document_js_1.Document({
+                pageContent: x[0].pageContent,
+                metadata: x[0].metadata || {},
+            }),
+            x[1],
+        ]);
+        return mapped;
+    }
+    /**
+     * Method to delete the vector store from a directory. It deletes the
+     * hnswlib.index file, the docstore.json file, and the args.json file from
+     * the directory.
+     * @param params An object with a directory property that specifies the directory from which to delete the vector store.
+     * @returns A Promise that resolves when the vector store has been deleted.
+     */
+    async delete(params) {
+        return await this.instance.delete(params);
+    }
+    static textsToDocuments(texts, metadatas) {
+        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 docs;
+    }
+}
+exports.CloseVector = CloseVector;

package/dist/vectorstores/closevector/common.d.ts

@@ -0,0 +1,82 @@
+import type { CloseVectorSaveableVectorStore } from "closevector-common";
+import { Embeddings } from "../../embeddings/base.js";
+import { Document } from "../../document.js";
+import { SaveableVectorStore } from "../base.js";
+type CloseVectorCredentials = {
+    key?: string;
+    secret?: string;
+};
+/**
+ * package closevector is largely based on hnswlib.ts in the current folder with the following exceptions:
+ * 1. It uses a modified version of hnswlib-node to ensure the generated index can be loaded by closevector_web.ts.
+ * 2. It adds features to upload and download the index to/from the CDN provided by CloseVector.
+ *
+ * For more information, check out https://closevector-docs.getmegaportal.com/
+ */
+/**
+ * Class that implements a vector store using Hierarchical Navigable Small
+ * World (HNSW) graphs. It extends the SaveableVectorStore class and
+ * provides methods for adding documents and vectors, performing
+ * similarity searches, and saving and loading the vector store.
+ */
+export declare abstract class CloseVector<CloseVectorHNSWImplementation extends CloseVectorSaveableVectorStore> extends SaveableVectorStore {
+    FilterType: (doc: Document) => boolean;
+    _instance?: CloseVectorHNSWImplementation;
+    credentials?: CloseVectorCredentials;
+    _vectorstoreType(): string;
+    constructor(embeddings: Embeddings, args: {
+        space: "l2" | "ip" | "cosine";
+        numDimensions?: number;
+        maxElements?: number;
+    }, credentials?: CloseVectorCredentials);
+    get instance(): CloseVectorHNSWImplementation;
+    protected set instance(instance: CloseVectorHNSWImplementation);
+    /**
+     * Method to add documents to the vector store. It first converts the
+     * documents to vectors using the embeddings, then adds the vectors to the
+     * vector store.
+     * @param documents The documents to be added to the vector store.
+     * @returns A Promise that resolves when the documents have been added.
+     */
+    addDocuments(documents: Document[]): Promise<void>;
+    abstract saveToCloud(_options: Record<string, unknown>): Promise<void>;
+    /**
+     * Method to save the vector store to a directory. It saves the HNSW
+     * index, the arguments, and the document store to the directory.
+     * @param directory The directory to which to save the vector store. In CloseVector, we use IndexedDB to mock the file system. Therefore, this parameter is can be treated as a key to the contents stored.
+     * @returns A Promise that resolves when the vector store has been saved.
+     */
+    save(directory: string): Promise<void>;
+    /**
+     * Method to add vectors to the vector store. It first initializes the
+     * index if it hasn't been initialized yet, then adds the vectors to the
+     * index and the documents to the document store.
+     * @param vectors The vectors to be added to the vector store.
+     * @param documents The documents corresponding to the vectors.
+     * @returns A Promise that resolves when the vectors and documents have been added.
+     */
+    addVectors(vectors: number[][], documents: Document[]): Promise<void>;
+    /**
+     * Method to perform a similarity search in the vector store using a query
+     * vector. It returns the k most similar documents along with their
+     * similarity scores. An optional filter function can be provided to
+     * filter the documents.
+     * @param query The query vector.
+     * @param k The number of most similar documents to return.
+     * @param filter An optional filter function to filter the documents.
+     * @returns A Promise that resolves to an array of tuples, where each tuple contains a document and its similarity score.
+     */
+    similaritySearchVectorWithScore(query: number[], k: number, filter?: this["FilterType"]): Promise<[Document<Record<string, unknown>>, number][]>;
+    /**
+     * Method to delete the vector store from a directory. It deletes the
+     * hnswlib.index file, the docstore.json file, and the args.json file from
+     * the directory.
+     * @param params An object with a directory property that specifies the directory from which to delete the vector store.
+     * @returns A Promise that resolves when the vector store has been deleted.
+     */
+    delete(params: {
+        directory: string;
+    }): Promise<void>;
+    static textsToDocuments(texts: string[], metadatas: object[] | object): Document<Record<string, any>>[];
+}
+export {};

package/dist/vectorstores/closevector/common.js

@@ -0,0 +1,124 @@
+import { Document } from "../../document.js";
+import { SaveableVectorStore } from "../base.js";
+/**
+ * package closevector is largely based on hnswlib.ts in the current folder with the following exceptions:
+ * 1. It uses a modified version of hnswlib-node to ensure the generated index can be loaded by closevector_web.ts.
+ * 2. It adds features to upload and download the index to/from the CDN provided by CloseVector.
+ *
+ * For more information, check out https://closevector-docs.getmegaportal.com/
+ */
+/**
+ * Class that implements a vector store using Hierarchical Navigable Small
+ * World (HNSW) graphs. It extends the SaveableVectorStore class and
+ * provides methods for adding documents and vectors, performing
+ * similarity searches, and saving and loading the vector store.
+ */
+export class CloseVector extends SaveableVectorStore {
+    _vectorstoreType() {
+        return "closevector";
+    }
+    constructor(embeddings, args, credentials) {
+        super(embeddings, args);
+        Object.defineProperty(this, "_instance", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        // credentials will not be saved to disk
+        Object.defineProperty(this, "credentials", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.credentials = credentials;
+    }
+    get instance() {
+        if (!this._instance) {
+            throw new Error("Vector store not initialised yet. Try calling `addTexts` first.");
+        }
+        return this._instance;
+    }
+    set instance(instance) {
+        this._instance = instance;
+    }
+    /**
+     * Method to add documents to the vector store. It first converts the
+     * documents to vectors using the embeddings, then adds the vectors to the
+     * vector store.
+     * @param documents The documents to be added to the vector store.
+     * @returns A Promise that resolves when the documents have been added.
+     */
+    async addDocuments(documents) {
+        await this.instance.addDocuments(documents);
+    }
+    /**
+     * Method to save the vector store to a directory. It saves the HNSW
+     * index, the arguments, and the document store to the directory.
+     * @param directory The directory to which to save the vector store. In CloseVector, we use IndexedDB to mock the file system. Therefore, this parameter is can be treated as a key to the contents stored.
+     * @returns A Promise that resolves when the vector store has been saved.
+     */
+    async save(directory) {
+        await this.instance.save(directory);
+    }
+    /**
+     * Method to add vectors to the vector store. It first initializes the
+     * index if it hasn't been initialized yet, then adds the vectors to the
+     * index and the documents to the document store.
+     * @param vectors The vectors to be added to the vector store.
+     * @param documents The documents corresponding to the vectors.
+     * @returns A Promise that resolves when the vectors and documents have been added.
+     */
+    async addVectors(vectors, documents) {
+        await this.instance.addVectors(vectors, documents);
+    }
+    /**
+     * Method to perform a similarity search in the vector store using a query
+     * vector. It returns the k most similar documents along with their
+     * similarity scores. An optional filter function can be provided to
+     * filter the documents.
+     * @param query The query vector.
+     * @param k The number of most similar documents to return.
+     * @param filter An optional filter function to filter the documents.
+     * @returns A Promise that resolves to an array of tuples, where each tuple contains a document and its similarity score.
+     */
+    async similaritySearchVectorWithScore(query, k, filter) {
+        const resp = await this.instance.similaritySearchVectorWithScore(query, k, filter
+            ? (x) => filter?.({
+                pageContent: x.pageContent,
+                metadata: x.metadata || {},
+            }) || false
+            : undefined);
+        const mapped = resp.map((x) => [
+            new Document({
+                pageContent: x[0].pageContent,
+                metadata: x[0].metadata || {},
+            }),
+            x[1],
+        ]);
+        return mapped;
+    }
+    /**
+     * Method to delete the vector store from a directory. It deletes the
+     * hnswlib.index file, the docstore.json file, and the args.json file from
+     * the directory.
+     * @param params An object with a directory property that specifies the directory from which to delete the vector store.
+     * @returns A Promise that resolves when the vector store has been deleted.
+     */
+    async delete(params) {
+        return await this.instance.delete(params);
+    }
+    static textsToDocuments(texts, metadatas) {
+        const docs = [];
+        for (let i = 0; i < texts.length; i += 1) {
+            const metadata = Array.isArray(metadatas) ? metadatas[i] : metadatas;
+            const newDoc = new Document({
+                pageContent: texts[i],
+                metadata,
+            });
+            docs.push(newDoc);
+        }
+        return docs;
+    }
+}

package/dist/vectorstores/closevector/node.cjs

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloseVectorNode = void 0;
+const closevector_node_1 = require("closevector-node");
+const common_js_1 = require("./common.cjs");
+/**
+ * Class that implements a vector store using Hierarchical Navigable Small
+ * World (HNSW) graphs. It extends the SaveableVectorStore class and
+ * provides methods for adding documents and vectors, performing
+ * similarity searches, and saving and loading the vector store.
+ */
+class CloseVectorNode extends common_js_1.CloseVector {
+    constructor(embeddings, args, credentials) {
+        super(embeddings, args, credentials);
+        if (args.instance) {
+            this.instance = args.instance;
+        }
+        else {
+            this.instance = new closevector_node_1.CloseVectorHNSWNode(embeddings, args);
+        }
+        if (this.credentials?.key) {
+            this.instance.accessKey = this.credentials.key;
+        }
+        if (this.credentials?.secret) {
+            this.instance.secret = this.credentials.secret;
+        }
+    }
+    /**
+     * Method to save the index to the CloseVector CDN.
+     * @param options
+     * @param options.description A description of the index.
+     * @param options.public Whether the index should be public or private. Defaults to false.
+     * @param options.uuid A UUID for the index. If not provided, a new index will be created.
+     * @param options.onProgress A callback function that will be called with the progress of the upload.
+     */
+    async saveToCloud(options) {
+        await this.instance.saveToCloud(options);
+    }
+    /**
+     * Method to load the index from the CloseVector CDN.
+     * @param options
+     * @param options.uuid The UUID of the index to be downloaded.
+     * @param options.credentials The credentials to be used by the CloseVectorNode instance.
+     * @param options.embeddings The embeddings to be used by the CloseVectorNode instance.
+     * @param options.onProgress A callback function that will be called with the progress of the download.
+     */
+    static async loadFromCloud(options) {
+        if (!options.credentials.key || !options.credentials.secret) {
+            throw new Error("key and secret must be provided");
+        }
+        const instance = await closevector_node_1.CloseVectorHNSWNode.loadFromCloud({
+            ...options,
+            accessKey: options.credentials.key,
+            secret: options.credentials.secret,
+        });
+        const vectorstore = new this(options.embeddings, instance.args, options.credentials);
+        return vectorstore;
+    }
+    /**
+     * Static method to load a vector store from a directory. It reads the
+     * HNSW index, the arguments, and the document store from the directory,
+     * then creates a new HNSWLib instance with these values.
+     * @param directory The directory from which to load the vector store.
+     * @param embeddings The embeddings to be used by the CloseVectorNode instance.
+     * @returns A Promise that resolves to a new CloseVectorNode instance.
+     */
+    static async load(directory, embeddings, credentials) {
+        const instance = await closevector_node_1.CloseVectorHNSWNode.load(directory, embeddings);
+        const vectorstore = new this(embeddings, instance.args, credentials);
+        return vectorstore;
+    }
+    /**
+     * Static method to create a new CloseVectorWeb instance from texts and metadata.
+     * It creates a new Document instance for each text and metadata, then
+     * calls the fromDocuments method to create the CloseVectorWeb instance.
+     * @param texts The texts to be used to create the documents.
+     * @param metadatas The metadata to be used to create the documents.
+     * @param embeddings The embeddings to be used by the CloseVectorWeb instance.
+     * @param args An optional configuration object for the CloseVectorWeb instance.
+     * @param credential An optional credential object for the CloseVector API.
+     * @returns A Promise that resolves to a new CloseVectorWeb instance.
+     */
+    static async fromTexts(texts, metadatas, embeddings, args, credential) {
+        const docs = common_js_1.CloseVector.textsToDocuments(texts, metadatas);
+        return await CloseVectorNode.fromDocuments(docs, embeddings, args, credential);
+    }
+    /**
+     * Static method to create a new CloseVectorNode instance from documents. It
+     * creates a new CloseVectorNode instance, adds the documents to it, then returns
+     * the instance.
+     * @param docs The documents to be added to the HNSWLib instance.
+     * @param embeddings The embeddings to be used by the HNSWLib instance.
+     * @param args An optional configuration object for the HNSWLib instance.
+     * @param credentials An optional credential object for the CloseVector API.
+     * @returns A Promise that resolves to a new CloseVectorNode instance.
+     */
+    static async fromDocuments(docs, embeddings, args, credentials) {
+        const _args = args || {
+            space: "cosine",
+        };
+        const instance = new this(embeddings, _args, credentials);
+        await instance.addDocuments(docs);
+        return instance;
+    }
+    static async imports() {
+        return closevector_node_1.CloseVectorHNSWNode.imports();
+    }
+}
+exports.CloseVectorNode = CloseVectorNode;