Alkampfer.KernelMemory.ElasticSearch 0.9.4

There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Alkampfer.KernelMemory.ElasticSearch --version 0.9.4
                    
NuGet\Install-Package Alkampfer.KernelMemory.ElasticSearch -Version 0.9.4
                    
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="Alkampfer.KernelMemory.ElasticSearch" Version="0.9.4" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Alkampfer.KernelMemory.ElasticSearch" Version="0.9.4" />
                    
Directory.Packages.props
<PackageReference Include="Alkampfer.KernelMemory.ElasticSearch" />
                    
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 Alkampfer.KernelMemory.ElasticSearch --version 0.9.4
                    
#r "nuget: Alkampfer.KernelMemory.ElasticSearch, 0.9.4"
                    
#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 Alkampfer.KernelMemory.ElasticSearch@0.9.4
                    
#: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=Alkampfer.KernelMemory.ElasticSearch&version=0.9.4
                    
Install as a Cake Addin
#tool nuget:?package=Alkampfer.KernelMemory.ElasticSearch&version=0.9.4
                    
Install as a Cake Tool

Use ElasticSeach with Kernel Memory

In this project there is an opinionated implementation of IMemoryDb for Microsoft Kernel Memory based on the latest version of ElasticSearch >=8.13. This implementation was tested only on the latest version of ES 8, and it is not meant to work with older version.

This library implements only the Memory DB part, so you still need to configure a different database for Binary Storage in Kernel Memory.

Nuget

Package is published in Nuget Alkampfer.KernelMemory.ElasticSearch

NuGet Version NuGet Downloads

Details of implementation

This implementation uses dynamic template mapping so we do not need to do nested object mapping, this was done to have a better schema of the object and a real simple way to query the data.

Search in payload

Kernel memory uses only tags to filter results, and the MemoryRecord has payload dictionary that contains non searchable fields. Actually this implementation was created to allow mixing vector search and BM25 search, so you have a special property called IndexablePayloadProperties in the configuration that allows you to specify which payload you want to be indexed and searchable.

You can use that kind of functionality with custom code like that one in Kernel Memory Extensions

Developing with ElasticSearch

You can run on local machine, run with docker or use an instance on the cloud. Check documentation at https://www.elastic.co/

Elasticsearch Version used to develop this driver

At the date of today the latest version that you can download is used, no work has been done to check compatibility with previous versions.

A ui to elastic

If you need an UI to manage your elastic search, you can use elasticsearch ui running in docker

docker run -d -p 5000:5000 elastichq/elasticsearch-hq

Then connect to the local instance of elastic at http://host.docker.internal:9200

You can also use kibana or other UI of your choice.

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.10.0-updatelibraries0018 156 4/5/2025
0.10.0-alpha0022 323 6/10/2025
0.10.0-alpha0017 131 1/21/2025
0.10.0-alpha0014 111 1/13/2025
0.10.0-alpha0009 153 7/22/2024
0.10.0-alpha0005 147 7/22/2024
0.9.4 345 6/10/2025
0.9.4-beta0003 304 6/10/2025
0.9.4-beta0002 316 6/10/2025
0.9.4-beta0001 303 6/10/2025
0.9.3 343 1/21/2025
0.9.3-beta0001 132 1/21/2025
0.9.2 155 1/13/2025
0.9.2-beta0003 95 1/13/2025
0.9.1 378 7/22/2024
0.9.0 173 7/22/2024
0.9.0-not-filter0006 164 7/8/2024
0.9.0-alpha0006 135 7/16/2024
0.9.0-alpha0005 160 7/5/2024
0.9.0-alpha0004 120 6/4/2024
0.8.0 172 6/4/2024
0.8.0-alpha0013 125 6/3/2024
0.8.0-alpha0012 135 6/1/2024
0.7.0 140 6/1/2024
0.7.0-bulkoperations0025 170 5/16/2024
0.7.0-beta0010 129 6/1/2024
0.7.0-beta0001 180 5/27/2024
0.7.0-beta0000 149 5/18/2024
0.7.0-alpha0025 139 5/17/2024
0.7.0-alpha0024 130 5/11/2024
0.7.0-alpha0020 160 5/8/2024
0.7.0-alpha0017 151 5/8/2024
0.7.0-alpha0014 146 4/26/2024
0.7.0-alpha0010 148 4/25/2024
0.7.0-alpha0009 153 4/25/2024
0.7.0-alpha0008 171 4/23/2024
0.6.4 153 5/11/2024
0.6.4-beta0001 128 5/11/2024
0.6.3 181 5/8/2024
0.6.3-beta0002 170 5/8/2024
0.6.3-beta0001 145 5/8/2024
0.6.2 139 5/8/2024
0.6.2-beta0001 147 5/8/2024
0.6.1 274 4/26/2024
0.6.1-beta0009 153 4/26/2024
0.6.1-beta0008 180 4/26/2024
0.6.0 239 4/23/2024
0.6.0-alpha0015 159 4/23/2024
0.6.0-alpha0014 161 4/20/2024
0.6.0-alpha0013 185 4/19/2024
0.6.0-alpha0012 142 4/17/2024
0.6.0-alpha0011 150 4/17/2024
0.6.0-alpha0010 157 4/17/2024
0.5.0 205 4/17/2024
0.5.0-nuget0017 210 4/17/2024
0.5.0-nuget0016 173 4/17/2024
0.5.0-nuget0015 210 4/17/2024
0.5.0-nuget0014 163 4/17/2024
0.5.0-nuget0013 166 4/17/2024
0.5.0-nuget0009 157 4/17/2024
0.5.0-beta0002 165 4/17/2024
0.5.0-beta0001 156 4/17/2024
0.5.0-beta0000 162 4/17/2024
0.5.0-alpha0006 170 4/17/2024