UNPKG

@langchain/community

Version:
1 lines • 4.63 kB
{"version":3,"file":"lancedb.d.ts","names":["Table","EmbeddingsInterface","VectorStore","Document","LanceDBArgs","LanceDB","Promise"],"sources":["../../src/vectorstores/lancedb.d.ts"],"sourcesContent":["import { Table } from \"@lancedb/lancedb\";\nimport type { EmbeddingsInterface } from \"@langchain/core/embeddings\";\nimport { VectorStore } from \"@langchain/core/vectorstores\";\nimport { Document } from \"@langchain/core/documents\";\n/**\n * Defines the arguments for the LanceDB class constructor. It includes a\n * table and an optional textKey.\n */\nexport type LanceDBArgs = {\n table?: Table;\n textKey?: string;\n uri?: string;\n tableName?: string;\n mode?: \"create\" | \"overwrite\";\n};\n/**\n * A wrapper for an open-source database for vector-search with persistent\n * storage. It simplifies retrieval, filtering, and management of\n * embeddings.\n */\nexport declare class LanceDB extends VectorStore {\n private table?;\n private textKey;\n private uri;\n private tableName;\n private mode?;\n constructor(embeddings: EmbeddingsInterface, args?: LanceDBArgs);\n /**\n * Adds documents to the database.\n * @param documents The documents to be added.\n * @returns A Promise that resolves when the documents have been added.\n */\n addDocuments(documents: Document[]): Promise<void>;\n _vectorstoreType(): string;\n /**\n * Adds vectors and their corresponding documents to the database.\n * @param vectors The vectors to be added.\n * @param documents The corresponding documents to be added.\n * @returns A Promise that resolves when the vectors and documents have been added.\n */\n addVectors(vectors: number[][], documents: Document[]): Promise<void>;\n /**\n * Performs a similarity search in the database and returns\n * the documents.\n * @param query The query string.\n * @param k The number of results to return.\n * @returns A Promise that resolves with an array, each containing a Document.\n */\n similaritySearch(query: string, k: number): Promise<Document[]>;\n /**\n * Performs a similarity search in the database and returns\n * the documents and their scores.\n * @param query The query string.\n * @param k The number of results to return.\n * @returns A Promise that resolves with an array of tuples, each containing a Document and its score.\n */\n similaritySearchWithScore(query: string, k: number): Promise<[Document, number][]>;\n /**\n * Performs a similarity search on the vectors in the database and returns\n * the documents and their scores.\n * @param query The query vector.\n * @param k The number of results to return.\n * @returns A Promise that resolves with an array of tuples, each containing a Document and its score.\n */\n similaritySearchVectorWithScore(query: number[], k: number): Promise<[Document, number][]>;\n /**\n * Creates a new instance of LanceDB from texts.\n * @param texts The texts to be converted into documents.\n * @param metadatas The metadata for the texts.\n * @param embeddings The embeddings to be managed.\n * @param dbConfig The configuration for the LanceDB instance.\n * @returns A Promise that resolves with a new instance of LanceDB.\n */\n static fromTexts(texts: string[], metadatas: object[] | object, embeddings: EmbeddingsInterface, dbConfig?: LanceDBArgs): Promise<LanceDB>;\n /**\n * Creates a new instance of LanceDB from documents.\n * @param docs The documents to be added to the database.\n * @param embeddings The embeddings to be managed.\n * @param dbConfig The configuration for the LanceDB instance.\n * @returns A Promise that resolves with a new instance of LanceDB.\n */\n static fromDocuments(docs: Document[], embeddings: EmbeddingsInterface, dbConfig?: LanceDBArgs): Promise<LanceDB>;\n}\n//# sourceMappingURL=lancedb.d.ts.map"],"mappings":";;;;;;;;;AAQA;AAYA;AAM4BC,KAlBhBG,WAAAA,GAkBgBH;EAA4BG,KAAAA,CAAAA,EAjB5CJ,KAiB4CI;EAM5BD,OAAAA,CAAAA,EAAAA,MAAAA;EAAaG,GAAAA,CAAAA,EAAAA,MAAAA;EAQMH,SAAAA,CAAAA,EAAAA,MAAAA;EAAaG,IAAAA,CAAAA,EAAAA,QAAAA,GAAAA,WAAAA;CAQJH;;;;;;AAyBwBF,cArD3DI,OAAAA,SAAgBH,WAAAA,CAqD2CD;EAAgCG,QAAAA,KAAAA;EAAsBC,QAAAA,OAAAA;EAARC,QAAAA,GAAAA;EAQ/FH,QAAAA,SAAAA;EAAwBF,QAAAA,IAAAA;EAAgCG,WAAAA,CAAAA,UAAAA,EAvD3DH,mBAuD2DG,EAAAA,IAAAA,CAAAA,EAvD/BA,WAuD+BA;EAAsBC;;;AA7D7D;;0BAYpBF,aAAaG;;;;;;;;6CAQMH,aAAaG;;;;;;;;8CAQZA,QAAQH;;;;;;;;uDAQCG,SAASH;;;;;;;;+DAQDG,SAASH;;;;;;;;;8EASMF,gCAAgCG,cAAcE,QAAQD;;;;;;;;6BAQvGF,wBAAwBF,gCAAgCG,cAAcE,QAAQD"}