Update 02-dotnet-agent-framework

- Also updated 01-dotnet-agent-framework for consistency

Author: justinyoo

01-intro-to-ai-agents/code_samples/01-dotnet-agent-framework.cs

@@ -1,6 +1,6 @@
 #!/usr/bin/dotnet run
 
-#:package Microsoft.Extensions.AI@9.*
+#:package Microsoft.Extensions.AI@10.*
 #:package Microsoft.Agents.AI.OpenAI@1.*-*
 
 using System.ClientModel;
@@ -63,8 +63,8 @@ static string GetRandomDestination()
 var openAIClient = new OpenAIClient(new ApiKeyCredential(github_token), openAIOptions);
 
 // Create AI Agent with Travel Planning Capabilities
-// Initialize OpenAI client, get chat client for specified model, and create AI agent
-// Configure agent with travel planning instructions and random destination tool
+// Initialize complete agent pipeline: OpenAI client → Chat client → AI agent
+// Configure agent with name, instructions, and available tools
 // The agent can now plan trips using the GetRandomDestination function
 AIAgent agent = openAIClient
     .GetChatClient(github_model_id)

01-intro-to-ai-agents/code_samples/01-dotnet-agent-framework.md

@@ -2,7 +2,7 @@
 
 ## 📋 Scenario Overview
 
-This notebook demonstrates how to build an intelligent travel planning agent using the Microsoft Agent Framework for .NET. The agent can automatically generate personalized day-trip itineraries for random destinations around the world.
+This example demonstrates how to build an intelligent travel planning agent using the Microsoft Agent Framework for .NET. The agent can automatically generate personalized day-trip itineraries for random destinations around the world.
 
 ### Key Capabilities:
 
@@ -164,4 +164,18 @@ await foreach (var update in agent.RunStreamingAsync("Plan me a day trip"))
     await Task.Delay(10);
     Console.Write(update);
 }
