Class CassandraStore

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

  • VectorStore
    • CassandraStore

Constructors

constructor

Properties

FilterType embeddings

Methods

addDocuments addVectors asRetriever delete getCassandraTable maxMarginalRelevanceSearch search similaritySearch similaritySearchVectorWithScore similaritySearchWithScore toJSON toJSONNotImplemented fromDocuments fromExistingIndex fromTexts

Constructors

constructor

Properties

FilterType

FilterType: WhereClause

embeddings

embeddings: EmbeddingsInterface

Methods

addDocuments

  • addDocuments(documents): Promise<void>

  • Method to add documents to the Cassandra database.

    Parameters

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

      The documents to add.

    Returns Promise<void>

    Promise that resolves when the documents have been added.

addVectors

  • addVectors(vectors, documents): Promise<void>

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

asRetriever

  • asRetriever(kOrFields?, filter?, callbacks?, tags?, metadata?, verbose?): VectorStoreRetriever<CassandraStore>

  • Parameters

    • OptionalkOrFields: number | Partial<VectorStoreRetrieverInput<CassandraStore>>
    • Optionalfilter: WhereClause
    • Optionalcallbacks: Callbacks
    • Optionaltags: string[]
    • Optionalmetadata: Record<string, unknown>
    • Optionalverbose: boolean

    Returns VectorStoreRetriever<CassandraStore>

delete

  • delete(_params?): Promise<void>

  • Parameters

    • Optional_params: Record<string, any>

    Returns Promise<void>

getCassandraTable

maxMarginalRelevanceSearch

  • maxMarginalRelevanceSearch(query, options): Promise<Document<Record<string, any>>[]>

  • Method to search for vectors that are similar to a given query vector, but with the results selected using the maximal marginal relevance.

    Parameters

    • query: string

      The query string.

    • options: MaxMarginalRelevanceSearchOptions<WhereClause>

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

    List of documents selected by maximal marginal relevance.

search

  • search(query, k, filter?, includeEmbedding?): Promise<[Document<Record<string, any>>, number][]>

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

    • Optionalfilter: WhereClause

      Optional filter to be applied as a WHERE clause.

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

similaritySearch

  • similaritySearch(query, k?, filter?, _callbacks?): Promise<DocumentInterface<Record<string, any>>[]>

  • Parameters

    • query: string
    • Optionalk: number
    • Optionalfilter: WhereClause
    • Optional_callbacks: Callbacks

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

similaritySearchVectorWithScore

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

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

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

similaritySearchWithScore

  • similaritySearchWithScore(query, k?, filter?, _callbacks?): Promise<[DocumentInterface<Record<string, any>>, number][]>

  • Parameters

    • query: string
    • Optionalk: number
    • Optionalfilter: WhereClause
    • Optional_callbacks: Callbacks

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

toJSON

  • toJSON(): Serialized

  • Returns Serialized

toJSONNotImplemented

StaticfromDocuments

  • fromDocuments(docs, embeddings, args): Promise<CassandraStore>

  • Static method to create an instance of CassandraStore from documents.

    Parameters

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

      The documents to use.

    • embeddings: EmbeddingsInterface

      The embeddings to use.

    • args: CassandraLibArgs

      The arguments for the CassandraStore.

    Returns Promise<CassandraStore>

    Promise that resolves with a new instance of CassandraStore.

StaticfromExistingIndex

StaticfromTexts

  • fromTexts(texts, metadatas, embeddings, args): Promise<CassandraStore>

  • Static method to create an instance of CassandraStore from texts.

    Parameters

    • texts: string[]

      The texts to use.

    • metadatas: object | object[]

      The metadata associated with the texts.

    • embeddings: EmbeddingsInterface

      The embeddings to use.

    • args: CassandraLibArgs

      The arguments for the CassandraStore.

    Returns Promise<CassandraStore>

    Promise that resolves with a new instance of CassandraStore.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods