ðš Azure OpenAI (Responses API) (.NET) ááŸáá·áºá¡áá° Agentic Design Patterns
ð áááºáá°áááºáááºááœááºáá»ááºáá»á¬áž
á€ááá°áá¬ááẠ.NET ááœáẠMicrosoft Agent Framework ááá¯á¡áá¯á¶ážááŒá¯ááŒá®áž Azure OpenAI (Responses API) áá²á· áá±á«ááºážá
ááºááŒá®áž áá¬ááºáááºááŸááá±á¬ agent áá»á¬áž áááºáá®ážáá¬ááœáẠá
ááºááŸá¯áá¯ááºáááºážá¡ááá·áºáá®ááá¯ááºážáá¯á¶á
á¶áá»á¬ážááᯠááŒááááºá áááºááẠagents áá»á¬ážááᯠáá¯ááºáá¯ááºááŸá¯ááá¯ááºáᬠá¡ááá·áºááŒááºáááºáá¬ážáá±á¬á ááááºážááááºážáááœááºáá°áá±á¬ááŸáá·áº ááá¬áááá¯ážááŒáŸáá·áºááá¯ááºáá±á¬ áá¯á¶á
á¶áá»á¬ážááŸáá·áº áááºážáá»á°áá¬ááá¯ááºáá¬áááºážáááºážáá»á¬ážááᯠáááºáá°ááá«áááºá
á
ááºááŸá¯áá¯ááºáááºážáá®ááá¯ááºážáá¯á¶á
á¶áá»á¬áž
- ð Factory Pattern: á¡á¬ážáá¬ážááá¯ááºááŒá®áž dependency injection áá²á· agent áááºáá®ážááŒááºáž
- ð§ Builder Pattern: agent ááᯠá¡áááºááŒá±á
áœá¬ áááºáááºááœáá·áºááŒááºážááŸáá·áº ááŒááºáááºááŒááºáž
- ð§µ Thread-Safe Patterns: áááŒáá¯ááºáááºá
áá¬ážááŒá±á¬áááºáá¶ááŸá¯ á
á®áá¶ááá·áºááœá²ááŒááºáž
- ð Repository Pattern: áááááá¬ááŸáá·áº ááááºáááºááá¯ááºá
áœááºáž á
á®áá¶ááá·áºááœá²ááŒááºáž
ð¯ .NET áá®ážááá·áº áááºážáá»á°áá¬ááá¯ážáááºááŸá¯áá»á¬áž
á
ááºááŸá¯áá¯ááºáááºážá¡ááºá¹áá«áááºáá»á¬áž
- ááŒá¶á·ááá¯ááºáá±á¬ typing: Compile-time á
á
áºáá±ážááŸá¯ááŸáá·áº IntelliSense ááŸá¬ážááœáá·áº
- Dependency Injection: ááá·áºááœááºážáá¬ážáá±á¬ DI container áá±á«ááºážá
ááºááŒááºáž
- Configuration Management: IConfiguration ááŸáá·áº Options áá¯á¶á
á¶áá»á¬áž
- Async/Await: Asynchronous programming á¡á¬ážáá±á¬ááºážááŸá¯
áá¯ááºáá¯ááºááŸá¯á¡áááºááá·áº áá¯á¶á
á¶áá»á¬áž
- Logging Integration: ILogger ááŸáá·áº áá¯á¶ážá
áœá²áá°á
áá
Ạlogging áá±á¬ááºáá¶á·ááŸá¯
- Health Checks: ááá·áºááœááºážáá¬ážáá±á¬ áá±á¬áá®áá¬ááŸáá·áº ØªØŽØ®ÙØµ
- Configuration Validation: data annotation ááŒáá·áº ááŒá¶á·ááá¯áẠtyping
- Error Handling: á
áá
áºááá» exception á
á®áá¶ááá·áºááœá²ááŸá¯
ð§ áááºážááá¬ááá¯ááºáᬠáááºážáá»á°áá¬
á¡ááŒá±áá¶ .NET ááœááºááœááºáááºá·áá»á¬áž
- Microsoft.Extensions.AI: AI áááºáá±á¬ááºááŸá¯áá»á¬áž áá±á«ááºážá
ááºá
áá
áº
- Microsoft.Agents.AI: á
ááºááŸá¯áá¯ááºáááºáž agent á
á®áá¶ framework
- Azure OpenAI (Responses API): á¡ááŒááºááŸáá¯ážááœá² API client áá¯á¶á
á¶áá»á¬áž
- Configuration System: appsettings.json ááŸáá·áº áááºáááºážáá»ááºáá±á«ááºážá
ááºááŸá¯
áá®ááá¯ááºážáá¯á¶á
á¶á¡áá±á¬ááºá¡áááºáá±á¬áºááŒááºáž
graph LR
A[IServiceCollection] --> B[Agent á¡áá±á¬ááºá¡á¡á¯á¶]
B --> C[áááºáááºáá»á¬áž]
C --> D[áááááᬠá¡áááºážá¡ááŒá
áºá
á¬áááºáž]
D --> E[AI Agent]
ðïž ááŒááá¬ážááá·áº á
ááºááŸá¯áá¯ááºáááºáž áá¯á¶á
á¶áá»á¬áž
1. áááºáá®ážááŸá¯ áá¯á¶á
á¶áá»á¬áž
- Agent Factory: áá»áááºááŸáááŸá¯áá°áá®ááŸá¯ááŒáá·áº agent áááºáá®ážááŸá¯á
ááºáá¬ááá¯ááº
- Builder Pattern: agent áá»áááºááŸáááŸá¯ ááŒá®ážááŒááºááẠFluent API
- Singleton Pattern: áá±áá»áŸá¡áá¯á¶ážááŒá¯ááŸá¯á¡áááºážá¡ááŒá
áºááŸáá·áº áá»áááºááŸáááŸá¯á
á®áá¶ááŸá¯
- Dependency Injection: áá»áááºáááºááŸá¯ ááŒá¯ááºáá¬ážááŒááºážááŸáá·áº á
ááºážáááºááá¯ááºááŸá¯
2. á¡ááŒá¯á¡áá° áá¯á¶á
á¶áá»á¬áž
- Strategy Pattern: á¡ááŒá¬áž tool á
áá
áºáá»á¬áž á¡á
á¬ážááá¯ážáá»áœááºážáá»ááºááŸá¯
- Command Pattern: undo/redo áá²á·á¡áá° agent áá¯ááºáá±á¬ááºáá»ááºáá»á¬áž áá¯ááºááá¯ážááŒááºáž
- Observer Pattern: á¡ááŒá
áºá¡áá»áẠá¡ááŒá±ááŒá¯ agent á¡áááºááŸááºááŸá¯ á
á®áá¶ááá·áºááœá²ááŸá¯
- Template Method: á
á¶áá»ááẠagent áá¯ááºáá±á¬ááºááŸá¯ áááºážá
ááºáá»á¬áž
3. ááœá²á·á
ááºážáá¯á¶ áá¯á¶á
á¶áá»á¬áž
- Adapter Pattern: Azure OpenAI (Responses API) áá±á«ááºážá
ááºááŸá¯ á¡ááœáŸá¬
- Decorator Pattern: agent áá«áááºá
áœááºážááẠááá¯ážáááºááŸá¯
- Facade Pattern: agent áá»á¬ážááŸáá·áº áááºááœááºááŸá¯ ááá¯ážááŸááºážáá±á¬ áá»ááºááŸá¬ááŒááºáá»á¬áž
- Proxy Pattern: á¡áá±á¬ááºážáá¯á¶ážááŒá
áºááá¯ááºááẠlazy loading ááŸáá·áº caching
ð .NET áá®ááá¯ááºážáá°ááŒááºážáá»á¬áž
SOLID áá°ááŒááºážáá»á¬áž
- Single Responsibility: áááºááá·áºááœááºááœááºáááºá·á០áá
áºáá¯áááºážáá±á¬ áááºááœááºáá»ááºááŸáááŒááºáž
- Open/Closed: ááŒááºáááºááŸá¯ááá²á· áááºáááºááŒáá·áºáá»áááá¯ááºááŒááºáž
- Liskov Substitution: á¡ááºáá¬áá±á·á
áºá¡ááŒá±ááŒá¯ tool á¡áá±á¬ááºá¡áááºáá±á¬áºááŸá¯áá»á¬áž
- Interface Segregation: áŠážáááºáá»ááºááŒáá·áºá
á¯á¶áá±á¬á ááá¯ááºáᬠá¡ááºáá¬áá±á·á
áºáá»á¬áž
- Dependency Inversion: áááá»ááŒááºážáááŸááá²á· á¡áá¬áá»á¬ážáá±á«áº á¡á¬ážáá¬ážááŒááºáž
ááŸááºážáááºáž Architecture
- Domain Layer: á¡ááá agent ááŸáá·áº tool á¡ááŒá±á¬ááºážá¡áá¬áá»á¬áž
- Application Layer: agent á
á®áá¶ááá·áºááœá²ááŸá¯ááŸáá·áº áá¯ááºáááºážá
ááºáá»á¬áž
- Infrastructure Layer: Azure OpenAI (Responses API) áá±á«ááºážá
ááºážááŸá¯ááŸáá·áº ááŒááºá áááºáá±á¬ááºááŸá¯áá»á¬áž
- Presentation Layer: á¡áá¯á¶ážááŒá¯áá°ááŸáá·áº áááºááœááºááŸá¯á áá¯á¶á·ááŒááºááŸá¯ áá¯á¶áá±á¬áºááŒááºáž
ð á
ááºááŸá¯áá¯ááºáááºáž á
ááºážá
á¬ážáá»ááºáá»á¬áž
áá¯á¶ááŒá¯á¶áá±áž
- áááºááŸááºá
á®áá¶ááá·áºááœá²ááŸá¯: IConfiguration ááŒáá·áº API key áá¯á¶ááŒá¯á¶á
áœá¬ ááá¯ááºááœááºááŒááºáž
- ááá·áºááœááºážááŸá¯ á
á
áºáá±ážááŸá¯: ááŒá¶á·ááá¯ááºáá±á¬ typing ááŸáá·áº data annotation á
á
áºáá±ážááŒááºáž
- ááœááºááŸáááŸá¯ ááá·áºááŸááºážááŸá¯: áá¯á¶ááŒá¯á¶áá±á¬ áá¯á¶á·ááŒááºááŸá¯ áááºáá¶ááŸá¯ ááŸáá·áº á
á
áºáá¯ááºááŸá¯
- á
á¬áááºážááœááºáž ááŸááºáááºáž: áá¯ááºáááºážáá±á¬ááºááœááºáá»ááºáá»á¬áž ááŒá¬ááŸáẠá
á±á¬áá·áºááŒáá·áºááŒááºáž
áá±á¬ááºááœááºááŸá¯
- Async Patterns: ááŒááºáá±á¬ááºáááŸááá±á¬ I/O áá¯ááºáááºážá
ááºáá»á¬áž
- Connection Pooling: áááá±á¬ááºáá±á¬ HTTP client á
á®áá¶ááá·áºááœá²ááŸá¯
- Caching: áá¯á¶á·ááŒááºááŸá¯ caching ááŒáá·áº áá±á¬ááºááœááºááŸá¯ ááá¯ážáááºááŸá¯
- Resource Management: ááá·áºáá±á¬áºááá·áº áá»ááºáá
áºááŸá¯ ááŸáá·áº ááá·áºááŸááºážááŸá¯ áá¯á¶á
á¶áá»á¬áž
ááá¬áááá¯ážáááºááŸá¯
- Thread Safety: áááŒáá¯ááºááẠagent áá±á¬ááºááœááºááŸá¯ áá±á¬ááºáá¶á·ááŸá¯
- Resource Pooling: áááá±á¬ááºáá±á¬ áááºážááŒá
áºá¡áá¯á¶ážááŒá¯ááŸá¯
- Load Management: á¡ááŒááºááŸá¯ááºážááá·áºáááºááŒááºážááŸáá·áº áá±á¬ááºáá¯á¶á·ááŒááºááŸá¯ ááá¯ááºááœááºááŒááºáž
- Monitoring: áá±á¬ááºááœááºááŸá¯ ááááºážááááºážáá»á¬ážááŸáá·áº áá»ááºážáá¬áá±ážá
á
áºáá±ážááŒááºáž
ð áá¯ááºáá¯ááºááŸá¯ á¡ááá·áºááá¯á· ááŒá±á¬ááºážááœáŸá±á·ááŒááºáž
- Configuration Management: áááºáááºážáá»áẠá¡áá°ážáá»á¯ááºáá»ááºáá»á¬áž
- Logging Strategy: á¡áááºá¡ááœáẠID áá»á¬ážááŸáá·áº á¡á
á®á¡á
áẠlogging
- Error Handling: ááŒáá·áºá
á¯á¶áá±á¬ exception ááá¯ááºááœááºááŸá¯ááŸáá·áº ááá·áºáá±á¬áºáá±á¬ ááŒááºáááºáá°áá±á¬ááºááŸá¯
- Monitoring: Application insights ááŸáá·áº áá±á¬ááºááœááºááŸá¯ á¡ááá¯ážá¡áá»áẠáá®áá¬áá»á¬áž
- Testing: áá°áá
áºá
ááºážáááºááŸá¯áá»á¬ážá áá±á«ááºážá
ááºá
ááºážáááºááŸá¯áá»á¬ážááŸáá·áº á¡áá±ážáá»ááẠá
ááºážáááºááŸá¯ áá¯á¶á
á¶áá»á¬áž
.NET ááŸáá·áºá¡áá° á
ááºááŸá¯áá¯ááºáááºážá¡ááá·áº áá¬ááºá
áœááºáž agents áá»á¬áž áááºáá®ážááá¯á· á¡ááá·áºááŒá
áºáá«ááŒá®áá¬áž? áá¬áá¬áááºááŒá®ážáá
áºáᯠá¡á¬ážáá±á¬ááºážá
áœá¬ áá±á¬ááºááŒáá«á
áá¯á·! ð¢âš
ð á
áááºááŒááºáž
ááá¯á¡ááºáá»ááºáá»á¬áž
- .NET 10 SDK ááá¯á·ááá¯áẠáááºááŒáá·áºáá±á¬ áá¬ážááŸááºáž
- Azure OpenAI resource ááŸáá·áº áá±á¬áºááẠáááºáááºáá¬ážáá±á¬ Azure subscription
- Azure CLI â
az login ááŒáá·áº áááºáá±á¬ááºááŸá¯
ááá¯á¡ááºáá±á¬ áááºáááºážáá»áẠáá°ááááºážáá»á¬áž
# zsh/bash
export AZURE_OPENAI_ENDPOINT=https://<your-resource>.openai.azure.com
export AZURE_OPENAI_DEPLOYMENT=gpt-4.1-mini
# áá«áá²á· AzureCliCredential á token ááᯠáááá¯ááºá¡á±á¬áẠá¡áá±á¬áá·áºáááºáá«á
az login
# PowerShell
$env:AZURE_OPENAI_ENDPOINT = "https://<your-resource>.openai.azure.com"
$env:AZURE_OPENAI_DEPLOYMENT = "gpt-4.1-mini"
# ááá¯á·áá±á¬áẠAzureCliCredential ááẠtoken ááᯠááá°ááá¯ááºááẠááá·áºá¡áá±á¬áá·áºááá¯á· áááºááŸááºááá¯ážáááºáá«á
az login
ááá°áᬠáá¯ááº
áá¯ááºááá°áá¬ááᯠchạy áá²á·á¡áá«ïŒ
# zsh/bash
chmod +x ./03-dotnet-agent-framework.cs
./03-dotnet-agent-framework.cs
áá«ááŸááá¯áẠdotnet CLI ááŒáá·áºá
dotnet run ./03-dotnet-agent-framework.cs
ááŒáá·áºá
á¯á¶áá±á¬ áá¯ááºááᯠ03-dotnet-agent-framework.cs ááœáẠááŒáá·áºááŸá¯ááá¯ááºáá«áááºá
#!/usr/bin/dotnet run
#:package Microsoft.Extensions.AI@10.*
#:package Microsoft.Agents.AI.OpenAI@1.*-*
#:package Azure.AI.OpenAI@2.1.0
#:package Azure.Identity@1.13.1
using System.ComponentModel;
using Microsoft.Agents.AI;
using Microsoft.Extensions.AI;
using Azure.AI.OpenAI;
using Azure.Identity;
// 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()
{
// List of popular vacation destinations around the world
// The agent will randomly select from these options
var destinations = new List<string>
{
"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 and return selected destination
// Uses System.Random for simple random selection
var random = new Random();
int index = random.Next(destinations.Count);
return destinations[index];
}
// Azure OpenAI with the Responses API (stable v1 endpoint). Sign in with `az login`.
var azureEndpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT")
?? throw new InvalidOperationException("AZURE_OPENAI_ENDPOINT is not set.");
var deployment = Environment.GetEnvironmentVariable("AZURE_OPENAI_DEPLOYMENT") ?? "gpt-4.1-mini";
var azureClient = new AzureOpenAIClient(new Uri(azureEndpoint), new AzureCliCredential());
// Define Agent Identity and Comprehensive Instructions
// Agent name for identification and logging purposes
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
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:
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?"
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
// Get the Responses client for the deployment and create the AI agent
// Configure agent with name, detailed instructions, and available tools
// This demonstrates the .NET agent creation pattern with full configuration
AIAgent agent = azureClient
.GetChatClient(deployment)
.AsAIAgent(
name: AGENT_NAME,
instructions: AGENT_INSTRUCTIONS,
tools: [AIFunctionFactory.Create(GetRandomDestination)]
);
// Create New Conversation Session for Context Management
// Initialize a new conversation session to maintain context across multiple interactions
// Sessions enable the agent to remember previous exchanges and maintain conversational state
// This is essential for multi-turn conversations and contextual understanding
var session = await agent.CreateSessionAsync();
// 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 session parameter maintains conversation context for subsequent interactions
await foreach (var update in agent.RunStreamingAsync("Plan me a day trip", session))
{
await Task.Delay(10);
Console.Write(update);
}
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 sessions and contextual understanding in .NET agents
await foreach (var update in agent.RunStreamingAsync("I don't like that destination. Plan me another vacation.", session))
{
await Task.Delay(10);
Console.Write(update);
}
ááŒá±á¬ááŒá¬ážáá»ááº
á€á
á¬áááºážááᯠAI áá¬áá¬ááŒááºáááºáá±á¬ááºááŸá¯ Co-op Translator á¡áá¯á¶ážááŒá¯á áá¬áá¬ááŒááºáá¬ážáá«áááºá áá»áœááºá¯ááºááá¯á·ááẠáááá»ááŸááºáááºááŸá¯á¡ááœáẠááŒáá¯ážáááºážáá±áá±á¬áºáááºážá á
ááºáááááá¬áá¬áá¬ááŒááºááŒááºážáá»á¬ážááœáẠá¡ááŸá¬ážáá»á¬áž ááá¯á·ááá¯áẠááŸá¬ážááœááºážáá»ááºáá»á¬áž áá«áááºááá¯ááºááŒá±á¬ááºáž áááááŒá¯áá«ááẠááá¯á¡ááºáá«áááºá áá°áá
á¬áááºážááᯠáá°áááºážáá¬áá¬ááŒáá·áºáᬠáá¯á¶ááŒááºá
áááºáá»ááá±á¬ á¡áá»ááºá¡áááºá¡ááŒá
ẠáááºááŸááºááá·áºáááºá á¡áá±ážááŒá®ážááá·áº ááááºážá¡áá»ááºá¡áááºáá»á¬ážá¡ááœáẠááá±á¬áºáááºááŸááºááẠáá°áá¬ážáá¬áá¬ááŒááºáá°áááºáá±á¬ááºááŸá¯ááᯠá¡ááŒá¶ááŒá¯áá«áááºá á€áá¬áá¬ááŒááºáá»ááºááᯠá¡áá¯á¶ážááŒá¯ááŒááºážá០ááŒá
áºáá±á«áºáá¬áá±á¬ áá¬ážáááºááŸá¯ááœá¬ááŒá¬ážááŸá¯áá»á¬áž ááá¯á·ááá¯áẠáááŸááºáááºáá±á¬ á¡áá¯á¶ážááŒá¯ááŸá¯áá»á¬ážá¡ááœáẠáá»áœááºá¯ááºááá¯á· áá¬áááºááá¶áá«á