agent/agent-framework
1
0
Fork 0
mirror of https://github.com/microsoft/agent-framework.git synced 2026-06-16 21:04:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

Python: [BREAKING] Python: Provider-leading client design & OpenAI package extraction (#4818)

Browse Source 
* Python: Provider-leading client design & OpenAI package extraction

Major refactoring of the Python Agent Framework client architecture:

- Extract OpenAI clients into new `agent-framework-openai` package
- Core package no longer depends on openai, azure-identity, azure-ai-projects
- Rename clients for discoverability: OpenAIResponsesClient → OpenAIChatClient,
  OpenAIChatClient → OpenAIChatCompletionClient
- Unify `model_id`/`deployment_name`/`model_deployment_name` → `model` param
- New FoundryChatClient for Azure AI Foundry Responses API
- New FoundryAgent/FoundryAgentClient for connecting to pre-configured Foundry agents
- Remove OpenAIBase/OpenAIConfigMixin from non-deprecated client MRO
- Deprecate AzureOpenAI* clients, AzureAIClient, OpenAIAssistantsClient
- Reorganize samples: azure_openai+azure_ai+azure_ai_agent → azure/
- ADR-0020: Provider-Leading Client Design

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix: missing Agent imports in samples, .model_id → .model in foundry_local sample

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix: CI failures — mypy errors, coverage targets, sample imports

- azure-ai mypy: add type ignores for TypedDict total=, model arg, forward ref
- Coverage: replace core.azure/openai targets with openai package target
- project_provider: add type annotation for opts dict

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix: populate openai .pyi stub, fix broken README links, coverage targets

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fixes

* updated observabilitty

* reset azure init.pyi

* fix errors

* updated adr number

* fix foundry local

* fixed not renamed docstrings and comments, and added deprecated markers to old classes

* fix tests and pyprojects

* fix test vars

* updated function tests

* update durable

* updated test setup for functions

* Fix Foundry auth in workflow samples

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Stabilize Python integration workflows

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Update hosting samples for Foundry

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Trigger full CI rerun

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Trigger CI rerun again

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* trigger rerun

* trigger rerun

* fix for litellm

* undo durabletask changes

* Move Foundry APIs into foundry namespace

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fix Foundry pyproject formatting

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Split provider samples by Foundry surface

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Restore hosting sample requirements

Also fix the Foundry Local sample link after the provider sample move.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* updated tests

* udpated foundry integration tests

* removed dist from azurefunctions tests

* Use separate Foundry clients for concurrent agents

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix client setup in azfunc and durable

* disabled two tests

* updated setup for some function and durable tests

* improved azure openai setup with new clients

* ignore deprecated

* fixes

* skip 11

* remove openai assistants int tests

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
Eduard van Valkenburg
2026-03-25 10:56:29 +01:00
committed by GitHub
Unverified
parent 4b533608b6
commit 5e056b672e
485 changed files with 9784 additions and 12084 deletions
Download Patch File Download Diff File Expand all files Collapse all files
python/samples/02-agents/middleware/agent_and_run_level_middleware.py
+4 -2
View File
@@ -7,13 +7,14 @@ from random import randint
from typing import Annotated
from agent_framework import (
Agent,
AgentContext,
AgentMiddleware,
AgentResponse,
FunctionInvocationContext,
tool,
)
from agent_framework.azure import AzureAIAgentClient
from agent_framework.foundry import FoundryChatClient
from azure.identity.aio import AzureCliCredential
from dotenv import load_dotenv
from pydantic import Field
@@ -194,7 +195,8 @@ async def main() -> None:
# authentication option.
async with (
AzureCliCredential() as credential,
AzureAIAgentClient(credential=credential).as_agent(
Agent(
client=FoundryChatClient(credential=credential),
name="WeatherAgent",
instructions="You are a helpful weather assistant.",
tools=get_weather,
python/samples/02-agents/middleware/chat_middleware.py
+8 -4
View File
@@ -6,6 +6,7 @@ from random import randint
from typing import Annotated
from agent_framework import (
Agent,
ChatContext,
ChatMiddleware,
ChatResponse,
@@ -14,7 +15,7 @@ from agent_framework import (
chat_middleware,
tool,
)
from agent_framework.azure import AzureAIAgentClient
from agent_framework.foundry import FoundryChatClient
from azure.identity.aio import AzureCliCredential
from dotenv import load_dotenv
from pydantic import Field
@@ -150,7 +151,8 @@ async def class_based_chat_middleware() -> None:
# authentication option.
async with (
AzureCliCredential() as credential,
AzureAIAgentClient(credential=credential).as_agent(
Agent(
client=FoundryChatClient(credential=credential),
name="EnhancedChatAgent",
instructions="You are a helpful AI assistant.",
# Register class-based middleware at agent level (applies to all runs)
@@ -172,7 +174,8 @@ async def function_based_chat_middleware() -> None:
async with (
AzureCliCredential() as credential,
AzureAIAgentClient(credential=credential).as_agent(
Agent(
client=FoundryChatClient(credential=credential),
name="FunctionMiddlewareAgent",
instructions="You are a helpful AI assistant.",
# Register function-based middleware at agent level
@@ -202,7 +205,8 @@ async def run_level_middleware() -> None:
async with (
AzureCliCredential() as credential,
AzureAIAgentClient(credential=credential).as_agent(
Agent(
client=FoundryChatClient(credential=credential),
name="RunLevelAgent",
instructions="You are a helpful AI assistant.",
tools=get_weather,
python/samples/02-agents/middleware/class_based_middleware.py
+4 -2
View File
@@ -7,6 +7,7 @@ from random import randint
from typing import Annotated
from agent_framework import (
Agent,
AgentContext,
AgentMiddleware,
AgentResponse,
@@ -15,7 +16,7 @@ from agent_framework import (
Message,
tool,
)
from agent_framework.azure import AzureAIAgentClient
from agent_framework.foundry import FoundryChatClient
from azure.identity.aio import AzureCliCredential
from dotenv import load_dotenv
from pydantic import Field
@@ -105,7 +106,8 @@ async def main() -> None:
# authentication option.
async with (
AzureCliCredential() as credential,
AzureAIAgentClient(credential=credential).as_agent(
Agent(
client=FoundryChatClient(credential=credential),
name="WeatherAgent",
instructions="You are a helpful weather assistant.",
tools=get_weather,
python/samples/02-agents/middleware/decorator_middleware.py
+4 -2
View File
@@ -4,11 +4,12 @@ import asyncio
import datetime
from agent_framework import (
Agent,
agent_middleware,
function_middleware,
tool,
)
from agent_framework.azure import AzureAIAgentClient
from agent_framework.foundry import FoundryChatClient
from azure.identity.aio import AzureCliCredential
from dotenv import load_dotenv
@@ -79,7 +80,8 @@ async def main() -> None:
# authentication option.
async with (
AzureCliCredential() as credential,
AzureAIAgentClient(credential=credential).as_agent(
Agent(
client=FoundryChatClient(credential=credential),
name="TimeAgent",
instructions="You are a helpful time assistant. Call get_current_time when asked about time.",
tools=get_current_time,
python/samples/02-agents/middleware/exception_handling_with_middleware.py
+4 -3
View File
@@ -4,8 +4,8 @@ import asyncio
from collections.abc import Awaitable, Callable
from typing import Annotated
from agent_framework import FunctionInvocationContext, tool
from agent_framework.azure import AzureAIAgentClient
from agent_framework import Agent, FunctionInvocationContext, tool
from agent_framework.foundry import FoundryChatClient
from azure.identity.aio import AzureCliCredential
from dotenv import load_dotenv
from pydantic import Field
@@ -66,7 +66,8 @@ async def main() -> None:
# authentication option.
async with (
AzureCliCredential() as credential,
AzureAIAgentClient(credential=credential).as_agent(
Agent(
client=FoundryChatClient(credential=credential),
name="DataAgent",
instructions="You are a helpful data assistant. Use the data service tool to fetch information for users.",
tools=unstable_data_service,
python/samples/02-agents/middleware/function_based_middleware.py
+4 -2
View File
@@ -7,11 +7,12 @@ from random import randint
from typing import Annotated
from agent_framework import (
Agent,
AgentContext,
FunctionInvocationContext,
tool,
)
from agent_framework.azure import AzureAIAgentClient
from agent_framework.foundry import FoundryChatClient
from azure.identity.aio import AzureCliCredential
from dotenv import load_dotenv
from pydantic import Field
@@ -92,7 +93,8 @@ async def main() -> None:
# authentication option.
async with (
AzureCliCredential() as credential,
AzureAIAgentClient(credential=credential).as_agent(
Agent(
client=FoundryChatClient(credential=credential),
name="WeatherAgent",
instructions="You are a helpful weather assistant.",
tools=get_weather,
python/samples/02-agents/middleware/middleware_termination.py
+6 -3
View File
@@ -6,6 +6,7 @@ from random import randint
from typing import Annotated
from agent_framework import (
Agent,
AgentContext,
AgentMiddleware,
AgentResponse,
@@ -13,7 +14,7 @@ from agent_framework import (
MiddlewareTermination,
tool,
)
from agent_framework.azure import AzureAIAgentClient
from agent_framework.foundry import FoundryChatClient
from azure.identity.aio import AzureCliCredential
from dotenv import load_dotenv
from pydantic import Field
@@ -118,7 +119,8 @@ async def pre_termination_middleware() -> None:
print("\n--- Example 1: Pre-termination MiddlewareTypes ---")
async with (
AzureCliCredential() as credential,
AzureAIAgentClient(credential=credential).as_agent(
Agent(
client=FoundryChatClient(credential=credential),
name="WeatherAgent",
instructions="You are a helpful weather assistant.",
tools=get_weather,
@@ -145,7 +147,8 @@ async def post_termination_middleware() -> None:
print("\n--- Example 2: Post-termination MiddlewareTypes ---")
async with (
AzureCliCredential() as credential,
AzureAIAgentClient(credential=credential).as_agent(
Agent(
client=FoundryChatClient(credential=credential),
name="WeatherAgent",
instructions="You are a helpful weather assistant.",
tools=get_weather,
python/samples/02-agents/middleware/override_result_with_middleware.py
+5 -3
View File
@@ -7,6 +7,7 @@ from random import randint
from typing import Annotated
from agent_framework import (
Agent,
AgentContext,
AgentResponse,
AgentResponseUpdate,
@@ -188,9 +189,10 @@ async def main() -> None:
# For authentication, run `az login` command in terminal or replace AzureCliCredential with preferred
# authentication option.
agent = OpenAIResponsesClient(
middleware=[validate_weather_middleware, weather_override_middleware],
).as_agent(
agent = Agent(
client=OpenAIResponsesClient(
middleware=[validate_weather_middleware, weather_override_middleware],
),
name="WeatherAgent",
instructions="You are a helpful weather assistant. Use the weather tool to get current conditions.",
tools=get_weather,
python/samples/02-agents/middleware/runtime_context_delegation.py
+17 -11
View File
@@ -4,8 +4,8 @@ import asyncio
from collections.abc import Awaitable, Callable
from typing import Annotated
from agent_framework import FunctionInvocationContext, function_middleware, tool
from agent_framework.openai import OpenAIChatClient
from agent_framework import Agent, FunctionInvocationContext, function_middleware, tool
from agent_framework.foundry import FoundryChatClient
from dotenv import load_dotenv
from pydantic import Field
@@ -149,10 +149,11 @@ async def pattern_1_single_agent_with_closure() -> None:
print("Use case: Single agent with multiple tools sharing runtime context")
print()
client = OpenAIChatClient(model_id="gpt-4o-mini")
client = FoundryChatClient(model="gpt-4o-mini")
# Create agent with both tools and shared context via middleware
communication_agent = client.as_agent(
communication_agent = Agent(
client=client,
name="communication_agent",
instructions=(
"You are a communication assistant that can send emails and notifications. "
@@ -294,17 +295,19 @@ async def pattern_2_hierarchical_with_kwargs_propagation() -> None:
print(f"[SMSAgent] Received runtime context: {list(context.kwargs.keys())}")
await call_next()
client = OpenAIChatClient(model_id="gpt-4o-mini")
client = FoundryChatClient(model="gpt-4o-mini")
# Create specialized sub-agents
email_agent = client.as_agent(
email_agent = Agent(
client=client,
name="email_agent",
instructions="You send emails using the send_email_v2 tool.",
tools=[send_email_v2],
middleware=[email_kwargs_tracker],
)
sms_agent = client.as_agent(
sms_agent = Agent(
client=client,
name="sms_agent",
instructions="You send SMS messages using the send_sms tool.",
tools=[send_sms],
@@ -312,7 +315,8 @@ async def pattern_2_hierarchical_with_kwargs_propagation() -> None:
)
# Create coordinator that delegates to sub-agents
coordinator = client.as_agent(
coordinator = Agent(
client=client,
name="coordinator",
instructions=(
"You coordinate communication tasks. "
@@ -396,10 +400,11 @@ async def pattern_3_hierarchical_with_middleware() -> None:
auth_middleware = AuthContextMiddleware()
client = OpenAIChatClient(model_id="gpt-4o-mini")
client = FoundryChatClient(model="gpt-4o-mini")
# Sub-agent with validation middleware
protected_agent = client.as_agent(
protected_agent = Agent(
client=client,
name="protected_agent",
instructions="You perform protected operations that require authentication.",
tools=[protected_operation],
@@ -407,7 +412,8 @@ async def pattern_3_hierarchical_with_middleware() -> None:
)
# Coordinator delegates to protected agent
coordinator = client.as_agent(
coordinator = Agent(
client=client,
name="coordinator",
instructions="You coordinate protected operations. Delegate to protected_executor.",
tools=[
python/samples/02-agents/middleware/session_behavior_middleware.py
+4 -2
View File
@@ -5,11 +5,12 @@ from collections.abc import Awaitable, Callable
from typing import Annotated
from agent_framework import (
Agent,
AgentContext,
InMemoryHistoryProvider,
tool,
)
from agent_framework.azure import AzureOpenAIChatClient
from agent_framework.foundry import FoundryChatClient
from azure.identity import AzureCliCredential
from dotenv import load_dotenv
from pydantic import Field
@@ -81,7 +82,8 @@ async def main() -> None:
# For authentication, run `az login` command in terminal or replace AzureCliCredential with preferred
# authentication option.
agent = AzureOpenAIChatClient(credential=AzureCliCredential()).as_agent(
agent = Agent(
client=FoundryChatClient(credential=AzureCliCredential()),
name="WeatherAgent",
instructions="You are a helpful weather assistant.",
tools=get_weather,
python/samples/02-agents/middleware/shared_state_middleware.py
+4 -2
View File
@@ -6,10 +6,11 @@ from random import randint
from typing import Annotated
from agent_framework import (
Agent,
FunctionInvocationContext,
tool,
)
from agent_framework.azure import AzureAIAgentClient
from agent_framework.foundry import FoundryChatClient
from azure.identity.aio import AzureCliCredential
from dotenv import load_dotenv
from pydantic import Field
@@ -103,7 +104,8 @@ async def main() -> None:
# authentication option.
async with (
AzureCliCredential() as credential,
AzureAIAgentClient(credential=credential).as_agent(
Agent(
client=FoundryChatClient(credential=credential),
name="UtilityAgent",
instructions="You are a helpful assistant that can provide weather information and current time.",
tools=[get_weather, get_time],
python/samples/02-agents/middleware/usage_tracking_middleware.py
+1 -2
View File
@@ -50,8 +50,7 @@ def _reset_usage_counters() -> None:
STREAMING_CALL_COUNT = 0
def _create_agent(
) -> Agent:
def _create_agent() -> Agent:
"""Create the shared agent used by both demonstrations."""
return Agent(
client=OpenAIResponsesClient(),