langchain 0.0.130 → 0.0.132

package/dist/vectorstores/weaviate.d.ts

@@ -3,6 +3,11 @@ import { VectorStore } from "./base.js";
 import { Embeddings } from "../embeddings/base.js";
 import { Document } from "../document.js";
 export declare const flattenObjectForWeaviate: (obj: Record<string, any>) => Record<string, any>;
+/**
+ * Interface that defines the arguments required to create a new instance
+ * of the `WeaviateStore` class. It includes the Weaviate client, the name
+ * of the class in Weaviate, and optional keys for text and metadata.
+ */
 export interface WeaviateLibArgs {
     client: WeaviateClient;
     /**
@@ -13,10 +18,19 @@ export interface WeaviateLibArgs {
     metadataKeys?: string[];
     tenant?: string;
 }
+/**
+ * Interface that defines a filter for querying data from Weaviate. It
+ * includes a distance and a `WhereFilter`.
+ */
 export interface WeaviateFilter {
     distance?: number;
     where: WhereFilter;
 }
+/**
+ * Class that extends the `VectorStore` base class. It provides methods to
+ * interact with a Weaviate index, including adding vectors and documents,
+ * deleting data, and performing similarity searches.
+ */
 export declare class WeaviateStore extends VectorStore {
     embeddings: Embeddings;
     FilterType: WeaviateFilter;
@@ -27,18 +41,74 @@ export declare class WeaviateStore extends VectorStore {
     private tenant?;
     _vectorstoreType(): string;
     constructor(embeddings: Embeddings, args: WeaviateLibArgs);
+    /**
+     * Method to add vectors and corresponding documents to the Weaviate
+     * index.
+     * @param vectors Array of vectors to be added.
+     * @param documents Array of documents corresponding to the vectors.
+     * @param options Optional parameter that can include specific IDs for the documents.
+     * @returns An array of document IDs.
+     */
     addVectors(vectors: number[][], documents: Document[], options?: {
         ids?: string[];
     }): Promise<string[]>;
+    /**
+     * Method to add documents to the Weaviate index. It first generates
+     * vectors for the documents using the embeddings, then adds the vectors
+     * and documents to the index.
+     * @param documents Array of documents to be added.
+     * @param options Optional parameter that can include specific IDs for the documents.
+     * @returns An array of document IDs.
+     */
     addDocuments(documents: Document[], options?: {
         ids?: string[];
     }): Promise<string[]>;
+    /**
+     * Method to delete data from the Weaviate index. It can delete data based
+     * on specific IDs or a filter.
+     * @param params Object that includes either an array of IDs or a filter for the data to be deleted.
+     * @returns Promise that resolves when the deletion is complete.
+     */
     delete(params: {
         ids?: string[];
         filter?: WeaviateFilter;
     }): Promise<void>;
+    /**
+     * Method to perform a similarity search on the stored vectors in the
+     * Weaviate index. It returns the top k most similar documents and their
+     * similarity scores.
+     * @param query The query vector.
+     * @param k The number of most similar documents to return.
+     * @param filter Optional filter to apply to the search.
+     * @returns An array of tuples, where each tuple contains a document and its similarity score.
+     */
     similaritySearchVectorWithScore(query: number[], k: number, filter?: WeaviateFilter): Promise<[Document, number][]>;
+    /**
+     * Static method to create a new `WeaviateStore` instance from a list of
+     * texts. It first creates documents from the texts and metadata, then
+     * adds the documents to the Weaviate index.
+     * @param texts Array of texts.
+     * @param metadatas Metadata for the texts. Can be a single object or an array of objects.
+     * @param embeddings Embeddings to be used for the texts.
+     * @param args Arguments required to create a new `WeaviateStore` instance.
+     * @returns A new `WeaviateStore` instance.
+     */
     static fromTexts(texts: string[], metadatas: object | object[], embeddings: Embeddings, args: WeaviateLibArgs): Promise<WeaviateStore>;
+    /**
+     * Static method to create a new `WeaviateStore` instance from a list of
+     * documents. It adds the documents to the Weaviate index.
+     * @param docs Array of documents.
+     * @param embeddings Embeddings to be used for the documents.
+     * @param args Arguments required to create a new `WeaviateStore` instance.
+     * @returns A new `WeaviateStore` instance.
+     */
     static fromDocuments(docs: Document[], embeddings: Embeddings, args: WeaviateLibArgs): Promise<WeaviateStore>;
+    /**
+     * Static method to create a new `WeaviateStore` instance from an existing
+     * Weaviate index.
+     * @param embeddings Embeddings to be used for the Weaviate index.
+     * @param args Arguments required to create a new `WeaviateStore` instance.
+     * @returns A new `WeaviateStore` instance.
+     */
     static fromExistingIndex(embeddings: Embeddings, args: WeaviateLibArgs): Promise<WeaviateStore>;
 }

package/dist/vectorstores/weaviate.js

@@ -37,6 +37,11 @@ obj) => {
     }
     return flattenedObject;
 };
