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

* 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>
2026-06-16 21:04:09 +08:00 · 2026-03-25 10:56:29 +01:00
parent 4b533608b6
commit 5e056b672e
485 changed files with 9784 additions and 12084 deletions
@@ -7,9 +7,9 @@ from typing import Annotated, Any, Literal

 from agent_framework import Message, SupportsChatGetResponse, tool
 from agent_framework.azure import (
-    AzureAIAgentClient,
    AzureOpenAIAssistantsClient,
 )
+from agent_framework.foundry import FoundryChatClient
 from agent_framework.openai import OpenAIAssistantsClient
 from azure.identity import AzureCliCredential
 from azure.identity.aio import AzureCliCredential as AsyncAzureCliCredential
@@ -70,16 +70,12 @@ def get_client(client_name: ClientName) -> SupportsChatGetResponse[Any]:
    """Create a built-in chat client from a name."""
    from agent_framework.amazon import BedrockChatClient
    from agent_framework.anthropic import AnthropicClient
-    from agent_framework.azure import (
-        AzureOpenAIChatClient,
-        AzureOpenAIResponsesClient,
-    )
    from agent_framework.ollama import OllamaChatClient
-    from agent_framework.openai import OpenAIChatClient, OpenAIResponsesClient
+    from agent_framework.openai import OpenAIResponsesClient

    # 1. Create OpenAI clients.
    if client_name == "openai_chat":
-        return OpenAIChatClient()
+        return FoundryChatClient()
    if client_name == "openai_responses":
        return OpenAIResponsesClient()
    if client_name == "openai_assistants":
@@ -93,13 +89,13 @@ def get_client(client_name: ClientName) -> SupportsChatGetResponse[Any]:

    # 2. Create Azure OpenAI clients.
    if client_name == "azure_openai_chat":
-        return AzureOpenAIChatClient(credential=AzureCliCredential())
+        return FoundryChatClient(credential=AzureCliCredential())
    if client_name == "azure_openai_responses":
-        return AzureOpenAIResponsesClient(credential=AzureCliCredential(), api_version="preview")
+        return FoundryChatClient(credential=AzureCliCredential(), api_version="preview")
    if client_name == "azure_openai_responses_foundry":
-        return AzureOpenAIResponsesClient(
-            project_endpoint=os.environ["AZURE_AI_PROJECT_ENDPOINT"],
-            deployment_name=os.environ["AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAME"],
+        return FoundryChatClient(
+            project_endpoint=os.environ["FOUNDRY_PROJECT_ENDPOINT"],
+            model=os.environ["FOUNDRY_MODEL"],
            credential=AzureCliCredential(),
        )
    if client_name == "azure_openai_assistants":
@@ -107,7 +103,7 @@ def get_client(client_name: ClientName) -> SupportsChatGetResponse[Any]:

    # 3. Create Azure AI client.
    if client_name == "azure_ai_agent":
-        return AzureAIAgentClient(credential=AsyncAzureCliCredential())
+        return FoundryChatClient(credential=AsyncAzureCliCredential())

    raise ValueError(f"Unsupported client name: {client_name}")

@@ -123,7 +119,7 @@ async def main(client_name: ClientName = "openai_chat") -> None:
    print(f"User: {message.text}")

    # 2. Run with context-managed clients.
-    if isinstance(client, OpenAIAssistantsClient | AzureOpenAIAssistantsClient | AzureAIAgentClient):
+    if isinstance(client, OpenAIAssistantsClient | AzureOpenAIAssistantsClient | FoundryChatClient):
        async with client:
            if stream:
                response_stream = client.get_response([message], stream=True, options={"tools": get_weather})
@@ -3,7 +3,7 @@
 import asyncio

 from agent_framework import Message
-from agent_framework.openai import OpenAIChatClient
+from agent_framework.foundry import FoundryChatClient
 from dotenv import load_dotenv

 # Load environment variables from .env file
@@ -23,10 +23,10 @@ async def main() -> None:
    Creates a task for the chat request, waits briefly, then cancels it to show proper cleanup.

    Configuration:
-    - OpenAI model ID: Use "model_id" parameter or "OPENAI_CHAT_MODEL_ID" environment variable
+    - OpenAI model ID: Use "model_id" parameter or "OPENAI_MODEL" environment variable
    - OpenAI API key: Use "api_key" parameter or "OPENAI_API_KEY" environment variable
    """
-    client = OpenAIChatClient()
+    client = FoundryChatClient()

    try:
        task = asyncio.create_task(
@@ -7,6 +7,7 @@ from collections.abc import AsyncIterable, Awaitable, Mapping, Sequence
 from typing import Any, ClassVar, TypeAlias, TypedDict

 from agent_framework import (
+    Agent,
    BaseChatClient,
    ChatMiddlewareLayer,
    ChatResponse,
@@ -159,7 +160,8 @@ async def main() -> None:
    print(f"Direct response: {direct_response.messages[0].text}")

    # Create an agent using the custom chat client
-    echo_agent = echo_client.as_agent(
+    echo_agent = Agent(
+        client=echo_client,
        name="EchoAgent",
        instructions="You are a helpful assistant that echoes back what users say.",
    )