ai-agents-for-beginners

🎨 GitHub āĻŽāĻĄā§‡āĻ˛ (.NET) āĻ¸āĻš Agentic āĻĄāĻŋāĻœāĻžāĻ‡āĻ¨ āĻĒā§āĻ¯āĻžāĻŸāĻžāĻ°ā§āĻ¨

📋 āĻļā§‡āĻ–āĻžāĻ° āĻ˛āĻ•ā§āĻˇā§āĻ¯

āĻāĻ‡ āĻ‰āĻĻāĻžāĻšāĻ°āĻŖāĻŸāĻŋ Microsoft Agent Framework āĻŦā§āĻ¯āĻŦāĻšāĻžāĻ° āĻ•āĻ°ā§‡ .NET-āĻ GitHub āĻŽāĻĄā§‡āĻ˛ āĻ‡āĻ¨ā§āĻŸāĻŋāĻ—ā§āĻ°ā§‡āĻļāĻ¨ā§‡āĻ° āĻŽāĻžāĻ§ā§āĻ¯āĻŽā§‡ āĻŦā§āĻĻā§āĻ§āĻŋāĻŽāĻžāĻ¨ āĻāĻœā§‡āĻ¨ā§āĻŸ āĻ¤ā§ˆāĻ°āĻŋ āĻ•āĻ°āĻžāĻ° āĻœāĻ¨ā§āĻ¯ āĻāĻ¨ā§āĻŸāĻžāĻ°āĻĒā§āĻ°āĻžāĻ‡āĻœ-āĻ—ā§āĻ°ā§‡āĻĄ āĻĄāĻŋāĻœāĻžāĻ‡āĻ¨ āĻĒā§āĻ¯āĻžāĻŸāĻžāĻ°ā§āĻ¨āĻ—ā§āĻ˛āĻŋ āĻĒā§āĻ°āĻĻāĻ°ā§āĻļāĻ¨ āĻ•āĻ°ā§‡āĨ¤ āĻ†āĻĒāĻ¨āĻŋ āĻāĻŽāĻ¨ āĻĒā§‡āĻļāĻžāĻĻāĻžāĻ° āĻĒā§āĻ¯āĻžāĻŸāĻžāĻ°ā§āĻ¨ āĻāĻŦāĻ‚ āĻ¸ā§āĻĨāĻžāĻĒāĻ¤ā§āĻ¯āĻ—āĻ¤ āĻĒāĻĻā§āĻ§āĻ¤āĻŋ āĻļāĻŋāĻ–āĻŦā§‡āĻ¨ āĻ¯āĻž āĻāĻœā§‡āĻ¨ā§āĻŸāĻ•ā§‡ āĻĒā§āĻ°ā§‹āĻĄāĻžāĻ•āĻļāĻ¨-āĻ°ā§‡āĻĄāĻŋ, āĻ°āĻ•ā§āĻˇāĻŖāĻžāĻŦā§‡āĻ•ā§āĻˇāĻŖāĻ¯ā§‹āĻ—ā§āĻ¯ āĻāĻŦāĻ‚ āĻ¸ā§āĻ•ā§‡āĻ˛āĻ¯ā§‹āĻ—ā§āĻ¯ āĻ•āĻ°ā§‡ āĻ¤ā§‹āĻ˛ā§‡āĨ¤

āĻāĻ¨ā§āĻŸāĻžāĻ°āĻĒā§āĻ°āĻžāĻ‡āĻœ āĻĄāĻŋāĻœāĻžāĻ‡āĻ¨ āĻĒā§āĻ¯āĻžāĻŸāĻžāĻ°ā§āĻ¨

đŸŽ¯ .NET-āĻ¨āĻŋāĻ°ā§āĻĻāĻŋāĻˇā§āĻŸ āĻ¸ā§āĻĨāĻžāĻĒāĻ¤ā§āĻ¯āĻ—āĻ¤ āĻ¸ā§āĻŦāĻŋāĻ§āĻž

āĻāĻ¨ā§āĻŸāĻžāĻ°āĻĒā§āĻ°āĻžāĻ‡āĻœ āĻŦā§ˆāĻļāĻŋāĻˇā§āĻŸā§āĻ¯

