mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Merge branch 'main' into a2a-agent-migration
This commit is contained in:
+15
@@ -0,0 +1,15 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<PropertyGroup>
|
||||
<OutputType>Exe</OutputType>
|
||||
<TargetFrameworks>net10.0</TargetFrameworks>
|
||||
|
||||
<Nullable>enable</Nullable>
|
||||
<ImplicitUsings>enable</ImplicitUsings>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.OpenAI\Microsoft.Agents.AI.OpenAI.csproj" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
+89
@@ -0,0 +1,89 @@
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
// This sample shows how to download files generated by Code Interpreter using the Containers API.
|
||||
// Code Interpreter generates files inside containers (cfile_ / cntr_ IDs) which cannot be
|
||||
// downloaded via the standard Files API. Use ContainerClient instead.
|
||||
|
||||
#pragma warning disable OPENAI001
|
||||
|
||||
using System.ClientModel;
|
||||
using Microsoft.Agents.AI;
|
||||
using Microsoft.Extensions.AI;
|
||||
using OpenAI;
|
||||
using OpenAI.Containers;
|
||||
using OpenAI.Responses;
|
||||
|
||||
string apiKey = Environment.GetEnvironmentVariable("OPENAI_API_KEY") ?? throw new InvalidOperationException("OPENAI_API_KEY is not set.");
|
||||
string model = Environment.GetEnvironmentVariable("OPENAI_CHAT_MODEL_NAME") ?? "gpt-4o-mini";
|
||||
|
||||
var openAIClient = new OpenAIClient(new ApiKeyCredential(apiKey));
|
||||
|
||||
// Create an agent with Code Interpreter tool enabled
|
||||
AIAgent agent = openAIClient
|
||||
.GetResponsesClient()
|
||||
.AsAIAgent(
|
||||
model: model,
|
||||
instructions: "You are a helpful assistant that can generate files using code.",
|
||||
name: "CodeInterpreterAgent",
|
||||
tools: [new HostedCodeInterpreterTool()]);
|
||||
|
||||
// Ask the agent to generate a file
|
||||
AgentResponse response = await agent.RunAsync(
|
||||
"Create a CSV file with the multiplication times tables from 1 to 12. Include headers.");
|
||||
|
||||
// Display the text response
|
||||
foreach (TextContent textContent in response.Messages.SelectMany(x => x.Contents).OfType<TextContent>())
|
||||
{
|
||||
Console.WriteLine(textContent.Text);
|
||||
}
|
||||
|
||||
// Extract container file citations from response annotations and download
|
||||
ContainerClient containerClient = openAIClient.GetContainerClient();
|
||||
|
||||
HashSet<string> downloadedFiles = [];
|
||||
bool foundContainerFiles = false;
|
||||
|
||||
foreach (AIContent content in response.Messages.SelectMany(x => x.Contents))
|
||||
{
|
||||
if (content.Annotations is null)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
foreach (AIAnnotation annotation in content.Annotations)
|
||||
{
|
||||
// Container files from Code Interpreter have ContainerFileCitationMessageAnnotation as raw representation
|
||||
if (annotation is CitationAnnotation citation
|
||||
&& citation.RawRepresentation is ContainerFileCitationMessageAnnotation containerCitation)
|
||||
{
|
||||
foundContainerFiles = true;
|
||||
|
||||
// Deduplicate by container+file ID in case the same file is cited multiple times
|
||||
string key = $"{containerCitation.ContainerId}/{containerCitation.FileId}";
|
||||
if (!downloadedFiles.Add(key))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
Console.WriteLine($"\nDownloading container file: {containerCitation.Filename}");
|
||||
Console.WriteLine($" Container ID: {containerCitation.ContainerId}");
|
||||
Console.WriteLine($" File ID: {containerCitation.FileId}");
|
||||
|
||||
BinaryData fileData = await containerClient.DownloadContainerFileAsync(
|
||||
containerCitation.ContainerId,
|
||||
containerCitation.FileId);
|
||||
|
||||
// Sanitize filename to prevent path traversal
|
||||
string safeFilename = Path.GetFileName(containerCitation.Filename);
|
||||
string outputPath = Path.Combine(Directory.GetCurrentDirectory(), safeFilename);
|
||||
await File.WriteAllBytesAsync(outputPath, fileData.ToArray());
|
||||
Console.WriteLine($" Saved to: {outputPath}");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (!foundContainerFiles)
|
||||
{
|
||||
Console.WriteLine("\nNo container file citations found in the response.");
|
||||
Console.WriteLine("The model may not have generated a downloadable file for this prompt.");
|
||||
}
|
||||
+51
@@ -0,0 +1,51 @@
|
||||
# Code Interpreter File Download (OpenAI)
|
||||
|
||||
This sample demonstrates how to download files generated by Code Interpreter when using the OpenAI Responses API.
|
||||
|
||||
## What this sample demonstrates
|
||||
|
||||
- Creating an agent with Code Interpreter tool using `ResponsesClient.AsAIAgent()`
|
||||
- Generating files through Code Interpreter (e.g., CSV, Excel, images)
|
||||
- Extracting container file citations from agent response annotations
|
||||
- Downloading container files using the `ContainerClient` API
|
||||
|
||||
## Container files vs regular files
|
||||
|
||||
When Code Interpreter generates a file, the file is stored inside a **container** with a `cntr_` prefixed ID. The file itself gets a `cfile_` prefixed ID.
|
||||
|
||||
These container files **cannot** be downloaded using the standard Files API (`GetOpenAIFileClient`), which returns 404 for `cfile_` IDs. Instead, you must use the **Containers API** (`GetContainerClient`) to download them:
|
||||
|
||||
```csharp
|
||||
// ❌ This does NOT work for container files
|
||||
var filesClient = openAIClient.GetOpenAIFileClient();
|
||||
await filesClient.DownloadFileAsync("cfile_..."); // Returns 404
|
||||
|
||||
// ✅ Use ContainerClient instead
|
||||
var containerClient = openAIClient.GetContainerClient();
|
||||
await containerClient.DownloadContainerFileAsync("cntr_...", "cfile_...");
|
||||
```
|
||||
|
||||
The container ID and file ID are available from the `ContainerFileCitationMessageAnnotation` annotation in the response, accessible via `CitationAnnotation.RawRepresentation`.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- .NET 10 SDK or later
|
||||
- OpenAI API key with access to a model that supports Code Interpreter
|
||||
|
||||
Set the following environment variables:
|
||||
|
||||
```powershell
|
||||
$env:OPENAI_API_KEY="sk-..."
|
||||
$env:OPENAI_CHAT_MODEL_NAME="gpt-4o-mini" # Optional, defaults to gpt-4o-mini
|
||||
```
|
||||
|
||||
## Run the sample
|
||||
|
||||
```powershell
|
||||
dotnet run
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
- [Code Interpreter File Download with Foundry](../../../02-agents/AgentsWithFoundry/Agent_Step24_CodeInterpreterFileDownload/) — same scenario using Microsoft Foundry
|
||||
- [Code Interpreter](../../../02-agents/AgentsWithFoundry/Agent_Step14_CodeInterpreter/) — Code Interpreter without file download
|
||||
@@ -14,4 +14,5 @@ Agent Framework provides additional support to allow OpenAI developers to use th
|
||||
|[Using Reasoning Capabilities](./Agent_OpenAI_Step02_Reasoning/)|This sample demonstrates how to create an AI agent with reasoning capabilities using OpenAI's reasoning models and response types.|
|
||||
|[Creating an Agent from a ChatClient](./Agent_OpenAI_Step03_CreateFromChatClient/)|This sample demonstrates how to create an AI agent directly from an OpenAI.Chat.ChatClient instance using OpenAIChatClientAgent.|
|
||||
|[Creating an Agent from an OpenAIResponseClient](./Agent_OpenAI_Step04_CreateFromOpenAIResponseClient/)|This sample demonstrates how to create an AI agent directly from an OpenAI.Responses.OpenAIResponseClient instance using OpenAIResponseClientAgent.|
|
||||
|[Managing Conversation State](./Agent_OpenAI_Step05_Conversation/)|This sample demonstrates how to maintain conversation state across multiple turns using the AgentSession for context continuity.|
|
||||
|[Managing Conversation State](./Agent_OpenAI_Step05_Conversation/)|This sample demonstrates how to maintain conversation state across multiple turns using the AgentSession for context continuity.|
|
||||
|[Code Interpreter File Download](./Agent_OpenAI_Step06_CodeInterpreterFileDownload/)|This sample demonstrates how to download files generated by Code Interpreter using the Containers API (`cfile_`/`cntr_` IDs).|
|
||||
+19
@@ -0,0 +1,19 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<PropertyGroup>
|
||||
<OutputType>Exe</OutputType>
|
||||
<TargetFrameworks>net10.0</TargetFrameworks>
|
||||
|
||||
<Nullable>enable</Nullable>
|
||||
<ImplicitUsings>enable</ImplicitUsings>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Azure.Identity" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.Foundry\Microsoft.Agents.AI.Foundry.csproj" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
+91
@@ -0,0 +1,91 @@
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
// This sample shows how to download files generated by Code Interpreter using Microsoft Foundry.
|
||||
// Code Interpreter generates files inside containers (cfile_ / cntr_ IDs) which cannot be
|
||||
// downloaded via the standard Files API. Use ContainerClient from the project's OpenAI client instead.
|
||||
|
||||
#pragma warning disable OPENAI001
|
||||
|
||||
using Azure.AI.Projects;
|
||||
using Azure.Identity;
|
||||
using Microsoft.Agents.AI;
|
||||
using Microsoft.Extensions.AI;
|
||||
using OpenAI.Responses;
|
||||
|
||||
string endpoint = Environment.GetEnvironmentVariable("AZURE_AI_PROJECT_ENDPOINT") ?? throw new InvalidOperationException("AZURE_AI_PROJECT_ENDPOINT is not set.");
|
||||
string deploymentName = Environment.GetEnvironmentVariable("AZURE_AI_MODEL_DEPLOYMENT_NAME") ?? "gpt-4o-mini";
|
||||
|
||||
// WARNING: DefaultAzureCredential is convenient for development but requires careful consideration in production.
|
||||
// In production, consider using a specific credential (e.g., ManagedIdentityCredential) to avoid
|
||||
// latency issues, unintended credential probing, and potential security risks from fallback mechanisms.
|
||||
AIProjectClient aiProjectClient = new(new Uri(endpoint), new DefaultAzureCredential());
|
||||
|
||||
// Create an agent with Code Interpreter tool enabled
|
||||
AIAgent agent = aiProjectClient.AsAIAgent(
|
||||
deploymentName,
|
||||
instructions: "You are a helpful assistant that can generate files using code.",
|
||||
name: "CodeInterpreterAgent",
|
||||
tools: [new HostedCodeInterpreterTool()]);
|
||||
|
||||
// Ask the agent to generate a file
|
||||
AgentResponse response = await agent.RunAsync(
|
||||
"Create a CSV file with the multiplication times tables from 1 to 12. Include headers.");
|
||||
|
||||
// Display the text response
|
||||
foreach (TextContent textContent in response.Messages.SelectMany(x => x.Contents).OfType<TextContent>())
|
||||
{
|
||||
Console.WriteLine(textContent.Text);
|
||||
}
|
||||
|
||||
// Extract container file citations from response annotations and download.
|
||||
// AIProjectClient.GetProjectOpenAIClient() returns a ProjectOpenAIClient (inherits from OpenAI.OpenAIClient)
|
||||
// which supports GetContainerClient(), unlike AzureOpenAIClient which does not.
|
||||
var containerClient = aiProjectClient.GetProjectOpenAIClient().GetContainerClient();
|
||||
|
||||
HashSet<string> downloadedFiles = [];
|
||||
bool foundContainerFiles = false;
|
||||
|
||||
foreach (AIContent content in response.Messages.SelectMany(x => x.Contents))
|
||||
{
|
||||
if (content.Annotations is null)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
foreach (AIAnnotation annotation in content.Annotations)
|
||||
{
|
||||
// Container files from Code Interpreter have ContainerFileCitationMessageAnnotation as raw representation
|
||||
if (annotation is CitationAnnotation citation
|
||||
&& citation.RawRepresentation is ContainerFileCitationMessageAnnotation containerCitation)
|
||||
{
|
||||
foundContainerFiles = true;
|
||||
|
||||
// Deduplicate by container+file ID in case the same file is cited multiple times
|
||||
string key = $"{containerCitation.ContainerId}/{containerCitation.FileId}";
|
||||
if (!downloadedFiles.Add(key))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
Console.WriteLine($"\nDownloading container file: {containerCitation.Filename}");
|
||||
Console.WriteLine($" Container ID: {containerCitation.ContainerId}");
|
||||
Console.WriteLine($" File ID: {containerCitation.FileId}");
|
||||
|
||||
BinaryData fileData = await containerClient.DownloadContainerFileAsync(
|
||||
containerCitation.ContainerId,
|
||||
containerCitation.FileId);
|
||||
|
||||
// Sanitize filename to prevent path traversal
|
||||
string safeFilename = Path.GetFileName(containerCitation.Filename);
|
||||
string outputPath = Path.Combine(Directory.GetCurrentDirectory(), safeFilename);
|
||||
await File.WriteAllBytesAsync(outputPath, fileData.ToArray());
|
||||
Console.WriteLine($" Saved to: {outputPath}");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (!foundContainerFiles)
|
||||
{
|
||||
Console.WriteLine("\nNo container file citations found in the response.");
|
||||
Console.WriteLine("The model may not have generated a downloadable file for this prompt.");
|
||||
}
|
||||
+56
@@ -0,0 +1,56 @@
|
||||
# Code Interpreter File Download (Microsoft Foundry)
|
||||
|
||||
This sample demonstrates how to download files generated by Code Interpreter when using Microsoft Foundry.
|
||||
|
||||
## What this sample demonstrates
|
||||
|
||||
- Creating an agent with Code Interpreter tool using `AIProjectClient.AsAIAgent()`
|
||||
- Generating files through Code Interpreter (e.g., CSV, Excel, images)
|
||||
- Extracting container file citations from agent response annotations
|
||||
- Downloading container files using the `ContainerClient` via `AIProjectClient.GetProjectOpenAIClient()`
|
||||
|
||||
## Container files vs regular files
|
||||
|
||||
When Code Interpreter generates a file, the file is stored inside a **container** with a `cntr_` prefixed ID. The file itself gets a `cfile_` prefixed ID.
|
||||
|
||||
These container files **cannot** be downloaded using the standard Files API (`GetOpenAIFileClient`), which returns 404 for `cfile_` IDs. Instead, you must use the **Containers API** to download them.
|
||||
|
||||
### Getting the ContainerClient with Foundry
|
||||
|
||||
`AzureOpenAIClient.GetContainerClient()` is not supported and throws `InvalidOperationException`. Instead, use the project's OpenAI client which inherits directly from `OpenAI.OpenAIClient`:
|
||||
|
||||
```csharp
|
||||
// ❌ AzureOpenAIClient does not support ContainerClient
|
||||
var azureClient = new AzureOpenAIClient(endpoint, credential);
|
||||
azureClient.GetContainerClient(); // Throws InvalidOperationException
|
||||
|
||||
// ✅ Use AIProjectClient's project OpenAI client
|
||||
var containerClient = aiProjectClient.GetProjectOpenAIClient().GetContainerClient();
|
||||
await containerClient.DownloadContainerFileAsync("cntr_...", "cfile_...");
|
||||
```
|
||||
|
||||
The container ID and file ID are available from the `ContainerFileCitationMessageAnnotation` annotation in the response, accessible via `CitationAnnotation.RawRepresentation`.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- .NET 10 SDK or later
|
||||
- Microsoft Foundry service endpoint and deployment configured
|
||||
- Azure CLI installed and authenticated (`az login`)
|
||||
|
||||
Set the following environment variables:
|
||||
|
||||
```powershell
|
||||
$env:AZURE_AI_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project"
|
||||
$env:AZURE_AI_MODEL_DEPLOYMENT_NAME="gpt-4o-mini" # Optional, defaults to gpt-4o-mini
|
||||
```
|
||||
|
||||
## Run the sample
|
||||
|
||||
```powershell
|
||||
dotnet run
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
- [Code Interpreter File Download with OpenAI](../../../02-agents/AgentWithOpenAI/Agent_OpenAI_Step06_CodeInterpreterFileDownload/) — same scenario using Public OpenAI
|
||||
- [Code Interpreter](../Agent_Step14_CodeInterpreter/) — Code Interpreter without file download
|
||||
@@ -72,6 +72,7 @@ Some samples require extra tool-specific environment variables. See each sample
|
||||
| [Web search](./Agent_Step21_WebSearch/) | Web search tool |
|
||||
| [Memory search](./Agent_Step22_MemorySearch/) | Memory search tool |
|
||||
| [Local MCP](./Agent_Step23_LocalMCP/) | Local MCP client with HTTP transport |
|
||||
| [Code interpreter file download](./Agent_Step24_CodeInterpreterFileDownload/) | Download container files generated by code interpreter |
|
||||
|
||||
## Running the samples
|
||||
|
||||
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<PropertyGroup>
|
||||
<OutputType>Exe</OutputType>
|
||||
<TargetFrameworks>net10.0</TargetFrameworks>
|
||||
|
||||
<Nullable>enable</Nullable>
|
||||
<ImplicitUsings>enable</ImplicitUsings>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.Foundry\Microsoft.Agents.AI.Foundry.csproj" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
@@ -0,0 +1,67 @@
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
// This sample demonstrates writing custom evaluation functions for domain-specific
|
||||
// checks. Custom evaluators run locally — no cloud evaluator service needed.
|
||||
// For LLM-based quality scoring (relevance, coherence), see Evaluation_SimpleEval.
|
||||
|
||||
using Azure.AI.Projects;
|
||||
using Azure.Identity;
|
||||
using Microsoft.Agents.AI;
|
||||
|
||||
string endpoint = Environment.GetEnvironmentVariable("AZURE_AI_PROJECT_ENDPOINT") ?? throw new InvalidOperationException("AZURE_AI_PROJECT_ENDPOINT is not set.");
|
||||
string deploymentName = Environment.GetEnvironmentVariable("AZURE_AI_MODEL_DEPLOYMENT_NAME") ?? "gpt-4o-mini";
|
||||
|
||||
// WARNING: DefaultAzureCredential is convenient for development but requires careful consideration in production.
|
||||
// In production, consider using a specific credential (e.g., ManagedIdentityCredential) to avoid
|
||||
// latency issues, unintended credential probing, and potential security risks from fallback mechanisms.
|
||||
AIProjectClient projectClient = new(new Uri(endpoint), new DefaultAzureCredential());
|
||||
|
||||
AIAgent agent = projectClient.AsAIAgent(
|
||||
model: deploymentName,
|
||||
instructions: "You are a customer support agent. Help users resolve their issues "
|
||||
+ "politely and provide clear, actionable steps.",
|
||||
name: "SupportAgent");
|
||||
|
||||
// Custom check: the agent should not refuse to help.
|
||||
EvalCheck noRefusal = FunctionEvaluator.Create("no_refusal", (string response) =>
|
||||
!response.Contains("I can't help", StringComparison.OrdinalIgnoreCase)
|
||||
&& !response.Contains("I'm unable to", StringComparison.OrdinalIgnoreCase)
|
||||
&& !response.Contains("outside my scope", StringComparison.OrdinalIgnoreCase));
|
||||
|
||||
// Custom check: response should include actionable guidance (numbered steps or bullet points).
|
||||
EvalCheck hasActionableSteps = FunctionEvaluator.Create("has_actionable_steps", (string response) =>
|
||||
response.Contains("1.", StringComparison.Ordinal)
|
||||
|| response.Contains("- ", StringComparison.Ordinal)
|
||||
|| response.Contains("• ", StringComparison.Ordinal));
|
||||
|
||||
// Custom check: response should be substantial but not excessively long.
|
||||
EvalCheck reasonableLength = FunctionEvaluator.Create("reasonable_length", (string response) =>
|
||||
response.Length >= 50 && response.Length <= 2000);
|
||||
|
||||
// Combine all custom checks into a local evaluator.
|
||||
LocalEvaluator evaluator = new(noRefusal, hasActionableSteps, reasonableLength);
|
||||
|
||||
string[] queries =
|
||||
[
|
||||
"My order hasn't arrived after two weeks. What should I do?",
|
||||
"I was charged twice for the same item. Can you help?",
|
||||
"How do I return a damaged product?",
|
||||
];
|
||||
|
||||
AgentEvaluationResults results = await agent.EvaluateAsync(queries, evaluator);
|
||||
|
||||
Console.WriteLine($"Passed: {results.Passed}/{results.Total}");
|
||||
Console.WriteLine();
|
||||
|
||||
for (int i = 0; i < results.Items.Count; i++)
|
||||
{
|
||||
Console.WriteLine($"Query: {queries[i]}");
|
||||
Console.WriteLine($"Response: {(results.InputItems?[i].Response is { } resp ? resp.Substring(0, Math.Min(50, resp.Length)) : "N/A")}...");
|
||||
foreach (var metric in results.Items[i].Metrics)
|
||||
{
|
||||
string status = metric.Value.Interpretation?.Failed == true ? "FAIL" : "PASS";
|
||||
Console.WriteLine($" [{status}] {metric.Key}");
|
||||
}
|
||||
|
||||
Console.WriteLine();
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
# Evaluation - Custom Evals
|
||||
|
||||
This sample demonstrates writing custom domain-specific evaluation functions using `FunctionEvaluator.Create`. Custom evaluators run locally with no cloud evaluator service needed — useful for enforcing business rules, format requirements, or safety guardrails.
|
||||
|
||||
## What this sample demonstrates
|
||||
|
||||
- Writing custom checks with `FunctionEvaluator.Create` for domain-specific logic
|
||||
- Checking that a customer support agent doesn't refuse to help
|
||||
- Verifying responses contain actionable steps (numbered lists or bullet points)
|
||||
- Enforcing response length constraints
|
||||
- Combining multiple custom checks into a `LocalEvaluator`
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- .NET 10 SDK or later
|
||||
- Azure CLI installed and authenticated (`az login`)
|
||||
|
||||
Set the following environment variables:
|
||||
|
||||
```powershell
|
||||
$env:AZURE_AI_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project"
|
||||
$env:AZURE_AI_MODEL_DEPLOYMENT_NAME="gpt-4o-mini"
|
||||
```
|
||||
|
||||
## Run the sample
|
||||
|
||||
```powershell
|
||||
cd dotnet/samples/02-agents/Evaluation
|
||||
dotnet run --project .\Evaluation_CustomEvals
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
- [Evaluation_SimpleEval](../Evaluation_SimpleEval/) — Simplest evaluation using Foundry quality evaluators (Relevance, Coherence)
|
||||
- [Evaluation_ExpectedOutputs](../Evaluation_ExpectedOutputs/) — Evaluating against ground-truth expected outputs
|
||||
- [Evaluation_MixedProviders](../../../05-end-to-end/Evaluation/Evaluation_MixedProviders/) — Combining custom + Foundry evaluators in one call
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<PropertyGroup>
|
||||
<OutputType>Exe</OutputType>
|
||||
<TargetFrameworks>net10.0</TargetFrameworks>
|
||||
|
||||
<Nullable>enable</Nullable>
|
||||
<ImplicitUsings>enable</ImplicitUsings>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.Foundry\Microsoft.Agents.AI.Foundry.csproj" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
@@ -0,0 +1,51 @@
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
// This sample demonstrates evaluating agent responses against expected outputs.
|
||||
|
||||
using Azure.AI.Projects;
|
||||
using Azure.Identity;
|
||||
using Microsoft.Agents.AI;
|
||||
|
||||
string endpoint = Environment.GetEnvironmentVariable("AZURE_AI_PROJECT_ENDPOINT") ?? throw new InvalidOperationException("AZURE_AI_PROJECT_ENDPOINT is not set.");
|
||||
string deploymentName = Environment.GetEnvironmentVariable("AZURE_AI_MODEL_DEPLOYMENT_NAME") ?? "gpt-4o-mini";
|
||||
|
||||
// Create a math tutor agent.
|
||||
AIAgent agent = new AIProjectClient(new Uri(endpoint), new DefaultAzureCredential())
|
||||
.AsAIAgent(
|
||||
model: deploymentName,
|
||||
instructions: "You are a math tutor. Answer concisely with the numeric result.",
|
||||
name: "MathTutor");
|
||||
|
||||
// Combine built-in checks.
|
||||
LocalEvaluator localEvaluator = new(
|
||||
EvalChecks.ContainsExpected(), // response must contain the expected answer
|
||||
EvalChecks.NonEmpty()); // response must not be empty
|
||||
|
||||
// Queries and expected outputs.
|
||||
string[] queries = ["What is 2 + 2?", "What is the square root of 144?"];
|
||||
string[] expectedOutputs = ["4", "12"];
|
||||
|
||||
// Run the agent and evaluate with expected outputs.
|
||||
AgentEvaluationResults results = await agent.EvaluateAsync(
|
||||
queries,
|
||||
localEvaluator,
|
||||
expectedOutput: expectedOutputs);
|
||||
|
||||
// Print results.
|
||||
Console.WriteLine($"Evaluation: {results.ProviderName}");
|
||||
Console.WriteLine($" Passed: {results.Passed}/{results.Total}");
|
||||
Console.WriteLine($" All passed: {results.AllPassed}");
|
||||
Console.WriteLine();
|
||||
|
||||
for (int i = 0; i < results.Items.Count; i++)
|
||||
{
|
||||
Console.WriteLine($"Query: {queries[i]} | Expected: {expectedOutputs[i]}");
|
||||
Console.WriteLine($"Response: {(results.InputItems?[i].Response is { } resp ? resp.Substring(0, Math.Min(50, resp.Length)) : "N/A")}");
|
||||
foreach (var metric in results.Items[i].Metrics)
|
||||
{
|
||||
string status = metric.Value.Interpretation?.Failed == true ? "FAIL" : "PASS";
|
||||
Console.WriteLine($" [{status}] {metric.Key}: {metric.Value.Interpretation?.Reason}");
|
||||
}
|
||||
|
||||
Console.WriteLine();
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
# Evaluation - Expected Outputs
|
||||
|
||||
This sample demonstrates evaluating agent responses against expected outputs using built-in checks.
|
||||
|
||||
## What this sample demonstrates
|
||||
|
||||
- Using `EvalChecks.ContainsExpected` for ground-truth comparison
|
||||
- Using `EvalChecks.NonEmpty` for basic response validation
|
||||
- Passing `expectedOutput` to `agent.EvaluateAsync()` so checks can access ground truth
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- .NET 10 SDK or later
|
||||
- Azure CLI installed and authenticated (`az login`)
|
||||
|
||||
Set the following environment variables:
|
||||
|
||||
```powershell
|
||||
$env:AZURE_AI_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project"
|
||||
$env:AZURE_AI_MODEL_DEPLOYMENT_NAME="gpt-4o-mini"
|
||||
```
|
||||
|
||||
## Run the sample
|
||||
|
||||
```powershell
|
||||
cd dotnet/samples/02-agents/Evaluation
|
||||
dotnet run --project .\Evaluation_ExpectedOutputs
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
- [Evaluation_SimpleEval](../Evaluation_SimpleEval/) — Simplest evaluation with built-in and custom checks
|
||||
- [Evaluation_FoundryQuality](../../../05-end-to-end/Evaluation/Evaluation_FoundryQuality/) — Cloud-based quality evaluation with Foundry evaluators
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<PropertyGroup>
|
||||
<OutputType>Exe</OutputType>
|
||||
<TargetFrameworks>net10.0</TargetFrameworks>
|
||||
|
||||
<Nullable>enable</Nullable>
|
||||
<ImplicitUsings>enable</ImplicitUsings>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.Foundry\Microsoft.Agents.AI.Foundry.csproj" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
@@ -0,0 +1,57 @@
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
// This sample demonstrates that the evaluation pipeline preserves multimodal content.
|
||||
// When an agent conversation includes images, EvalChecks.HasImageContent() can verify
|
||||
// they survived into the EvalItem — useful for testing vision-capable agents.
|
||||
//
|
||||
// No Azure credentials needed: this sample builds EvalItems locally to show the pattern.
|
||||
|
||||
using Microsoft.Agents.AI;
|
||||
using Microsoft.Extensions.AI;
|
||||
|
||||
// Simulate a vision agent conversation where the user sends an image.
|
||||
// Just pass the conversation — query/response are derived automatically.
|
||||
// For cloud-based quality evaluation of multimodal conversations, see the
|
||||
// 05-end-to-end/Evaluation samples (FoundryQuality, ConversationSplits).
|
||||
EvalItem imageItem = new(
|
||||
conversation:
|
||||
[
|
||||
new(ChatRole.User,
|
||||
[
|
||||
new TextContent("What do you see in this image?"),
|
||||
new UriContent(new Uri("https://example.com/mountain.png"), "image/png"),
|
||||
]),
|
||||
new(ChatRole.Assistant, "The image shows a mountain landscape with snow-capped peaks."),
|
||||
]);
|
||||
|
||||
// Simulate a text-only conversation (no image).
|
||||
EvalItem textItem = new(
|
||||
query: "Tell me about mountains.",
|
||||
response: "Mountains are large landforms that rise above the surrounding terrain.");
|
||||
|
||||
// HasImageContent() passes when the conversation contains an image, fails otherwise.
|
||||
// This lets you verify that your vision agent actually received the image.
|
||||
LocalEvaluator evaluator = new(
|
||||
EvalChecks.HasImageContent(),
|
||||
EvalChecks.NonEmpty());
|
||||
|
||||
AgentEvaluationResults results = await evaluator.EvaluateAsync([imageItem, textItem]);
|
||||
|
||||
Console.WriteLine($"Evaluation: {results.Passed}/{results.Total} passed");
|
||||
Console.WriteLine();
|
||||
|
||||
Console.WriteLine($"Image conversation: has_image_content = {imageItem.HasImageContent}"); // true
|
||||
Console.WriteLine($"Text conversation: has_image_content = {textItem.HasImageContent}"); // false
|
||||
Console.WriteLine();
|
||||
|
||||
for (int i = 0; i < results.Items.Count; i++)
|
||||
{
|
||||
Console.WriteLine($"Item {i + 1}: {results.InputItems![i].Query}");
|
||||
foreach (var metric in results.Items[i].Metrics)
|
||||
{
|
||||
string status = metric.Value.Interpretation?.Failed == true ? "FAIL" : "PASS";
|
||||
Console.WriteLine($" [{status}] {metric.Key}: {metric.Value.Interpretation?.Reason}");
|
||||
}
|
||||
|
||||
Console.WriteLine();
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
# Evaluation - Multimodal
|
||||
|
||||
This sample demonstrates that the evaluation pipeline preserves multimodal content. When conversations include images, `EvalChecks.HasImageContent` can verify they survived into the `EvalItem`.
|
||||
|
||||
## What this sample demonstrates
|
||||
|
||||
- Building `EvalItem` objects with `UriContent` image content
|
||||
- Using built-in `EvalChecks.HasImageContent` to detect images in conversations
|
||||
- Comparing image vs. text-only conversations to show when the check passes/fails
|
||||
- Evaluating directly with `LocalEvaluator.EvaluateAsync()` (no agent needed)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- .NET 10 SDK or later
|
||||
|
||||
No Azure credentials or environment variables are required for this sample since it evaluates locally without calling an agent.
|
||||
|
||||
## Run the sample
|
||||
|
||||
```powershell
|
||||
cd dotnet/samples/02-agents/Evaluation
|
||||
dotnet run --project .\Evaluation_Multimodal
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
- [Evaluation_SimpleEval](../Evaluation_SimpleEval/) — Simplest evaluation with built-in checks and `agent.EvaluateAsync()`
|
||||
- [Evaluation_FoundryQuality](../../../05-end-to-end/Evaluation/Evaluation_FoundryQuality/) — Cloud-based quality evaluation with Foundry evaluators
|
||||
- [Evaluation_ConversationSplits](../../../05-end-to-end/Evaluation/Evaluation_ConversationSplits/) — Multi-turn conversation split strategies
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<PropertyGroup>
|
||||
<OutputType>Exe</OutputType>
|
||||
<TargetFrameworks>net10.0</TargetFrameworks>
|
||||
|
||||
<Nullable>enable</Nullable>
|
||||
<ImplicitUsings>enable</ImplicitUsings>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.Foundry\Microsoft.Agents.AI.Foundry.csproj" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
@@ -0,0 +1,55 @@
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
// Simplest possible agent evaluation: create a Foundry agent, run it against
|
||||
// test questions, and use Foundry quality evaluators to score the responses.
|
||||
// For custom domain-specific checks, see the Evaluation_CustomEvals sample.
|
||||
|
||||
using Azure.AI.Projects;
|
||||
using Azure.Identity;
|
||||
using Microsoft.Agents.AI;
|
||||
using Microsoft.Extensions.AI.Evaluation;
|
||||
using FoundryEvals = Microsoft.Agents.AI.Foundry.FoundryEvals;
|
||||
|
||||
string endpoint = Environment.GetEnvironmentVariable("AZURE_AI_PROJECT_ENDPOINT") ?? throw new InvalidOperationException("AZURE_AI_PROJECT_ENDPOINT is not set.");
|
||||
string deploymentName = Environment.GetEnvironmentVariable("AZURE_AI_MODEL_DEPLOYMENT_NAME") ?? "gpt-4o-mini";
|
||||
|
||||
// WARNING: DefaultAzureCredential is convenient for development but requires careful consideration in production.
|
||||
// In production, consider using a specific credential (e.g., ManagedIdentityCredential) to avoid
|
||||
// latency issues, unintended credential probing, and potential security risks from fallback mechanisms.
|
||||
AIProjectClient projectClient = new(new Uri(endpoint), new DefaultAzureCredential());
|
||||
|
||||
AIAgent agent = projectClient.AsAIAgent(
|
||||
model: deploymentName,
|
||||
instructions: "You are a helpful assistant. Provide clear, accurate answers.",
|
||||
name: "SimpleAgent");
|
||||
|
||||
// Configure Foundry quality evaluators — runs evaluations server-side via the Foundry Evals API.
|
||||
FoundryEvals evaluator = new(projectClient, deploymentName, FoundryEvals.Relevance, FoundryEvals.Coherence);
|
||||
|
||||
// Run the agent against test queries and evaluate in one call.
|
||||
string[] queries = ["What is photosynthesis?", "How do vaccines work?"];
|
||||
AgentEvaluationResults results = await agent.EvaluateAsync(queries, evaluator);
|
||||
|
||||
// Print results.
|
||||
Console.WriteLine($"Passed: {results.Passed}/{results.Total}");
|
||||
if (results.ReportUrl is not null)
|
||||
{
|
||||
Console.WriteLine($"Report: {results.ReportUrl}");
|
||||
}
|
||||
|
||||
Console.WriteLine();
|
||||
|
||||
for (int i = 0; i < results.Items.Count; i++)
|
||||
{
|
||||
Console.WriteLine($"Query: {queries[i]}");
|
||||
Console.WriteLine($"Response: {(results.InputItems?[i].Response is { } resp ? resp.Substring(0, Math.Min(50, resp.Length)) : "N/A")}...");
|
||||
foreach (var metric in results.Items[i].Metrics)
|
||||
{
|
||||
string score = metric.Value is NumericMetric nm && nm.Value.HasValue
|
||||
? nm.Value.Value.ToString("F1")
|
||||
: "N/A";
|
||||
Console.WriteLine($" {metric.Key}: {score}");
|
||||
}
|
||||
|
||||
Console.WriteLine();
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
# Evaluation - Simple Eval
|
||||
|
||||
The simplest agent evaluation: create a Foundry agent, run it against test questions, and use Foundry quality evaluators (Relevance, Coherence) to score the responses.
|
||||
|
||||
## What this sample demonstrates
|
||||
|
||||
- Creating an agent with `AIProjectClient.AsAIAgent()`
|
||||
- Using `FoundryEvals` with Relevance and Coherence quality evaluators
|
||||
- Running evaluation with `agent.EvaluateAsync()` — runs the agent and evaluates in one call
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- .NET 10 SDK or later
|
||||
- Azure CLI installed and authenticated (`az login`)
|
||||
- A deployed model in your Azure AI Foundry project
|
||||
|
||||
Set the following environment variables:
|
||||
|
||||
```powershell
|
||||
$env:AZURE_AI_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project"
|
||||
$env:AZURE_AI_MODEL_DEPLOYMENT_NAME="gpt-4o-mini"
|
||||
```
|
||||
|
||||
## Run the sample
|
||||
|
||||
```powershell
|
||||
cd dotnet/samples/02-agents/Evaluation
|
||||
dotnet run --project .\Evaluation_SimpleEval
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
- [Evaluation_CustomEvals](../Evaluation_CustomEvals/) — Writing custom domain-specific evaluation checks
|
||||
- [Evaluation_ExpectedOutputs](../Evaluation_ExpectedOutputs/) — Evaluating against ground-truth expected outputs
|
||||
- [Evaluation_MixedProviders](../../../05-end-to-end/Evaluation/Evaluation_MixedProviders/) — Combining local + Foundry evaluators in one call
|
||||
Reference in New Issue
Block a user