langchain 0.0.202 → 0.0.204-rc.0

package/dist/vectorstores/typesense.cjs

@@ -1,225 +1,17 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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.Typesense = void 0;
-const base_js_1 = require("./base.cjs");
-const async_caller_js_1 = require("../util/async_caller.cjs");
-/**
- * Typesense vector store.
- */
-class Typesense extends base_js_1.VectorStore {
-    _vectorstoreType() {
-        return "typesense";
-    }
-    constructor(embeddings, config) {
-        super(embeddings, config);
-        Object.defineProperty(this, "client", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "schemaName", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "searchParams", {
-            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, "pageContentColumnName", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "metadataColumnNames", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "caller", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "import", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        // Assign config values to class properties.
-        this.client = config.typesenseClient;
-        this.schemaName = config.schemaName;
-        this.searchParams = config.searchParams || {
-            q: "*",
-            per_page: 5,
-            query_by: "",
-        };
-        this.vectorColumnName = config.columnNames?.vector || "vec";
-        this.pageContentColumnName = config.columnNames?.pageContent || "text";
-        this.metadataColumnNames = config.columnNames?.metadataColumnNames || [];
-        // Assign import function.
-        this.import = config.import || this.importToTypesense.bind(this);
-        this.caller = new async_caller_js_1.AsyncCaller(config);
-    }
-    /**
-     * Default function to import data to typesense
-     * @param data
-     * @param collectionName
-     */
-    async importToTypesense(data, collectionName) {
-        const chunkSize = 2000;
-        for (let i = 0; i < data.length; i += chunkSize) {
-            const chunk = data.slice(i, i + chunkSize);
-            await this.caller.call(async () => {
-                await this.client
-                    .collections(collectionName)
-                    .documents()
-                    .import(chunk, { action: "emplace", dirty_values: "drop" });
-            });
-        }
-    }
-    /**
-     * Transform documents to Typesense records.
-     * @param documents
-     * @returns Typesense records.
-     */
-    _documentsToTypesenseRecords(documents, vectors) {
-        const metadatas = documents.map((doc) => doc.metadata);
-        const typesenseDocuments = documents.map((doc, index) => {
-            const metadata = metadatas[index];
-            const objectWithMetadatas = {};
-            this.metadataColumnNames.forEach((metadataColumnName) => {
-                objectWithMetadatas[metadataColumnName] = metadata[metadataColumnName];
-            });
-            return {
-                [this.pageContentColumnName]: doc.pageContent,
-                [this.vectorColumnName]: vectors[index],
-                ...objectWithMetadatas,
-            };
-        });
-        return typesenseDocuments;
-    }
-    /**
-     * Transform the Typesense records to documents.
-     * @param typesenseRecords
-     * @returns documents
-     */
-    _typesenseRecordsToDocuments(typesenseRecords) {
-        const documents = typesenseRecords?.map((hit) => {
-            const objectWithMetadatas = {};
-            const hitDoc = hit.document || {};
-            this.metadataColumnNames.forEach((metadataColumnName) => {
-                objectWithMetadatas[metadataColumnName] = hitDoc[metadataColumnName];
-            });
-            const document = {
-                pageContent: hitDoc[this.pageContentColumnName] || "",
-                metadata: objectWithMetadatas,
-            };
-            return [document, hit.vector_distance];
-        }) || [];
-        return documents;
-    }
-    /**
-     * Add documents to the vector store.
-     * Will be updated if in the metadata there is a document with the same id if is using the default import function.
-     * Metadata will be added in the columns of the schema based on metadataColumnNames.
-     * @param documents Documents to add.
-     */
-    async addDocuments(documents) {
-        const typesenseDocuments = this._documentsToTypesenseRecords(documents, await this.embeddings.embedDocuments(documents.map((doc) => doc.pageContent)));
-        await this.import(typesenseDocuments, this.schemaName);
-    }
-    /**
-     * Adds vectors to the vector store.
-     * @param vectors Vectors to add.
-     * @param documents Documents associated with the vectors.
-     */
-    async addVectors(vectors, documents) {
-        const typesenseDocuments = this._documentsToTypesenseRecords(documents, vectors);
-        await this.import(typesenseDocuments, this.schemaName);
-    }
-    /**
-     * Search for similar documents with their similarity score.
-     * @param vectorPrompt vector to search for
-     * @param k amount of results to return
-     * @returns similar documents with their similarity score
-     */
-    async similaritySearchVectorWithScore(vectorPrompt, k, filter = {}) {
-        const amount = k || this.searchParams.per_page || 5;
-        const vector_query = `${this.vectorColumnName}:([${vectorPrompt}], k:${amount})`;
-        const typesenseResponse = await this.client.multiSearch.perform({
-            searches: [
-                {
-                    ...this.searchParams,
-                    ...filter,
-                    per_page: amount,
-                    vector_query,
-                    collection: this.schemaName,
-                },
-            ],
-        }, {});
-        const results = typesenseResponse.results[0].hits;
-        const hits = results?.map((hit) => ({
-            document: hit?.document || {},
-            vector_distance: hit?.vector_distance || 2,
-        }));
-        return this._typesenseRecordsToDocuments(hits);
-    }
-    /**
-     * Delete documents from the vector store.
-     * @param documentIds ids of the documents to delete
-     */
-    async deleteDocuments(documentIds) {
-        await this.client
-            .collections(this.schemaName)
-            .documents()
-            .delete({
-            filter_by: `id:=${documentIds.join(",")}`,
-        });
-    }
-    /**
-     * Create a vector store from documents.
-     * @param docs documents
-     * @param embeddings embeddings
-     * @param config Typesense configuration
-     * @returns Typesense vector store
-     * @warning You can omit this method, and only use the constructor and addDocuments.
-     */
-    static async fromDocuments(docs, embeddings, config) {
-        const instance = new Typesense(embeddings, config);
-        await instance.addDocuments(docs);
-        return instance;
-    }
-    /**
-     * Create a vector store from texts.
-     * @param texts
-     * @param metadatas
-     * @param embeddings
-     * @param config
-     * @returns Typesense vector store
-     */
-    static async fromTexts(texts, metadatas, embeddings, config) {
-        const instance = new Typesense(embeddings, config);
-        const documents = texts.map((text, i) => ({
-            pageContent: text,
-            metadata: metadatas[i] || {},
-        }));
-        await instance.addDocuments(documents);
-        return instance;
-    }
-}
-exports.Typesense = Typesense;
+__exportStar(require("@langchain/community/vectorstores/typesense"), exports);

package/dist/vectorstores/typesense.d.ts

@@ -1,131 +1 @@
-import type { Client } from "typesense";
-import type { MultiSearchRequestSchema } from "typesense/lib/Typesense/MultiSearch.js";
-import type { Document } from "../document.js";
-import { Embeddings } from "../embeddings/base.js";
-import { VectorStore } from "./base.js";
-import { AsyncCallerParams } from "../util/async_caller.js";
-/**
- * Typesense vector store configuration.
- */
-export interface TypesenseConfig extends AsyncCallerParams {
-    /**
-     * Typesense client.
-     */
-    typesenseClient: Client;
-    /**
-     * Typesense schema name in which documents will be stored and searched.
-     */
-    schemaName: string;
-    /**
-     * Typesense search parameters.
-     * @default { q: '*', per_page: 5, query_by: '' }
-     */
-    searchParams?: MultiSearchRequestSchema;
-    /**
-     * Column names.
-     */
-    columnNames?: {
-        /**
-         * Vector column name.
-         * @default 'vec'
-         */
-        vector?: string;
-        /**
-         * Page content column name.
-         * @default 'text'
-         */
-        pageContent?: string;
-        /**
-         * Metadata column names.
-         * @default []
-         */
-        metadataColumnNames?: string[];
-    };
-    /**
-     * Replace default import function.
-     * Default import function will update documents if there is a document with the same id.
-     * @param data
-     * @param collectionName
-     */
-    import?<T extends Record<string, unknown> = Record<string, unknown>>(data: T[], collectionName: string): Promise<void>;
-}
-/**
- * Typesense vector store.
- */
-export declare class Typesense extends VectorStore {
-    FilterType: Partial<MultiSearchRequestSchema>;
-    private client;
-    private schemaName;
-    private searchParams;
-    private vectorColumnName;
-    private pageContentColumnName;
-    private metadataColumnNames;
-    private caller;
-    private import;
-    _vectorstoreType(): string;
-    constructor(embeddings: Embeddings, config: TypesenseConfig);
-    /**
-     * Default function to import data to typesense
-     * @param data
-     * @param collectionName
-     */
-    private importToTypesense;
-    /**
-     * Transform documents to Typesense records.
-     * @param documents
-     * @returns Typesense records.
-     */
-    _documentsToTypesenseRecords(documents: Document[], vectors: number[][]): Record<string, unknown>[];
-    /**
-     * Transform the Typesense records to documents.
-     * @param typesenseRecords
-     * @returns documents
-     */
-    _typesenseRecordsToDocuments(typesenseRecords: {
-        document?: Record<string, unknown>;
-        vector_distance: number;
-    }[] | undefined): [Document, number][];
-    /**
-     * Add documents to the vector store.
-     * Will be updated if in the metadata there is a document with the same id if is using the default import function.
-     * Metadata will be added in the columns of the schema based on metadataColumnNames.
-     * @param documents Documents to add.
-     */
-    addDocuments(documents: Document[]): Promise<void>;
-    /**
-     * Adds vectors to the vector store.
-     * @param vectors Vectors to add.
-     * @param documents Documents associated with the vectors.
-     */
-    addVectors(vectors: number[][], documents: Document[]): Promise<void>;
-    /**
-     * Search for similar documents with their similarity score.
-     * @param vectorPrompt vector to search for
-     * @param k amount of results to return
-     * @returns similar documents with their similarity score
-     */
-    similaritySearchVectorWithScore(vectorPrompt: number[], k?: number, filter?: this["FilterType"]): Promise<[Document<Record<string, any>>, number][]>;
-    /**
-     * Delete documents from the vector store.
-     * @param documentIds ids of the documents to delete
-     */
-    deleteDocuments(documentIds: string[]): Promise<void>;
-    /**
-     * Create a vector store from documents.
-     * @param docs documents
-     * @param embeddings embeddings
-     * @param config Typesense configuration
-     * @returns Typesense vector store
-     * @warning You can omit this method, and only use the constructor and addDocuments.
-     */
-    static fromDocuments(docs: Document[], embeddings: Embeddings, config: TypesenseConfig): Promise<Typesense>;
-    /**
-     * Create a vector store from texts.
-     * @param texts
-     * @param metadatas
-     * @param embeddings
-     * @param config
-     * @returns Typesense vector store
-     */
-    static fromTexts(texts: string[], metadatas: object[], embeddings: Embeddings, config: TypesenseConfig): Promise<Typesense>;
-}
+export * from "@langchain/community/vectorstores/typesense";

package/dist/vectorstores/typesense.js

@@ -1,221 +1 @@
-import { VectorStore } from "./base.js";
-import { AsyncCaller } from "../util/async_caller.js";
-/**
- * Typesense vector store.
- */
-export class Typesense extends VectorStore {
-    _vectorstoreType() {
-        return "typesense";
-    }
-    constructor(embeddings, config) {
-        super(embeddings, config);
-        Object.defineProperty(this, "client", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "schemaName", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "searchParams", {
-            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, "pageContentColumnName", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "metadataColumnNames", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "caller", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "import", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        // Assign config values to class properties.
-        this.client = config.typesenseClient;
-        this.schemaName = config.schemaName;
-        this.searchParams = config.searchParams || {
-            q: "*",
-            per_page: 5,
-            query_by: "",
-        };
-        this.vectorColumnName = config.columnNames?.vector || "vec";
-        this.pageContentColumnName = config.columnNames?.pageContent || "text";
-        this.metadataColumnNames = config.columnNames?.metadataColumnNames || [];
-        // Assign import function.
-        this.import = config.import || this.importToTypesense.bind(this);
-        this.caller = new AsyncCaller(config);
-    }
-    /**
-     * Default function to import data to typesense
-     * @param data
-     * @param collectionName
-     */
-    async importToTypesense(data, collectionName) {
-        const chunkSize = 2000;
-        for (let i = 0; i < data.length; i += chunkSize) {
-            const chunk = data.slice(i, i + chunkSize);
-            await this.caller.call(async () => {
-                await this.client
-                    .collections(collectionName)
-                    .documents()
-                    .import(chunk, { action: "emplace", dirty_values: "drop" });
-            });
-        }
-    }
-    /**
-     * Transform documents to Typesense records.
-     * @param documents
-     * @returns Typesense records.
-     */
-    _documentsToTypesenseRecords(documents, vectors) {
-        const metadatas = documents.map((doc) => doc.metadata);
-        const typesenseDocuments = documents.map((doc, index) => {
-            const metadata = metadatas[index];
-            const objectWithMetadatas = {};
-            this.metadataColumnNames.forEach((metadataColumnName) => {
-                objectWithMetadatas[metadataColumnName] = metadata[metadataColumnName];
-            });
-            return {
-                [this.pageContentColumnName]: doc.pageContent,
-                [this.vectorColumnName]: vectors[index],
-                ...objectWithMetadatas,
-            };
-        });
-        return typesenseDocuments;
-    }
-    /**
-     * Transform the Typesense records to documents.
-     * @param typesenseRecords
-     * @returns documents
-     */
-    _typesenseRecordsToDocuments(typesenseRecords) {
-        const documents = typesenseRecords?.map((hit) => {
-            const objectWithMetadatas = {};
-            const hitDoc = hit.document || {};
-            this.metadataColumnNames.forEach((metadataColumnName) => {
-                objectWithMetadatas[metadataColumnName] = hitDoc[metadataColumnName];
-            });
-            const document = {
-                pageContent: hitDoc[this.pageContentColumnName] || "",
-                metadata: objectWithMetadatas,
-            };
-            return [document, hit.vector_distance];
-        }) || [];
-        return documents;
-    }
-    /**
-     * Add documents to the vector store.
-     * Will be updated if in the metadata there is a document with the same id if is using the default import function.
-     * Metadata will be added in the columns of the schema based on metadataColumnNames.
-     * @param documents Documents to add.
-     */
-    async addDocuments(documents) {
-        const typesenseDocuments = this._documentsToTypesenseRecords(documents, await this.embeddings.embedDocuments(documents.map((doc) => doc.pageContent)));
-        await this.import(typesenseDocuments, this.schemaName);
-    }
-    /**
-     * Adds vectors to the vector store.
-     * @param vectors Vectors to add.
-     * @param documents Documents associated with the vectors.
-     */
-    async addVectors(vectors, documents) {
-        const typesenseDocuments = this._documentsToTypesenseRecords(documents, vectors);
-        await this.import(typesenseDocuments, this.schemaName);
-    }
-    /**
-     * Search for similar documents with their similarity score.
-     * @param vectorPrompt vector to search for
-     * @param k amount of results to return
-     * @returns similar documents with their similarity score
-     */
-    async similaritySearchVectorWithScore(vectorPrompt, k, filter = {}) {
-        const amount = k || this.searchParams.per_page || 5;
-        const vector_query = `${this.vectorColumnName}:([${vectorPrompt}], k:${amount})`;
-        const typesenseResponse = await this.client.multiSearch.perform({
-            searches: [
-                {
-                    ...this.searchParams,
-                    ...filter,
-                    per_page: amount,
-                    vector_query,
-                    collection: this.schemaName,
-                },
-            ],
-        }, {});
-        const results = typesenseResponse.results[0].hits;
-        const hits = results?.map((hit) => ({
-            document: hit?.document || {},
-            vector_distance: hit?.vector_distance || 2,
-        }));
-        return this._typesenseRecordsToDocuments(hits);
-    }
-    /**
-     * Delete documents from the vector store.
-     * @param documentIds ids of the documents to delete
-     */
-    async deleteDocuments(documentIds) {
-        await this.client
-            .collections(this.schemaName)
-            .documents()
-            .delete({
-            filter_by: `id:=${documentIds.join(",")}`,
-        });
-    }
-    /**
-     * Create a vector store from documents.
-     * @param docs documents
-     * @param embeddings embeddings
-     * @param config Typesense configuration
-     * @returns Typesense vector store
-     * @warning You can omit this method, and only use the constructor and addDocuments.
-     */
-    static async fromDocuments(docs, embeddings, config) {
-        const instance = new Typesense(embeddings, config);
-        await instance.addDocuments(docs);
-        return instance;
-    }
-    /**
-     * Create a vector store from texts.
-     * @param texts
-     * @param metadatas
-     * @param embeddings
-     * @param config
-     * @returns Typesense vector store
-     */
-    static async fromTexts(texts, metadatas, embeddings, config) {
-        const instance = new Typesense(embeddings, config);
-        const documents = texts.map((text, i) => ({
-            pageContent: text,
-            metadata: metadatas[i] || {},
-        }));
-        await instance.addDocuments(documents);
-        return instance;
-    }
-}
+export * from "@langchain/community/vectorstores/typesense";