ClickHouse.SemanticKernel 0.1.1

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package ClickHouse.SemanticKernel --version 0.1.1
                    


                    

                
NuGet\Install-Package ClickHouse.SemanticKernel -Version 0.1.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="ClickHouse.SemanticKernel" Version="0.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="ClickHouse.SemanticKernel" Version="0.1.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="ClickHouse.SemanticKernel" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add ClickHouse.SemanticKernel --version 0.1.1
                    


                    

                
#r "nuget: ClickHouse.SemanticKernel, 0.1.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package ClickHouse.SemanticKernel@0.1.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=ClickHouse.SemanticKernel&version=0.1.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=ClickHouse.SemanticKernel&version=0.1.1
                    


                            Install as a Cake Tool

ClickHouse.SemanticKernel

A Microsoft.Extensions.VectorData connector for ClickHouse, built on ClickHouse.Driver. Use ClickHouse as a vector store from Semantic Kernel and any other Microsoft.Extensions.VectorData consumer — CRUD, filtered queries, and vector similarity search through the standard SK interface.

Features

  • Vector similarity search via the native vector_similarity HNSW index with cosineDistance or L2Distance
  • LINQ-based filters translated to ClickHouse SQL (has(), hasAny(), null-safe equality, range predicates)
  • Upsert semantics on top of ReplacingMergeTree with FINAL reads for immediate consistency
  • Dynamic collections (Dictionary<string, object?>) alongside strongly-typed records
  • Client-side embedding generation via IEmbeddingGenerator<string, Embedding<float>>
  • DI integration via AddClickHouseVectorStore / AddClickHouseCollection

Usage

using ClickHouse.SemanticKernel;
using Microsoft.Extensions.VectorData;

public class Movie
{
    [VectorStoreKey] public string Key { get; set; } = "";
    [VectorStoreData] public string Title { get; set; } = "";
    [VectorStoreData(IsIndexed = true)] public int Year { get; set; }
    [VectorStoreData] public string[] Genres { get; set; } = [];

    [VectorStoreVector(Dimensions: 768, DistanceFunction = DistanceFunction.CosineDistance, IndexKind = IndexKind.Hnsw)]
    public ReadOnlyMemory<float> Embedding { get; set; }
}

var store = new ClickHouseVectorStore("Host=localhost;Protocol=http;Database=default");
var collection = store.GetCollection<string, Movie>("movies");
await collection.EnsureCollectionExistsAsync();

await collection.UpsertAsync(new Movie { /* ... */ });

var results = collection.SearchAsync(
    queryEmbedding,
    top: 5,
    new VectorSearchOptions<Movie>
    {
        Filter = m => m.Year >= 2015 && m.Genres.Contains("Sci-Fi")
    });

Requirements

  • .NET 8 runtime or newer (the package targets net8.0; building from source needs the .NET 10 SDK pinned in global.json)
  • ClickHouse 25.2+ (for the vector_similarity skip index)

More information

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.1.1 26 4/23/2026
0.1.0 36 4/23/2026