Alkampfer.KernelMemory.ElasticSearch 0.6.2-beta0001

This is a prerelease version of Alkampfer.KernelMemory.ElasticSearch.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Alkampfer.KernelMemory.ElasticSearch --version 0.6.2-beta0001                
NuGet\Install-Package Alkampfer.KernelMemory.ElasticSearch -Version 0.6.2-beta0001                
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.6.2-beta0001" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Alkampfer.KernelMemory.ElasticSearch --version 0.6.2-beta0001                
#r "nuget: Alkampfer.KernelMemory.ElasticSearch, 0.6.2-beta0001"                
#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.6.2-beta0001&prerelease

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

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.

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. 
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-alpha0009 86 7/22/2024
0.10.0-alpha0005 80 7/22/2024
0.9.1 134 7/22/2024
0.9.0 103 7/22/2024
0.9.0-not-filter0006 98 7/8/2024
0.9.0-alpha0006 80 7/16/2024
0.9.0-alpha0005 100 7/5/2024
0.9.0-alpha0004 61 6/4/2024
0.8.0 106 6/4/2024
0.8.0-alpha0013 63 6/3/2024
0.8.0-alpha0012 68 6/1/2024
0.7.0 78 6/1/2024
0.7.0-bulkoperations0025 102 5/16/2024
0.7.0-beta0010 67 6/1/2024
0.7.0-beta0001 95 5/27/2024
0.7.0-beta0000 83 5/18/2024
0.7.0-alpha0025 75 5/17/2024
0.7.0-alpha0024 66 5/11/2024
0.7.0-alpha0020 94 5/8/2024
0.7.0-alpha0017 99 5/8/2024
0.7.0-alpha0014 79 4/26/2024
0.7.0-alpha0010 95 4/25/2024
0.7.0-alpha0009 86 4/25/2024
0.7.0-alpha0008 99 4/23/2024
0.6.4 81 5/11/2024
0.6.4-beta0001 66 5/11/2024
0.6.3 108 5/8/2024
0.6.3-beta0002 94 5/8/2024
0.6.3-beta0001 82 5/8/2024
0.6.2 84 5/8/2024
0.6.2-beta0001 81 5/8/2024
0.6.1 210 4/26/2024
0.6.1-beta0009 88 4/26/2024
0.6.1-beta0008 99 4/26/2024
0.6.0 135 4/23/2024
0.6.0-alpha0015 92 4/23/2024
0.6.0-alpha0014 99 4/20/2024
0.6.0-alpha0013 107 4/19/2024
0.6.0-alpha0012 83 4/17/2024
0.6.0-alpha0011 86 4/17/2024
0.6.0-alpha0010 95 4/17/2024
0.5.0 122 4/17/2024
0.5.0-nuget0017 118 4/17/2024
0.5.0-nuget0016 108 4/17/2024
0.5.0-nuget0015 113 4/17/2024
0.5.0-nuget0014 99 4/17/2024
0.5.0-nuget0013 96 4/17/2024
0.5.0-nuget0009 92 4/17/2024
0.5.0-beta0002 109 4/17/2024
0.5.0-beta0001 90 4/17/2024
0.5.0-beta0000 95 4/17/2024
0.5.0-alpha0006 102 4/17/2024