diff --git a/README.md b/README.md index 2c9ec03b6b..c45d7811e6 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,53 @@ -# Microsoft Agent Framework +![Microsoft Agent Framework](docs/assets/readme-banner.png) -## Welcome to the Private Preview of Agent Framework! +# Welcome to Microsoft Agent Framework! +[![Microsoft Azure AI Foundry Discord](https://dcbadge.limes.pink/api/server/b5zjErwbQM)](https://discord.gg/b5zjErwbQM) -You're getting early access 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. -### 📋 Important Setup Information -**Package Availability:** Public PyPI and NuGet packages are not yet available. You have two options: +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. -**Option 1: Run samples directly from this repository (no package installation needed)** -- Clone this repository -- For .NET: Run samples with `dotnet run` from any sample directory (e.g., `dotnet/samples/GettingStarted/Agents/Agent_Step01_Running`) -- For Python: Run samples from any sample directory (e.g., [`python/samples/getting_started/minimal_sample.py`](python/samples/getting_started/minimal_sample.py)) after setting up the local dev environment following this [guide](python/DEV_SETUP.md). +### 📋 Getting Started -**Option 2: Install packages in your own project** -- **[.NET Getting Started Guide](./user-documentation-dotnet/getting-started/README.md)** - Instructions for using nightly packages -- **[Python Package Installation Guide](./user-documentation-python/getting-started/package_installation.md)** - Install packages directly from GitHub +**Quick Installation:** +- **Python**: `pip install agent-framework` +- **.NET**: `dotnet add package Microsoft.Agents.AI` -**Stay Updated:** This is an active project - sync your local repository regularly to get the latest updates. +**Complete Getting Started Guides:** +- **[.NET Getting Started Guide](./user-documentation-dotnet/getting-started/README.md)** - Complete setup and usage instructions +- **[Python Getting Started Guide](./user-documentation-python/getting-started/package_installation.md)** - Installation and first steps + +### ✨ **Highlights** +- **Multi-Agent Orchestration**: Coordinate multiple agents with sequential, concurrent, group chat, and handoff patterns + - [Python samples](./python/samples/getting_started/workflow/orchestration/) | [.NET samples](./dotnet/samples/GettingStarted/AgentOrchestration/) +- **Graph-based Workflows**: Connect agents and deterministic functions using data flows with streaming, checkpointing, human-in-the-loop, and time-travel capabilities + - [Python workflows](./python/samples/getting_started/workflow/) | [.NET workflows](./dotnet/samples/GettingStarted/Workflows/) +- **AF Labs**: Experimental packages for cutting-edge features including benchmarking, reinforcement learning, and research initiatives + - [Labs directory](./python/packages/lab/) +- **DevUI**: Interactive developer UI for agent development, testing, and debugging workflows + - [DevUI package](./python/packages/devui/) +- **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 + - [Python observability](./python/samples/getting_started/workflow/observability/) | [.NET telemetry](./dotnet/samples/GettingStarted/AgentOpenTelemetry/) +- **Multiple Agent Provider Support**: Support for various LLM providers with more being added continuously + - [Python examples](./python/samples/getting_started/agents/) | [.NET examples](./dotnet/samples/GettingStarted/AgentProviders/) +- **Middleware**: Flexible middleware system for request/response processing, exception handling, and custom pipelines + - [Python middleware](./python/samples/getting_started/middleware/) | [.NET middleware](./dotnet/samples/GettingStarted/Agents/Agent_Step14_Middleware/) ### 💬 **We want your feedback!** - For bugs, please file a [GitHub issue](https://github.com/microsoft/agent-framework/issues). -- For feedback and suggestions for the team, please fill out [this survey](https://forms.office.com/Pages/ResponsePage.aspx?id=v4j5cvGGr0GRqy180BHbR9huAe5pW55CqgnnimXONJJUMlVMUzdCN1ZGOURXODlBSVJOSkxERVNCNS4u). - -### ✨ **Highlights** -- Flexible Agent Framework: build, orchestrate, and deploy AI agents and workflows -- Multi-Agent Orchestration: group chat, sequential, concurrent, and handoff patterns -- Graph-based Workflows: connect agents and deterministic functions using data flows with streaming, checkpointing, time-travel, and Human-in-the-loop. -- Plugin Ecosystem: extend with native functions, OpenAPI, Model Context Protocol (MCP), and more -- LLM Support: OpenAI, Azure OpenAI, Azure AI Foundry, and more -- Runtime Support: in-process and distributed agent execution -- Multimodal: text, vision, and function calling -- Cross-Platform: .NET and Python implementations - -Below are the basics for each language implementation. For more details on python see [here](./python/README.md) and for .NET see [here](./dotnet/README.md). ## More Examples & Samples ### Python - [Getting Started with Agents](./python/samples/getting_started/agents): basic agent creation and tool usage - [Chat Client Examples](./python/samples/getting_started/chat_client): direct chat client usage patterns -- [Azure Integration](./python/packages/azure): Azure OpenAI and AI Foundry integration - [Getting Started with Workflows](./python/samples/getting_started/workflow): basic workflow creation and integration with agents ### .NET - [Getting Started with Agents](./dotnet/samples/GettingStarted/Agents): basic agent creation and tool usage - [Agent Provider Samples](./dotnet/samples/GettingStarted/AgentProviders): samples showing different agent providers -- [Orchestration Samples](./dotnet/samples/GettingStarted/AgentOrchestration): advanced multi-agent patterns +- [Workflow Samples](./dotnet/samples/GettingStarted/Workflows): advanced multi-agent patterns and workflow orchestration ## Agent Framework Documentation @@ -54,4 +56,4 @@ Below are the basics for each language implementation. For more details on pytho - [Agent Framework Repository](https://github.com/microsoft/agent-framework) - [Design Documents](./docs/design) - [Architectural Decision Records](./docs/decisions) -- Learn docs are coming soon. +- [MSFT Learn Docs](https://learn.microsoft.com/agent-framework/overview/agent-framework-overview) \ No newline at end of file diff --git a/docs/assets/readme-banner.png b/docs/assets/readme-banner.png new file mode 100644 index 0000000000..defc110e49 Binary files /dev/null and b/docs/assets/readme-banner.png differ diff --git a/dotnet/nuget/NUGET.md b/dotnet/nuget/NUGET.md index fb422cf9b1..c507d0a2fb 100644 --- a/dotnet/nuget/NUGET.md +++ b/dotnet/nuget/NUGET.md @@ -1,10 +1,21 @@ # About Microsoft Agent Framework -To be filled in. +Microsoft Agent Framework is a comprehensive .NET library for building, orchestrating, and deploying AI agents and multi-agent workflows. The framework provides everything from simple chat agents to complex multi-agent systems with graph-based orchestration capabilities. + +## Key Features + +- **Multi-Agent Orchestration**: Coordinate multiple agents using sequential, concurrent, group chat, and handoff patterns +- **Graph-based Workflows**: Connect agents and deterministic functions with streaming, checkpointing, and human-in-the-loop capabilities +- **Multiple Provider Support**: Seamlessly integrate with various LLM providers with more being added continuously +- **Extensible Middleware**: Flexible request/response processing with custom pipelines and exception handling +- **Built-in Observability**: OpenTelemetry integration for distributed tracing, monitoring, and debugging +- **Cross-Platform**: Compatible with .NET 8.0, .NET Standard 2.0, and .NET Framework for broad deployment options + +Whether you're building simple AI assistants or complex multi-agent systems, Microsoft Agent Framework provides the tools and abstractions needed to create robust, scalable AI applications in .NET. # Getting Started ⚡ -- Learn more at the [documentation site](https://aka.ms/TBD). -- Join the [Discord community](https://aka.ms/TBD). -- Follow the team on [Semantic Kernel blog](https://aka.ms/TBD). +- Learn more at the [documentation site](https://learn.microsoft.com/agent-framework/overview/agent-framework-overview). +- Join the [Discord community](https://discord.gg/b5zjErwbQM). +- Follow the team on [Semantic Kernel blog](https://devblogs.microsoft.com/semantic-kernel/). - Check out the [GitHub repository](https://github.com/microsoft/agent-framework) for the latest updates. diff --git a/dotnet/nuget/agent-framework-icon.png b/dotnet/nuget/agent-framework-icon.png new file mode 100644 index 0000000000..2306a64a6a Binary files /dev/null and b/dotnet/nuget/agent-framework-icon.png differ