diff --git a/README.md b/README.md index b904b062df..05c0171a2f 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,18 @@ Welcome to Microsoft's comprehensive multi-language framework for building, orchestrating, and deploying AI agents with support for both .NET and Python implementations. This framework provides everything from simple chat agents to complex multi-agent workflows with graph-based orchestration. +

+ + Watch the full Agent Framework introduction (30 min) + +

+

+ + Watch the full Agent Framework introduction (30 min) + +

+ ## 📋 Getting Started **Quick Installation:** @@ -25,6 +37,18 @@ Welcome to Microsoft's comprehensive multi-language framework for building, orch - [Labs directory](./python/packages/lab/) - **DevUI**: Interactive developer UI for agent development, testing, and debugging workflows - [DevUI package](./python/packages/devui/) + +

+ + See the DevUI in action + +

+

+ + See the DevUI in action (1 min) + +

+ - **Python and C#/.NET Support**: Full framework support for both Python and C#/.NET implementations with consistent APIs - [Python packages](./python/packages/) | [.NET source](./dotnet/src/) - **Observability**: Built-in OpenTelemetry integration for distributed tracing, monitoring, and debugging @@ -38,6 +62,47 @@ Welcome to Microsoft's comprehensive multi-language framework for building, orch - For bugs, please file a [GitHub issue](https://github.com/microsoft/agent-framework/issues). +## Quickstart + +### Basic Agent - Python + +Create a simple Azure Responses Agent that writes a haiku about the Microsoft Agent Framework + +```python +import asyncio +from agent_framework.azure import AzureOpenAIResponsesClient +from azure.identity import AzureCliCredential + +async def main(): + # Initialize a chat agent with basic instructions + agent = AzureOpenAIResponsesClient(credential=AzureCliCredential()).create_agent( + name="HaikuBot", + instructions="You are an upbeat assistant that writes beautifully.", + ) + + print(await agent.run("Write a haiku about Microsoft Agent Framework.")) + +asyncio.run(main()) +``` + +### Basic Agent - .NET + +```c# +using System; +using Azure.AI.OpenAI; +using Azure.Identity; +using Microsoft.Agents.AI; + +var endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT")!; +var deploymentName = Environment.GetEnvironmentVariable("AZURE_OPENAI_DEPLOYMENT_NAME")!; + +var agent = new AzureOpenAIClient(new Uri(endpoint), new AzureCliCredential()) + .GetOpenAIResponseClient(deploymentName) + .CreateAIAgent(name: "HaikuBot", instructions: "You are an upbeat assistant that writes beautifully."); + +Console.WriteLine(await agent.RunAsync("Write a haiku about Microsoft Agent Framework.")); +``` + ## More Examples & Samples ### Python diff --git a/python/.DS_Store b/python/.DS_Store deleted file mode 100644 index 8cb7761ef9..0000000000 Binary files a/python/.DS_Store and /dev/null differ