langchain 0.0.203 → 0.0.204-rc.0

package/dist/vectorstores/opensearch.cjs

@@ -10,279 +10,8 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenSearchVectorStore = void 0;
-const opensearch_1 = require("@opensearch-project/opensearch");
-const uuid = __importStar(require("uuid"));
-const document_js_1 = require("../document.cjs");
-const base_js_1 = require("./base.cjs");
-/**
- * Class that provides a wrapper around the OpenSearch service for vector
- * search. It provides methods for adding documents and vectors to the
- * OpenSearch index, searching for similar vectors, and managing the
- * OpenSearch index.
- */
-class OpenSearchVectorStore extends base_js_1.VectorStore {
-    _vectorstoreType() {
-        return "opensearch";
-    }
-    constructor(embeddings, args) {
-        super(embeddings, args);
-        Object.defineProperty(this, "client", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "indexName", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "engine", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "spaceType", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "efConstruction", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "efSearch", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "m", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.spaceType = args.vectorSearchOptions?.spaceType ?? "l2";
-        this.engine = args.vectorSearchOptions?.engine ?? "nmslib";
-        this.m = args.vectorSearchOptions?.m ?? 16;
-        this.efConstruction = args.vectorSearchOptions?.efConstruction ?? 512;
-        this.efSearch = args.vectorSearchOptions?.efSearch ?? 512;
-        this.client = args.client;
-        this.indexName = args.indexName ?? "documents";
-    }
-    /**
-     * Method to add documents to the OpenSearch index. It first converts the
-     * documents to vectors using the embeddings, then adds the vectors to the
-     * index.
-     * @param documents The documents to be added to the OpenSearch index.
-     * @returns Promise resolving to void.
-     */
-    async addDocuments(documents) {
-        const texts = documents.map(({ pageContent }) => pageContent);
-        return this.addVectors(await this.embeddings.embedDocuments(texts), documents);
-    }
-    /**
-     * Method to add vectors to the OpenSearch index. It ensures the index
-     * exists, then adds the vectors and associated documents to the index.
-     * @param vectors The vectors to be added to the OpenSearch index.
-     * @param documents The documents associated with the vectors.
-     * @param options Optional parameter that can contain the IDs for the documents.
-     * @returns Promise resolving to void.
-     */
-    async addVectors(vectors, documents, options) {
-        await this.ensureIndexExists(vectors[0].length, this.engine, this.spaceType, this.efSearch, this.efConstruction, this.m);
-        const documentIds = options?.ids ?? Array.from({ length: vectors.length }, () => uuid.v4());
-        const operations = vectors.flatMap((embedding, idx) => [
-            {
-                index: {
-                    _index: this.indexName,
-                    _id: documentIds[idx],
-                },
-            },
-            {
-                embedding,
-                metadata: documents[idx].metadata,
-                text: documents[idx].pageContent,
-            },
-        ]);
-        await this.client.bulk({ body: operations });
-        await this.client.indices.refresh({ index: this.indexName });
-    }
-    /**
-     * Method to perform a similarity search on the OpenSearch index using a
-     * query vector. It returns the k most similar documents and their scores.
-     * @param query The query vector.
-     * @param k The number of similar documents to return.
-     * @param filter Optional filter for the OpenSearch query.
-     * @returns Promise resolving to an array of tuples, each containing a Document and its score.
-     */
-    async similaritySearchVectorWithScore(query, k, filter) {
-        const search = {
-            index: this.indexName,
-            body: {
-                query: {
-                    bool: {
-                        filter: { bool: { must: this.buildMetadataTerms(filter) } },
-                        must: [
-                            {
-                                knn: {
-                                    embedding: { vector: query, k },
-                                },
-                            },
-                        ],
-                    },
-                },
-                size: k,
-            },
-        };
-        const { body } = await this.client.search(search);
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        return body.hits.hits.map((hit) => [
-            new document_js_1.Document({
-                pageContent: hit._source.text,
-                metadata: hit._source.metadata,
-            }),
-            hit._score,
-        ]);
-    }
-    /**
-     * Static method to create a new OpenSearchVectorStore from an array of
-     * texts, their metadata, embeddings, and OpenSearch client arguments.
-     * @param texts The texts to be converted into documents and added to the OpenSearch index.
-     * @param metadatas The metadata associated with the texts. Can be an array of objects or a single object.
-     * @param embeddings The embeddings used to convert the texts into vectors.
-     * @param args The OpenSearch client arguments.
-     * @returns Promise resolving to a new instance of OpenSearchVectorStore.
-     */
-    static fromTexts(texts, metadatas, embeddings, args) {
-        const documents = texts.map((text, idx) => {
-            const metadata = Array.isArray(metadatas) ? metadatas[idx] : metadatas;
-            return new document_js_1.Document({ pageContent: text, metadata });
-        });
-        return OpenSearchVectorStore.fromDocuments(documents, embeddings, args);
-    }
-    /**
-     * Static method to create a new OpenSearchVectorStore from an array of
-     * Documents, embeddings, and OpenSearch client arguments.
-     * @param docs The documents to be added to the OpenSearch index.
-     * @param embeddings The embeddings used to convert the documents into vectors.
-     * @param dbConfig The OpenSearch client arguments.
-     * @returns Promise resolving to a new instance of OpenSearchVectorStore.
-     */
-    static async fromDocuments(docs, embeddings, dbConfig) {
-        const store = new OpenSearchVectorStore(embeddings, dbConfig);
-        await store.addDocuments(docs).then(() => store);
-        return store;
-    }
-    /**
-     * Static method to create a new OpenSearchVectorStore from an existing
-     * OpenSearch index, embeddings, and OpenSearch client arguments.
-     * @param embeddings The embeddings used to convert the documents into vectors.
-     * @param dbConfig The OpenSearch client arguments.
-     * @returns Promise resolving to a new instance of OpenSearchVectorStore.
-     */
-    static async fromExistingIndex(embeddings, dbConfig) {
-        const store = new OpenSearchVectorStore(embeddings, dbConfig);
-        await store.client.cat.indices({ index: store.indexName });
-        return store;
-    }
-    async ensureIndexExists(dimension, engine = "nmslib", spaceType = "l2", efSearch = 512, efConstruction = 512, m = 16) {
-        const body = {
-            settings: {
-                index: {
-                    number_of_shards: 5,
-                    number_of_replicas: 1,
-                    knn: true,
-                    "knn.algo_param.ef_search": efSearch,
-                },
-            },
-            mappings: {
-                dynamic_templates: [
-                    {
-                        // map all metadata properties to be keyword
-                        "metadata.*": {
-                            match_mapping_type: "*",
-                            mapping: { type: "keyword" },
-                        },
-                    },
-                ],
-                properties: {
-                    text: { type: "text" },
-                    metadata: { type: "object" },
-                    embedding: {
-                        type: "knn_vector",
-                        dimension,
-                        method: {
-                            name: "hnsw",
-                            engine,
-                            space_type: spaceType,
-                            parameters: { ef_construction: efConstruction, m },
-                        },
-                    },
-                },
-            },
-        };
-        const indexExists = await this.doesIndexExist();
-        if (indexExists)
-            return;
-        await this.client.indices.create({ index: this.indexName, body });
-    }
-    buildMetadataTerms(filter) {
-        if (filter == null)
-            return [];
-        const result = [];
-        for (const [key, value] of Object.entries(filter)) {
-            const aggregatorKey = Array.isArray(value) ? "terms" : "term";
-            result.push({ [aggregatorKey]: { [`metadata.${key}`]: value } });
-        }
-        return result;
-    }
-    /**
-     * Method to check if the OpenSearch index exists.
-     * @returns Promise resolving to a boolean indicating whether the index exists.
-     */
-    async doesIndexExist() {
-        try {
-            await this.client.cat.indices({ index: this.indexName });
-            return true;
-        }
-        catch (err) {
-            // eslint-disable-next-line no-instanceof/no-instanceof
-            if (err instanceof opensearch_1.errors.ResponseError && err.statusCode === 404) {
-                return false;
-            }
-            throw err;
-        }
-    }
-    /**
-     * Method to delete the OpenSearch index if it exists.
-     * @returns Promise resolving to void.
-     */
-    async deleteIfExists() {
-        const indexExists = await this.doesIndexExist();
-        if (!indexExists)
-            return;
-        await this.client.indices.delete({ index: this.indexName });
-    }
-}
-exports.OpenSearchVectorStore = OpenSearchVectorStore;
+__exportStar(require("@langchain/community/vectorstores/opensearch"), exports);

package/dist/vectorstores/opensearch.d.ts

@@ -1,119 +1 @@
-import { Client } from "@opensearch-project/opensearch";
-import { Embeddings } from "../embeddings/base.js";
-import { Document } from "../document.js";
-import { VectorStore } from "./base.js";
-type OpenSearchEngine = "nmslib" | "hnsw";
-type OpenSearchSpaceType = "l2" | "cosinesimil" | "ip";
-/**
- * Interface defining the options for vector search in OpenSearch. It
- * includes the engine type, space type, and parameters for the HNSW
- * algorithm.
- */
-interface VectorSearchOptions {
-    readonly engine?: OpenSearchEngine;
-    readonly spaceType?: OpenSearchSpaceType;
-    readonly m?: number;
-    readonly efConstruction?: number;
-    readonly efSearch?: number;
-}
-/**
- * Interface defining the arguments required to create an instance of the
- * OpenSearchVectorStore class. It includes the OpenSearch client, index
- * name, and vector search options.
- */
-export interface OpenSearchClientArgs {
-    readonly client: Client;
-    readonly indexName?: string;
-    readonly vectorSearchOptions?: VectorSearchOptions;
-}
-/**
- * Type alias for an object. It's used to define filters for OpenSearch
- * queries.
- */
-type OpenSearchFilter = object;
-/**
- * Class that provides a wrapper around the OpenSearch service for vector
- * search. It provides methods for adding documents and vectors to the
- * OpenSearch index, searching for similar vectors, and managing the
- * OpenSearch index.
- */
-export declare class OpenSearchVectorStore extends VectorStore {
-    FilterType: OpenSearchFilter;
-    private readonly client;
-    private readonly indexName;
-    private readonly engine;
-    private readonly spaceType;
-    private readonly efConstruction;
-    private readonly efSearch;
-    private readonly m;
-    _vectorstoreType(): string;
-    constructor(embeddings: Embeddings, args: OpenSearchClientArgs);
-    /**
-     * Method to add documents to the OpenSearch index. It first converts the
-     * documents to vectors using the embeddings, then adds the vectors to the
-     * index.
-     * @param documents The documents to be added to the OpenSearch index.
-     * @returns Promise resolving to void.
-     */
-    addDocuments(documents: Document[]): Promise<void>;
-    /**
-     * Method to add vectors to the OpenSearch index. It ensures the index
-     * exists, then adds the vectors and associated documents to the index.
-     * @param vectors The vectors to be added to the OpenSearch index.
-     * @param documents The documents associated with the vectors.
-     * @param options Optional parameter that can contain the IDs for the documents.
-     * @returns Promise resolving to void.
-     */
-    addVectors(vectors: number[][], documents: Document[], options?: {
-        ids?: string[];
-    }): Promise<void>;
-    /**
-     * Method to perform a similarity search on the OpenSearch index using a
-     * query vector. It returns the k most similar documents and their scores.
-     * @param query The query vector.
-     * @param k The number of similar documents to return.
-     * @param filter Optional filter for the OpenSearch query.
-     * @returns Promise resolving to an array of tuples, each containing a Document and its score.
-     */
-    similaritySearchVectorWithScore(query: number[], k: number, filter?: OpenSearchFilter | undefined): Promise<[Document, number][]>;
-    /**
-     * Static method to create a new OpenSearchVectorStore from an array of
-     * texts, their metadata, embeddings, and OpenSearch client arguments.
-     * @param texts The texts to be converted into documents and added to the OpenSearch index.
-     * @param metadatas The metadata associated with the texts. Can be an array of objects or a single object.
-     * @param embeddings The embeddings used to convert the texts into vectors.
-     * @param args The OpenSearch client arguments.
-     * @returns Promise resolving to a new instance of OpenSearchVectorStore.
-     */
-    static fromTexts(texts: string[], metadatas: object[] | object, embeddings: Embeddings, args: OpenSearchClientArgs): Promise<OpenSearchVectorStore>;
-    /**
-     * Static method to create a new OpenSearchVectorStore from an array of
-     * Documents, embeddings, and OpenSearch client arguments.
-     * @param docs The documents to be added to the OpenSearch index.
-     * @param embeddings The embeddings used to convert the documents into vectors.
-     * @param dbConfig The OpenSearch client arguments.
-     * @returns Promise resolving to a new instance of OpenSearchVectorStore.
-     */
-    static fromDocuments(docs: Document[], embeddings: Embeddings, dbConfig: OpenSearchClientArgs): Promise<OpenSearchVectorStore>;
-    /**
-     * Static method to create a new OpenSearchVectorStore from an existing
-     * OpenSearch index, embeddings, and OpenSearch client arguments.
-     * @param embeddings The embeddings used to convert the documents into vectors.
-     * @param dbConfig The OpenSearch client arguments.
-     * @returns Promise resolving to a new instance of OpenSearchVectorStore.
-     */
-    static fromExistingIndex(embeddings: Embeddings, dbConfig: OpenSearchClientArgs): Promise<OpenSearchVectorStore>;
-    private ensureIndexExists;
-    private buildMetadataTerms;
-    /**
-     * Method to check if the OpenSearch index exists.
-     * @returns Promise resolving to a boolean indicating whether the index exists.
-     */
-    doesIndexExist(): Promise<boolean>;
-    /**
-     * Method to delete the OpenSearch index if it exists.
-     * @returns Promise resolving to void.
-     */
-    deleteIfExists(): Promise<void>;
-}
-export {};
+export * from "@langchain/community/vectorstores/opensearch";

package/dist/vectorstores/opensearch.js

@@ -1,261 +1 @@
-import { errors } from "@opensearch-project/opensearch";
-import * as uuid from "uuid";
-import { Document } from "../document.js";
-import { VectorStore } from "./base.js";
-/**
- * Class that provides a wrapper around the OpenSearch service for vector
- * search. It provides methods for adding documents and vectors to the
- * OpenSearch index, searching for similar vectors, and managing the
- * OpenSearch index.
- */
-export class OpenSearchVectorStore extends VectorStore {
-    _vectorstoreType() {
-        return "opensearch";
-    }
-    constructor(embeddings, args) {
-        super(embeddings, args);
-        Object.defineProperty(this, "client", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "indexName", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "engine", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "spaceType", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "efConstruction", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "efSearch", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "m", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.spaceType = args.vectorSearchOptions?.spaceType ?? "l2";
-        this.engine = args.vectorSearchOptions?.engine ?? "nmslib";
-        this.m = args.vectorSearchOptions?.m ?? 16;
-        this.efConstruction = args.vectorSearchOptions?.efConstruction ?? 512;
-        this.efSearch = args.vectorSearchOptions?.efSearch ?? 512;
-        this.client = args.client;
-        this.indexName = args.indexName ?? "documents";
-    }
-    /**
-     * Method to add documents to the OpenSearch index. It first converts the
-     * documents to vectors using the embeddings, then adds the vectors to the
-     * index.
-     * @param documents The documents to be added to the OpenSearch index.
-     * @returns Promise resolving to void.
-     */
-    async addDocuments(documents) {
-        const texts = documents.map(({ pageContent }) => pageContent);
-        return this.addVectors(await this.embeddings.embedDocuments(texts), documents);
-    }
-    /**
-     * Method to add vectors to the OpenSearch index. It ensures the index
-     * exists, then adds the vectors and associated documents to the index.
-     * @param vectors The vectors to be added to the OpenSearch index.
-     * @param documents The documents associated with the vectors.
-     * @param options Optional parameter that can contain the IDs for the documents.
-     * @returns Promise resolving to void.
-     */
-    async addVectors(vectors, documents, options) {
-        await this.ensureIndexExists(vectors[0].length, this.engine, this.spaceType, this.efSearch, this.efConstruction, this.m);
-        const documentIds = options?.ids ?? Array.from({ length: vectors.length }, () => uuid.v4());
-        const operations = vectors.flatMap((embedding, idx) => [
-            {
-                index: {
-                    _index: this.indexName,
-                    _id: documentIds[idx],
-                },
-            },
-            {
-                embedding,
-                metadata: documents[idx].metadata,
-                text: documents[idx].pageContent,
-            },
-        ]);
-        await this.client.bulk({ body: operations });
-        await this.client.indices.refresh({ index: this.indexName });
-    }
-    /**
-     * Method to perform a similarity search on the OpenSearch index using a
-     * query vector. It returns the k most similar documents and their scores.
-     * @param query The query vector.
-     * @param k The number of similar documents to return.
-     * @param filter Optional filter for the OpenSearch query.
-     * @returns Promise resolving to an array of tuples, each containing a Document and its score.
-     */
-    async similaritySearchVectorWithScore(query, k, filter) {
-        const search = {
-            index: this.indexName,
-            body: {
-                query: {
-                    bool: {
-                        filter: { bool: { must: this.buildMetadataTerms(filter) } },
-                        must: [
-                            {
-                                knn: {
-                                    embedding: { vector: query, k },
-                                },
-                            },
-                        ],
-                    },
-                },
-                size: k,
-            },
-        };
-        const { body } = await this.client.search(search);
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        return body.hits.hits.map((hit) => [
-            new Document({
-                pageContent: hit._source.text,
-                metadata: hit._source.metadata,
-            }),
-            hit._score,
-        ]);
-    }
-    /**
-     * Static method to create a new OpenSearchVectorStore from an array of
-     * texts, their metadata, embeddings, and OpenSearch client arguments.
-     * @param texts The texts to be converted into documents and added to the OpenSearch index.
-     * @param metadatas The metadata associated with the texts. Can be an array of objects or a single object.
-     * @param embeddings The embeddings used to convert the texts into vectors.
-     * @param args The OpenSearch client arguments.
-     * @returns Promise resolving to a new instance of OpenSearchVectorStore.
-     */
-    static fromTexts(texts, metadatas, embeddings, args) {
-        const documents = texts.map((text, idx) => {
-            const metadata = Array.isArray(metadatas) ? metadatas[idx] : metadatas;
-            return new Document({ pageContent: text, metadata });
-        });
-        return OpenSearchVectorStore.fromDocuments(documents, embeddings, args);
-    }
-    /**
-     * Static method to create a new OpenSearchVectorStore from an array of
-     * Documents, embeddings, and OpenSearch client arguments.
-     * @param docs The documents to be added to the OpenSearch index.
-     * @param embeddings The embeddings used to convert the documents into vectors.
-     * @param dbConfig The OpenSearch client arguments.
-     * @returns Promise resolving to a new instance of OpenSearchVectorStore.
-     */
-    static async fromDocuments(docs, embeddings, dbConfig) {
-        const store = new OpenSearchVectorStore(embeddings, dbConfig);
-        await store.addDocuments(docs).then(() => store);
-        return store;
-    }
-    /**
-     * Static method to create a new OpenSearchVectorStore from an existing
-     * OpenSearch index, embeddings, and OpenSearch client arguments.
-     * @param embeddings The embeddings used to convert the documents into vectors.
-     * @param dbConfig The OpenSearch client arguments.
-     * @returns Promise resolving to a new instance of OpenSearchVectorStore.
-     */
-    static async fromExistingIndex(embeddings, dbConfig) {
-        const store = new OpenSearchVectorStore(embeddings, dbConfig);
-        await store.client.cat.indices({ index: store.indexName });
-        return store;
-    }
-    async ensureIndexExists(dimension, engine = "nmslib", spaceType = "l2", efSearch = 512, efConstruction = 512, m = 16) {
-        const body = {
-            settings: {
-                index: {
-                    number_of_shards: 5,
-                    number_of_replicas: 1,
-                    knn: true,
-                    "knn.algo_param.ef_search": efSearch,
-                },
-            },
-            mappings: {
-                dynamic_templates: [
-                    {
-                        // map all metadata properties to be keyword
-                        "metadata.*": {
-                            match_mapping_type: "*",
-                            mapping: { type: "keyword" },
-                        },
-                    },
-                ],
-                properties: {
-                    text: { type: "text" },
-                    metadata: { type: "object" },
-                    embedding: {
-                        type: "knn_vector",
-                        dimension,
-                        method: {
-                            name: "hnsw",
-                            engine,
-                            space_type: spaceType,
-                            parameters: { ef_construction: efConstruction, m },
-                        },
-                    },
-                },
-            },
-        };
-        const indexExists = await this.doesIndexExist();
-        if (indexExists)
-            return;
-        await this.client.indices.create({ index: this.indexName, body });
-    }
-    buildMetadataTerms(filter) {
-        if (filter == null)
-            return [];
-        const result = [];
-        for (const [key, value] of Object.entries(filter)) {
-            const aggregatorKey = Array.isArray(value) ? "terms" : "term";
-            result.push({ [aggregatorKey]: { [`metadata.${key}`]: value } });
-        }
-        return result;
-    }
-    /**
-     * Method to check if the OpenSearch index exists.
-     * @returns Promise resolving to a boolean indicating whether the index exists.
-     */
-    async doesIndexExist() {
-        try {
-            await this.client.cat.indices({ index: this.indexName });
-            return true;
-        }
-        catch (err) {
-            // eslint-disable-next-line no-instanceof/no-instanceof
-            if (err instanceof errors.ResponseError && err.statusCode === 404) {
-                return false;
-            }
-            throw err;
-        }
-    }
-    /**
-     * Method to delete the OpenSearch index if it exists.
-     * @returns Promise resolving to void.
-     */
-    async deleteIfExists() {
-        const indexExists = await this.doesIndexExist();
-        if (!indexExists)
-            return;
-        await this.client.indices.delete({ index: this.indexName });
-    }
-}
+export * from "@langchain/community/vectorstores/opensearch";