Class LanceDB

A wrapper for an open-source database for vector-search with persistent storage. It simplifies retrieval, filtering, and management of embeddings.

Hierarchy (view full)

Toolkit
- LanceDB

Index

Constructors

Methods

addDocuments addVectors similaritySearchVectorWithScore fromDocuments fromTexts

Constructors

constructor

new LanceDB(embeddings, args): LanceDB
Parameters
- embeddings: EmbeddingsInterface
- args: LanceDBArgs
Returns LanceDB
Overrides VectorStore.constructor
- Defined in libs/langchain-community/src/vectorstores/lancedb.ts:25

Methods

addDocuments

addDocuments(documents): Promise<void>
Adds documents to the database.
Parameters
- documents: Document[]
  The documents to be added.
Returns Promise<void>
A Promise that resolves when the documents have been added.
- Defined in libs/langchain-community/src/vectorstores/lancedb.ts:37

addVectors

addVectors(vectors, documents): Promise<void>
Adds vectors and their corresponding documents to the database.
Parameters
- vectors: number[][]
  The vectors to be added.
- documents: Document[]
  The corresponding documents to be added.
Returns Promise<void>
A Promise that resolves when the vectors and documents have been added.
- Defined in libs/langchain-community/src/vectorstores/lancedb.ts:55

similaritySearchVectorWithScore

similaritySearchVectorWithScore(query, k): Promise<[Document, number][]>
Performs a similarity search on the vectors in the database and returns the documents and their scores.
Parameters
- query: number[]
  The query vector.
- k: number
  The number of results to return.
Returns Promise<[Document, number][]>
A Promise that resolves with an array of tuples, each containing a Document and its score.
- Defined in libs/langchain-community/src/vectorstores/lancedb.ts:84

`Static`fromDocuments

fromDocuments(docs, embeddings, dbConfig): Promise<LanceDB>
Creates a new instance of LanceDB from documents.
Parameters
- docs: Document[]
  The documents to be added to the database.
- embeddings: EmbeddingsInterface
  The embeddings to be managed.
- dbConfig: LanceDBArgs
  The configuration for the LanceDB instance.
Returns Promise<LanceDB>
A Promise that resolves with a new instance of LanceDB.
- Defined in libs/langchain-community/src/vectorstores/lancedb.ts:143

`Static`fromTexts

fromTexts(texts, metadatas, embeddings, dbConfig): Promise<LanceDB>
Creates a new instance of LanceDB from texts.
Parameters
- texts: string[]
  The texts to be converted into documents.
- metadatas: object | object[]
  The metadata for the texts.
- embeddings: EmbeddingsInterface
  The embeddings to be managed.
- dbConfig: LanceDBArgs
  The configuration for the LanceDB instance.
Returns Promise<LanceDB>
A Promise that resolves with a new instance of LanceDB.
- Defined in libs/langchain-community/src/vectorstores/lancedb.ts:118