Codeblaze.SemanticKernel.Connectors.Memory.Neo4j 1.3.0

dotnet add package Codeblaze.SemanticKernel.Connectors.Memory.Neo4j --version 1.3.0
NuGet\Install-Package Codeblaze.SemanticKernel.Connectors.Memory.Neo4j -Version 1.3.0
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="Codeblaze.SemanticKernel.Connectors.Memory.Neo4j" Version="1.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Codeblaze.SemanticKernel.Connectors.Memory.Neo4j --version 1.3.0
#r "nuget: Codeblaze.SemanticKernel.Connectors.Memory.Neo4j, 1.3.0"
#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 Codeblaze.SemanticKernel.Connectors.Memory.Neo4j as a Cake Addin
#addin nuget:?package=Codeblaze.SemanticKernel.Connectors.Memory.Neo4j&version=1.3.0

// Install Codeblaze.SemanticKernel.Connectors.Memory.Neo4j as a Cake Tool
#tool nuget:?package=Codeblaze.SemanticKernel.Connectors.Memory.Neo4j&version=1.3.0

Neo4j Memory Store

Supports

  • Customizable queries
  • Runtime properties
  • Vector embedding Update, Get, Remove and Search
  • TextMemoryPlugin support see example 15 of Semantic Kernel

⚠️ Kernel Memory: Is experimental in the semantic kernel.

Quick Start

  • Install from nuget
    dotnet add package Codeblaze.SemanticKernel.Connectors.Memory.Neo4j
    
  • Configure the memory store
    var builder = new MemoryBuilder();
    
    builder.WithHttpClient(new HttpClient());
    builder.WithOllamaTextEmbeddingGeneration(config["Ollama:Model"], config["Ollama:BaseUrlEmbeddings"]);
    builder.WithNeo4jMemoryStore(config["Neo4j:Url"], config["Neo4j:Username"], config["Neo4j:Password"],
        new Neo4jVectorIndexQueryFactory(
            "<index-name>",
            "<node-name>",
            "<index-property-name>",
            "<text-property-name>",
            384 // Dimensions
        )
    );
    
    memory = builder.Build();
    
  • Store embedding
    memory.SaveReferenceAsync(
        collection: "<index-name>",
        externalSourceName: "<node-name>",
        externalId: "<node-id>",
        description: "not used",
        text: "<actual-text>"
    );
    
  • Search embedding
    var results = memory.SearchAsync("<index-name>", "<search-text>", limit: 3);
    
  • Retrieve node
    var results = await memory.GetAsync("<index-name>", "<node-id>");
    

Query Factory

You can implement you own INeo4jQueryFactory or Extend Neo4jVectorIndexQueryFactory to modify any of the queries (Default queries found in Neo4jVectorQueries).

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos 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
1.3.0 101 2/1/2024
1.2.3 84 1/23/2024
1.2.2 88 1/19/2024
1.2.1 74 1/18/2024
1.2.0 67 1/18/2024