From f19ebf5b1b7e00fe37618e756494fec39453420c Mon Sep 17 00:00:00 2001 From: Evan Mattson <35585003+moonbox3@users.noreply.github.com> Date: Wed, 1 Oct 2025 17:22:21 +0900 Subject: [PATCH] Python: Update README with links to video content. Include initial code samples as a quickstart (#1049) * Update README with links to video content. Include initial code samples as a quickstart. * Include import * Fix .net code * Simplify sample * Fix python spacing * updates * Remove .DS_Store file. --- README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++ python/.DS_Store | Bin 6148 -> 0 bytes 2 files changed, 65 insertions(+) delete mode 100644 python/.DS_Store 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 8cb7761ef990fa292af3fa5c19375bd056e23233..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeHK%}T>S5Z<-XrW7Fug&r5Y7Ob_X#Y>3w1&ruHr6#6mFlI}WnnNk%tS{t~_&m<+ zZp31}ir5+0{pNQ!`$6`HF~+@Vw8xmk7_*@va#WTGx|fF5Ofn+JF~TAnhlvcqelxMZ z4*2aBit1M5cKVr=y7~h@%mtTwlg%BnwYY(jr-h;2oukr|q0b+m{AO=>K z0dpqU&DEuVR!$5M13xf;`-6an=o&0Fs;vV$ygp;xLPP-_-x7$zplh(y2oVsjO96E$ zH%|<%%fT;9o@=nwsLL5wGs8G$=IZgn)$HIGDxGmxBlW}pF|f!$O`8s$|EKWFEPdoJ zmXJjZ5Ci{=0d5Wafd`8+XY04+;aMx7-9kgbyb=`<&=)QNVBkK|Qb8RTs6(D>u+)g7 TpkI{((nUZKLLD*i3k-Y!c=k$K