Class LanceDB

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

Hierarchy

  • VectorStore
    • LanceDB

Constructors

constructor

Properties

FilterType embeddings

Methods

addDocuments addVectors asRetriever delete maxMarginalRelevanceSearch? similaritySearch similaritySearchVectorWithScore similaritySearchWithScore toJSON toJSONNotImplemented fromDocuments fromTexts

Constructors

constructor

Properties

FilterType

FilterType: string | object

embeddings

embeddings: EmbeddingsInterface

Methods

addDocuments

  • addDocuments(documents): Promise<void>

  • Adds documents to the database.

    Parameters

    • documents: Document<Record<string, any>>[]

      The documents to be added.

    Returns Promise<void>

    A Promise that resolves when the documents have been added.

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<Record<string, any>>[]

      The corresponding documents to be added.

    Returns Promise<void>

    A Promise that resolves when the vectors and documents have been added.

asRetriever

  • asRetriever(kOrFields?, filter?, callbacks?, tags?, metadata?, verbose?): VectorStoreRetriever<LanceDB>

  • Parameters

    • OptionalkOrFields: number | Partial<VectorStoreRetrieverInput<LanceDB>>
    • Optionalfilter: string | object
    • Optionalcallbacks: Callbacks
    • Optionaltags: string[]
    • Optionalmetadata: Record<string, unknown>
    • Optionalverbose: boolean

    Returns VectorStoreRetriever<LanceDB>

delete

  • delete(_params?): Promise<void>

  • Parameters

    • Optional_params: Record<string, any>

    Returns Promise<void>

OptionalmaxMarginalRelevanceSearch

  • maxMarginalRelevanceSearch(query, options, _callbacks): Promise<DocumentInterface<Record<string, any>>[]>

  • Return documents selected using the maximal marginal relevance. Maximal marginal relevance optimizes for similarity to the query AND diversity among selected documents.

    Parameters

    • query: string

      Text to look up documents similar to.

    • options: MaxMarginalRelevanceSearchOptions<string | object>
    • _callbacks: undefined | Callbacks

    Returns Promise<DocumentInterface<Record<string, any>>[]>

    • List of documents selected by maximal marginal relevance.

similaritySearch

  • similaritySearch(query, k?, filter?, _callbacks?): Promise<DocumentInterface<Record<string, any>>[]>

  • Parameters

    • query: string
    • Optionalk: number
    • Optionalfilter: string | object
    • Optional_callbacks: Callbacks

    Returns Promise<DocumentInterface<Record<string, any>>[]>

similaritySearchVectorWithScore

  • similaritySearchVectorWithScore(query, k): Promise<[Document<Record<string, any>>, 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<Record<string, any>>, number][]>

    A Promise that resolves with an array of tuples, each containing a Document and its score.

similaritySearchWithScore

  • similaritySearchWithScore(query, k?, filter?, _callbacks?): Promise<[DocumentInterface<Record<string, any>>, number][]>

  • Parameters

    • query: string
    • Optionalk: number
    • Optionalfilter: string | object
    • Optional_callbacks: Callbacks

    Returns Promise<[DocumentInterface<Record<string, any>>, number][]>

toJSON

  • toJSON(): Serialized

  • Returns Serialized

toJSONNotImplemented

StaticfromDocuments

  • fromDocuments(docs, embeddings, dbConfig): Promise<LanceDB>

  • Creates a new instance of LanceDB from documents.

    Parameters

    • docs: Document<Record<string, any>>[]

      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.

StaticfromTexts

  • 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.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods