Class ClickHouseStore

constructor

• new ClickHouseStore(embeddings, args): ClickHouseStore

• Parameters

  • embeddings: EmbeddingsInterface

  • args: ClickHouseLibArgs

  Returns ClickHouseStore

FilterType

addDocuments

• addDocuments(documents): Promise<void>

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

addVectors

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

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

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 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 fromDocuments

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

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

  Parameters

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

    The documents to use.

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

Static fromExistingIndex

• fromExistingIndex(embeddings, args): Promise<ClickHouseStore>

• Static method to create an instance of ClickHouseStore from an existing index.

  Parameters

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

Static fromTexts

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

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