AgentEval samples.instructions.md

Sample Implementation Guidelines

Sample Naming Convention

Samples are numbered: Sample01_HelloWorld, Sample02_AgentWithOneTool, etc.

Sample Structure

Each sample should:

1. Have a clear single focus
2. Include time-to-understand estimate
3. Work with or without Azure credentials (use mocks when possible)
4. Print clear step-by-step output

Sample Header Template

/// <summary>
/// Sample XX: Title - Short description
/// 
/// This demonstrates:
/// - Feature 1
/// - Feature 2
/// - Feature 3
/// 
/// ⏱️ Time to understand: X minutes
/// </summary>
public static class Sample_XX_Title
{
    public static async Task RunAsync()
    {
        PrintHeader();
        
        if (!AIConfig.IsConfigured)
        {
            AIConfig.PrintMissingCredentialsWarning();
            Console.WriteLine("   ⚠️  This sample requires Azure OpenAI credentials.\n");
            return;
        }
        
        // Step 1, 2, 3...
    }
}

Console Output Pattern

Use consistent formatting:

Console.WriteLine("📝 Step 1: Creating agent...\n");
Console.WriteLine($"   ✓ Agent '{agent.Name}' created\n");

Console.WriteLine("📊 RESULTS:");
Console.WriteLine(new string('─', 60));

Using AIConfig

All samples should use AIConfig class for configuration:

var azureClient = new AzureOpenAIClient(AIConfig.Endpoint, AIConfig.KeyCredential);
var chatClient = azureClient.GetChatClient(AIConfig.ModelDeployment).AsIChatClient();

Creating Mock Agents

When credentials unavailable, provide mock fallback:

private static AIAgent CreateMockAgent()
{
    var mockClient = new MockChatClient("Expected response text");
    return new ChatClientAgent(mockClient, new ChatClientAgentOptions
    {
        Name = "MockAgent",
        ChatOptions = new() { Instructions = "You are a helpful assistant." }
    });
}

Registering in Program.cs

Add sample to the menu in samples/AgentEval.Samples/Program.cs:

("XX. Sample Title", Sample_XX_Title.RunAsync),