AugusteVN.Ollama.Client
1.0.7
dotnet add package AugusteVN.Ollama.Client --version 1.0.7
NuGet\Install-Package AugusteVN.Ollama.Client -Version 1.0.7
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="AugusteVN.Ollama.Client" Version="1.0.7" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AugusteVN.Ollama.Client --version 1.0.7
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: AugusteVN.Ollama.Client, 1.0.7"
#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 AugusteVN.Ollama.Client as a Cake Addin #addin nuget:?package=AugusteVN.Ollama.Client&version=1.0.7 // Install AugusteVN.Ollama.Client as a Cake Tool #tool nuget:?package=AugusteVN.Ollama.Client&version=1.0.7
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Ollama Client
A C# client library for interacting with your Ollama API setup. This package provides simple and easy-to-use APIs for generating model responses, listing local models, ...
Interact with your own Ollama API setup by passing an accessible host URL.
You can use Ngrok to temporarily, publicly expose your local setup.
Configuration
Program.cs
builder.Services.AddOllamaHttpClient(builder.Configuration);
// --- Or --- //
builder
.AddOptions<OllamaClientConfig>()
.BindConfiguration(nameof(OllamaClientConfig));
builder.Services.AddHttpClient(); // Registers the IHttpClientFactory
builder.Services.AddScoped<OllamaHttpClient>();
// Or
builder.Services.AddHttpClient<OllamaHttpClient>(); // Registers the IHttpClientFactory
// Or
var ollamaClient = new OllamaHttpClient(
new HttpClient(),
new OllamaClientConfig { HostUrl = "<optionally-set-here-or-pass-as-param-in-method>" }
);
List Models
class Example(OllamaHttpClient ollamaClient)
{
public async Task ListModelsAsync()
{
var result = await ollamaClient.ListLocalModelsAsync(hostUrl: "http://localhost:11434");
if (!result.IsFailure && result.Value.Models?.Any() == true)
{
Console.WriteLine(result.Value.Models.Select(model => model.Name));
}
}
});
Generate Model Response
class Example(OllamaHttpClient ollamaClient)
{
public async Task GenerateResponseAsync()
{
var result = await ollamaClient.GenerateModelResponseAsync(
new OllamaGenerateRequest
{
Model = "llama3",
Stream = false,
Prompt = "Document this C# method as XML comment format: ```csharp ...```"
}, hostUrl: "http://localhost:11434");
if (!result.IsFailure)
{
Console.WriteLine(result.Value.Response);
}
}
}
Get the original code of my package, here:
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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- AugusteVN.ResultPattern.Contracts (>= 1.0.7)
- Microsoft.Extensions.Http (>= 8.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Add optional config.