AugusteVN.Ollama.Client 1.1.1

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.

Some links to get you started:

• Local setup video
• Implementation video
• Official API Docs

Configuration

Program.cs

builder.Services.AddOllamaHttpClient(builder.Configuration);

// --- Or --- //

builder.Services
    .AddOptions<OllamaClientConfig>()
    .BindConfiguration(nameof(OllamaClientConfig));

builder.Services.AddHttpClient(); // Registers the IHttpClientFactory
builder.Services.AddScoped<IOllamaHttpClient, OllamaHttpClient>();

// Or
builder.Services.AddHttpClient<IOllamaHttpClient, 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 Embedding

class Example(OllamaHttpClient ollamaClient)
{
    public async Task EmbedAsync()
    {
        var result = await OllamaHttpClient.EmbedAsync(
            new OllamaEmbedRequest
            {
                Model = "llama3.1",
                Input = [
                    "Document this C# method as XML comment format: ```csharp ...```",
                    "More text to embed"
                ]
            }, hostUrl: "http://localhost:11434"));
        
        Console.WriteLine(result.Embeddings);
    }
}

Generate Model Response

class Example(OllamaHttpClient ollamaClient)
{
    public async Task GenerateAsync()
    {
        await foreach (var stream in OllamaHttpClient.GenerateAsync(
            new OllamaGenerateRequest
            {
                Model = "llama3.1",
                Stream = false,
                Prompt = "Document this C# method as XML comment format: ```csharp ...```"
            }, hostUrl: "http://localhost:11434"))
        {
            Console.WriteLine(stream.Response);
        }
    }
}

Chat with Model

class Example(OllamaHttpClient ollamaClient)
{
    public async Task ChatAsync()
    {
        await foreach (var stream in OllamaHttpClient.ChatAsync(
            new OllamaChatRequest
            {
                Messages = new []{ new OllamaChatMessageRequest {
                    Content = "C# pass Http completion option to PostAsJsonAsync" }
                },
                Model = "llama3.1",
                Stream = true
            }, hostUrl: "http://localhost:11434"))
        {
            Console.WriteLine(stream.Message.Content);
        }
    }
}

Find a more complete client package: OllamaSharp

Get the original code of my package, here:

• kiss-code.com
• Patreon