CommunityToolkit.Aspire.OllamaSharp
9.6.0
Prefix Reserved
dotnet add package CommunityToolkit.Aspire.OllamaSharp --version 9.6.0
NuGet\Install-Package CommunityToolkit.Aspire.OllamaSharp -Version 9.6.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="CommunityToolkit.Aspire.OllamaSharp" Version="9.6.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="CommunityToolkit.Aspire.OllamaSharp" Version="9.6.0" />
<PackageReference Include="CommunityToolkit.Aspire.OllamaSharp" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add CommunityToolkit.Aspire.OllamaSharp --version 9.6.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: CommunityToolkit.Aspire.OllamaSharp, 9.6.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.
#addin nuget:?package=CommunityToolkit.Aspire.OllamaSharp&version=9.6.0
#tool nuget:?package=CommunityToolkit.Aspire.OllamaSharp&version=9.6.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
CommunityToolkit.Aspire.OllamaSharp library
Registers IOllamaClientApi in the DI container to interact with the Ollama API and optionally supports registering an IChatClient or IEmbeddingGenerator from Microsoft.Extensions.AI.
Getting Started
Prerequisites
- Ollama HTTP(S) endpoint
Install the package
Install the .NET Aspire OllamaSharp library using the following command:
dotnet add package CommunityToolkit.Aspire.OllamaSharp
Example usage
In the Program.cs file of your project, call the AddOllamaClientApi extension method to register the IOllamaClientApi in the DI container. This method takes the connection name as a parameter:
builder.AddOllamaClientApi("ollama");
Then, in your service, inject IOllamaClientApi and use it to interact with the Ollama API:
public class MyService(IOllamaClientApi ollamaClientApi)
{
// ...
}
Integration with Microsoft.Extensions.AI
To use the integration with Microsoft.Extensions.AI, call the AddOllamaSharpChatClient or AddOllamaSharpEmbeddingGenerator extension method in the Program.cs file of your project. These methods take the connection name as a parameter, just as AddOllamaClientApi does, and will register the IOllamaApiClient, as well as the IChatClient or IEmbeddingGenerator in the DI container. The IEmbeddingsGenerator is registered with the generic arguments of <string, Embedding<float>>.
Additional documentation
- https://github.com/awaescher/OllamaSharp
- https://learn.microsoft.com/dotnet/aspire/community-toolkit/ollama
- https://devblogs.microsoft.com/dotnet/introducing-microsoft-extensions-ai-preview/
Feedback & contributing
| Product | Versions 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 is compatible. 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. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- Microsoft.Extensions.AI (>= 9.5.0)
- Microsoft.Extensions.Configuration.Binder (>= 9.0.4)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 9.0.4)
- Microsoft.Extensions.Hosting.Abstractions (>= 9.0.4)
- Microsoft.Extensions.Http (>= 9.0.4)
- OllamaSharp (>= 5.1.12)
-
net9.0
- Microsoft.Extensions.AI (>= 9.5.0)
- Microsoft.Extensions.Configuration.Binder (>= 9.0.4)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 9.0.4)
- Microsoft.Extensions.Hosting.Abstractions (>= 9.0.4)
- Microsoft.Extensions.Http (>= 9.0.4)
- OllamaSharp (>= 5.1.12)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories (3)
Showing the top 3 popular GitHub repositories that depend on CommunityToolkit.Aspire.OllamaSharp:
| Repository | Stars |
|---|---|
|
dotnet/eShop
A reference .NET application implementing an eCommerce site
|
|
|
foxminchan/BookWorm
The practical implementation of .NET Aspire using Microservices
|
|
|
davidfowl/aspire-ai-chat-demo
Aspire AI Chat is a full-stack chat sample that combines modern technologies to deliver a ChatGPT-like experience.
|
| Version | Downloads | Last Updated |
|---|---|---|
| 9.6.0 | 119 | 7/10/2025 |
| 9.6.0-beta.324 | 96 | 7/10/2025 |
| 9.5.1-beta.323 | 91 | 7/10/2025 |
| 9.5.1-beta.322 | 96 | 7/10/2025 |
| 9.5.1-beta.321 | 97 | 7/10/2025 |
| 9.5.1-beta.320 | 115 | 7/9/2025 |
| 9.5.1-beta.319 | 102 | 7/8/2025 |
| 9.5.1-beta.318 | 143 | 7/2/2025 |
| 9.5.1-beta.317 | 107 | 6/30/2025 |
| 9.5.1-beta.315 | 127 | 6/26/2025 |
| 9.5.1-beta.314 | 168 | 6/23/2025 |
| 9.5.1-beta.313 | 139 | 6/20/2025 |
| 9.5.1-beta.312 | 109 | 6/20/2025 |
| 9.5.1-beta.311 | 128 | 6/18/2025 |
| 9.5.1-beta.310 | 114 | 6/17/2025 |
| 9.5.1-beta.309 | 105 | 6/17/2025 |
| 9.5.1-beta.308 | 110 | 6/17/2025 |
| 9.5.1-beta.307 | 114 | 6/16/2025 |
| 9.5.1-beta.306 | 302 | 6/11/2025 |
| 9.5.1-beta.305 | 186 | 6/7/2025 |
| 9.5.1-beta.304 | 130 | 6/6/2025 |
| 9.5.1-beta.303 | 140 | 6/4/2025 |
| 9.5.1-beta.302 | 115 | 6/4/2025 |
| 9.5.1-beta.301 | 128 | 6/2/2025 |
| 9.5.1-beta.300 | 226 | 5/28/2025 |
| 9.5.0 | 3,660 | 5/27/2025 |
| 9.5.0-beta.299 | 117 | 5/27/2025 |
| 9.5.0-beta.298 | 125 | 5/26/2025 |
| 9.5.0-beta.297 | 77 | 5/24/2025 |
| 9.5.0-beta.296 | 69 | 5/24/2025 |
| 9.5.0-beta.295 | 39 | 5/24/2025 |
| 9.4.1-beta.291 | 976 | 5/19/2025 |
| 9.4.1-beta.289 | 5,337 | 5/16/2025 |
| 9.4.1-beta.288 | 193 | 5/16/2025 |
| 9.4.1-beta.287 | 177 | 5/16/2025 |
| 9.4.1-beta.286 | 177 | 5/16/2025 |
| 9.4.1-beta.285 | 216 | 5/14/2025 |
| 9.4.1-beta.284 | 211 | 5/13/2025 |
| 9.4.1-beta.283 | 214 | 5/12/2025 |
| 9.4.1-beta.282 | 414 | 5/7/2025 |
| 9.4.1-beta.280 | 169 | 5/2/2025 |
| 9.4.1-beta.279 | 125 | 5/2/2025 |
| 9.4.1-beta.277 | 728 | 4/23/2025 |
| 9.4.1-beta.276 | 139 | 4/23/2025 |
| 9.4.1-beta.275 | 143 | 4/23/2025 |
| 9.4.1-beta.274 | 134 | 4/23/2025 |
| 9.4.1-beta.273 | 122 | 4/23/2025 |
| 9.4.1-beta.272 | 131 | 4/23/2025 |
| 9.4.1-beta.271 | 129 | 4/23/2025 |
| 9.4.1-beta.270 | 149 | 4/20/2025 |
| 9.4.0-preview.1.250420-0640 | 1,153 | 4/20/2025 |
| 9.4.0-beta.269 | 122 | 4/20/2025 |
| 9.4.0-beta.268 | 135 | 4/20/2025 |
| 9.3.1-beta.267 | 371 | 4/20/2025 |
| 9.3.1-beta.266 | 275 | 4/19/2025 |
| 9.3.1-beta.265 | 438 | 4/15/2025 |
| 9.3.1-beta.264 | 384 | 4/15/2025 |
| 9.3.1-beta.263 | 377 | 4/15/2025 |
| 9.3.1-beta.262 | 384 | 4/15/2025 |
| 9.3.1-beta.260 | 1,142 | 4/10/2025 |
| 9.3.1-beta.259 | 4,316 | 4/8/2025 |
| 9.3.1-beta.258 | 128 | 4/8/2025 |
| 9.3.1-beta.257 | 132 | 4/8/2025 |
| 9.3.1-beta.256 | 133 | 4/8/2025 |
| 9.3.1-beta.255 | 131 | 4/8/2025 |
| 9.3.1-beta.254 | 135 | 4/8/2025 |
| 9.3.1-beta.253 | 186 | 4/1/2025 |
| 9.3.1-beta.252 | 176 | 3/27/2025 |
| 9.3.1-beta.250 | 108 | 3/27/2025 |
| 9.3.1-beta.249 | 109 | 3/27/2025 |
| 9.3.1-beta.248 | 106 | 3/27/2025 |
| 9.3.1-beta.247 | 111 | 3/27/2025 |
| 9.3.1-beta.244 | 466 | 3/25/2025 |
| 9.3.1-beta.242 | 458 | 3/24/2025 |
| 9.3.1-beta.241 | 167 | 3/19/2025 |
| 9.3.0-preview.1.250319-0516 | 1,318 | 3/19/2025 |
| 9.3.0-beta.239 | 125 | 3/19/2025 |
| 9.2.2-beta.237 | 125 | 3/19/2025 |
| 9.2.2-beta.236 | 260 | 3/14/2025 |
| 9.2.2-beta.230 | 130 | 3/13/2025 |
| 9.2.2-beta.229 | 126 | 3/13/2025 |
| 9.2.2-beta.228 | 167 | 3/11/2025 |
| 9.2.2-beta.227 | 135 | 3/11/2025 |
| 9.2.2-beta.226 | 132 | 3/11/2025 |
| 9.2.2-beta.225 | 131 | 3/11/2025 |
| 9.2.2-beta.224 | 126 | 3/11/2025 |
| 9.2.2-beta.223 | 137 | 3/10/2025 |
| 9.2.2-beta.222 | 135 | 3/10/2025 |
| 9.2.2-beta.220 | 131 | 3/9/2025 |
| 9.2.2-beta.218 | 128 | 3/9/2025 |
| 9.2.2-beta.217 | 193 | 3/7/2025 |
| 9.2.2-beta.216 | 172 | 3/7/2025 |
| 9.2.2-beta.215 | 189 | 3/7/2025 |
| 9.2.2-beta.214 | 180 | 3/5/2025 |
| 9.2.2-beta.213 | 170 | 3/5/2025 |
| 9.2.2-beta.212 | 167 | 3/5/2025 |
| 9.2.2-beta.211 | 177 | 3/4/2025 |
| 9.2.2-beta.210 | 177 | 3/4/2025 |
| 9.2.2-beta.208 | 71 | 3/3/2025 |
| 9.2.1-preview.1.250303-0329 | 796 | 3/3/2025 |
| 9.2.1-beta.207 | 359 | 3/2/2025 |
| 9.2.1-beta.206 | 63 | 3/1/2025 |
| 9.2.1-beta.205 | 81 | 2/27/2025 |
| 9.2.1-beta.204 | 68 | 2/26/2025 |
| 9.2.1-beta.203 | 58 | 2/26/2025 |
| 9.2.0-preview.1.250226-0510 | 7,754 | 2/26/2025 |
| 9.2.0-beta.202 | 52 | 2/26/2025 |
| 9.2.0-beta.201 | 66 | 2/26/2025 |
| 9.2.0-beta.199 | 64 | 2/26/2025 |
| 9.2.0-beta.198 | 53 | 2/26/2025 |
| 9.1.1-beta.197 | 101 | 2/25/2025 |
| 9.1.1-beta.196 | 70 | 2/25/2025 |
| 9.1.1-beta.195 | 69 | 2/25/2025 |
| 9.1.1-beta.194 | 68 | 2/25/2025 |
| 9.1.1-beta.193 | 69 | 2/25/2025 |
| 9.1.1-beta.192 | 65 | 2/24/2025 |
| 9.1.1-beta.191 | 74 | 2/24/2025 |
| 9.1.1-beta.190 | 705 | 2/19/2025 |
| 9.1.1-beta.189 | 68 | 2/19/2025 |
| 9.1.1-beta.188 | 63 | 2/19/2025 |
| 9.1.1-beta.187 | 80 | 2/19/2025 |
| 9.1.1-beta.183 | 96 | 2/18/2025 |
| 9.1.1-beta.182 | 74 | 2/18/2025 |
| 9.1.1-beta.181 | 81 | 2/18/2025 |
| 9.1.1-beta.180 | 78 | 2/17/2025 |
| 9.1.1-beta.178 | 254 | 2/17/2025 |
| 9.1.1-beta.177 | 184 | 2/12/2025 |
| 9.1.1-beta.176 | 118 | 2/11/2025 |
| 9.1.1-beta.175 | 71 | 2/11/2025 |
| 9.1.1-beta.173 | 241 | 2/10/2025 |
| 9.1.1-beta.169 | 121 | 2/6/2025 |
| 9.1.1-beta.168 | 71 | 2/5/2025 |
| 9.1.1-beta.166 | 87 | 2/5/2025 |
| 9.1.1-beta.165 | 64 | 2/5/2025 |
| 9.1.1-beta.164 | 76 | 2/3/2025 |
| 9.1.1-beta.162 | 77 | 2/3/2025 |
| 9.1.1-beta.155 | 160 | 1/30/2025 |
| 9.1.1-beta.154 | 63 | 1/30/2025 |
| 9.1.1-beta.153 | 56 | 1/30/2025 |
| 9.1.1-beta.152 | 50 | 1/29/2025 |
| 9.1.1-beta.150 | 75 | 1/29/2025 |
| 9.1.1-beta.148 | 78 | 1/26/2025 |
| 9.1.1-beta.147 | 63 | 1/26/2025 |
| 9.1.1-beta.146 | 71 | 1/23/2025 |
| 9.1.1-beta.145 | 60 | 1/22/2025 |
| 9.1.1-beta.144 | 54 | 1/22/2025 |
| 9.1.1-beta.142 | 59 | 1/22/2025 |
| 9.1.1-beta.140 | 70 | 1/22/2025 |
| 9.1.1-beta.139 | 70 | 1/21/2025 |
| 9.1.1-beta.138 | 62 | 1/20/2025 |
| 9.1.1-beta.137 | 72 | 1/17/2025 |
| 9.1.1-beta.136 | 57 | 1/15/2025 |
| 9.1.1-beta.135 | 32 | 1/15/2025 |
| 9.1.1-beta.134 | 34 | 1/15/2025 |
| 9.1.1-beta.128 | 56 | 1/9/2025 |
| 9.1.1-beta.127 | 50 | 1/9/2025 |
| 9.1.1-beta.126 | 51 | 1/9/2025 |
| 9.1.1-beta.125 | 60 | 1/9/2025 |
| 9.1.1-beta.124 | 54 | 1/9/2025 |
| 9.1.0 | 19,728 | 12/12/2024 |
| 9.1.0-beta.123 | 74 | 1/3/2025 |
| 9.1.0-beta.122 | 72 | 1/3/2025 |
| 9.1.0-beta.121 | 72 | 1/2/2025 |
| 9.1.0-beta.120 | 66 | 12/30/2024 |
| 9.1.0-beta.119 | 59 | 12/30/2024 |
| 9.1.0-beta.118 | 65 | 12/30/2024 |
| 9.1.0-beta.116 | 66 | 12/30/2024 |
| 9.1.0-beta.114 | 67 | 12/30/2024 |
| 9.1.0-beta.113 | 61 | 12/30/2024 |
| 9.1.0-beta.112 | 71 | 12/18/2024 |
| 9.1.0-beta.110 | 67 | 12/16/2024 |
| 9.1.0-beta.109 | 68 | 12/12/2024 |
| 9.0.1-beta.108 | 70 | 12/12/2024 |
| 9.0.1-beta.107 | 58 | 12/11/2024 |
| 9.0.1-beta.106 | 64 | 12/12/2024 |
| 9.0.1-beta.104 | 70 | 12/11/2024 |
| 9.0.1-beta.102 | 127 | 12/6/2024 |
| 9.0.1-beta.99 | 64 | 12/6/2024 |
| 9.0.1-beta.98 | 60 | 12/6/2024 |
| 9.0.1-beta.95 | 65 | 12/5/2024 |
| 9.0.1-beta.94 | 61 | 12/5/2024 |
| 9.0.1-beta.93 | 63 | 12/2/2024 |
| 9.0.1-beta.92 | 75 | 11/30/2024 |
| 9.0.1-beta.91 | 57 | 11/30/2024 |
| 9.0.1-beta.90 | 71 | 11/29/2024 |
| 9.0.1-beta.89 | 68 | 11/29/2024 |
| 9.0.1-beta.88 | 66 | 11/27/2024 |
| 9.0.1-beta.87 | 70 | 11/27/2024 |
| 9.0.1-beta.86 | 66 | 11/27/2024 |
| 9.0.1-beta.84 | 95 | 11/24/2024 |
| 9.0.1-beta.83 | 84 | 11/22/2024 |
| 9.0.1-beta.82 | 74 | 11/21/2024 |
| 9.0.1-beta.81 | 72 | 11/19/2024 |
| 9.0.1-beta.80 | 58 | 11/19/2024 |
| 9.0.1-beta.79 | 61 | 11/19/2024 |
| 9.0.1-beta.77 | 82 | 11/15/2024 |
| 9.0.0 | 602 | 11/15/2024 |
| 9.0.0-beta.76 | 67 | 11/14/2024 |
| 9.0.0-beta.75 | 61 | 11/14/2024 |
| 9.0.0-beta.74 | 55 | 11/14/2024 |
| 9.0.0-beta.73 | 71 | 11/14/2024 |
| 9.0.0-beta.72 | 69 | 11/14/2024 |
| 9.0.0-beta.71 | 67 | 11/13/2024 |
| 9.0.0-beta.70 | 70 | 11/13/2024 |
| 9.0.0-beta.69 | 85 | 11/13/2024 |
| 9.0.0-beta.68 | 65 | 11/13/2024 |
| 9.0.0-beta.67 | 65 | 11/13/2024 |
| 9.0.0-beta.66 | 78 | 11/13/2024 |
| 9.0.0-beta.63 | 77 | 11/12/2024 |
| 9.0.0-beta.54 | 76 | 10/31/2024 |
| 9.0.0-beta.53 | 62 | 10/29/2024 |
| 8.3.0 | 304 | 10/29/2024 |
| 8.3.0-beta.51 | 61 | 10/29/2024 |
| 8.3.0-beta.50 | 75 | 10/28/2024 |
| 8.3.0-beta.49 | 68 | 10/28/2024 |
| 8.3.0-beta.48 | 59 | 10/28/2024 |
| 8.3.0-beta.47 | 76 | 10/28/2024 |
| 8.3.0-beta.46 | 65 | 10/27/2024 |
| 8.3.0-beta.45 | 70 | 10/25/2024 |
| 8.3.0-beta.44 | 59 | 10/25/2024 |
| 8.3.0-beta.43 | 64 | 10/25/2024 |
| 8.3.0-beta.42 | 74 | 10/24/2024 |
| 8.2.1 | 1,041 | 10/23/2024 |
| 8.2.1-beta.40 | 59 | 10/23/2024 |
| 8.2.1-beta.39 | 61 | 10/23/2024 |
| 8.2.1-beta.38 | 69 | 10/23/2024 |
| 8.2.1-beta.37 | 66 | 10/23/2024 |
| 8.2.1-beta.36 | 69 | 10/23/2024 |
| 8.2.1-beta.35 | 86 | 10/23/2024 |
| 8.2.0-beta.34 | 71 | 10/23/2024 |
| 8.2.0-beta.33 | 68 | 10/23/2024 |
| 8.2.0-beta.32 | 61 | 10/22/2024 |
| 1.0.0-beta.60 | 73 | 11/11/2024 |
| 1.0.0-beta.58 | 71 | 11/4/2024 |
| 1.0.0-beta.57 | 69 | 11/1/2024 |
| 1.0.0-beta.56 | 63 | 11/1/2024 |
| 1.0.0-beta.55 | 65 | 11/1/2024 |