Class for interacting with a Xata database as a VectorStore. Provides methods to add documents and vectors to the database, delete entries, and perform similarity searches.

Type Parameters

  • XataClient extends BaseClient

Hierarchy

Constructors

Properties

FilterType: object
embeddings: Embeddings

Methods

  • Method to add documents to the Xata database. Maps the page content of each document, embeds the documents using the embeddings, and adds the vectors to the database.

    Parameters

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

      Array of documents to be added.

    • Optional options: {
          ids?: string[];
      }

      Optional object containing an array of ids.

      • Optional ids?: string[]

    Returns Promise<string[]>

    Promise resolving to an array of ids of the added documents.

  • Method to add vectors to the Xata database. Maps each vector to a row with the document's content, embedding, and metadata. Creates or replaces these rows in the Xata database.

    Parameters

    • vectors: number[][]

      Array of vectors to be added.

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

      Array of documents corresponding to the vectors.

    • Optional options: {
          ids?: string[];
      }

      Optional object containing an array of ids.

      • Optional ids?: string[]

    Returns Promise<string[]>

    Promise resolving to an array of ids of the added vectors.

  • Method to delete entries from the Xata database. Deletes the entries with the provided ids.

    Parameters

    • params: {
          ids: string[];
      }

      Object containing an array of ids of the entries to be deleted.

      • ids: string[]

    Returns Promise<void>

    Promise resolving to void.

  • Parameters

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

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

  • Method to perform a similarity search in the Xata database. Returns the k most similar documents along with their scores.

    Parameters

    • query: number[]

      Query vector for the similarity search.

    • k: number

      Number of most similar documents to return.

    • Optional filter: object

      Optional filter for the search.

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

    Promise resolving to an array of tuples, each containing a Document and its score.

  • Parameters

    • query: string
    • Optional k: number
    • Optional filter: 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.
  • Parameters

    • _texts: string[]
    • _metadatas: object | object[]
    • _embeddings: Embeddings
    • _dbConfig: Record<string, any>

    Returns Promise<VectorStore>

Generated using TypeDoc