Skip to content

Support Build() options in KM builder extension methods #980

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dluc merged 1 commit into from
Jan 16, 2025
Merged

Support Build() options in KM builder extension methods #980

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,19 +96,19 @@
</ItemGroup>
<!-- Tests -->
<ItemGroup>
<PackageVersion Include="coverlet.collector" Version="6.0.2">
<PackageVersion Include="coverlet.collector" Version="6.0.3">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageVersion>
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
<PackageVersion Include="xunit" Version="2.9.2" />
<PackageVersion Include="xunit" Version="2.9.3" />
<PackageVersion Include="xunit.abstractions" Version="2.0.3" />
<PackageVersion Include="xunit.extensibility.core" Version="2.7.1" />
<PackageVersion Include="xunit.runner.visualstudio" Version="3.0.0">
<PackageVersion Include="xunit.runner.visualstudio" Version="3.0.1">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageVersion>
<PackageVersion Include="Xunit.DependencyInjection" Version="9.7.0" />
<PackageVersion Include="Xunit.DependencyInjection" Version="9.7.1" />
<PackageVersion Include="Xunit.DependencyInjection.Logging" Version="9.0.0" />
</ItemGroup>
<!-- Aspire -->
Expand Down
2 changes: 1 addition & 1 deletion examples/204-dotnet-ASP.NET-MVC-integration/204-dotnet-ASP.NET-MVC-integration.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.KernelMemory.Service.AspNetCore" Version="0.95.241216.2" />
<PackageReference Include="Microsoft.KernelMemory.Service.AspNetCore" Version="0.96.250115.1" />
</ItemGroup>

</Project>
2 changes: 1 addition & 1 deletion examples/301-discord-test-application/301-discord-test-application.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<ItemGroup>
<PackageReference Include="Aspire.Npgsql.EntityFrameworkCore.PostgreSQL" Version="9.0.0" />
<PackageReference Include="Discord.Net" Version="3.16.0" />
<PackageReference Include="Microsoft.KernelMemory.Service.AspNetCore" Version="0.95.241216.2" />
<PackageReference Include="Microsoft.KernelMemory.Service.AspNetCore" Version="0.96.250115.1" />
</ItemGroup>

</Project>
16 changes: 12 additions & 4 deletions service/Core/ServiceCollectionExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,17 @@ public static partial class ServiceCollectionExtensions
/// </summary>
/// <param name="services">The <see cref="IServiceCollection"/> to add the services to.</param>
/// <param name="setupAction">An optional action to configure the <see cref="IKernelMemory">Kernel Memory builder</see>.</param>
/// <param name="buildOptions">Optional options passed to Build() call</param>
/// <returns>A reference to this instance after the operation has completed.</returns>
public static IServiceCollection AddKernelMemory(this IServiceCollection services, Action<IKernelMemoryBuilder>? setupAction = null)
public static IServiceCollection AddKernelMemory(
this IServiceCollection services,
Action<IKernelMemoryBuilder>? setupAction = null,
KernelMemoryBuilderBuildOptions? buildOptions = null)
{
var kernelMemoryBuilder = new KernelMemoryBuilder(services);
setupAction?.Invoke(kernelMemoryBuilder);

var kernelMemory = kernelMemoryBuilder.Build();
var kernelMemory = kernelMemoryBuilder.Build(buildOptions);
services.AddSingleton<IKernelMemory>(kernelMemory);

return services;
Expand All @@ -32,14 +36,18 @@ public static IServiceCollection AddKernelMemory(this IServiceCollection service
/// </summary>
/// <param name="services">The <see cref="IServiceCollection"/> to add the services to.</param>
/// <param name="setupAction">An optional action to configure the <see cref="IKernelMemory">Kernel Memory builder</see>.</param>
/// <param name="buildOptions">Optional options passed to Build() call</param>
/// <returns>A reference to this instance after the operation has completed.</returns>
public static IServiceCollection AddKernelMemory<T>(this IServiceCollection services, Action<IKernelMemoryBuilder>? setupAction = null)
public static IServiceCollection AddKernelMemory<T>(
this IServiceCollection services,
Action<IKernelMemoryBuilder>? setupAction = null,
KernelMemoryBuilderBuildOptions? buildOptions = null)
where T : class, IKernelMemory
{
var kernelMemoryBuilder = new KernelMemoryBuilder(services);
setupAction?.Invoke(kernelMemoryBuilder);

var kernelMemory = kernelMemoryBuilder.Build<T>();
var kernelMemory = kernelMemoryBuilder.Build<T>(buildOptions);

services.AddSingleton(kernelMemory);
services.AddSingleton<IKernelMemory>(provider => provider.GetRequiredService<T>());
Expand Down
35 changes: 35 additions & 0 deletions service/tests/Core.UnitTests/KernelMemoryBuilderTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
using Microsoft.KernelMemory;
using Microsoft.KernelMemory.AI;
using Microsoft.KernelMemory.DocumentStorage;
using Microsoft.KernelMemory.DocumentStorage.DevTools;
using Microsoft.KernelMemory.MemoryStorage;
using Microsoft.KernelMemory.Pipeline;
using Microsoft.KernelMemory.Pipeline.Queue;
Expand Down Expand Up @@ -116,14 +117,48 @@ public void ItDetectsMissingEmbeddingGenerator()
[Trait("Category", "UnitTest")]
public void ItCanMixPersistentAndVolatileStorageIfNeeded()
{
// Arrange
KernelMemoryBuilderBuildOptions kmbOptions = new()
{
AllowMixingVolatileAndPersistentData = true
};

// Act - Assert no exception occurs
new KernelMemoryBuilder()
.WithOpenAIDefaults("key")
.WithSimpleFileStorage(SimpleFileStorageConfig.Volatile)
.WithPostgresMemoryDb("Host=localhost;Port=5432;Username=public;Password=;Database=public")
.Build<MemoryServerless>(kmbOptions);
}

[Fact]
[Trait("Category", "UnitTest")]
public void ItCanMixPersistentAndVolatileStorageIfNeeded2()
{
// Arrange
KernelMemoryBuilderBuildOptions kmbOptions = new()
{
AllowMixingVolatileAndPersistentData = true
};

var serviceCollection1 = new ServiceCollection();
var serviceCollection2 = new ServiceCollection();

// Act - Assert no exception occurs
serviceCollection1.AddKernelMemory(builder =>
{
builder
.WithOpenAIDefaults("key")
.WithSimpleFileStorage(SimpleFileStorageConfig.Volatile)
.WithPostgresMemoryDb("Host=localhost;Port=5432;Username=public;Password=;Database=public");
}, kmbOptions);

serviceCollection2.AddKernelMemory<MemoryServerless>(builder =>
{
builder
.WithOpenAIDefaults("key")
.WithSimpleFileStorage(SimpleFileStorageConfig.Volatile)
.WithPostgresMemoryDb("Host=localhost;Port=5432;Username=public;Password=;Database=public");
}, kmbOptions);
}
}
Loading