Files
agent-framework/python/CHANGELOG.md
Ren Finlayson 539852f81c
Some checks are pending
CodeQL / Analyze (csharp) (push) Waiting to run
CodeQL / Analyze (python) (push) Waiting to run
dotnet-build-and-test / paths-filter (push) Waiting to run
dotnet-build-and-test / dotnet-build-and-test (Debug, windows-latest, net9.0) (push) Blocked by required conditions
dotnet-build-and-test / dotnet-build-and-test (Release, integration, true, ubuntu-latest, net10.0) (push) Blocked by required conditions
dotnet-build-and-test / dotnet-build-and-test (Release, integration, true, windows-latest, net472) (push) Blocked by required conditions
dotnet-build-and-test / dotnet-build-and-test (Release, ubuntu-latest, net8.0) (push) Blocked by required conditions
dotnet-build-and-test / dotnet-build-and-test-check (push) Blocked by required conditions
test
2026-01-24 03:05:12 +11:00

37 KiB

Changelog

All notable changes to the Agent Framework Python packages will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

1.0.0b260116 - 2026-01-16

Added

  • agent-framework-azure-ai: Create/Get Agent API for Azure V1 (#3192)
  • agent-framework-core: Create/Get Agent API for OpenAI Assistants (#3208)
  • agent-framework-ag-ui: Support service-managed thread on AG-UI (#3136)
  • agent-framework-ag-ui: Add MCP tool support for AG-UI approval flows (#3212)
  • samples: Add AzureAI sample for downloading code interpreter generated files (#3189)

Changed

  • agent-framework-core: [BREAKING] Rename create_agent to as_agent (#3249)
  • agent-framework-core: [BREAKING] Rename WorkflowOutputEvent.source_executor_id to executor_id for API consistency (#3166)

Fixed

  • agent-framework-core: Properly configure structured outputs based on new options dict (#3213)
  • agent-framework-core: Correct FunctionResultContent ordering in WorkflowAgent.merge_updates (#3168)
  • agent-framework-azurefunctions: Update DurableAIAgent and fix integration tests (#3241)
  • agent-framework-azure-ai: Create/Get Agent API fixes and example improvements (#3246)

1.0.0b260114 - 2026-01-14

Added

  • agent-framework-azure-ai: Create/Get Agent API for Azure V2 (#3059) by @moonbox3
  • agent-framework-declarative: Add declarative workflow runtime (#2815) by @moonbox3
  • agent-framework-ag-ui: Add dependencies param to ag-ui FastAPI endpoint (#3191) by @moonbox3
  • agent-framework-ag-ui: Add Pydantic request model and OpenAPI tags support to AG-UI FastAPI endpoint (#2522) by @claude89757
  • agent-framework-core: Add tool call/result content types and update connectors and samples (#2971) by @moonbox3
  • agent-framework-core: Add more specific exceptions to Workflow (#3188) by @TaoChenOSU

Changed

  • agent-framework-core: [BREAKING] Refactor orchestrations (#3023) by @TaoChenOSU
  • agent-framework-core: [BREAKING] Introducing Options as TypedDict and Generic (#3140) by @eavanvalkenburg
  • agent-framework-core: [BREAKING] Removed display_name, renamed context_providers, middleware and AggregateContextProvider (#3139) by @eavanvalkenburg
  • agent-framework-core: MCP Improvements: improved connection loss behavior, pagination for loading and a param to control representation (#3154) by @eavanvalkenburg
  • agent-framework-azure-ai: Azure AI direct A2A endpoint support (#3127) by @moonbox3

Fixed

  • agent-framework-anthropic: Fix duplicate ToolCallStartEvent in streaming tool calls (#3051) by @moonbox3
  • agent-framework-anthropic: Fix Anthropic streaming response bugs (#3141) by @eavanvalkenburg
  • agent-framework-ag-ui: Execute tools with approval_mode, fix shared state, code cleanup (#3079) by @moonbox3
  • agent-framework-azure-ai: Fix AzureAIClient tool call bug for AG-UI use (#3148) by @moonbox3
  • agent-framework-core: Fix MCPStreamableHTTPTool to use new streamable_http_client API (#3088) by @Copilot
  • agent-framework-core: Multiple bug fixes (#3150) by @eavanvalkenburg

1.0.0b260107 - 2026-01-07

Added

  • agent-framework-devui: Improve DevUI and add Context Inspector view as a new tab under traces (#2742) by @victordibia
  • samples: Add streaming sample for Azure Functions (#3057) by @gavin-aguiar

Changed

  • repo: Update templates (#3106) by @eavanvalkenburg

Fixed

  • agent-framework-ag-ui: Fix MCP tool result serialization for list[TextContent] (#2523) by @claude89757
  • agent-framework-azure-ai: Fix response_format handling for structured outputs (#3114) by @moonbox3

1.0.0b260106 - 2026-01-06

Added

  • repo: Add issue template and additional labeling (#3006) by @eavanvalkenburg

Changed

  • None

Fixed

  • agent-framework-core: Fix max tokens translation and add extra integer test (#3037) by @eavanvalkenburg
  • agent-framework-azure-ai: Fix failure when conversation history contains assistant messages (#3076) by @moonbox3
  • agent-framework-core: Use HTTP exporter for http/protobuf protocol (#3070) by @takanori-terai
  • agent-framework-core: Fix ExecutorInvokedEvent and ExecutorCompletedEvent observability data (#3090) by @moonbox3
  • agent-framework-core: Honor tool_choice parameter passed to agent.run() and chat client methods (#3095) by @moonbox3
  • samples: AzureAI SharePoint sample fix (#3108) by @giles17

1.0.0b251223 - 2025-12-23

Added

  • agent-framework-bedrock: Introducing support for Bedrock-hosted models (Anthropic, Cohere, etc.) (#2610)
  • agent-framework-core: Added response.created and response.in_progress event process to OpenAIBaseResponseClient (#2975)
  • agent-framework-foundry-local: Introducing Foundry Local Chat Clients (#2915)
  • samples: Added GitHub MCP sample with PAT (#2967)

Changed

  • agent-framework-core: Preserve reasoning blocks with OpenRouter (#2950)

1.0.0b251218 - 2025-12-18

Added

  • agent-framework-core: Azure AI Agent with Bing Grounding Citations sample (#2892)
  • agent-framework-core: Workflow option to visualize internal executors (#2917)
  • agent-framework-core: Workflow cancellation sample (#2732)
  • agent-framework-core: Azure Managed Redis support with credential provider (#2887)
  • agent-framework-core: Additional arguments for Azure AI agent configuration (#2922)

Changed

  • agent-framework-ollama: Updated Ollama package version (#2920)
  • agent-framework-ollama: Move Ollama samples to samples getting started directory (#2921)
  • agent-framework-core: Cleanup and refactoring of chat clients (#2937)
  • agent-framework-core: Align Run ID and Thread ID casing with AG-UI TypeScript SDK (#2948)

Fixed

  • agent-framework-core: Fix Pydantic error when using Literal types for tool parameters (#2893)
  • agent-framework-core: Correct MCP image type conversion in _mcp.py (#2901)
  • agent-framework-core: Fix BadRequestError when using Pydantic models in response formatting (#1843)
  • agent-framework-core: Propagate workflow kwargs to sub-workflows via WorkflowExecutor (#2923)
  • agent-framework-core: Fix WorkflowAgent event handling and kwargs forwarding (#2946)

1.0.0b251216 - 2025-12-16

Added

  • agent-framework-ollama: Ollama connector for Agent Framework (#1104)
  • agent-framework-core: Added custom args and thread object to ai_function kwargs (#2769)
  • agent-framework-core: Enable checkpointing for WorkflowAgent (#2774)

Changed

  • agent-framework-core: [BREAKING] Observability updates (#2782)
  • agent-framework-core: Use agent description in HandoffBuilder auto-generated tools (#2714)
  • agent-framework-core: Remove warnings from workflow builder when not using factories (#2808)

Fixed

  • agent-framework-core: Fix WorkflowAgent to include thread conversation history (#2774)
  • agent-framework-core: Fix context duplication in handoff workflows when restoring from checkpoint (#2867)
  • agent-framework-core: Fix middleware terminate flag to exit function calling loop immediately (#2868)
  • agent-framework-core: Fix WorkflowAgent to emit yield_output as agent response (#2866)
  • agent-framework-core: Filter framework kwargs from MCP tool invocations (#2870)

1.0.0b251211 - 2025-12-11

Added

  • agent-framework-core: Extend HITL support for all orchestration patterns (#2620)
  • agent-framework-core: Add factory pattern to concurrent orchestration builder (#2738)
  • agent-framework-core: Add factory pattern to sequential orchestration builder (#2710)
  • agent-framework-azure-ai: Capture file IDs from code interpreter in streaming responses (#2741)

Changed

  • agent-framework-azurefunctions: Change DurableAIAgent log level from warning to debug when invoked without thread (#2736)

Fixed

  • agent-framework-core: Added more complete parsing for mcp tool arguments (#2756)
  • agent-framework-core: Fix GroupChat ManagerSelectionResponse JSON Schema for OpenAI Structured Outputs (#2750)
  • samples: Standardize OpenAI API key environment variable naming (#2629)

1.0.0b251209 - 2025-12-09

Added

  • agent-framework-core: Support an autonomous handoff flow (#2497)
  • agent-framework-core: WorkflowBuilder registry (#2486)
  • agent-framework-a2a: Add configurable timeout support to A2AAgent (#2432)
  • samples: Added Azure OpenAI Responses File Search sample + Integration test update (#2645)
  • samples: Update fan in fan out sample to show concurrency (#2705)

Changed

  • agent-framework-azure-ai: [BREAKING] Renamed async_credential to credential (#2648)
  • samples: Improve sample logging (#2692)
  • samples: azureai image gen sample update (#2709)

Fixed

  • agent-framework-core: Fix DurableState schema serializations (#2670)
  • agent-framework-core: Fix context provider lifecycle agentic mode (#2650)
  • agent-framework-devui: Fix WorkflowFailedEvent error extraction (#2706)
  • agent-framework-devui: Fix DevUI fails when uploading Pdf file (#2675)
  • agent-framework-devui: Fix message serialization issue (#2674)
  • observability: Display system prompt in langfuse (#2653)

1.0.0b251204 - 2025-12-04

Added

  • agent-framework-core: Add support for Pydantic BaseModel as function call result (#2606)
  • agent-framework-core: Executor events now include I/O data (#2591)
  • samples: Inline YAML declarative sample (#2582)
  • samples: Handoff-as-agent with HITL sample (#2534)

Changed

  • agent-framework-core: [BREAKING] Support Magentic agent tool call approvals and plan stalling HITL behavior (#2569)
  • agent-framework-core: [BREAKING] Standardize orchestration outputs as list of ChatMessage; allow agent as group chat manager (#2291)
  • agent-framework-core: [BREAKING] Respond with AgentRunResponse including serialized structured output (#2285)
  • observability: Use executor_id and edge_group_id as span names for clearer traces (#2538)
  • agent-framework-devui: Add multimodal input support for workflows and refactor chat input (#2593)
  • docs: Update Python orchestration documentation (#2087)

Fixed

  • observability: Resolve mypy error in observability module (#2641)
  • agent-framework-core: Fix AgentRunResponse.created_at returning local datetime labeled as UTC (#2590)
  • agent-framework-core: Emit ExecutorFailedEvent before WorkflowFailedEvent when executor throws (#2537)
  • agent-framework-core: Fix MagenticAgentExecutor producing repr string for tool call content (#2566)
  • agent-framework-core: Fixed empty text content Pydantic validation failure (#2539)
  • agent-framework-azure-ai: Added support for application endpoints in Azure AI client (#2460)
  • agent-framework-azurefunctions: Add MCP tool support (#2385)
  • agent-framework-core: Preserve MCP array items schema in Pydantic field generation (#2382)
  • agent-framework-devui: Make tool call view optional and fix links (#2243)
  • agent-framework-core: Always include output in function call result messages (#2414)
  • agent-framework-redis: Fix TypeError (#2411)

1.0.0b251120 - 2025-11-20

Added

  • agent-framework-core: Introducing support for declarative YAML spec (#2002)
  • agent-framework-core: Use AI Foundry evaluators for self-reflection (#2250)
  • agent-framework-core: Propagate as_tool() kwargs and add runtime context + middleware sample (#2311)
  • agent-framework-anthropic: Anthropic Foundry integration (#2302)
  • samples: M365 Agent SDK Hosting sample (#2292)
  • samples: Foundry Sample for A2A + SharePoint Samples (#2313)

Changed

  • agent-framework-azurefunctions: [BREAKING] Schema changes for Azure Functions package (#2151)
  • agent-framework-core: Move evaluation folders under evaluations (#2355)
  • agent-framework-core: Move red teaming files to their own folder (#2333)
  • agent-framework-core: "fix all" task now single source of truth (#2303)
  • agent-framework-core: Improve and clean up exception handling (#2337, #2319)
  • agent-framework-core: Clean up imports (#2318)

Fixed

  • agent-framework-azure-ai: Fix for Azure AI client (#2358)
  • agent-framework-core: Fix tool execution bleed-over in aiohttp/Bot Framework scenarios (#2314)
  • agent-framework-core: @ai_function now correctly handles self parameter (#2266)
  • agent-framework-core: Resolve string annotations in FunctionExecutor (#2308)
  • agent-framework-core: Langfuse observability captures ChatAgent system instructions (#2316)
  • agent-framework-core: Incomplete URL substring sanitization fix (#2274)
  • observability: Handle datetime serialization in tool results (#2248)

1.0.0b251117 - 2025-11-17

Fixed

  • agent-framework-ag-ui: Fix ag-ui state handling issues (#2289)

1.0.0b251114 - 2025-11-14

Added

  • samples: Bing Custom Search sample using HostedWebSearchTool (#2226)
  • samples: Fabric and Browser Automation samples (#2207)
  • samples: Hosted agent samples (#2205)
  • samples: Azure OpenAI Responses API Hosted MCP sample (#2108)
  • samples: Bing Grounding and Custom Search samples (#2200)

Changed

  • agent-framework-azure-ai: Enhance Azure AI Search citations with complete URL information (#2066)
  • agent-framework-azurefunctions: Update samples to latest stable Azure Functions Worker packages (#2189)
  • agent-framework-azure-ai: Agent name now required for AzureAIClient (#2198)
  • build: Use uv build for packaging (#2161)
  • tooling: Pre-commit improvements (#2222)
  • dependencies: Updated package versions (#2208)

Fixed

  • agent-framework-core: Prevent duplicate MCP tools and prompts (#1876) (#1890)
  • agent-framework-devui: Fix HIL regression (#2167)
  • agent-framework-chatkit: ChatKit sample fixes (#2174)

1.0.0b251112.post1 - 2025-11-12

Added

  • agent-framework-azurefunctions: Merge Azure Functions feature branch (#1916)

Fixed

  • agent-framework-ag-ui: fix tool call id mismatch in ag-ui (#2166)

1.0.0b251112 - 2025-11-12

Added

  • agent-framework-azure-ai: Azure AI client based on new azure-ai-projects package (#1910)
  • agent-framework-anthropic: Add convenience method on data content (#2083)

Changed

  • agent-framework-core: Update OpenAI samples to use agents (#2012)

Fixed

  • agent-framework-anthropic: Fixed image handling in Anthropic client (#2083)

1.0.0b251111 - 2025-11-11

Added

  • agent-framework-core: Add OpenAI Responses Image Generation Stream Support with partial images and unit tests (#1853)
  • agent-framework-ag-ui: Add concrete AGUIChatClient implementation (#2072)

Fixed

  • agent-framework-a2a: Use the last entry in the task history to avoid empty responses (#2101)
  • agent-framework-core: Fix MCP Tool Parameter Descriptions not propagated to LLMs (#1978)
  • agent-framework-core: Handle agent user input request in AgentExecutor (#2022)
  • agent-framework-core: Fix Model ID attribute not showing up in invoke_agent span (#2061)
  • agent-framework-core: Fix underlying tool choice bug and enable return to previous Handoff subagent (#2037)

1.0.0b251108 - 2025-11-08

Added

  • agent-framework-devui: Add OpenAI Responses API proxy support + HIL (Human-in-the-Loop) for Workflows (#1737)
  • agent-framework-purview: Add Caching and background processing in Python Purview Middleware (#1844)

Changed

  • agent-framework-devui: Use metadata.entity_id instead of model field (#1984)
  • agent-framework-devui: Serialize workflow input as string to maintain conformance with OpenAI Responses format (#2021)

1.0.0b251106.post1 - 2025-11-06

Fixed

  • agent-framework-ag-ui: Fix ag-ui examples packaging for PyPI publish (#1953)

1.0.0b251106 - 2025-11-06

Changed

  • agent-framework-ag-ui: export sample ag-ui agents (#1927)

1.0.0b251105 - 2025-11-05

Added

  • agent-framework-ag-ui: Initial release of AG-UI protocol integration for Agent Framework (#1826)
  • agent-framework-chatkit: ChatKit integration with a sample application (#1273)
  • Added parameter to disable agent cleanup in AzureAIAgentClient (#1882)
  • Add support for Python 3.14 (#1904)

Changed

  • [BREAKING] Replaced AIProjectClient with AgentsClient in Foundry (#1936)
  • Updates to Tools (#1835)

Fixed

  • Fix missing packaging dependency (#1929)

1.0.0b251104 - 2025-11-04

Added

  • Introducing the Anthropic Client (#1819)

Changed

  • [BREAKING] Consolidate workflow run APIs (#1723)
  • [BREAKING] Remove request_type param from ctx.request_info() (#1824)
  • [BREAKING] Cleanup of dependencies (#1803)
  • [BREAKING] Replace RequestInfoExecutor with request_info API and @response_handler (#1466)
  • Azure AI Search Support Update + Refactored Samples & Unit Tests (#1683)
  • Lab: Updates to GAIA module (#1763)

Fixed

  • Azure AI top_p and temperature parameters fix (#1839)
  • Ensure agent thread is part of checkpoint (#1756)
  • Fix middleware and cleanup confusing function (#1865)
  • Fix type compatibility check (#1753)
  • Fix mcp tool cloning for handoff pattern (#1883)

1.0.0b251028 - 2025-10-28

Added

  • Added thread to AgentRunContext (#1732)
  • AutoGen migration samples (#1738)
  • Add Handoff orchestration pattern support (#1469)
  • Added Samples for HostedCodeInterpreterTool with files (#1583)

Changed

  • [BREAKING] Introduce group chat and refactor orchestrations. Fix as_agent(). Standardize orchestration start msg types. (#1538)
  • [BREAKING] Update Agent Framework Lab Lightning to use Agent-lightning v0.2.0 API (#1644)
  • [BREAKING] Refactor Checkpointing for runner and runner context (#1645)
  • Update lab packages and installation instructions (#1687)
  • Remove deprecated add_agent() calls from workflow samples (#1508)

Fixed

  • Reject @executor on staticmethod/classmethod with clear error message (#1719)
  • DevUI Fix Serialization, Timestamp and Other Issues (#1584)
  • MCP Error Handling Fix + Added Unit Tests (#1621)
  • InMemoryCheckpointManager is not JSON serializable (#1639)
  • Fix gen_ai.operation.name to be invoke_agent (#1729)

1.0.0b251016 - 2025-10-16

Added

  • Add Purview Middleware (#1142)
  • Added URL Citation Support to Azure AI Agent (#1397)
  • Added MCP headers for AzureAI (#1506)
  • Add Function Approval UI to DevUI (#1401)
  • Added function approval example with streaming (#1365)
  • Added A2A AuthInterceptor Support (#1317)
  • Added example with MCP and authentication (#1389)
  • Added sample with Foundry Redteams (#1306)
  • Added AzureAI Agent AI Search Sample (#1281)
  • Added AzureAI Bing Connection Name Support (#1364)

Changed

  • Enhanced documentation for dependency injection and serialization features (#1324)
  • Update README to list all available examples (#1394)
  • Reorganize workflows modules (#1282)
  • Improved thread serialization and deserialization with better tests (#1316)
  • Included existing agent definition in requests to Azure AI (#1285)
  • DevUI - Internal Refactor, Conversations API support, and performance improvements (#1235)
  • Refactor RequestInfoExecutor (#1403)

Fixed

  • Fix AI Search Tool Sample and improve AI Search Exceptions (#1206)
  • Fix Failure with Function Approval Messages in Chat Clients (#1322)
  • Fix deadlock in Magentic workflow (#1325)
  • Fix tool call content not showing up in workflow events (#1290)
  • Fixed instructions duplication in model clients (#1332)
  • Agent Name Sanitization (#1523)

1.0.0b251007 - 2025-10-07

Added

  • Added method to expose agent as MCP server (#1248)
  • Add PDF file support to OpenAI content parser with filename mapping (#1121)
  • Sample on integration of Azure OpenAI Responses Client with a local MCP server (#1215)
  • Added approval_mode and allowed_tools to local MCP (#1203)
  • Introducing AI Function approval (#1131)
  • Add name and description to workflows (#1183)
  • Add Ollama example using OpenAIChatClient (#1100)
  • Add DevUI improvements with color scheme, linking, agent details, and token usage data (#1091)
  • Add semantic-kernel to agent-framework migration code samples (#1045)

Changed

  • [BREAKING] Parameter naming and other fixes (#1255)
  • [BREAKING] Introduce add_agent functionality and added output_response to AgentExecutor; agent streaming behavior to follow workflow invocation (#1184)
  • OpenAI Clients accepting api_key callback (#1139)
  • Updated docstrings (#1225)
  • Standardize docstrings: Use Keyword Args for Settings classes and add environment variable examples (#1202)
  • Update References to Agent2Agent protocol to use correct terminology (#1162)
  • Update getting started samples to reflect AF and update unit test (#1093)
  • Update Lab Installation instructions to install from source (#1051)
  • Update python DEV_SETUP to add brew-based uv installation (#1173)
  • Update docstrings of all files and add example code in public interfaces (#1107)
  • Clarifications on installing packages in README (#1036)
  • DevUI Fixes (#1035)
  • Packaging fixes: removed lab from dependencies, setup build/publish tasks, set homepage url (#1056)
  • Agents + Chat Client Samples Docstring Updates (#1028)
  • Python: Foundry Agent Completeness (#954)

Fixed

  • Ollama + azureai openapi samples fix (#1244)
  • Fix multimodal input sample: Document required environment variables and configuration options (#1088)
  • Fix Azure AI Getting Started samples: Improve documentation and code readability (#1089)
  • Fix a2a import (#1058)
  • Fix DevUI serialization and agent structured outputs (#1055)
  • Default DevUI workflows to string input when start node is auto-wrapped agent (#1143)
  • Add missing pre flags on pip packages (#1130)

1.0.0b251001 - 2025-10-01

Added

  • First release of Agent Framework for Python
  • agent-framework-core: Main abstractions, types and implementations for OpenAI and Azure OpenAI
  • agent-framework-azure-ai: Integration with Azure AI Foundry Agents
  • agent-framework-copilotstudio: Integration with Microsoft Copilot Studio agents
  • agent-framework-a2a: Create A2A agents
  • agent-framework-devui: Browser-based UI to chat with agents and workflows, with tracing visualization
  • agent-framework-mem0 and agent-framework-redis: Integrations for Mem0 Context Provider and Redis Context Provider/Chat Memory Store
  • agent-framework: Meta-package for installing all packages

For more information, see the announcement blog post.