Alkampfer.KernelMemory.ElasticSearch 0.10.0-alpha0005

This is a prerelease version of Alkampfer.KernelMemory.ElasticSearch.
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.10.0-alpha0005                
NuGet\Install-Package Alkampfer.KernelMemory.ElasticSearch -Version 0.10.0-alpha0005                
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.10.0-alpha0005" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Alkampfer.KernelMemory.ElasticSearch --version 0.10.0-alpha0005                
#r "nuget: Alkampfer.KernelMemory.ElasticSearch, 0.10.0-alpha0005"                
#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.
// Install Alkampfer.KernelMemory.ElasticSearch as a Cake Addin
#addin nuget:?package=Alkampfer.KernelMemory.ElasticSearch&version=0.10.0-alpha0005&prerelease

// Install Alkampfer.KernelMemory.ElasticSearch as a Cake Tool
#tool nuget:?package=Alkampfer.KernelMemory.ElasticSearch&version=0.10.0-alpha0005&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

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. 
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-alpha0017 78 2 months ago
0.10.0-alpha0014 51 2 months ago
0.10.0-alpha0009 105 8 months ago
0.10.0-alpha0005 95 8 months ago
0.9.3 147 2 months ago
0.9.3-beta0001 79 2 months ago
0.9.2 84 2 months ago
0.9.2-beta0003 53 2 months ago
0.9.1 321 8 months ago
0.9.0 124 8 months ago
0.9.0-not-filter0006 114 8 months ago
0.9.0-alpha0006 96 8 months ago
0.9.0-alpha0005 116 8 months ago
0.9.0-alpha0004 77 9 months ago
0.8.0 125 9 months ago
0.8.0-alpha0013 77 9 months ago
0.8.0-alpha0012 82 9 months ago
0.7.0 101 9 months ago
0.7.0-bulkoperations0025 119 10 months ago
0.7.0-beta0010 81 9 months ago
0.7.0-beta0001 133 9 months ago
0.7.0-beta0000 100 10 months ago
0.7.0-alpha0025 91 10 months ago
0.7.0-alpha0024 82 10 months ago
0.7.0-alpha0020 110 5/8/2024
0.7.0-alpha0017 114 5/8/2024
0.7.0-alpha0014 94 4/26/2024
0.7.0-alpha0010 112 4/25/2024
0.7.0-alpha0009 108 4/25/2024
0.7.0-alpha0008 117 4/23/2024
0.6.4 103 10 months ago
0.6.4-beta0001 83 10 months ago
0.6.3 127 5/8/2024
0.6.3-beta0002 119 5/8/2024
0.6.3-beta0001 98 5/8/2024
0.6.2 105 5/8/2024
0.6.2-beta0001 97 5/8/2024
0.6.1 227 4/26/2024
0.6.1-beta0009 103 4/26/2024
0.6.1-beta0008 114 4/26/2024
0.6.0 159 4/23/2024
0.6.0-alpha0015 108 4/23/2024
0.6.0-alpha0014 112 4/20/2024
0.6.0-alpha0013 138 4/19/2024
0.6.0-alpha0012 98 4/17/2024
0.6.0-alpha0011 105 4/17/2024
0.6.0-alpha0010 112 4/17/2024
0.5.0 147 4/17/2024
0.5.0-nuget0017 165 4/17/2024
0.5.0-nuget0016 124 4/17/2024
0.5.0-nuget0015 155 4/17/2024
0.5.0-nuget0014 116 4/17/2024
0.5.0-nuget0013 119 4/17/2024
0.5.0-nuget0009 114 4/17/2024
0.5.0-beta0002 122 4/17/2024
0.5.0-beta0001 105 4/17/2024
0.5.0-beta0000 118 4/17/2024
0.5.0-alpha0006 120 4/17/2024