āĻĒā§āĻ°ā§‹āĻĄāĻžāĻ•āĻļāĻ¨-āĻ°ā§‡āĻĄāĻŋ āĻĒā§āĻ¯āĻžāĻŸāĻžāĻ°ā§āĻ¨

🔧 āĻŸā§‡āĻ•āĻ¨āĻŋāĻ•ā§āĻ¯āĻžāĻ˛ āĻ¸ā§āĻĨāĻžāĻĒāĻ¤ā§āĻ¯

āĻŽā§‚āĻ˛ .NET āĻ‰āĻĒāĻžāĻĻāĻžāĻ¨

āĻĄāĻŋāĻœāĻžāĻ‡āĻ¨ āĻĒā§āĻ¯āĻžāĻŸāĻžāĻ°ā§āĻ¨ āĻŦāĻžāĻ¸ā§āĻ¤āĻŦāĻžā§ŸāĻ¨

graph LR
    A[IServiceCollection] --> B[Agent Builder]
    B --> C[Configuration]
    C --> D[Tool Registry]
    D --> E[AI Agent]

🏗ī¸ āĻĒā§āĻ°āĻĻāĻ°ā§āĻļāĻŋāĻ¤ āĻāĻ¨ā§āĻŸāĻžāĻ°āĻĒā§āĻ°āĻžāĻ‡āĻœ āĻĒā§āĻ¯āĻžāĻŸāĻžāĻ°ā§āĻ¨

1. āĻ•ā§āĻ°āĻŋā§Ÿā§‡āĻļāĻ¨āĻžāĻ˛ āĻĒā§āĻ¯āĻžāĻŸāĻžāĻ°ā§āĻ¨

2. āĻŦāĻŋāĻšā§‡āĻ­āĻŋāĻ°āĻžāĻ˛ āĻĒā§āĻ¯āĻžāĻŸāĻžāĻ°ā§āĻ¨

3. āĻ¸ā§āĻŸā§āĻ°āĻžāĻ•āĻšāĻžāĻ°āĻžāĻ˛ āĻĒā§āĻ¯āĻžāĻŸāĻžāĻ°ā§āĻ¨

📚 .NET āĻĄāĻŋāĻœāĻžāĻ‡āĻ¨ āĻ¨ā§€āĻ¤āĻŋāĻŽāĻžāĻ˛āĻž

SOLID āĻ¨ā§€āĻ¤āĻŋāĻŽāĻžāĻ˛āĻž

āĻ•ā§āĻ˛āĻŋāĻ¨ āĻ†āĻ°ā§āĻ•āĻŋāĻŸā§‡āĻ•āĻšāĻžāĻ°

🔒 āĻāĻ¨ā§āĻŸāĻžāĻ°āĻĒā§āĻ°āĻžāĻ‡āĻœ āĻŦāĻŋāĻŦā§‡āĻšāĻ¨āĻž

āĻ¨āĻŋāĻ°āĻžāĻĒāĻ¤ā§āĻ¤āĻž

āĻĒāĻžāĻ°āĻĢāĻ°āĻŽā§āĻ¯āĻžāĻ¨ā§āĻ¸

āĻ¸ā§āĻ•ā§‡āĻ˛ā§‡āĻŦāĻŋāĻ˛āĻŋāĻŸāĻŋ

🚀 āĻĒā§āĻ°ā§‹āĻĄāĻžāĻ•āĻļāĻ¨ āĻĄāĻŋāĻĒā§āĻ˛ā§ŸāĻŽā§‡āĻ¨ā§āĻŸ

āĻāĻ¨ā§āĻŸāĻžāĻ°āĻĒā§āĻ°āĻžāĻ‡āĻœ-āĻ—ā§āĻ°ā§‡āĻĄ āĻŦā§āĻĻā§āĻ§āĻŋāĻŽāĻžāĻ¨ āĻāĻœā§‡āĻ¨ā§āĻŸ āĻ¤ā§ˆāĻ°āĻŋ āĻ•āĻ°āĻ¤ā§‡ āĻĒā§āĻ°āĻ¸ā§āĻ¤ā§āĻ¤ .NET āĻĻāĻŋā§Ÿā§‡? āĻšāĻ˛ā§āĻ¨ āĻ•āĻŋāĻ›ā§ āĻļāĻ•ā§āĻ¤āĻŋāĻļāĻžāĻ˛ā§€ āĻ¸ā§āĻĨāĻžāĻĒāĻ¤ā§āĻ¯ āĻ¤ā§ˆāĻ°āĻŋ āĻ•āĻ°āĻŋ! đŸĸ✨

