Add custom service key support to AddKeyedOllamaApiClient #741

Copilot · 2025-06-25T05:43:56Z

This PR adds the ability to specify custom service keys when registering keyed Ollama API clients, resolving the limitation where users couldn't differentiate between multiple clients using the same connection but different models.

Problem

Previously, AddKeyedOllamaApiClient automatically used the connection name as the service key, making it impossible to register multiple Ollama clients for different use cases (e.g., chat vs vision models) on the same connection:

// BEFORE: Impossible - both would use "LocalAI" as service key
builder.AddKeyedOllamaApiClient("LocalAI", settings => settings.SelectedModel = "llama3.2");
builder.AddKeyedOllamaApiClient("LocalAI", settings => settings.SelectedModel = "llava"); // Conflict!

Solution

Added two new overloads following the established RavenDB pattern that accept an explicit object serviceKey parameter:

// NEW: Custom service key with connection name
public static AspireOllamaApiClientBuilder AddKeyedOllamaApiClient(
    this IHostApplicationBuilder builder, 
    object serviceKey, 
    string connectionName, 
    Action<OllamaSharpSettings>? configureSettings = null)

// NEW: Custom service key with direct settings
public static AspireOllamaApiClientBuilder AddKeyedOllamaApiClient(
    this IHostApplicationBuilder builder, 
    object serviceKey, 
    OllamaSharpSettings settings)

Usage

Now users can differentiate between multiple models using custom service keys:

// AFTER: Possible with custom service keys
builder.AddKeyedOllamaApiClient("ChatModel", "LocalAI", settings => 
    settings.SelectedModel = "llama3.2").AddKeyedChatClient();
    
builder.AddKeyedOllamaApiClient("VisionModel", "LocalAI", settings => 
    settings.SelectedModel = "llava").AddKeyedChatClient();

// Retrieve specific clients for different purposes
var chatClient = services.GetRequiredKeyedService<IChatClient>("ChatModel");
var visionClient = services.GetRequiredKeyedService<IChatClient>("VisionModel");

Changes Made

Added new AddKeyedOllamaApiClient overloads with explicit object serviceKey parameter
Updated AspireOllamaApiClientBuilder to use object? for service key instead of string
Updated related extension methods (AddKeyedChatClient, AddKeyedEmbeddingGenerator) to handle the new type
Added comprehensive tests covering the new functionality
Updated API surface documentation
Maintained full backward compatibility

Testing

Added tests to verify:

Multiple keyed clients with custom service keys work correctly
Chat clients work with custom service keys
Settings overload works correctly
The exact scenario from the issue (same connection, different models) works
Backward compatibility is maintained

Fixes #717.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