+/**
+ * Class that extends the `VectorStore` base class. It provides methods to
+ * interact with a Weaviate index, including adding vectors and documents,
+ * deleting data, and performing similarity searches.
+ */
 export class WeaviateStore extends VectorStore {
     _vectorstoreType() {
         return "weaviate";
@@ -101,6 +106,14 @@ export class WeaviateStore extends VectorStore {
             ];
         }
     }
+    /**
+     * Method to add vectors and corresponding documents to the Weaviate
+     * index.
+     * @param vectors Array of vectors to be added.
+     * @param documents Array of documents corresponding to the vectors.
+     * @param options Optional parameter that can include specific IDs for the documents.
+     * @returns An array of document IDs.
+     */
     async addVectors(vectors, documents, options) {
         const documentIds = options?.ids ?? documents.map((_) => uuid.v4());
         const batch = documents.map((document, index) => {
@@ -129,9 +142,23 @@ export class WeaviateStore extends VectorStore {
         }
         return documentIds;
     }
+    /**
+     * Method to add documents to the Weaviate index. It first generates
+     * vectors for the documents using the embeddings, then adds the vectors
+     * and documents to the index.
+     * @param documents Array of documents to be added.
+     * @param options Optional parameter that can include specific IDs for the documents.
+     * @returns An array of document IDs.
+     */
     async addDocuments(documents, options) {
         return this.addVectors(await this.embeddings.embedDocuments(documents.map((d) => d.pageContent)), documents, options);
     }
+    /**
+     * Method to delete data from the Weaviate index. It can delete data based
+     * on specific IDs or a filter.
+     * @param params Object that includes either an array of IDs or a filter for the data to be deleted.
+     * @returns Promise that resolves when the deletion is complete.
+     */
     async delete(params) {
         const { ids, filter } = params;
         if (ids && ids.length > 0) {
@@ -160,6 +187,15 @@ export class WeaviateStore extends VectorStore {
             throw new Error(`This method requires either "ids" or "filter" to be set in the input object`);
         }
     }
+    /**
+     * Method to perform a similarity search on the stored vectors in the
+     * Weaviate index. It returns the top k most similar documents and their
+     * similarity scores.
+     * @param query The query vector.
+     * @param k The number of most similar documents to return.
+     * @param filter Optional filter to apply to the search.
+     * @returns An array of tuples, where each tuple contains a document and its similarity score.
+     */
     async similaritySearchVectorWithScore(query, k, filter) {
         try {
             let builder = await this.client.graphql
@@ -195,6 +231,16 @@ export class WeaviateStore extends VectorStore {
             throw Error(`'Error in similaritySearch' ${e}`);
         }
     }
+    /**
+     * Static method to create a new `WeaviateStore` instance from a list of
+     * texts. It first creates documents from the texts and metadata, then
+     * adds the documents to the Weaviate index.
+     * @param texts Array of texts.
+     * @param metadatas Metadata for the texts. Can be a single object or an array of objects.
+     * @param embeddings Embeddings to be used for the texts.
+     * @param args Arguments required to create a new `WeaviateStore` instance.
+     * @returns A new `WeaviateStore` instance.
+     */
     static fromTexts(texts, metadatas, embeddings, args) {
         const docs = [];
         for (let i = 0; i < texts.length; i += 1) {
@@ -207,11 +253,26 @@ export class WeaviateStore extends VectorStore {
         }
         return WeaviateStore.fromDocuments(docs, embeddings, args);
     }
+    /**
+     * Static method to create a new `WeaviateStore` instance from a list of
+     * documents. It adds the documents to the Weaviate index.
+     * @param docs Array of documents.
+     * @param embeddings Embeddings to be used for the documents.
+     * @param args Arguments required to create a new `WeaviateStore` instance.
+     * @returns A new `WeaviateStore` instance.
+     */
     static async fromDocuments(docs, embeddings, args) {
         const instance = new this(embeddings, args);
         await instance.addDocuments(docs);
         return instance;
     }
+    /**
+     * Static method to create a new `WeaviateStore` instance from an existing
+     * Weaviate index.
+     * @param embeddings Embeddings to be used for the Weaviate index.
+     * @param args Arguments required to create a new `WeaviateStore` instance.
+     * @returns A new `WeaviateStore` instance.
+     */
     static async fromExistingIndex(embeddings, args) {
         return new this(embeddings, args);
     }

package/dist/vectorstores/xata.cjs

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.XataVectorSearch = void 0;
 const base_js_1 = require("./base.cjs");
 const document_js_1 = require("../document.cjs");
+/**
+ * Class for interacting with a Xata database as a VectorStore. Provides
+ * methods to add documents and vectors to the database, delete entries,
+ * and perform similarity searches.
+ */
 class XataVectorSearch extends base_js_1.VectorStore {
     _vectorstoreType() {
         return "xata";
@@ -24,10 +29,27 @@ class XataVectorSearch extends base_js_1.VectorStore {
         this.client = args.client;
         this.table = args.table;
     }
+    /**
+     * Method to add documents to the Xata database. Maps the page content of
+     * each document, embeds the documents using the embeddings, and adds the
+     * vectors to the database.
+     * @param documents Array of documents to be added.
+     * @param options Optional object containing an array of ids.
+     * @returns Promise resolving to an array of ids of the added documents.
+     */
     async addDocuments(documents, options) {
         const texts = documents.map(({ pageContent }) => pageContent);
         return this.addVectors(await this.embeddings.embedDocuments(texts), documents, options);
     }
+    /**
+     * Method to add vectors to the Xata database. Maps each vector to a row
+     * with the document's content, embedding, and metadata. Creates or
+     * replaces these rows in the Xata database.
+     * @param vectors Array of vectors to be added.
+     * @param documents Array of documents corresponding to the vectors.
+     * @param options Optional object containing an array of ids.
+     * @returns Promise resolving to an array of ids of the added vectors.
+     */
     async addVectors(vectors, documents, options) {
         const rows = vectors
             .map((embedding, idx) => ({
@@ -48,10 +70,24 @@ class XataVectorSearch extends base_js_1.VectorStore {
         const returnedIds = results.map((row) => row.id);
         return returnedIds;
     }
+    /**
+     * Method to delete entries from the Xata database. Deletes the entries
+     * with the provided ids.
+     * @param params Object containing an array of ids of the entries to be deleted.
+     * @returns Promise resolving to void.
+     */
     async delete(params) {
         const { ids } = params;
         await this.client.db[this.table].delete(ids);
     }
+    /**
+     * Method to perform a similarity search in the Xata database. Returns the
+     * k most similar documents along with their scores.
+     * @param query Query vector for the similarity search.
+     * @param k Number of most similar documents to return.
+     * @param filter Optional filter for the search.
+     * @returns Promise resolving to an array of tuples, each containing a Document and its score.
+     */
     async similaritySearchVectorWithScore(query, k, filter) {
         const records = await this.client.db[this.table].vectorSearch("embedding", query, {
             size: k,

package/dist/vectorstores/xata.d.ts

@@ -2,26 +2,69 @@ import { BaseClient } from "@xata.io/client";
 import { VectorStore } from "./base.js";
 import { Embeddings } from "../embeddings/base.js";
 import { Document } from "../document.js";
+/**
+ * Interface for the arguments required to create a XataClient. Includes
+ * the client instance and the table name.
+ */
 export interface XataClientArgs<XataClient> {
     readonly client: XataClient;
     readonly table: string;
 }
+/**
+ * Type for the filter object used in Xata database queries.
+ */
 type XataFilter = object;
+/**
+ * Class for interacting with a Xata database as a VectorStore. Provides
+ * methods to add documents and vectors to the database, delete entries,
+ * and perform similarity searches.
+ */
 export declare class XataVectorSearch<XataClient extends BaseClient> extends VectorStore {
     FilterType: XataFilter;
     private readonly client;
     private readonly table;
     _vectorstoreType(): string;
     constructor(embeddings: Embeddings, args: XataClientArgs<XataClient>);
+    /**
+     * Method to add documents to the Xata database. Maps the page content of
+     * each document, embeds the documents using the embeddings, and adds the
+     * vectors to the database.
+     * @param documents Array of documents to be added.
+     * @param options Optional object containing an array of ids.
+     * @returns Promise resolving to an array of ids of the added documents.
+     */
     addDocuments(documents: Document[], options?: {
         ids?: string[];
     }): Promise<string[]>;
+    /**
+     * Method to add vectors to the Xata database. Maps each vector to a row
+     * with the document's content, embedding, and metadata. Creates or
+     * replaces these rows in the Xata database.
+     * @param vectors Array of vectors to be added.
+     * @param documents Array of documents corresponding to the vectors.
+     * @param options Optional object containing an array of ids.
+     * @returns Promise resolving to an array of ids of the added vectors.
+     */
     addVectors(vectors: number[][], documents: Document[], options?: {
         ids?: string[];
     }): Promise<string[]>;
+    /**
+     * Method to delete entries from the Xata database. Deletes the entries
+     * with the provided ids.
+     * @param params Object containing an array of ids of the entries to be deleted.
+     * @returns Promise resolving to void.
+     */
     delete(params: {
         ids: string[];
     }): Promise<void>;
+    /**
+     * Method to perform a similarity search in the Xata database. Returns the
+     * k most similar documents along with their scores.
+     * @param query Query vector for the similarity search.
+     * @param k Number of most similar documents to return.
+     * @param filter Optional filter for the search.
+     * @returns Promise resolving to an array of tuples, each containing a Document and its score.
+     */
     similaritySearchVectorWithScore(query: number[], k: number, filter?: XataFilter | undefined): Promise<[Document, number][]>;
 }
 export {};

package/dist/vectorstores/xata.js

@@ -1,5 +1,10 @@
 import { VectorStore } from "./base.js";
 import { Document } from "../document.js";
+/**
+ * Class for interacting with a Xata database as a VectorStore. Provides
+ * methods to add documents and vectors to the database, delete entries,
+ * and perform similarity searches.
+ */
 export class XataVectorSearch extends VectorStore {
     _vectorstoreType() {
         return "xata";
@@ -21,10 +26,27 @@ export class XataVectorSearch extends VectorStore {
         this.client = args.client;
         this.table = args.table;
     }
+    /**
+     * Method to add documents to the Xata database. Maps the page content of
+     * each document, embeds the documents using the embeddings, and adds the
+     * vectors to the database.
+     * @param documents Array of documents to be added.
+     * @param options Optional object containing an array of ids.
+     * @returns Promise resolving to an array of ids of the added documents.
+     */
     async addDocuments(documents, options) {
         const texts = documents.map(({ pageContent }) => pageContent);
         return this.addVectors(await this.embeddings.embedDocuments(texts), documents, options);
     }
+    /**
+     * Method to add vectors to the Xata database. Maps each vector to a row
+     * with the document's content, embedding, and metadata. Creates or
+     * replaces these rows in the Xata database.
+     * @param vectors Array of vectors to be added.
+     * @param documents Array of documents corresponding to the vectors.
+     * @param options Optional object containing an array of ids.
+     * @returns Promise resolving to an array of ids of the added vectors.
+     */
     async addVectors(vectors, documents, options) {
         const rows = vectors
             .map((embedding, idx) => ({
@@ -45,10 +67,24 @@ export class XataVectorSearch extends VectorStore {
         const returnedIds = results.map((row) => row.id);
         return returnedIds;
     }
+    /**
+     * Method to delete entries from the Xata database. Deletes the entries
+     * with the provided ids.
+     * @param params Object containing an array of ids of the entries to be deleted.
+     * @returns Promise resolving to void.
+     */
     async delete(params) {
         const { ids } = params;
         await this.client.db[this.table].delete(ids);
     }
+    /**
+     * Method to perform a similarity search in the Xata database. Returns the
+     * k most similar documents along with their scores.
+     * @param query Query vector for the similarity search.
+     * @param k Number of most similar documents to return.
+     * @param filter Optional filter for the search.
+     * @returns Promise resolving to an array of tuples, each containing a Document and its score.
+     */
     async similaritySearchVectorWithScore(query, k, filter) {
         const records = await this.client.db[this.table].vectorSearch("embedding", query, {
             size: k,

package/dist/vectorstores/zep.d.ts

@@ -3,9 +3,16 @@ import { MaxMarginalRelevanceSearchOptions, VectorStore } from "./base.js";
 import { Embeddings } from "../embeddings/base.js";
 import { Document } from "../document.js";
 import { Callbacks } from "../callbacks/index.js";
+/**
+ * Interface for the arguments required to initialize a ZepVectorStore
+ * instance.
+ */
 export interface IZepArgs {
     collection: DocumentCollection;
 }
+/**
+ * Interface for the configuration options for a ZepVectorStore instance.
+ */
 export interface IZepConfig {
     apiUrl: string;
     apiKey?: string;
@@ -15,6 +22,10 @@ export interface IZepConfig {
     embeddingDimensions?: number;
     isAutoEmbedded?: boolean;
 }
+/**
+ * Interface for the parameters required to delete documents from a
+ * ZepVectorStore instance.
+ */
 export interface IZepDeleteParams {
     uuids: string[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "langchain",
-  "version": "0.0.130",
+  "version": "0.0.132",
   "description": "Typescript bindings for langchain",
   "type": "module",
   "engines": {
@@ -635,7 +635,7 @@
     "@typescript-eslint/parser": "^5.58.0",
     "@upstash/redis": "^1.20.6",
     "@xata.io/client": "^0.25.1",
-    "@zilliz/milvus2-sdk-node": ">=2.2.7",
+    "@zilliz/milvus2-sdk-node": ">=2.2.11",
     "apify-client": "^2.7.1",
     "axios": "^0.26.0",
     "cheerio": "^1.0.0-rc.12",