🚀 āĻļā§āĻ°ā§ āĻ•āĻ°āĻž

āĻĒā§āĻ°āĻ¯āĻŧā§‹āĻœāĻ¨ā§€āĻ¯āĻŧāĻ¤āĻž

āĻĒā§āĻ°āĻ¯āĻŧā§‹āĻœāĻ¨ā§€āĻ¯āĻŧ āĻĒāĻ°āĻŋāĻŦā§‡āĻļ āĻ­ā§‡āĻ°āĻŋāĻ¯āĻŧā§‡āĻŦāĻ˛

# zsh/bash
export GH_TOKEN=<your_github_token>
export GH_ENDPOINT=https://models.github.ai/inference
export GH_MODEL_ID=openai/gpt-5-mini

# PowerShell
$env:GH_TOKEN = "<your_github_token>"
$env:GH_ENDPOINT = "https://models.github.ai/inference"
$env:GH_MODEL_ID = "openai/gpt-5-mini"

āĻ¨āĻŽā§āĻ¨āĻž āĻ•ā§‹āĻĄ

āĻ•ā§‹āĻĄ āĻ‰āĻĻāĻžāĻšāĻ°āĻŖ āĻšāĻžāĻ˛āĻžāĻ¨ā§‹āĻ° āĻœāĻ¨ā§āĻ¯,

# 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.*-*

using System.ClientModel;
using System.ComponentModel;

using Microsoft.Agents.AI;
using Microsoft.Extensions.AI;

using OpenAI;

// 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];
}

// Extract configuration from environment variables
// Retrieve the GitHub Models API endpoint, defaults to https://models.github.ai/inference if not specified
// Retrieve the model ID, defaults to openai/gpt-5-mini if not specified
// Retrieve the GitHub token for authentication, throws exception if not specified
var github_endpoint = Environment.GetEnvironmentVariable("GH_ENDPOINT") ?? "https://models.github.ai/inference";
var github_model_id = Environment.GetEnvironmentVariable("GH_MODEL_ID") ?? "openai/gpt-5-mini";
var github_token = Environment.GetEnvironmentVariable("GH_TOKEN") ?? throw new InvalidOperationException("GH_TOKEN is not set.");

// Configure OpenAI Client Options
// Create configuration options to point to GitHub Models endpoint
// This redirects OpenAI client calls to GitHub's model inference service
var openAIOptions = new OpenAIClientOptions()
{
    Endpoint = new Uri(github_endpoint)
};

// Initialize OpenAI Client with GitHub Models Configuration
// Create OpenAI client using GitHub token for authentication
// Configure it to use GitHub Models endpoint instead of OpenAI directly
var openAIClient = new OpenAIClient(new ApiKeyCredential(github_token), openAIOptions);

// 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
// Initialize complete agent pipeline: OpenAI client → Chat client → AI agent
// Configure agent with name, detailed instructions, and available tools
// This demonstrates the .NET agent creation pattern with full configuration
AIAgent agent = openAIClient
    .GetChatClient(github_model_id)
    .CreateAIAgent(
        name: AGENT_NAME,
        instructions: AGENT_INSTRUCTIONS,
        tools: [AIFunctionFactory.Create(GetRandomDestination)]
    );

// Create New Conversation Thread for Context Management
// Initialize a new conversation thread to maintain context across multiple interactions
// Threads enable the agent to remember previous exchanges and maintain conversational state
// This is essential for multi-turn conversations and contextual understanding
AgentThread thread = agent.GetNewThread();

