Class for interacting with the Cassandra database. It extends the VectorStore class and provides methods for adding vectors and documents, searching for similar vectors, and creating instances from texts or documents.

Hierarchy

Constructors

Properties

FilterType: WhereClause

Methods

  • Method to save vectors to the Cassandra database.

    Parameters

    • vectors: number[][]

      Vectors to save.

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

      The documents associated with the vectors.

    Returns Promise<void>

    Promise that resolves when the vectors have been added.

  • Parameters

    • Optional _params: Record<string, any>

    Returns Promise<void>

  • Helper method to search for vectors that are similar to a given query vector.

    Parameters

    • query: number[]

      The query vector.

    • k: number

      The number of similar Documents to return.

    • Optional filter: WhereClause

      Optional filter to be applied as a WHERE clause.

    • Optional includeEmbedding: boolean

      Whether to include the embedding vectors in the results.

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

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

  • Parameters

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

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

  • Method to search for vectors that are similar to a given query vector.

    Parameters

    • query: number[]

      The query vector.

    • k: number

      The number of similar Documents to return.

    • Optional filter: WhereClause

      Optional filter to be applied as a WHERE clause.

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

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

  • Parameters

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

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

Generated using TypeDoc