ai-agents-for-beginners

🎨 Агентные паттерны проектирования с Azure OpenAI (Responses API) (.NET)

📋 Цели обучения

Этот пример демонстрирует корпоративные паттерны проектирования для создания интеллектуальных агентов с использованием Microsoft Agent Framework в .NET с интеграцией Azure OpenAI (Responses API). Вы изучите профессиональные паттерны и архитектурные подходы, которые делают агентов готовыми к промышленному применению, удобными в сопровождении и масштабируемыми.

Корпоративные паттерны проектирования

• 🏭 Паттерн Фабрика: Стандартизированное создание агентов с внедрением зависимостей
• 🔧 Паттерн Строитель: Плавная настройка и конфигурация агента
• 🧵 Паттерны потокобезопасности: Управление конкурентными беседами
• 📋 Паттерн Репозиторий: Организованное управление инструментами и возможностями

🎯 Преимущества архитектуры, специфичные для .NET

Корпоративные особенности

• Строгая типизация: Проверка во время компиляции и поддержка IntelliSense
• Внедрение зависимостей: Интеграция встроенного DI контейнера
• Управление конфигурацией: Шаблоны IConfiguration и Options
• Async/Await: Поддержка асинхронного программирования первого класса

Паттерны, готовые к продакшену

• Интеграция логирования: Поддержка ILogger и структурированного логирования
• Проверки здоровья: Встроенный мониторинг и диагностика
• Валидация конфигурации: Строгая типизация с использованием аннотаций данных
• Обработка ошибок: Структурированное управление исключениями

🔧 Техническая архитектура

Основные компоненты .NET

• Microsoft.Extensions.AI: Унифицированные абстракции AI-сервисов
• Microsoft.Agents.AI: Корпоративный фреймворк оркестрации агентов
• Azure OpenAI (Responses API): Паттерны высокопроизводительных API клиентов
• Система конфигурации: интеграция appsettings.json и окружения

Реализация паттернов проектирования

graph LR
    A[IServiceCollection] --> B[Конструктор агента]
    B --> C[Конфигурация]
    C --> D[Реестр инструментов]
    D --> E[ИИ агент]

🏗️ Демонстрация корпоративных паттернов

1. Порождающие паттерны

• Фабрика агентов: Централизованное создание агентов с единообразной конфигурацией
• Паттерн Строитель: Плавный API для сложной настройки агента
• Паттерн Одиночка: Управление общими ресурсами и конфигурациями
• Внедрение зависимостей: Слабое сцепление и тестируемость

2. Поведенческие паттерны

• Паттерн Стратегия: Взаимозаменяемые стратегии выполнения инструментов
• Паттерн Команда: Инкапсулированные операции агента с поддержкой отмены/повтора
• Паттерн Наблюдатель: Управление жизненным циклом агента на основе событий
• Шаблонный метод: Стандартизированные рабочие процессы агента

3. Структурные паттерны

• Паттерн Адаптер: Слой интеграции Azure OpenAI (Responses API)
• Паттерн Декоратор: Расширение возможностей агента
• Паттерн Фасад: Упрощённые интерфейсы взаимодействия с агентом
• Паттерн Заместитель: Ленивое создание и кэширование для повышения производительности

📚 Принципы проектирования в .NET

Принципы SOLID

• Принцип единственной ответственности: Каждый компонент имеет одну чёткую задачу
• Принцип открытости/закрытости: Расширяемость без модификации
• Принцип подстановки Лисков: Реализации инструментов на основе интерфейсов
• Принцип разделения интерфейсов: Фокусированные, когезивные интерфейсы
• Принцип инверсии зависимостей: Зависимость от абстракций, а не от конкретных классов

Чистая архитектура

• Доменный слой: Основные абстракции агентов и инструментов
• Прикладной слой: Оркестрация и рабочие процессы агентов
• Инфраструктурный слой: Интеграция Azure OpenAI (Responses API) и внешних сервисов
• Презентационный слой: Взаимодействие с пользователем и форматирование ответов

🔒 Корпоративные аспекты

Безопасность

• Управление учетными данными: Безопасное хранение ключей API через IConfiguration
• Валидация входных данных: Строгая типизация и проверка аннотаций данных
• Санитизация вывода: Безопасная обработка и фильтрация ответов
• Аудит логирование: Всеобъемлющее отслеживание операций

Производительность

• Асинхронные паттерны: Неблокирующие операции ввода/вывода
• Пул подключений: Эффективное управление HTTP клиентами
• Кэширование: Кэширование ответов для повышения производительности
• Управление ресурсами: Корректное освобождение и очистка ресурсов

Масштабируемость

• Потокобезопасность: Поддержка параллельного выполнения агентов
• Пул ресурсов: Эффективное использование ресурсов
• Управление нагрузкой: Ограничение скорости и обработка обратного давления
• Мониторинг: Метрики производительности и проверки здоровья

🚀 Развертывание в производстве

• Управление конфигурацией: Настройки для разных окружений
• Стратегия логирования: Структурированное логирование с корреляционными ID
• Обработка ошибок: Глобальная обработка исключений с корректным восстановлением
• Мониторинг: Application Insights и счётчики производительности
• Тестирование: Модульные тесты, интеграционные и нагрузочные шаблоны

Готовы создавать корпоративные интеллектуальные агенты на .NET? Давайте спроектируем что-то надёжное! 🏢✨

🚀 Начало работы

Требования

• .NET 10 SDK или выше
• Подписка Azure с ресурсом Azure OpenAI и развертыванием модели
• Установленный 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 мог получить токен
az login

# PowerShell
$env:AZURE_OPENAI_ENDPOINT = "https://<your-resource>.openai.azure.com"
$env:AZURE_OPENAI_DEPLOYMENT = "gpt-4.1-mini"
# Затем войдите в систему, чтобы AzureCliCredential мог получить токен
az login

Пример кода

Чтобы запустить пример кода,

# 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);
}

---

Отказ от ответственности: Этот документ был переведен с использованием сервиса машинного перевода Co-op Translator. Несмотря на наши усилия по обеспечению точности, имейте в виду, что автоматический перевод может содержать ошибки или неточности. Оригинальный документ на его исходном языке следует считать авторитетным источником. Для получения критически важной информации рекомендуется обратиться к профессиональному человеческому переводу. Мы не несем ответственности за любые недоразумения или неправильные толкования, возникшие в результате использования этого перевода.

This site is open source. Improve this page.