// 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 thread parameter maintains conversation context for subsequent interactions
await foreach (var update in agent.RunStreamingAsync("Plan me a day trip", thread))
{
    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 threads and contextual understanding in .NET agents
await foreach (var update in agent.RunStreamingAsync("I don't like that destination. Plan me another vacation.", thread))
{
    await Task.Delay(10);
    Console.Write(update);
}

āĻ…āĻ¸ā§āĻŦā§€āĻ•ā§ƒāĻ¤āĻŋ:
āĻāĻ‡ āĻ¨āĻĨāĻŋāĻŸāĻŋ AI āĻ…āĻ¨ā§āĻŦāĻžāĻĻ āĻĒāĻ°āĻŋāĻˇā§‡āĻŦāĻž Co-op Translator āĻŦā§āĻ¯āĻŦāĻšāĻžāĻ° āĻ•āĻ°ā§‡ āĻ…āĻ¨ā§āĻŦāĻžāĻĻ āĻ•āĻ°āĻž āĻšāĻ¯āĻŧā§‡āĻ›ā§‡āĨ¤ āĻ†āĻŽāĻ°āĻž āĻ¯āĻĨāĻžāĻ¸āĻžāĻ§ā§āĻ¯ āĻ¸āĻ āĻŋāĻ• āĻ…āĻ¨ā§āĻŦāĻžāĻĻā§‡āĻ° āĻšā§‡āĻˇā§āĻŸāĻž āĻ•āĻ°āĻŋ, āĻ¤āĻŦā§‡ āĻĻāĻ¯āĻŧāĻž āĻ•āĻ°ā§‡ āĻŽāĻ¨ā§‡ āĻ°āĻžāĻ–āĻŦā§‡āĻ¨ āĻ¯ā§‡ āĻ¸ā§āĻŦāĻ¯āĻŧāĻ‚āĻ•ā§āĻ°āĻŋāĻ¯āĻŧ āĻ…āĻ¨ā§āĻŦāĻžāĻĻā§‡ āĻ¤ā§āĻ°ā§āĻŸāĻŋ āĻŦāĻž āĻ…āĻ¸āĻ™ā§āĻ—āĻ¤āĻŋ āĻĨāĻžāĻ•āĻ¤ā§‡ āĻĒāĻžāĻ°ā§‡āĨ¤ āĻ¨āĻĨāĻŋāĻŸāĻŋāĻ° āĻŽā§‚āĻ˛ āĻ­āĻžāĻˇāĻžāĻ¯āĻŧ āĻĨāĻžāĻ•āĻž āĻ¸āĻ‚āĻ¸ā§āĻ•āĻ°āĻŖāĻŸāĻŋāĻ•ā§‡ āĻĒā§āĻ°āĻžāĻŽāĻžāĻŖāĻŋāĻ• āĻ‰ā§ŽāĻ¸ āĻšāĻŋāĻ¸ā§‡āĻŦā§‡ āĻŦāĻŋāĻŦā§‡āĻšāĻ¨āĻž āĻ•āĻ°āĻž āĻ‰āĻšāĻŋāĻ¤āĨ¤ āĻ—ā§āĻ°ā§āĻ¤ā§āĻŦāĻĒā§‚āĻ°ā§āĻŖ āĻ¤āĻĨā§āĻ¯ā§‡āĻ° āĻœāĻ¨ā§āĻ¯, āĻĒā§‡āĻļāĻžāĻĻāĻžāĻ° āĻŽāĻžāĻ¨āĻŦ āĻ…āĻ¨ā§āĻŦāĻžāĻĻ āĻ¸ā§āĻĒāĻžāĻ°āĻŋāĻļ āĻ•āĻ°āĻž āĻšāĻ¯āĻŧāĨ¤ āĻāĻ‡ āĻ…āĻ¨ā§āĻŦāĻžāĻĻ āĻŦā§āĻ¯āĻŦāĻšāĻžāĻ°ā§‡āĻ° āĻĢāĻ˛ā§‡ āĻ¸ā§ƒāĻˇā§āĻŸ āĻ•ā§‹āĻ¨ā§‹ āĻ­ā§āĻ˛ āĻŦā§‹āĻāĻžāĻŦā§āĻāĻŋ āĻŦāĻž āĻ­ā§āĻ˛ āĻŦā§āĻ¯āĻžāĻ–ā§āĻ¯āĻžāĻ° āĻœāĻ¨ā§āĻ¯ āĻ†āĻŽāĻ°āĻž āĻĻāĻžāĻ¯āĻŧā§€ āĻ¨āĻ‡āĨ¤

This site is open source. Improve this page.