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

Hierarchy

Constructors

Properties

FilterType: string | object
embeddings: Embeddings

Methods

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

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

  • Parameters

    • Optional _params: Record<string, any>

    Returns Promise<void>

  • Parameters

    • query: string
    • Optional k: number
    • Optional filter: string | object
    • Optional _callbacks: Callbacks

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

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

  • Parameters

    • query: string
    • Optional k: number
    • Optional filter: string | object
    • Optional _callbacks: Callbacks

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

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

    Parameters

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

    • List of documents selected by maximal marginal relevance.
  • Creates a new instance of LanceDB from documents.

    Parameters

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

      The documents to be added to the database.

    • embeddings: Embeddings

      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.

  • 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: Embeddings

      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.

Generated using TypeDoc