Update .NET Copilot SDK cookbook for current SDK releases (#3548)

* Update .NET Copilot SDK cookbook: fix On<T> breaking change, add in-process runtime, tool search, and message provenance recipes - Fix breaking change: Session.On is now generic (On<T> where T : SessionEvent). Updated all recipes that used the old non-generic session.On(evt => ...) pattern: error-handling, pr-visualization, managing-local-files, accessibility-report, ralph-loop (both .md and .cs where applicable). - Add new 'In-Process Runtime' recipe (in-process-runtime.md + recipe/in-process-runtime.cs) demonstrating RuntimeConnection.ForInProcess(), live-tested. - Document tool search / deferred loading (SessionConfig.ToolSearch / ToolSearchConfig) in pr-visualization.md, live-tested. - Document typed message provenance (MessageOptions.Source / MessageSource) in error-handling.md, live-tested. - Fix dotnet/README.md recipe index: it was missing Ralph Loop and Accessibility Report entries; also added the new In-Process Runtime entry. - Add In-Process Runtime entry to the top-level cookbook/copilot-sdk/README.md .NET section. - Update dotnet/recipe/README.md runnable-examples table with the new recipe. All existing .NET cookbook recipes were rebuilt and rechecked against the current GitHub Copilot SDK (Copilot CLI 1.0.85); no other breaking changes were found. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update cookbook model names to current supported models - Replace stale/nonexistent model IDs (gpt-5, claude-sonnet-4.5, claude-opus-4.6, gpt-5.1-codex-mini) with current values from the supported AI models list - Prefer Model = "auto" wherever a specific model isn't load-bearing to the recipe's teaching point - ralph-loop: pin gpt-5.3-codex (current codex-family GA model), since a dedicated coding model is a deliberate, documented choice for the autonomous loop - multiple-sessions: reshape the model narrative so it demonstrates a real explicit-override use case (A/B testing via claude-sonnet-5) instead of two sessions sharing the same hardcoded model Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Use SendAndWaitAsync in in-process runtime recipe Replace the event-based TaskCompletionSource pattern with SendAndWaitAsync so the example waits for the final assistant response, propagates session errors, and uses the SDK timeout behavior. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-09-22 22:30:49 +00:00 · 2026-09-22 00:15:06 +00:00
parent d67204825b
commit a19b3101cc
19 changed files with 255 additions and 38 deletions
@@ -26,6 +26,7 @@ dotnet run <filename>.cs
 | Persisting Sessions  | `dotnet run persisting-sessions.cs`  | Save and resume sessions across restarts   |
 | Accessibility Report ℹ️ | `dotnet run accessibility-report.cs` | Analyzes web page accessibility            |
 | Ralph Loop ⚠️         | `dotnet run ralph-loop.cs`           | Autonomous development loop                |
+| In-Process Runtime   | `dotnet run in-process-runtime.cs`  | Runs the Copilot runtime in-process         |

 ### Examples with Arguments

@@ -31,7 +31,7 @@ Console.WriteLine("Please wait...\n");
 // Create a session with Playwright MCP server
 await using var session = await client.CreateSessionAsync(new SessionConfig
 {
-  Model = "claude-opus-4.6",
+  Model = "auto",
  Streaming = true,
  OnPermissionRequest = PermissionHandler.ApproveAll,
  McpServers = new Dictionary<string, McpServerConfig>()
@@ -49,7 +49,7 @@ await using var session = await client.CreateSessionAsync(new SessionConfig
 // Wait for response using session.idle event
 var done = new TaskCompletionSource();

-session.On(evt =>
+session.On<SessionEvent>(evt =>
 {
  switch (evt)
  {
@@ -11,12 +11,12 @@ try
    await client.StartAsync();
    var session = await client.CreateSessionAsync(new SessionConfig
    {
-        Model = "gpt-5",
+        Model = "auto",
        OnPermissionRequest = PermissionHandler.ApproveAll
    });

    var done = new TaskCompletionSource<string>();
-    session.On(evt =>
+    session.On<SessionEvent>(evt =>
    {
        if (evt is AssistantMessageEvent msg)
        {
@@ -0,0 +1,38 @@
+#:package GitHub.Copilot.SDK@*
+#:property PublishAot=false
+
+// The GitHub.Copilot.SDK package exposes the GitHub.Copilot namespace.
+using GitHub.Copilot;
+
+// RuntimeConnection.ForInProcess() is an experimental API (diagnostic GHCP001):
+// it loads the native Copilot runtime directly into this process instead of
+// launching a separate Copilot CLI process.
+#pragma warning disable GHCP001
+
+var client = new CopilotClient(new CopilotClientOptions
+{
+    Connection = RuntimeConnection.ForInProcess()
+});
+
+try
+{
+    await client.StartAsync();
+
+    var session = await client.CreateSessionAsync(new SessionConfig
+    {
+        Model = "auto",
+        OnPermissionRequest = PermissionHandler.ApproveAll
+    });
+
+    var response = await session.SendAndWaitAsync(
+        new MessageOptions { Prompt = "Hello from the in-process runtime!" });
+    Console.WriteLine(response?.Data.Content);
+
+    await session.DisposeAsync();
+}
+finally
+{
+    // Gracefully stop; the native runtime library itself stays loaded for the
+    // lifetime of the process (see the "Lifecycle behavior" notes in the docs).
+    await client.StopAsync();
+}
@@ -11,14 +11,14 @@ await client.StartAsync();
 // Define tools for file operations
 var session = await client.CreateSessionAsync(new SessionConfig
 {
-    Model = "gpt-5",
+    Model = "auto",
    OnPermissionRequest = PermissionHandler.ApproveAll
 });

 // Wait for completion
 var done = new TaskCompletionSource();

-session.On(evt =>
+session.On<SessionEvent>(evt =>
 {
    switch (evt)
    {
@@ -7,20 +7,22 @@ using GitHub.Copilot;
 await using var client = new CopilotClient();
 await client.StartAsync();

-// Create multiple independent sessions
+// Create multiple independent sessions. Most sessions should let Copilot pick the
+// best model automatically; pin an explicit model only when you have a deliberate
+// reason to (e.g. an A/B comparison, as with session3 here).
 var session1 = await client.CreateSessionAsync(new SessionConfig
 {
-    Model = "gpt-5",
+    Model = "auto",
    OnPermissionRequest = PermissionHandler.ApproveAll
 });
 var session2 = await client.CreateSessionAsync(new SessionConfig
 {
-    Model = "gpt-5",
+    Model = "auto",
    OnPermissionRequest = PermissionHandler.ApproveAll
 });
 var session3 = await client.CreateSessionAsync(new SessionConfig
 {
-    Model = "claude-sonnet-4.5",
+    Model = "claude-sonnet-5",
    OnPermissionRequest = PermissionHandler.ApproveAll
 });

@@ -11,7 +11,7 @@ await client.StartAsync();
 var session = await client.CreateSessionAsync(new SessionConfig
 {
    SessionId = "user-123-conversation",
-    Model = "gpt-5",
+    Model = "auto",
    OnPermissionRequest = PermissionHandler.ApproveAll
 });

@@ -132,7 +132,7 @@ await client.StartAsync();

 var session = await client.CreateSessionAsync(new SessionConfig
 {
-    Model = "gpt-5",
+    Model = "auto",
    OnPermissionRequest = PermissionHandler.ApproveAll,
    SystemMessage = new SystemMessageConfig
    {
@@ -45,7 +45,7 @@ try
        var session = await client.CreateSessionAsync(
            new SessionConfig
            {
-                Model = "gpt-5.1-codex-mini",
+                Model = "gpt-5.3-codex",
                // Pin the agent to the project directory
                WorkingDirectory = Environment.CurrentDirectory,
                // Auto-approve tool calls for unattended operation
@@ -55,7 +55,7 @@ try
        try
        {
            var done = new TaskCompletionSource<string>();
-            session.On(evt =>
+            session.On<SessionEvent>(evt =>
            {
                // Log tool usage for visibility
                if (evt is ToolExecutionStartEvent toolStart)