Class XataVectorSearch<XataClient>

constructor

• new XataVectorSearch<XataClient>(embeddings, args): XataVectorSearch<XataClient>

• Type Parameters

  • XataClient extends BaseClient

  Parameters

  • embeddings: EmbeddingsInterface
  • args: XataClientArgs<XataClient>

  Returns XataVectorSearch<XataClient>

FilterType

addDocuments

• addDocuments(documents, options?): Promise<string[]>

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

    Array of documents to be added.
  • Optionaloptions: {
        ids?: string[];
    }

    Optional object containing an array of ids.

    • Optionalids?: string[]

  Returns Promise<string[]>

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

addVectors

• addVectors(vectors, documents, options?): Promise<string[]>

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

    Array of documents corresponding to the vectors.
  • Optionaloptions: {
        ids?: string[];
    }

    Optional object containing an array of ids.

    • Optionalids?: string[]

  Returns Promise<string[]>

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

delete

• delete(params): Promise<void>

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

similaritySearchVectorWithScore

• similaritySearchVectorWithScore(query, k, filter?): Promise<[Document, number][]>

• 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.
  • Optionalfilter: object

    Optional filter for the search.

  Returns Promise<[Document, number][]>

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