Class for interacting with the ClickHouse 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
    • ClickHouseStore

Constructors

Properties

FilterType: ClickHouseFilter

Methods

  • Method to add documents to the ClickHouse database.

    Parameters

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

      The documents to add.

    Returns Promise<void>

    Promise that resolves when the documents have been added.

  • Method to add vectors to the ClickHouse database.

    Parameters

    • vectors: number[][]

      The vectors to add.

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

      The documents associated with the vectors.

    Returns Promise<void>

    Promise that resolves when the vectors have been added.

  • 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 vectors to return.

    • Optional filter: ClickHouseFilter

      Optional filter for the search results.

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

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

  • Static method to create an instance of ClickHouseStore 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: ClickHouseLibArgs

      The arguments for the ClickHouseStore.

    Returns Promise<ClickHouseStore>

    Promise that resolves with a new instance of ClickHouseStore.

Generated using TypeDoc