-```
+```
+
+## 🎓 Key Takeaways
+
+1. **Agent Architecture**: The Microsoft Agent Framework provides a clean, type-safe approach to building AI agents in .NET
+2. **Tool Integration**: Functions decorated with `[Description]` attributes become available tools for the agent
+3. **Configuration Management**: Environment variables and secure credential handling follow .NET best practices
+4. **OpenAI Compatibility**: GitHub Models integration works seamlessly through OpenAI-compatible APIs
+
+## 🔗 Additional Resources
+
+- [Microsoft Agent Framework Documentation](https://learn.microsoft.com/agent-framework)
+- [GitHub Models Marketplace](https://github.com/marketplace?type=models)
+- [Microsoft.Extensions.AI](https://learn.microsoft.com/dotnet/ai/microsoft-extensions-ai)
+- [.NET Single File Apps](https://devblogs.microsoft.com/dotnet/announcing-dotnet-run-app)

02-explore-agentic-frameworks/README.md

@@ -739,7 +739,12 @@ The answer is yes, you can integrate your existing Azure ecosystem tools directl
 
 For AutoGen and Semantic Kernel, you can also integrate with Azure services, but it may require you to call the Azure services from your code. Another way to integrate is to use the Azure SDKs to interact with Azure services from your agents. Additionally, like was mentioned, you can use Azure AI Agent Service as an orchestrator for your agents built in AutoGen or Semantic Kernel which would give easy access to the Azure ecosystem.
 
-### Got More Questions about AI Agent Frameworks?
+## Sample Codes
+
+- Python: [Agent Framework](./code_samples/02-python-agent-framework.ipynb)
+- .NET: [Agent Framework](./code_samples/02-dotnet-agent-framework.md)
+
+## Got More Questions about AI Agent Frameworks?
 
 Join the [Azure AI Foundry Discord](https://aka.ms/ai-agents/discord) to meet with other learners, attend office hours and get your AI Agents questions answered.
 

02-explore-agentic-frameworks/code_samples/02-dotnet-agent-framework.cs

@@ -1,124 +1,126 @@
 #!/usr/bin/dotnet run
-#:package Microsoft.Extensions.AI@9.9.1
-#:package Microsoft.Agents.AI.OpenAI@1.0.0-preview.251001.3
-#:package Microsoft.Agents.AI@1.0.0-preview.251001.3
-#:package DotNetEnv@3.1.1
 
-// 📚 Import Essential Namespaces for Agent Development
-using System;
-using System.ComponentModel;
+#:package Microsoft.Extensions.AI@10.*
+#:package Microsoft.Agents.AI.OpenAI@1.*-*
+
 using System.ClientModel;
-using Microsoft.Extensions.AI;
+using System.ComponentModel;
+
 using Microsoft.Agents.AI;
+using Microsoft.Extensions.AI;
+
 using OpenAI;
-using DotNetEnv;
-
-// 🔧 Load Environment Configuration from .env File
-// Load configuration from a .env file located 3 directories up from current location
-// This loads: GITHUB_ENDPOINT, GITHUB_TOKEN, GITHUB_MODEL_ID
-// Ensures secure handling of API credentials and configuration settings
-Env.Load("../../../.env");
-
-// 🎲 Tool Function: Random Destination Generator (.NET Implementation)
-// This static method demonstrates how to create tools for agents in .NET
-// The [Description] attribute helps the AI understand when and how to use this function
-// This showcases the .NET approach to extending agent capabilities with custom tools
+
+// Tool Function: Random Destination Generator
+// This static method will be available to the agent as a callable tool
+// The [Description] attribute helps the AI understand when to use this function
+// This demonstrates how to create custom tools for AI agents
 [Description("Provides a random vacation destination.")]
 static string GetRandomDestination()
 {
-    // Curated list of popular vacation destinations worldwide
-    // The agent will randomly select from these options when users need destination suggestions
+    // List of popular vacation destinations around the world
+    // The agent will randomly select from these options
     var destinations = new List<string>
     {
-        "Paris, France",         // European cultural capital
-        "Tokyo, Japan",          // Asian modern metropolis  
-        "New York City, USA",    // American urban experience
-        "Sydney, Australia",     // Oceanic coastal beauty
-        "Rome, Italy",           // Historical European city
-        "Barcelona, Spain",      // Mediterranean cultural hub
-        "Cape Town, South Africa", // African scenic destination
-        "Rio de Janeiro, Brazil",  // South American beach city
-        "Bangkok, Thailand",        // Southeast Asian cultural center
-        "Vancouver, Canada"         // North American natural beauty
+        "Paris, France",
+        "Tokyo, Japan",
+        "New York City, USA",
+        "Sydney, Australia",
+        "Rome, Italy",
+        "Barcelona, Spain",
+        "Cape Town, South Africa",
+        "Rio de Janeiro, Brazil",
+        "Bangkok, Thailand",
+        "Vancouver, Canada"
     };
 
-    // Generate random index using System.Random and return selected destination
-    // This demonstrates simple random selection in .NET
+    // Generate random index and return selected destination
+    // Uses System.Random for simple random selection
     var random = new Random();
     int index = random.Next(destinations.Count);
     return destinations[index];
 }
 
-// 🔑 Extract and Validate Configuration from Environment Variables
-// Retrieve GitHub Models API endpoint - throws exception if not configured
-var github_endpoint = Environment.GetEnvironmentVariable("GITHUB_ENDPOINT") ?? throw new InvalidOperationException("GITHUB_ENDPOINT is not set.");
-// Get the AI model ID - defaults to gpt-4o-mini if not specified
-var github_model_id = Environment.GetEnvironmentVariable("GITHUB_MODEL_ID") ?? "gpt-4o-mini";
-// Retrieve GitHub authentication token - throws exception if missing
-var github_token = Environment.GetEnvironmentVariable("GITHUB_TOKEN") ?? throw new InvalidOperationException("GITHUB_TOKEN is not set.");
-
-// ⚙️ Configure OpenAI Client Options for GitHub Models Integration
-// Create configuration options to redirect OpenAI client calls to GitHub Models endpoint
-// This enables using OpenAI-compatible APIs with GitHub's model inference service
+// Extract configuration from environment variables
+// Retrieve the GitHub Models API endpoint, defaults to https://models.github.ai/inference if not specified
+// Retrieve the model ID, defaults to openai/gpt-5-mini if not specified
+// Retrieve the GitHub token for authentication, throws exception if not specified
+var github_endpoint = Environment.GetEnvironmentVariable("GH_ENDPOINT") ?? "https://models.github.ai/inference";
+var github_model_id = Environment.GetEnvironmentVariable("GH_MODEL_ID") ?? "openai/gpt-5-mini";
+var github_token = Environment.GetEnvironmentVariable("GH_TOKEN") ?? throw new InvalidOperationException("GH_TOKEN is not set.");
+
+// Configure OpenAI Client Options
+// Create configuration options to point to GitHub Models endpoint
+// This redirects OpenAI client calls to GitHub's model inference service
 var openAIOptions = new OpenAIClientOptions()
 {
-    Endpoint = new Uri(github_endpoint)  // Set custom endpoint for GitHub Models API
+    Endpoint = new Uri(github_endpoint)
 };
 
-// 🔌 Initialize OpenAI Client with GitHub Models Configuration
-// Create OpenAI client instance using GitHub token for authentication
+// Initialize OpenAI Client with GitHub Models Configuration
+// Create OpenAI client using GitHub token for authentication
 // Configure it to use GitHub Models endpoint instead of OpenAI directly
-// This client will handle all communication with the AI model
 var openAIClient = new OpenAIClient(new ApiKeyCredential(github_token), openAIOptions);
 
-// 🤖 Define Agent Identity and Comprehensive Instructions
+// Define Agent Identity and Comprehensive Instructions
 // Agent name for identification and logging purposes
-const string AGENT_NAME = "TravelAgent";
+var AGENT_NAME = "TravelAgent";
 
 // Detailed instructions that define the agent's personality, capabilities, and behavior
 // This system prompt shapes how the agent responds and interacts with users
-const string AGENT_INSTRUCTIONS = @"You are a helpful AI Agent that can help plan vacations for customers.
+var AGENT_INSTRUCTIONS = """
+You are a helpful AI Agent that can help plan vacations for customers.
 
 Important: When users specify a destination, always plan for that location. Only suggest random destinations when the user hasn't specified a preference.
 
 When the conversation begins, introduce yourself with this message:
-""Hello! I'm your TravelAgent assistant. I can help plan vacations and suggest interesting destinations for you. Here are some things you can ask me:
+"Hello! I'm your TravelAgent assistant. I can help plan vacations and suggest interesting destinations for you. Here are some things you can ask me:
 1. Plan a day trip to a specific location
 2. Suggest a random vacation destination
 3. Find destinations with specific features (beaches, mountains, historical sites, etc.)
 4. Plan an alternative trip if you don't like my first suggestion
 
-What kind of trip would you like me to help you plan today?""
+What kind of trip would you like me to help you plan today?"
 
-Always prioritize user preferences. If they mention a specific destination like ""Bali"" or ""Paris,"" focus your planning on that location rather than suggesting alternatives.
-";
+Always prioritize user preferences. If they mention a specific destination like "Bali" or "Paris," focus your planning on that location rather than suggesting alternatives.
+""";
 
-// 🤖 Create AI Agent with Advanced Travel Planning Capabilities
+// Create AI Agent with Advanced Travel Planning Capabilities
 // Initialize complete agent pipeline: OpenAI client → Chat client → AI agent
 // Configure agent with name, detailed instructions, and available tools
 // This demonstrates the .NET agent creation pattern with full configuration
-AIAgent agent = new OpenAIClient(new ApiKeyCredential(github_token), openAIOptions)
-    .GetChatClient(github_model_id)  // Get chat client for the specified AI model
+AIAgent agent = openAIClient
+    .GetChatClient(github_model_id)
     .CreateAIAgent(
-        name: AGENT_NAME,             // Set agent identifier for logging and tracking
-        instructions: AGENT_INSTRUCTIONS,  // Comprehensive behavior and personality instructions
-        tools: [AIFunctionFactory.Create((Func<string>)GetRandomDestination)]  // Register tool functions
+        name: AGENT_NAME,
+        instructions: AGENT_INSTRUCTIONS,
+        tools: [AIFunctionFactory.Create(GetRandomDestination)]
     );
 
-// 🧵 Create New Conversation Thread for Context Management
+// Create New Conversation Thread for Context Management
 // Initialize a new conversation thread to maintain context across multiple interactions
 // Threads enable the agent to remember previous exchanges and maintain conversational state
 // This is essential for multi-turn conversations and contextual understanding
 AgentThread thread = agent.GetNewThread();
 
-// 🚀 Execute Agent: First Travel Planning Request
+// Execute Agent: First Travel Planning Request
 // Run the agent with an initial request that will likely trigger the random destination tool
 // The agent will analyze the request, use the GetRandomDestination tool, and create an itinerary
 // Using the thread parameter maintains conversation context for subsequent interactions
-Console.WriteLine(await agent.RunAsync("Plan me a day trip", thread));
+await foreach (var update in agent.RunStreamingAsync("Plan me a day trip", thread))
+{
+    await Task.Delay(10);
+    Console.Write(update);
+}
 
-// 🔄 Execute Agent: Follow-up Request with Context Awareness
+Console.WriteLine();
+
+// Execute Agent: Follow-up Request with Context Awareness
 // Demonstrate contextual conversation by referencing the previous response
 // The agent remembers the previous destination suggestion and will provide an alternative
 // This showcases the power of conversation threads and contextual understanding in .NET agents
-Console.WriteLine(await agent.RunAsync("I don't like that destination. Plan me another vacation.", thread));
+await foreach (var update in agent.RunStreamingAsync("I don't like that destination. Plan me another vacation.", thread))
+{
+    await Task.Delay(10);
+    Console.Write(update);
+}