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 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>>[]>

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

Generated using TypeDoc