mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
aee1acbf8b
* Foundry Evals integration for .NET - Core evaluation framework: EvalItem, LocalEvaluator, FunctionEvaluator, EvalChecks - IAgentEvaluator interface with MeaiEvaluatorAdapter bridge - AgentEvaluationExtensions for agent.EvaluateAsync() overloads - FoundryEvals wrapping MEAI quality/safety evaluators - ConversationSplitters (LastTurn, Full) and IConversationSplitter - EvalItem.PerTurnItems() for multi-turn decomposition - HasImageContent for multimodal content detection - WorkflowEvaluationExtensions for per-agent workflow evaluation - 7 eval samples mirroring Python parity: 02-agents/Evaluation: SimpleEval, ExpectedOutputs, Multimodal 03-workflows/Evaluation: WorkflowEval 05-end-to-end/Evaluation: FoundryQuality, MixedProviders, ConversationSplits - Comprehensive unit tests (1958 passing) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Rewrite FoundryEvals to use real Foundry Evals API Replace MEAI evaluator shim with actual OpenAI EvaluationClient protocol methods. FoundryEvals now creates eval definitions, submits runs, polls for completion, and fetches per-item results server-side. - New constructor: FoundryEvals(AIProjectClient, model, evaluators) - Add FoundryEvalConverter for MEAI ChatMessage -> Foundry JSON format - Add EvalId, RunId, ReportUrl to AgentEvaluationResults - All 20 built-in evaluator constants now work (agent, tool, quality, safety) - Remove Microsoft.Extensions.AI.Evaluation.Quality/Safety dependencies - Update all samples for new constructor (no more ChatConfiguration) - Replace BuildEvaluators tests with ResolveEvaluator tests Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add response output to CustomEvals and ExpectedOutputs samples Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address review: pagination, validation, error handling, tests FoundryEvals fixes: - Add pagination for output items (has_more/after cursor) - Add guard clauses for pollIntervalSeconds/timeoutSeconds <= 0 - Fix double TryGetProperty for passed field parsing - Throw on all-tool-evaluators with no tool definitions - Fix XML doc (default 300s, not 180s) New tests (30 added, 1989 total): - EvalChecks: NonEmpty, ContainsExpected (pass/fail/skip/case), HasImageContent, ToolCallsPresent - FoundryEvalConverter: ConvertMessage (text, image, function call, function results fan-out, empty fallback, mixed content), ConvertEvalItem, BuildTestingCriteria (quality/agent/tool/groundedness data mappings), BuildItemSchema Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix review: null-refs, Data.ToString() bug, ContainsExpected, add tests - Fix NullReferenceException in sample Response display (pattern matching) - Fix WorkflowEvaluationExtensions Data?.ToString() producing type names instead of message text (pattern-match ChatMessage/AgentResponse/list) - Change EvalChecks.ContainsExpected to return Passed=false when no ExpectedOutput (was silently passing, masking misconfiguration) - Add EvalItem constructor tests with LastTurn/Full/null splitters - Add FoundryEvalConverter.ConvertMessage DataContent (base64 image) test - Add ExtractAgentData tests with ChatMessage, list, and AgentResponse data Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix review: conversation fidelity, eval caching, fallback tests - WorkflowEvaluationExtensions: preserve full response messages (tool calls, intermediate) instead of synthetic 2-message conversation. Cast completed Data to AgentResponse and use Messages when available, fallback to text. - FoundryEvals: cache evalId per schema shape (hasContext, hasTools) so subsequent EvaluateAsync calls create runs under the same eval definition. - MeaiEvaluatorAdapter: code already correctly passes queryMessages (not full conversation) to IEvaluator — no change needed, verified by inspection. - Add tests: AgentResponse full messages preservation, unknown object ToString() fallback for ExtractAgentData. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Rename AzureAI→Foundry: move eval files, update references - Move FoundryEvals.cs and FoundryEvalConverter.cs from Microsoft.Agents.AI.AzureAI to Microsoft.Agents.AI.Foundry - Update namespace from AzureAI to Foundry in both files - Add explicit usings required by Foundry project (no implicit usings) - Move FoundryEvalConverter tests to Foundry.UnitTests project (avoids ReplacingRedactor type conflict from dual project refs) - Update all sample csproj references and using statements - Remove Foundry project reference from AI UnitTests Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * PR review round 4: wire up tool extraction, remove eval cache, fix null safety - BuildEvalItem: extract tools from agent via GetService<ChatOptions>() into EvalItem.Tools (Python parity) - FoundryEvals: remove eval ID cache - each call creates fresh definition (matches Python behavior) - FoundryEvals: replace null-forgiving operators with descriptive InvalidOperationException - MixedProviders sample: remove unnecessary explicit PackageReferences (transitively provided) - FoundryEvalConverter: document that tool results take precedence over text content - Add LocalEvaluator zero-checks test documenting 0 metrics = failed behavior Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Python-dotnet parity: 9 feature gaps filled New checks: - ToolCallArgsMatch() — verify tool call names + argument subset match - ToolCalledCheck(ToolCalledMode.Any, ...) — match any of the specified tools - ToolCalledMode enum (All/Any) FoundryEvals enhancements: - Default evaluators now [Relevance, Coherence, TaskAdherence] (was Relevance, Coherence) - Auto-add ToolCallAccuracy when items have tool definitions - EvaluateTracesAsync — evaluate by response_ids, trace_ids, or agent_id - EvaluateFoundryTargetAsync — evaluate deployed Foundry targets Result type enrichment: - AgentEvaluationResults: added Status, Error, PerEvaluator, DetailedItems - New EvalItemResult/EvalScoreResult/PerEvaluatorResult types - FoundryEvals populates all new fields from API responses Workflow fix: - Skip internal executors (_*, input-conversation, end-conversation, end) Tests: 8 new tests covering ToolCallArgsMatch, ToolCalledMode.Any, internal executor filtering Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add MeaiEvaluatorAdapter and PerTurnItems edge case tests - 3 tests for MeaiEvaluatorAdapter: query message forwarding, synthetic response fallback, multiple items aggregation - 3 tests for EvalItem.PerTurnItems: empty conversation, no user messages, system+assistant only - StubEvaluator and StubChatClient test helpers Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Blocking link check for outdated package in DevUI. * Replace Dictionary<string, object> payloads with typed wire models Introduce internal FoundryEvalWireModels.cs with compile-time-safe types for the OpenAI Evals API wire format. The OpenAI .NET SDK (2.9.1) only provides protocol-level methods with BinaryContent/ClientResult — no typed request models. These internal models replace scattered dictionary literals with [JsonPropertyName]-annotated classes, giving: - Compile-time safety (typos become build errors) - Single point of change when the API evolves - IntelliSense discoverability - Cleaner serialization via JsonPolymorphic for content items Models: WireContentItem hierarchy (text, image, tool_call, tool_result), WireMessage, WireEvalItemPayload, WireTestingCriterion, WireItemSchema, WireCreateEvalRequest, WireCreateRunRequest, and data source variants. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Skip metric when Foundry returns neither score nor passed When an evaluator returns no score and no passed value, the previous code created BooleanMetric(name, false), which falsely failed items via ItemPassed. Now we skip the MEAI metric entirely for indeterminate results — the raw data remains available in DetailedItems for diagnostics. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address PR #4914 review comments: fix tool evaluator bug and add tests - Fix duplicate ToolCallAccuracy: resolve evaluator names before checking against ToolEvaluators set (Comment 2) - Make FilterToolEvaluators internal for testability; add tests for the ArgumentException edge case when all evaluators are tool-type (Comment 3) - Add CancellationToken test for LocalEvaluator (Comment 4) - Add EvaluateAsync integration test on Run with sequential workflow and per-agent SubResults verification (Comment 5) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address Peter's review comments on PR #4914 - Add trailing newline to Evaluation_FoundryQuality.csproj (Comment 6) - Make evaluator name lookups case-insensitive: switch BuiltinEvaluators, ToolEvaluators, AgentEvaluators, and ResolveEvaluator's StartsWith check from Ordinal to OrdinalIgnoreCase (Comment 7) - Add Trace.TraceWarning when Foundry returns fewer results than submitted items, indicating expected vs actual count before padding (Comment 8) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add Microsoft.Extensions.AI.Evaluation packages to Directory.Packages.props These were removed in #5269 as unused, but are needed by the Foundry and core evaluation integration added in this PR. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: alliscode <bentho@microsoft.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
149 lines
6.2 KiB
C#
149 lines
6.2 KiB
C#
// Copyright (c) Microsoft. All rights reserved.
|
|
|
|
// This sample demonstrates multi-turn conversation evaluation with different split strategies.
|
|
|
|
using Azure.AI.Projects;
|
|
using Azure.Identity;
|
|
using Microsoft.Agents.AI;
|
|
using Microsoft.Extensions.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());
|
|
|
|
// A multi-turn conversation with tool calls to evaluate three ways.
|
|
List<ChatMessage> conversation =
|
|
[
|
|
// Turn 1: user asks about weather -> agent calls tool -> responds
|
|
new(ChatRole.User, "What's the weather in Seattle?"),
|
|
new(ChatRole.Assistant,
|
|
[
|
|
new FunctionCallContent("c1", "get_weather", new Dictionary<string, object?> { ["location"] = "seattle" }),
|
|
]),
|
|
new(ChatRole.Tool,
|
|
[
|
|
new FunctionResultContent("c1", "62\u00b0F, cloudy with a chance of rain"),
|
|
]),
|
|
new(ChatRole.Assistant, "Seattle is 62\u00b0F, cloudy with a chance of rain."),
|
|
|
|
// Turn 2: user asks about Paris -> agent calls tool -> responds
|
|
new(ChatRole.User, "And Paris?"),
|
|
new(ChatRole.Assistant,
|
|
[
|
|
new FunctionCallContent("c2", "get_weather", new Dictionary<string, object?> { ["location"] = "paris" }),
|
|
]),
|
|
new(ChatRole.Tool,
|
|
[
|
|
new FunctionResultContent("c2", "Paris is 68\u00b0F, partly sunny"),
|
|
]),
|
|
new(ChatRole.Assistant, "Paris is 68\u00b0F, partly sunny."),
|
|
|
|
// Turn 3: user asks for comparison -> agent synthesizes without tool
|
|
new(ChatRole.User, "Can you compare them?"),
|
|
new(ChatRole.Assistant,
|
|
"Seattle is cooler at 62\u00b0F with rain likely, while Paris is warmer " +
|
|
"at 68\u00b0F and partly sunny. Paris is the better choice for outdoor activities."),
|
|
];
|
|
|
|
// =========================================================================
|
|
// Strategy 1: LastTurn (default)
|
|
// "Given all context, was the last response good?"
|
|
// =========================================================================
|
|
Console.WriteLine(new string('=', 70));
|
|
Console.WriteLine("Strategy 1: LastTurn \u2014 evaluate the final response");
|
|
Console.WriteLine(new string('=', 70));
|
|
|
|
EvalItem lastTurnItem = new(
|
|
query: "Can you compare them?",
|
|
response: "Seattle is cooler at 62\u00b0F with rain likely, while Paris is warmer at 68\u00b0F and partly sunny.",
|
|
conversation: conversation);
|
|
|
|
FoundryEvals lastTurnEvals = new(projectClient, deploymentName, FoundryEvals.Relevance, FoundryEvals.Coherence);
|
|
AgentEvaluationResults lastTurnResults = await lastTurnEvals.EvaluateAsync(
|
|
[lastTurnItem],
|
|
"Split Strategy: LastTurn");
|
|
|
|
PrintResults("LastTurn", lastTurnResults);
|
|
|
|
// =========================================================================
|
|
// Strategy 2: Full
|
|
// "Given the original request, did the whole conversation serve the user?"
|
|
// =========================================================================
|
|
Console.WriteLine(new string('=', 70));
|
|
Console.WriteLine("Strategy 2: Full \u2014 evaluate the entire conversation trajectory");
|
|
Console.WriteLine(new string('=', 70));
|
|
|
|
EvalItem fullItem = new(
|
|
query: "What's the weather in Seattle?",
|
|
response: "Seattle is cooler at 62\u00b0F with rain likely, while Paris is warmer at 68\u00b0F and partly sunny.",
|
|
conversation: conversation)
|
|
{
|
|
Splitter = ConversationSplitters.Full,
|
|
};
|
|
|
|
FoundryEvals fullEvals = new(projectClient, deploymentName, ConversationSplitters.Full, FoundryEvals.Relevance, FoundryEvals.Coherence);
|
|
AgentEvaluationResults fullResults = await fullEvals.EvaluateAsync(
|
|
[fullItem],
|
|
"Split Strategy: Full");
|
|
|
|
PrintResults("Full", fullResults);
|
|
|
|
// =========================================================================
|
|
// Strategy 3: PerTurnItems
|
|
// "Was each individual response appropriate at that point?"
|
|
// =========================================================================
|
|
Console.WriteLine(new string('=', 70));
|
|
Console.WriteLine("Strategy 3: PerTurnItems \u2014 evaluate each turn independently");
|
|
Console.WriteLine(new string('=', 70));
|
|
|
|
IReadOnlyList<EvalItem> perTurnItems = EvalItem.PerTurnItems(conversation);
|
|
Console.WriteLine($"Split into {perTurnItems.Count} items from {conversation.Count} messages:");
|
|
for (int i = 0; i < perTurnItems.Count; i++)
|
|
{
|
|
string response = perTurnItems[i].Response;
|
|
string truncated = response.Length > 60 ? response[..60] + "..." : response;
|
|
Console.WriteLine($" Turn {i + 1}: query=\"{perTurnItems[i].Query}\", response=\"{truncated}\"");
|
|
}
|
|
|
|
Console.WriteLine();
|
|
|
|
FoundryEvals perTurnEvals = new(projectClient, deploymentName, FoundryEvals.Relevance, FoundryEvals.Coherence);
|
|
AgentEvaluationResults perTurnResults = await perTurnEvals.EvaluateAsync(
|
|
perTurnItems,
|
|
"Split Strategy: Per-Turn");
|
|
|
|
PrintResults("Per-Turn", perTurnResults);
|
|
|
|
Console.WriteLine(new string('=', 70));
|
|
Console.WriteLine("All strategies complete. Compare results above.");
|
|
Console.WriteLine(new string('=', 70));
|
|
|
|
static void PrintResults(string strategy, AgentEvaluationResults results)
|
|
{
|
|
Console.WriteLine($"\n Result: {results.Passed}/{results.Total} passed");
|
|
if (results.ReportUrl is not null)
|
|
{
|
|
Console.WriteLine($" Report: {results.ReportUrl}");
|
|
}
|
|
|
|
for (int i = 0; i < results.Items.Count; i++)
|
|
{
|
|
foreach (var metric in results.Items[i].Metrics)
|
|
{
|
|
string status = metric.Value.Interpretation?.Failed == true ? "FAIL" : "PASS";
|
|
string score = metric.Value is NumericMetric nm && nm.Value.HasValue
|
|
? nm.Value.Value.ToString("F1")
|
|
: "N/A";
|
|
Console.WriteLine($" [{status}] {metric.Key}: {score}");
|
|
}
|
|
}
|
|
|
|
Console.WriteLine();
|
|
}
|