Python: Allow AzureOpenAIResponsesClient creation with Foundry project endpoint (#3814)

* Initial plan * feat: extend AzureOpenAIResponsesClient to support Foundry project endpoints Add project_client and project_endpoint parameters to allow creating the client via an Azure AI Foundry project. When provided, the client uses AIProjectClient.get_openai_client() to obtain the OpenAI client. The azure-ai-projects package is imported lazily and only required when using the project endpoint path. Co-authored-by: eavanvalkenburg <13749212+eavanvalkenburg@users.noreply.github.com> * fix: address code review - remove duplicate MagicMock imports in tests Co-authored-by: eavanvalkenburg <13749212+eavanvalkenburg@users.noreply.github.com> * fix: add type field to Responses API input items and add Foundry sample - Add 'type: message' to input items in _prepare_message_for_openai to comply with the Responses API schema requirement - Filter out empty dicts from unsupported content types to prevent sending items with invalid empty type values - Add azure_responses_client_with_foundry.py sample demonstrating AzureOpenAIResponsesClient with project_endpoint - Update README and pyrightconfig.samples.json accordingly * updates to response format and setup * fix: patch AIProjectClient at correct module path in test Patch agent_framework.azure._responses_client.AIProjectClient instead of azure.ai.projects.aio.AIProjectClient since the import is at module level. * docs: add Foundry sample to READMEs and document AZURE_AI_PROJECT_ENDPOINT env var --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: eavanvalkenburg <13749212+eavanvalkenburg@users.noreply.github.com> Co-authored-by: eavanvalkenburg <github@vanvalkenburg.eu>
2026-06-16 21:04:09 +08:00 · 2026-02-11 16:46:25 +01:00
parent 235c578059
commit a427af91a9
12 changed files with 349 additions and 28 deletions
@@ -3,6 +3,7 @@
 import json
 import os
 from typing import Annotated, Any
+from unittest.mock import MagicMock

 import pytest
 from azure.identity import AzureCliCredential
@@ -115,6 +116,119 @@ def test_init_with_empty_model_id(azure_openai_unit_test_env: dict[str, str]) ->
        )


