.NET: Foundry Agents V2 - Add CodeInterpreter Sample (#2180)

* Adding Code Interpreter sample and AgentName naming validation * Add agent name check UT * Improve sample code * Apply suggestion * Apply suggestion
2026-06-16 21:04:09 +08:00 · 2025-11-13 15:23:51 +00:00
parent eb2d573f03
commit 59d08ad29e
6 changed files with 457 additions and 15 deletions
@@ -0,0 +1,22 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net9.0</TargetFramework>
+
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <NoWarn>$(NoWarn);CA1812</NoWarn>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Logging.Console" />
+    <PackageReference Include="Azure.Identity" />
+    <PackageReference Include="Azure.AI.Agents" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.AzureAI\Microsoft.Agents.AI.AzureAI.csproj" />
+  </ItemGroup>
+  
+</Project>
@@ -0,0 +1,89 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+// This sample shows how to use Code Interpreter Tool with AI Agents.
+
+using System.Text;
+using Azure.AI.Agents;
+using Azure.Identity;
+using Microsoft.Agents.AI;
+using Microsoft.Extensions.AI;
+using OpenAI.Assistants;
+using OpenAI.Responses;
+
+string endpoint = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_PROJECT_ENDPOINT") ?? throw new InvalidOperationException("AZURE_FOUNDRY_PROJECT_ENDPOINT is not set.");
+string deploymentName = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_PROJECT_DEPLOYMENT_NAME") ?? "gpt-4o-mini";
+
+const string AgentInstructions = "You are a personal math tutor. When asked a math question, write and run code using the python tool to answer the question.";
+const string AgentNameMEAI = "CoderAgent-MEAI";
+const string AgentNameNative = "CoderAgent-NATIVE";
+
+// Get a client to create/retrieve/delete server side agents with Azure Foundry Agents.
+AgentClient agentClient = new(new Uri(endpoint), new AzureCliCredential());
+
+// Option 1 - Using HostedCodeInterpreterTool + AgentOptions (MEAI + AgentFramework)
+// Create the server side agent version
+AIAgent agentOption1 = await agentClient.CreateAIAgentAsync(
+    model: deploymentName,
+    name: AgentNameMEAI,
+    instructions: AgentInstructions,
+    tools: [new HostedCodeInterpreterTool() { Inputs = [] }]);
+
+// Option 2 - Using PromptAgentDefinition SDK native type
+// Create the server side agent version
+AIAgent agentOption2 = await agentClient.CreateAIAgentAsync(
+    name: AgentNameNative,
+    creationOptions: new AgentVersionCreationOptions(
+        new PromptAgentDefinition(model: deploymentName)
+        {
+            Instructions = AgentInstructions,
+            Tools = {
+                ResponseTool.CreateCodeInterpreterTool(
+                    new CodeInterpreterToolContainer(
+                        CodeInterpreterToolContainerConfiguration.CreateAutomaticContainerConfiguration(fileIds: [])
+                    )
+                ),
+            }
+        })
+);
+
+// Either invoke option1 or option2 agent, should have same result
+// Option 1
+AgentRunResponse response = await agentOption1.RunAsync("I need to solve the equation sin(x) + x^2 = 42");
+
+// Option 2
+// AgentRunResponse response = await agentOption2.RunAsync("I need to solve the equation sin(x) + x^2 = 42");
+
+// Get the CodeInterpreterToolCallContent
+CodeInterpreterToolCallContent? toolCallContent = response.Messages.SelectMany(m => m.Contents).OfType<CodeInterpreterToolCallContent>().SingleOrDefault();
+if (toolCallContent?.Inputs is not null)
+{
+    DataContent? codeInput = toolCallContent.Inputs.OfType<DataContent>().FirstOrDefault();
+    if (codeInput?.HasTopLevelMediaType("text") ?? false)
+    {
+        Console.WriteLine($"Code Input: {Encoding.UTF8.GetString(codeInput.Data.ToArray()) ?? "Not available"}");
+    }
+}
+
+// Get the CodeInterpreterToolResultContent
+CodeInterpreterToolResultContent? toolResultContent = response.Messages.SelectMany(m => m.Contents).OfType<CodeInterpreterToolResultContent>().FirstOrDefault();
+if (toolResultContent?.Outputs is not null && toolResultContent.Outputs.OfType<TextContent>().FirstOrDefault() is { } resultOutput)
+{
+    Console.WriteLine($"Code Tool Result: {resultOutput.Text}");
+}
+
+// Getting any annotations generated by the tool
+foreach (AIAnnotation annotation in response.Messages.SelectMany(m => m.Contents).SelectMany(C => C.Annotations ?? []))
+{
+    if (annotation.RawRepresentation is TextAnnotationUpdate citationAnnotation)
+    {
+        Console.WriteLine($$"""
+            File Id: {{citationAnnotation.OutputFileId}}
+            Text to Replace: {{citationAnnotation.TextToReplace}}
+            Filename: {{Path.GetFileName(citationAnnotation.TextToReplace)}}
+            """);
+    }
+}
+
+// Cleanup by agent name removes the agent version created.
+await agentClient.DeleteAgentAsync(agentOption1.Name);
+await agentClient.DeleteAgentAsync(agentOption2.Name);
@@ -0,0 +1,53 @@
+# Using Code Interpreter with AI Agents
+
+This sample demonstrates how to use the code interpreter tool with AI agents. The code interpreter allows agents to write and execute Python code to solve problems, perform calculations, and analyze data.
+
+## What this sample demonstrates
+
+- Creating agents with code interpreter capabilities
+- Using HostedCodeInterpreterTool (MEAI abstraction)
+- Using native SDK code interpreter tools (ResponseTool.CreateCodeInterpreterTool)
+- Extracting code inputs and results from agent responses
+- Handling code interpreter annotations
+- Managing agent lifecycle (creation and deletion)
+
+## Prerequisites
+
+Before you begin, ensure you have the following prerequisites:
+
+- .NET 8.0 SDK or later
+- Azure Foundry service endpoint and deployment configured
+- Azure CLI installed and authenticated (for Azure credential authentication)
+
+**Note**: This demo uses Azure CLI credentials for authentication. Make sure you're logged in with `az login` and have access to the Azure Foundry resource. For more information, see the [Azure CLI documentation](https://learn.microsoft.com/cli/azure/authenticate-azure-cli-interactively).
+
+Set the following environment variables:
+
+```powershell
+$env:AZURE_FOUNDRY_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project" # Replace with your Azure Foundry resource endpoint
+$env:AZURE_FOUNDRY_PROJECT_DEPLOYMENT_NAME="gpt-4o-mini"  # Optional, defaults to gpt-4o-mini
+```
+
+## Run the sample
+
+Navigate to the FoundryAgents sample directory and run:
+
+```powershell
+cd dotnet/samples/GettingStarted/FoundryAgents
+dotnet run --project .\FoundryAgents_Step14_CodeInterpreter
+```
+
+## Expected behavior
+
+The sample will:
+
+1. Create two agents with code interpreter capabilities:
+   - Option 1: Using HostedCodeInterpreterTool (MEAI abstraction)
+   - Option 2: Using native SDK code interpreter tools
+2. Run the agent with a mathematical problem: "I need to solve the equation sin(x) + x^2 = 42"
+3. The agent will use the code interpreter to write and execute Python code to solve the equation
+4. Extract and display the code that was executed
+5. Display the results from the code execution
+6. Display any annotations generated by the code interpreter tool
+7. Clean up resources by deleting both agents
+