Shiny.AiConversation.GithubCopilot 3.0.0

Shiny.AiConversation

Session-based AI conversations for .NET apps on top of Microsoft.Extensions.AI: streamed replies, typed questions, persisted and resumable sessions, and token/context tracking.

v3 is a session-based rewrite (breaking: IAiConversationService, IMessageStore and IContextProvider are gone). The core package no longer depends on Shiny.Speech or Shiny.Audio; voice lives in Shiny.AiConversation.Voice, the chat UI in Shiny.AiConversation.Maui.

Features

• Sessions — IAiSessionManager starts, resumes (Get / GetLatest), queries and deletes sessions. Sessions never end; they're persisted and can be picked up again at any time
• Streaming turns — session.Send(...) returns an IAiTurn whose events stream text as it arrives; a new Send supersedes the active turn
• Typed questions — the model calls the built-in ask_user tool when it needs an answer; the session moves to AwaitingUser with PendingQuestions (optionally with multiple-choice AiChoices). A reply that ends in ? still keeps the conversation open
• Interruption — turn.Interrupt(spokenText) records what the user actually heard, and the model is told the reply was cut off
• Usage & context — cumulative SessionUsage for billing and a ContextSnapshot for how full the context window is, with Normal / Warning / Critical pressure for the UI to act on
• Interceptors — ISessionInterceptor adds tools and system prompts per session (OnSessionLoaded) or per turn (OnBeforeTurn), optionally by Profile
• Honest persistence — the user message is stored before the model is called and the reply is stored as streaming then finalized, so failures and crashes leave an accurate record. Tool calls are persisted too
• One event stream — session.GetEvents() is an IAsyncEnumerable that starts with a Snapshot, so a UI binds to one ordered stream
• Compaction — sessions never end, so older messages are folded into a rolling summary: on demand with session.Compact(), or automatically as a safety net near the context limit. A failed summary degrades to a hard trim, never a failed turn
• Assistant memory — a silent memory tool lets the AI keep notes across conversations (session, profile or global scope) without reading them aloud. Only an index goes into each prompt, limits are fed back to the model, and manager.Memory lets the user see, edit and delete everything. On by default
• Conversation search — opt-in search_conversations / read_conversation tools find things in past (and compacted) conversations; plus optional session titles and long-term memory from recent sessions' summaries
• SQLite persistence — Shiny.AiConversation.Stores.SqliteDocDb stores sessions, messages and memory with database-checked concurrency and full-text search
• Voice — Shiny.AiConversation.Voice drives a session by voice: push-to-talk, optional wake word, follow-up answers without the wake word, interruption (quiet words or full barge-in) and sentence-by-sentence text-to-speech that starts before the reply is finished. Works with any Shiny.Speech provider
• MAUI chat UI — AiChatView binds a ChatView to a session: streamed bubbles, choice chips, history paging, photos, a push-to-talk action and context warnings; AiMemoryView shows (and edits) what the assistant remembers
• Images & camera — AiInput.WithImage(...) sends photos (stored as attachments, never inline); Shiny.AiConversation.Maui.Camera lets the assistant ask to use the camera (photo, or text/barcode/document scans) after asking the user

Quick Start

// Register an IChatClient in DI (from any Microsoft.Extensions.AI-compatible provider)
builder.Services.AddChatClient(new OpenAIClient("your-api-key").GetChatClient("gpt-4o").AsIChatClient());

builder.Services.AddShinyAiConversation(opts =>
{
    opts.SetSqliteDocDbStores(Path.Combine(FileSystem.AppDataDirectory, "ai.db"));   // default: in-memory
    opts.AddInterceptor<MyInterceptor>();                       // optional: tools + prompts
    opts.AddTool(AIFunctionFactory.Create(GetWeather), AiToolFlags.None);
    opts.AddSessionTitles();                                    // optional built-ins
    opts.AddConversationSearch();
    opts.AddLongTermMemory();
    // opts.ConfigureMemory(m => m with { Enabled = false });   // memory is on by default
});

// Voice (register your Shiny.Speech providers yourself, e.g. AddSpeechServices() or a cloud provider)
builder.Services.AddShinyAiConversationVoice(voice => voice.AddVoiceSelectionTools());

// MAUI: let the assistant use the camera (needs .UseShinyCamera() on the app builder)
builder.Services.AddAiConversationCamera();

Chat client providers

// Ready-made static OpenAI-compatible provider (Shiny.AiConversation.OpenAi)
opts.AddStaticOpenAIChatClient(apiToken: "your-api-key", endpointUri: "https://api.openai.com/v1", modelName: "gpt-4o");

// MAUI GitHub Copilot — self-contained device-code OAuth, tokens in SecureStorage (Shiny.AiConversation.Maui.GithubCopilot)
opts.AddGithubCopilotChatClient();

For other backends, implement IChatClientProvider and register with opts.SetChatClientProvider<MyProvider>(). Set ContextWindow on the provider (or AiSessionSettings.ContextWindow) to get context pressure.

Talk to the AI

public class ChatViewModel(IAiSessionManager sessions)
{
    IAiSession? session;

    public async Task Send(string text)
    {
        this.session ??= await sessions.GetLatest() ?? await sessions.Start();

        var turn = this.session.Send(AiInput.Text(text));
        await foreach (var e in turn.Events)
        {
            if (e is TextDelta delta)
                AppendToBubble(delta.Text);
        }

        var result = await turn.Completion;   // never throws; check result.Outcome
        if (result.Outcome == AiTurnOutcome.AwaitingUser)
            ShowChoices(this.session.PendingQuestions);
    }

    // a tapped choice goes back as a normal message
    public void Answer(AiQuestion question, AiChoice choice)
        => this.session!.Send(AiInput.Answer(question, choice.Id));
}

A UI that wants everything (both sides of the conversation, state, usage, errors) subscribes once:

await foreach (var e in session.GetEvents(ct))   // first item is always a Snapshot
{
    switch (e)
    {
        case MessageAdded m: ...; break;
        case TurnEventOccurred { Event: TextDelta d }: ...; break;
        case StateChanged s: ...; break;
        case ContextPressureChanged p: ...; break;  // e.g. "this conversation is getting long"
    }
}

API Overview

Dependencies

Documentation

Full documentation: https://shinylib.net/aiconversation/