+def test_init_with_project_client(azure_openai_unit_test_env: dict[str, str]) -> None:
+    """Test initialization with an existing AIProjectClient."""
+    from unittest.mock import patch
+
+    from openai import AsyncOpenAI
+
+    # Create a mock AIProjectClient that returns a mock AsyncOpenAI client
+    mock_openai_client = MagicMock(spec=AsyncOpenAI)
+    mock_openai_client.default_headers = {}
+
+    mock_project_client = MagicMock()
+    mock_project_client.get_openai_client.return_value = mock_openai_client
+
+    with patch(
+        "agent_framework.azure._responses_client.AzureOpenAIResponsesClient._create_client_from_project",
+        return_value=mock_openai_client,
+    ):
+        azure_responses_client = AzureOpenAIResponsesClient(
+            project_client=mock_project_client,
+            deployment_name="gpt-4o",
+        )
+
+    assert azure_responses_client.model_id == "gpt-4o"
+    assert azure_responses_client.client is mock_openai_client
+    assert isinstance(azure_responses_client, SupportsChatGetResponse)
+
+
+def test_init_with_project_endpoint(azure_openai_unit_test_env: dict[str, str]) -> None:
+    """Test initialization with a project endpoint and credential."""
+    from unittest.mock import patch
+
+    from openai import AsyncOpenAI
+
+    mock_openai_client = MagicMock(spec=AsyncOpenAI)
+    mock_openai_client.default_headers = {}
+
+    with patch(
+        "agent_framework.azure._responses_client.AzureOpenAIResponsesClient._create_client_from_project",
+        return_value=mock_openai_client,
+    ):
+        azure_responses_client = AzureOpenAIResponsesClient(
+            project_endpoint="https://test-project.services.ai.azure.com",
+            deployment_name="gpt-4o",
+            credential=AzureCliCredential(),
+        )
+
+    assert azure_responses_client.model_id == "gpt-4o"
+    assert azure_responses_client.client is mock_openai_client
+    assert isinstance(azure_responses_client, SupportsChatGetResponse)
+
+
+def test_create_client_from_project_with_project_client() -> None:
+    """Test _create_client_from_project with an existing project client."""
+    from openai import AsyncOpenAI
+
+    mock_openai_client = MagicMock(spec=AsyncOpenAI)
+    mock_project_client = MagicMock()
+    mock_project_client.get_openai_client.return_value = mock_openai_client
+
+    result = AzureOpenAIResponsesClient._create_client_from_project(
+        project_client=mock_project_client,
+        project_endpoint=None,
+        credential=None,
+    )
+
+    assert result is mock_openai_client
+    mock_project_client.get_openai_client.assert_called_once()
+
+
+def test_create_client_from_project_with_endpoint() -> None:
+    """Test _create_client_from_project with a project endpoint."""
+    from unittest.mock import patch
+
+    from openai import AsyncOpenAI
+
+    mock_openai_client = MagicMock(spec=AsyncOpenAI)
+    mock_credential = MagicMock()
+
+    with patch("agent_framework.azure._responses_client.AIProjectClient") as MockAIProjectClient:
+        mock_instance = MockAIProjectClient.return_value
+        mock_instance.get_openai_client.return_value = mock_openai_client
+
+        result = AzureOpenAIResponsesClient._create_client_from_project(
+            project_client=None,
+            project_endpoint="https://test-project.services.ai.azure.com",
+            credential=mock_credential,
+        )
+
+    assert result is mock_openai_client
+    MockAIProjectClient.assert_called_once()
+    mock_instance.get_openai_client.assert_called_once()
+
+
+def test_create_client_from_project_missing_endpoint() -> None:
+    """Test _create_client_from_project raises error when endpoint is missing."""
+    with pytest.raises(ServiceInitializationError, match="project endpoint is required"):
+        AzureOpenAIResponsesClient._create_client_from_project(
+            project_client=None,
+            project_endpoint=None,
+            credential=MagicMock(),
+        )
+
+
+def test_create_client_from_project_missing_credential() -> None:
+    """Test _create_client_from_project raises error when credential is missing."""
+    with pytest.raises(ServiceInitializationError, match="credential is required"):
+        AzureOpenAIResponsesClient._create_client_from_project(
+            project_client=None,
+            project_endpoint="https://test-project.services.ai.azure.com",
+            credential=None,
+        )
+
+
 def test_serialize(azure_openai_unit_test_env: dict[str, str]) -> None:
    default_headers = {"X-Unit-Test": "test-guid"}

@@ -798,12 +798,8 @@ def test_chat_message_with_error_content() -> None:

    result = client._prepare_message_for_openai(message, call_id_to_id)

-    # Message should be prepared with empty content list since ErrorContent returns {}
-    assert len(result) == 1
-    prepared_message = result[0]
-    assert prepared_message["role"] == "assistant"
-    # Content should be a list with empty dict since ErrorContent returns {}
-    assert prepared_message.get("content") == [{}]
+    # Message should be empty since ErrorContent is filtered out
+    assert len(result) == 0


 def test_chat_message_with_usage_content() -> None:
@@ -823,12 +819,8 @@ def test_chat_message_with_usage_content() -> None:

    result = client._prepare_message_for_openai(message, call_id_to_id)

-    # Message should be prepared with empty content list since UsageContent returns {}
-    assert len(result) == 1
-    prepared_message = result[0]
-    assert prepared_message["role"] == "assistant"
-    # Content should be a list with empty dict since UsageContent returns {}
-    assert prepared_message.get("content") == [{}]
+    # Message should be empty since UsageContent is filtered out
+    assert len(result) == 0


 def test_hosted_file_content_preparation() -> None: