Alkampfer.KernelMemory.ElasticSearch
0.7.0-alpha0025
See the version list below for details.
dotnet add package Alkampfer.KernelMemory.ElasticSearch --version 0.7.0-alpha0025
NuGet\Install-Package Alkampfer.KernelMemory.ElasticSearch -Version 0.7.0-alpha0025
<PackageReference Include="Alkampfer.KernelMemory.ElasticSearch" Version="0.7.0-alpha0025" />
<PackageVersion Include="Alkampfer.KernelMemory.ElasticSearch" Version="0.7.0-alpha0025" />
<PackageReference Include="Alkampfer.KernelMemory.ElasticSearch" />
paket add Alkampfer.KernelMemory.ElasticSearch --version 0.7.0-alpha0025
#r "nuget: Alkampfer.KernelMemory.ElasticSearch, 0.7.0-alpha0025"
#addin nuget:?package=Alkampfer.KernelMemory.ElasticSearch&version=0.7.0-alpha0025&prerelease
#tool nuget:?package=Alkampfer.KernelMemory.ElasticSearch&version=0.7.0-alpha0025&prerelease
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
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 | Versions 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. |
-
net8.0
- Alkampfer.KernelMemory.Extensions.Interfaces (>= 0.6.0)
- Elastic.Clients.Elasticsearch (>= 8.13.10)
- Microsoft.KernelMemory.Abstractions (>= 0.38.240424.2)
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 | 82 | 4/5/2025 |
| 0.10.0-alpha0017 | 86 | 1/21/2025 |
| 0.10.0-alpha0014 | 64 | 1/13/2025 |
| 0.10.0-alpha0009 | 109 | 7/22/2024 |
| 0.10.0-alpha0005 | 99 | 7/22/2024 |
| 0.9.3 | 208 | 1/21/2025 |
| 0.9.3-beta0001 | 87 | 1/21/2025 |
| 0.9.2 | 98 | 1/13/2025 |
| 0.9.2-beta0003 | 59 | 1/13/2025 |
| 0.9.1 | 331 | 7/22/2024 |
| 0.9.0 | 129 | 7/22/2024 |
| 0.9.0-not-filter0006 | 120 | 7/8/2024 |
| 0.9.0-alpha0006 | 100 | 7/16/2024 |
| 0.9.0-alpha0005 | 126 | 7/5/2024 |
| 0.9.0-alpha0004 | 81 | 6/4/2024 |
| 0.8.0 | 130 | 6/4/2024 |
| 0.8.0-alpha0013 | 80 | 6/3/2024 |
| 0.8.0-alpha0012 | 85 | 6/1/2024 |
| 0.7.0 | 104 | 6/1/2024 |
| 0.7.0-bulkoperations0025 | 122 | 5/16/2024 |
| 0.7.0-beta0010 | 84 | 6/1/2024 |
| 0.7.0-beta0001 | 136 | 5/27/2024 |
| 0.7.0-beta0000 | 104 | 5/18/2024 |
| 0.7.0-alpha0025 | 94 | 5/17/2024 |
| 0.7.0-alpha0024 | 85 | 5/11/2024 |
| 0.7.0-alpha0020 | 114 | 5/8/2024 |
| 0.7.0-alpha0017 | 117 | 5/8/2024 |
| 0.7.0-alpha0014 | 97 | 4/26/2024 |
| 0.7.0-alpha0010 | 115 | 4/25/2024 |
| 0.7.0-alpha0009 | 111 | 4/25/2024 |
| 0.7.0-alpha0008 | 120 | 4/23/2024 |
| 0.6.4 | 106 | 5/11/2024 |
| 0.6.4-beta0001 | 86 | 5/11/2024 |
| 0.6.3 | 131 | 5/8/2024 |
| 0.6.3-beta0002 | 123 | 5/8/2024 |
| 0.6.3-beta0001 | 101 | 5/8/2024 |
| 0.6.2 | 109 | 5/8/2024 |
| 0.6.2-beta0001 | 101 | 5/8/2024 |
| 0.6.1 | 231 | 4/26/2024 |
| 0.6.1-beta0009 | 106 | 4/26/2024 |
| 0.6.1-beta0008 | 123 | 4/26/2024 |
| 0.6.0 | 168 | 4/23/2024 |
| 0.6.0-alpha0015 | 111 | 4/23/2024 |
| 0.6.0-alpha0014 | 115 | 4/20/2024 |
| 0.6.0-alpha0013 | 141 | 4/19/2024 |
| 0.6.0-alpha0012 | 101 | 4/17/2024 |
| 0.6.0-alpha0011 | 109 | 4/17/2024 |
| 0.6.0-alpha0010 | 116 | 4/17/2024 |
| 0.5.0 | 154 | 4/17/2024 |
| 0.5.0-nuget0017 | 168 | 4/17/2024 |
| 0.5.0-nuget0016 | 128 | 4/17/2024 |
| 0.5.0-nuget0015 | 160 | 4/17/2024 |
| 0.5.0-nuget0014 | 122 | 4/17/2024 |
| 0.5.0-nuget0013 | 124 | 4/17/2024 |
| 0.5.0-nuget0009 | 117 | 4/17/2024 |
| 0.5.0-beta0002 | 126 | 4/17/2024 |
| 0.5.0-beta0001 | 109 | 4/17/2024 |
| 0.5.0-beta0000 | 121 | 4/17/2024 |
| 0.5.0-alpha0006 | 123 | 4/17/2024 |