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
@@ -3,7 +3,7 @@
 import asyncio

 from agent_framework import Content, Message
-from agent_framework.azure import AzureOpenAIChatClient
+from agent_framework.foundry import FoundryChatClient
 from azure.identity import AzureCliCredential
 from dotenv import load_dotenv

@@ -21,12 +21,11 @@ def create_sample_image() -> str:
 async def test_image() -> None:
    """Test image analysis with Azure OpenAI."""
    # For authentication, run `az login` command in terminal or replace AzureCliCredential with preferred
-    # authentication option. Requires AZURE_OPENAI_ENDPOINT and AZURE_OPENAI_CHAT_DEPLOYMENT_NAME
+    # authentication option. Requires AZURE_OPENAI_ENDPOINT and FOUNDRY_MODEL
    # environment variables to be set.
    # Alternatively, you can pass deployment_name explicitly:
-    # client = AzureOpenAIChatClient(credential=AzureCliCredential(), deployment_name="your-deployment-name")
-    client = AzureOpenAIChatClient(credential=AzureCliCredential())
-
+    # client = FoundryChatClient(credential=AzureCliCredential(), model="your-deployment-name")
+    client = FoundryChatClient(credential=AzureCliCredential())
    image_uri = create_sample_image()
    message = Message(
        role="user",
@@ -35,7 +34,6 @@ async def test_image() -> None:
            Content.from_uri(uri=image_uri, media_type="image/png"),
        ],
    )
-
    response = await client.get_response([message])
    print(f"Image Response: {response}")

@@ -4,7 +4,7 @@ import asyncio
 from pathlib import Path

 from agent_framework import Content, Message
-from agent_framework.azure import AzureOpenAIResponsesClient
+from agent_framework.foundry import FoundryChatClient
 from azure.identity import AzureCliCredential
 from dotenv import load_dotenv

@@ -30,11 +30,11 @@ def create_sample_image() -> str:
 async def test_image() -> None:
    """Test image analysis with Azure OpenAI Responses API."""
    # For authentication, run `az login` command in terminal or replace AzureCliCredential with preferred
-    # authentication option. Requires AZURE_OPENAI_ENDPOINT and AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAME
+    # authentication option. Requires AZURE_OPENAI_ENDPOINT and FOUNDRY_MODEL
    # environment variables to be set.
    # Alternatively, you can pass deployment_name explicitly:
-    # client = AzureOpenAIResponsesClient(credential=AzureCliCredential(), deployment_name="your-deployment-name")
-    client = AzureOpenAIResponsesClient(credential=AzureCliCredential())
+    # client = FoundryChatClient(credential=AzureCliCredential(), model="your-deployment-name")
+    client = FoundryChatClient(credential=AzureCliCredential())

    image_uri = create_sample_image()
    message = Message(
@@ -51,7 +51,7 @@ async def test_image() -> None:

 async def test_pdf() -> None:
    """Test PDF document analysis with Azure OpenAI Responses API."""
-    client = AzureOpenAIResponsesClient(credential=AzureCliCredential())
+    client = FoundryChatClient(credential=AzureCliCredential())

    pdf_bytes = load_sample_pdf()
    message = Message(
@@ -6,7 +6,7 @@ import struct
 from pathlib import Path

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

 # Load environment variables from .env file
@@ -46,7 +46,7 @@ def create_sample_audio() -> str:

 async def test_image() -> None:
    """Test image analysis with OpenAI."""
-    client = OpenAIChatClient(model_id="gpt-4o")
+    client = FoundryChatClient(model="gpt-4o")

    image_uri = create_sample_image()
    message = Message(
@@ -63,7 +63,7 @@ async def test_image() -> None:

 async def test_audio() -> None:
    """Test audio analysis with OpenAI."""
-    client = OpenAIChatClient(model_id="gpt-4o-audio-preview")
+    client = FoundryChatClient(model="gpt-4o-audio-preview")

    audio_uri = create_sample_audio()
    message = Message(
@@ -80,7 +80,7 @@ async def test_audio() -> None:

 async def test_pdf() -> None:
    """Test PDF document analysis with OpenAI."""
-    client = OpenAIChatClient(model_id="gpt-4o")
+    client = FoundryChatClient(model="gpt-4o")

    pdf_bytes = load_sample_pdf()
    message = Message(