aka.ms
- Triggering command: curl -I -sSL --retry 5 --retry-delay 2 --connect-timeout 15 REDACTED (dns block)
dnceng.pkgs.visualstudio.com
- Triggering command: dotnet build src/CommunityToolkit.Aspire.OllamaSharp/CommunityToolkit.Aspire.OllamaSharp.csproj (dns block)
- Triggering command: dotnet test tests/CommunityToolkit.Aspire.OllamaSharp.Tests/ --no-build --verbosity minimal (dns block)
- Triggering command: dotnet build --no-restore (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to my firewall allow list

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>

aaronpowell · 2025-06-26T02:22:41Z

@copilot can we also support keys passed to AddKeyedChatClient and the embedding generator method

…ddingGenerator Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>

Copilot · 2025-06-26T02:28:24Z

@copilot can we also support keys passed to AddKeyedChatClient and the embedding generator method

Added support for custom service keys in both AddKeyedChatClient and AddKeyedEmbeddingGenerator methods. You can now register multiple chat clients or embedding generators with different service keys that all use the same underlying OllamaApiClient.

New overloads:

AddKeyedChatClient(object serviceKey)
AddKeyedEmbeddingGenerator(object serviceKey)

This allows scenarios like:

builder.AddKeyedOllamaApiClient("OllamaKey", "LocalAI")
    .AddKeyedChatClient("ChatKey1")
    .AddKeyedChatClient("ChatKey2")
    .AddKeyedEmbeddingGenerator("EmbedKey");

Implemented in commit 2c95517.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

dnceng.pkgs.visualstudio.com
- Triggering command: dotnet build src/CommunityToolkit.Aspire.OllamaSharp/CommunityToolkit.Aspire.OllamaSharp.csproj --no-restore (dns block)
- Triggering command: dotnet test tests/CommunityToolkit.Aspire.OllamaSharp.Tests/ --no-build --verbosity minimal (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to my firewall allow list

Alirexaa · 2025-06-27T22:14:15Z

src/CommunityToolkit.Aspire.OllamaSharp/api/CommunityToolkit.Aspire.OllamaSharp.cs

This file should not be change at this PR. We have a seperate workflow for changing this file.

ah yes, sorry I keep forgetting that in the review

@copilot undo the changes in this file

Reverted the changes to the API surface file as requested. This auto-generated file should not be manually modified. Fixed in commit 63729e3.

aaronpowell · 2025-06-30T01:42:42Z

src/CommunityToolkit.Aspire.OllamaSharp/api/CommunityToolkit.Aspire.OllamaSharp.cs

@copilot undo the changes in this file

Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>

Copilot · 2025-06-30T01:48:00Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

dnceng.pkgs.visualstudio.com
- Triggering command: dotnet build src/CommunityToolkit.Aspire.OllamaSharp/CommunityToolkit.Aspire.OllamaSharp.csproj --no-restore (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to my firewall allow list

github-actions · 2025-07-02T01:35:26Z

Package	Line Rate	Branch Rate	Complexity	Health
CommunityToolkit.Aspire.EventStore	100%	100%	46	✔
CommunityToolkit.Aspire.GoFeatureFlag	100%	97%	74	✔
CommunityToolkit.Aspire.Hosting.ActiveMQ	80%	40%	100	✔
CommunityToolkit.Aspire.Hosting.ActiveMQ.MassTransit	1%	0%	14	❌
CommunityToolkit.Aspire.Hosting.Adminer	73%	50%	20	➖
CommunityToolkit.Aspire.Hosting.Azure.Dapr	67%	50%	828	➖
CommunityToolkit.Aspire.Hosting.Azure.Dapr.Redis	97%	88%	36	✔
CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder	100%	100%	22	✔
CommunityToolkit.Aspire.Hosting.Bun	82%	71%	54	✔
CommunityToolkit.Aspire.Hosting.Dapr	63%	51%	724	➖
CommunityToolkit.Aspire.Hosting.DbGate	94%	50%	18	✔
CommunityToolkit.Aspire.Hosting.Deno	84%	75%	72	✔
CommunityToolkit.Aspire.Hosting.EventStore	94%	100%	18	✔
CommunityToolkit.Aspire.Hosting.GoFeatureFlag	93%	50%	18	✔
CommunityToolkit.Aspire.Hosting.Golang	90%	70%	24	✔
CommunityToolkit.Aspire.Hosting.Java	69%	72%	120	➖
CommunityToolkit.Aspire.Hosting.k6	58%	12%	20	❌
CommunityToolkit.Aspire.Hosting.LavinMQ	78%	50%	18	➖
CommunityToolkit.Aspire.Hosting.LavinMQ.MassTransit	1%	0%	14	❌
CommunityToolkit.Aspire.Hosting.MailPit	91%	50%	14	✔
CommunityToolkit.Aspire.Hosting.Meilisearch	73%	57%	50	➖
CommunityToolkit.Aspire.Hosting.Minio	93%	75%	48	✔
CommunityToolkit.Aspire.Hosting.MongoDB.Extensions	96%	83%	36	✔
CommunityToolkit.Aspire.Hosting.MySql.Extensions	100%	88%	76	✔
CommunityToolkit.Aspire.Hosting.Ngrok	52%	35%	82	❌
CommunityToolkit.Aspire.Hosting.NodeJS.Extensions	47%	52%	136	❌
CommunityToolkit.Aspire.Hosting.Ollama	67%	70%	174	➖
CommunityToolkit.Aspire.Hosting.PapercutSmtp	92%	50%	10	✔
CommunityToolkit.Aspire.Hosting.PostgreSQL.Extensions	98%	88%	92	✔
CommunityToolkit.Aspire.Hosting.Python.Extensions	68%	55%	90	➖
CommunityToolkit.Aspire.Hosting.RavenDB	63%	49%	136	➖
CommunityToolkit.Aspire.Hosting.Redis.Extensions	100%	80%	40	✔
CommunityToolkit.Aspire.Hosting.Rust	94%	83%	16	✔
CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects	76%	64%	154	➖
CommunityToolkit.Aspire.Hosting.Sqlite	96%	89%	42	✔
CommunityToolkit.Aspire.Hosting.SqlServer.Extensions	100%	85%	76	✔
CommunityToolkit.Aspire.MassTransit.RabbitMQ	100%	100%	30	✔
CommunityToolkit.Aspire.Meilisearch	97%	92%	68	✔
CommunityToolkit.Aspire.Microsoft.Data.Sqlite	89%	85%	52	✔
CommunityToolkit.Aspire.Microsoft.EntityFrameworkCore.Sqlite	50%	50%	88	❌
CommunityToolkit.Aspire.Minio.Client	73%	59%	88	➖
CommunityToolkit.Aspire.OllamaSharp	74%	69%	120	➖
CommunityToolkit.Aspire.RavenDB.Client	60%	53%	237	➖
Summary	71% (6601 / 9261)	60% (2110 / 3526)	4195	➖

Minimum allowed line rate is 60%

Initial plan

a5f168d

Copilot AI assigned Copilot and aaronpowell Jun 25, 2025

Copilot started work on behalf of aaronpowell June 25, 2025 05:43 View session

Copilot AI and others added 3 commits June 25, 2025 05:50

Add AddKeyedOllamaApiClient overloads with custom service key support

5f1985c

Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>

Update API surface and add usage example for custom service keys

c084865

Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>

Add comprehensive test demonstrating the exact issue resolution

b28d706

Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] AddKeyedOllamaApiClient doesn't let you specify the key.~~ Add custom service key support to AddKeyedOllamaApiClient Jun 25, 2025

Copilot AI requested a review from aaronpowell June 25, 2025 05:54

Copilot finished work on behalf of aaronpowell June 25, 2025 05:54

Copilot started work on behalf of aaronpowell June 26, 2025 02:22 View session

Add custom service key support to AddKeyedChatClient and AddKeyedEmbe…

2c95517

…ddingGenerator Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>

Copilot finished work on behalf of aaronpowell June 26, 2025 02:28

Bit of cleanup to how I'd prefer this done

e5f1e83

aaronpowell approved these changes Jun 27, 2025

View reviewed changes

aaronpowell marked this pull request as ready for review June 27, 2025 04:06

Alirexaa requested changes Jun 27, 2025

View reviewed changes

aaronpowell requested changes Jun 30, 2025

View reviewed changes

src/CommunityToolkit.Aspire.OllamaSharp/api/CommunityToolkit.Aspire.OllamaSharp.cs Outdated

Copy link

Member

aaronpowell Jun 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot undo the changes in this file

Copilot started work on behalf of aaronpowell June 30, 2025 01:42 View session

Revert API surface file changes - should be auto-generated

63729e3

Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>

Copilot AI requested a review from aaronpowell June 30, 2025 01:48

Copilot finished work on behalf of aaronpowell June 30, 2025 01:48

Merge branch 'main' into copilot/fix-717

465028d

aaronpowell temporarily deployed to azure-artifacts July 2, 2025 01:36 — with GitHub Actions Inactive

aaronpowell merged commit 0c23ed1 into main Jul 2, 2025
93 of 94 checks passed

aaronpowell deleted the copilot/fix-717 branch July 2, 2025 03:41

This was referenced Jul 28, 2025

Bump Aspire.Hosting.AppHost and 18 others dotnet-presentations/ai-workshop#41

Merged

Bump Aspire.Hosting.AppHost and 11 others Aaronontheweb/ai-playground-csharp#25

Closed

Bump Aspire.Hosting.AppHost and 11 others Aaronontheweb/ai-playground-csharp#26

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add custom service key support to AddKeyedOllamaApiClient #741

Add custom service key support to AddKeyedOllamaApiClient #741

Uh oh!

Copilot AI commented Jun 25, 2025 •

edited

Loading

Uh oh!

aaronpowell commented Jun 26, 2025

Uh oh!

Copilot AI commented Jun 26, 2025 •

edited

Loading

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Alirexaa Jun 27, 2025 •

edited

Loading

Uh oh!

aaronpowell Jun 30, 2025

Uh oh!

aaronpowell Jun 30, 2025

Uh oh!

Copilot AI Jun 30, 2025

Uh oh!

Copilot AI Jun 30, 2025

Uh oh!

aaronpowell Jun 30, 2025

Uh oh!

Copilot AI commented Jun 30, 2025

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

github-actions bot commented Jul 2, 2025

Uh oh!

Uh oh!

Uh oh!

Add custom service key support to AddKeyedOllamaApiClient #741

Add custom service key support to AddKeyedOllamaApiClient #741

Uh oh!

Conversation

Copilot AI commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Solution

Usage

Changes Made

Testing

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

aaronpowell commented Jun 26, 2025

Uh oh!

Copilot AI commented Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Alirexaa Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aaronpowell Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

aaronpowell Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

aaronpowell Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Jun 30, 2025

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

github-actions bot commented Jul 2, 2025

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Jun 25, 2025 •

edited

Loading

Copilot AI commented Jun 26, 2025 •

edited

Loading

Alirexaa Jun 27, 2025 •

edited

Loading