Take a look the function tool sample. This sample code generate the… (Azure#44776)

* Take a look the function tool sample.   This sample code generate the following as user agent for openai call

MyApp/1.0-AIProjectClient-OpenAI/Python 2.6.1

* Refactor user agent handling in AIProjectClient and add tests for user agent patching

* Refactor user agent handling in AIProjectClient and related tests

* Refactor user agent construction in AIProjectClient for consistency and clarity

* resolved comments

* clean up

Author: howieleung

sdk/ai/azure-ai-projects/azure/ai/projects/_patch.py

@@ -9,7 +9,7 @@
 """
 import os
 import logging
-from typing import List, Any, Optional
+from typing import List, Any
 from openai import OpenAI
 from azure.core.tracing.decorator import distributed_trace
 from azure.core.credentials import TokenCredential
@@ -21,22 +21,6 @@
 logger = logging.getLogger(__name__)
 
 
-def _patch_user_agent(user_agent: Optional[str]) -> str:
-    # All authenticated external clients exposed by this client will have this application id
-    # set on their user-agent. For more info on user-agent HTTP header, see:
-    # https://azure.github.io/azure-sdk/general_azurecore.html#telemetry-policy
-    USER_AGENT_APP_ID = "AIProjectClient"
-
-    if user_agent:
-        # If the calling application has set "user_agent" when constructing the AIProjectClient,
-        # take that value and prepend it to USER_AGENT_APP_ID.
-        patched_user_agent = f"{user_agent}-{USER_AGENT_APP_ID}"
-    else:
-        patched_user_agent = USER_AGENT_APP_ID
-
-    return patched_user_agent
-
-
 class AIProjectClient(AIProjectClientGenerated):  # pylint: disable=too-many-instance-attributes
     """AIProjectClient.
 
@@ -78,6 +62,7 @@ class AIProjectClient(AIProjectClientGenerated):  # pylint: disable=too-many-ins
     :paramtype api_version: str
     :keyword int polling_interval: Default waiting time between two polls for LRO operations if no
      Retry-After header is present.
+    :keyword user_agent: Optional string identifying the caller. This string will show up at the front of the "User-Agent" HTTP request header in all network calls this client makes. If an OpenAI client was obtained by calling get_openai_client(), this string will also show up at the front of the "User-Agent" request header in network calls that OpenAI client makes.
     """
 
     def __init__(self, endpoint: str, credential: TokenCredential, **kwargs: Any) -> None:
@@ -103,7 +88,7 @@ def __init__(self, endpoint: str, credential: TokenCredential, **kwargs: Any) ->
             kwargs.setdefault("logging_enable", self._console_logging_enabled)
 
         self._kwargs = kwargs.copy()
-        self._patched_user_agent = _patch_user_agent(self._kwargs.pop("user_agent", None))
+        self._custom_user_agent = self._kwargs.get("user_agent", None)
 
         super().__init__(endpoint=endpoint, credential=credential, **kwargs)
 
@@ -143,6 +128,8 @@ def get_openai_client(self, **kwargs: Any) -> "OpenAI":  # type: ignore[name-def
 
         http_client = None
 
+        kwargs = kwargs.copy() if kwargs else {}
+
         if self._console_logging_enabled:
             try:
                 import httpx
@@ -241,16 +228,38 @@ def _log_request_body(self, request: httpx.Request) -> None:
 
             http_client = httpx.Client(transport=OpenAILoggingTransport())
 
-        client = OpenAI(
-            # See https://learn.microsoft.com/python/api/azure-identity/azure.identity?view=azure-python#azure-identity-get-bearer-token-provider # pylint: disable=line-too-long
-            api_key=get_bearer_token_provider(
-                self._config.credential,  # pylint: disable=protected-access
-                "https://ai.azure.com/.default",
-            ),
-            base_url=base_url,
-            http_client=http_client,
-            **kwargs,
-        )
+        default_headers = dict[str, str](kwargs.pop("default_headers", None) or {})
+
+        openai_custom_user_agent = default_headers.get("User-Agent", None)
+
+        def _create_openai_client(**kwargs) -> OpenAI:
+            return OpenAI(
+                # See https://learn.microsoft.com/python/api/azure-identity/azure.identity?view=azure-python#azure-identity-get-bearer-token-provider # pylint: disable=line-too-long
+                api_key=get_bearer_token_provider(
+                    self._config.credential,  # pylint: disable=protected-access
+                    "https://ai.azure.com/.default",
+                ),
+                base_url=base_url,
+                http_client=http_client,
+                **kwargs,
+            )
+
+        dummy_client = _create_openai_client()
+
+        openai_default_user_agent = dummy_client.user_agent
+
+        if openai_custom_user_agent:
+            final_user_agent = openai_custom_user_agent
+        else:
+            final_user_agent = (
+                "-".join(ua for ua in [self._custom_user_agent, "AIProjectClient"] if ua)
+                + " "
+                + openai_default_user_agent
+            )
+
+        default_headers["User-Agent"] = final_user_agent
+
+        client = _create_openai_client(default_headers=default_headers, **kwargs)
 
         return client
 

sdk/ai/azure-ai-projects/azure/ai/projects/aio/_patch.py

@@ -15,7 +15,6 @@
 from azure.core.credentials_async import AsyncTokenCredential
 from azure.identity.aio import get_bearer_token_provider
 from ._client import AIProjectClient as AIProjectClientGenerated
-from .._patch import _patch_user_agent
 from .operations import TelemetryOperations
 
 
@@ -63,6 +62,8 @@ class AIProjectClient(AIProjectClientGenerated):  # pylint: disable=too-many-ins
     :paramtype api_version: str
     :keyword int polling_interval: Default waiting time between two polls for LRO operations if no
      Retry-After header is present.
+    :keyword user_agent: Optional string identifying the caller. This string will show up at the front of the "User-Agent" HTTP request header in all network calls this client makes. If an OpenAI client was obtained by calling get_openai_client(), this string will also show up at the front of the "User-Agent" request header in network calls that OpenAI client makes.
+     :meth:`get_openai_client`.
     """
 
     def __init__(self, endpoint: str, credential: AsyncTokenCredential, **kwargs: Any) -> None:
@@ -88,7 +89,7 @@ def __init__(self, endpoint: str, credential: AsyncTokenCredential, **kwargs: An
             kwargs.setdefault("logging_enable", self._console_logging_enabled)
 
         self._kwargs = kwargs.copy()
-        self._patched_user_agent = _patch_user_agent(self._kwargs.pop("user_agent", None))
+        self._custom_user_agent = self._kwargs.get("user_agent", None)
 
         super().__init__(endpoint=endpoint, credential=credential, **kwargs)
 
@@ -128,6 +129,8 @@ def get_openai_client(self, **kwargs: Any) -> "AsyncOpenAI":  # type: ignore[nam
 
         http_client = None
 
+        kwargs = kwargs.copy() if kwargs else {}
+
         if self._console_logging_enabled:
             try:
                 import httpx
@@ -226,16 +229,38 @@ def _log_request_body(self, request: httpx.Request) -> None:
 
             http_client = httpx.AsyncClient(transport=OpenAILoggingTransport())
 
-        client = AsyncOpenAI(
-            # See https://learn.microsoft.com/python/api/azure-identity/azure.identity?view=azure-python#azure-identity-get-bearer-token-provider # pylint: disable=line-too-long
-            api_key=get_bearer_token_provider(
-                self._config.credential,  # pylint: disable=protected-access
-                "https://ai.azure.com/.default",
-            ),
-            base_url=base_url,
-            http_client=http_client,
-            **kwargs,
-        )
+        default_headers = dict[str, str](kwargs.pop("default_headers", None) or {})
+
+        openai_custom_user_agent = default_headers.get("User-Agent", None)
+
+        def _create_openai_client(**kwargs) -> AsyncOpenAI:
+            return AsyncOpenAI(
+                # See https://learn.microsoft.com/python/api/azure-identity/azure.identity?view=azure-python#azure-identity-get-bearer-token-provider # pylint: disable=line-too-long
+                api_key=get_bearer_token_provider(
+                    self._config.credential,  # pylint: disable=protected-access
+                    "https://ai.azure.com/.default",
+                ),
+                base_url=base_url,
+                http_client=http_client,
+                **kwargs,
+            )
+
+        dummy_client = _create_openai_client()
+
+        openai_default_user_agent = dummy_client.user_agent
+
+        if openai_custom_user_agent:
+            final_user_agent = openai_custom_user_agent
+        else:
+            final_user_agent = (
+                "-".join(ua for ua in [self._custom_user_agent, "AIProjectClient"] if ua)
+                + " "
+                + openai_default_user_agent
+            )
+
+        default_headers["User-Agent"] = final_user_agent
+
+        client = _create_openai_client(default_headers=default_headers, **kwargs)
 
         return client
 

sdk/ai/azure-ai-projects/tests/conftest.py

@@ -19,7 +19,6 @@
     add_general_regex_sanitizer,
     add_body_key_sanitizer,
     add_remove_header_sanitizer,
-    add_body_regex_sanitizer,
 )
 
 if not load_dotenv(find_dotenv(), override=True):
@@ -121,10 +120,7 @@ def sanitize_url_paths():
     add_general_regex_sanitizer(regex=r"ftchkpt-[a-f0-9]+", value="sanitized-checkpoint-id")
 
     # Sanitize eval dataset names with timestamps (e.g., eval-data-2026-01-19_040648_UTC)
-    add_general_regex_sanitizer(
-        regex=r"eval-data-\d{4}-\d{2}-\d{2}_\d{6}_UTC",
-        value="eval-data-sanitized-timestamp"
-    )
+    add_general_regex_sanitizer(regex=r"eval-data-\d{4}-\d{2}-\d{2}_\d{6}_UTC", value="eval-data-sanitized-timestamp")
 
     # Sanitize API key from service response (this includes Application Insights connection string)
     add_body_key_sanitizer(json_path="credentials.key", value="sanitized-api-key")

sdk/ai/azure-ai-projects/tests/responses/test_responses.py

@@ -5,9 +5,40 @@
 # ------------------------------------
 # cSpell:disable
 
-# import os
+import pytest
+import httpx
 from devtools_testutils import recorded_by_proxy, RecordedTransport
 from test_base import TestBase, servicePreparer
+from typing import Any, Dict, Optional
+from openai import OpenAI
+from azure.core.credentials import TokenCredential
+from azure.ai.projects import AIProjectClient
+
+BASE_OPENAI_UA = OpenAI(api_key="dummy").user_agent
+
+
+class DummyTokenCredential(TokenCredential):
+    def get_token(self, *scopes: str, **kwargs: Any):  # type: ignore[override]
+        return None
+
+
+@pytest.fixture(autouse=True)
+def patch_openai(monkeypatch):
+    # Ensure no real network/token calls are made during the test.
+    monkeypatch.setattr("azure.ai.projects._patch.get_bearer_token_provider", lambda *_, **__: "token-provider")
+
+
+def _build_client(
+    project_user_agent: Optional[str],
+    default_headers: Optional[Dict[str, str]],
+):
+    project_client = AIProjectClient(
+        "https://example.com/api/projects/test",
+        DummyTokenCredential(),
+        user_agent=project_user_agent,
+    )
+    kwargs: Dict[str, Any] = {"default_headers": default_headers}
+    return project_client.get_openai_client(**kwargs)
 
 
 class TestResponses(TestBase):
@@ -42,3 +73,64 @@ def test_responses(self, **kwargs):
         )
         print(f"Response id: {response2.id}, output text: {response2.output_text}")
         assert "1609" in response2.output_text or "1,609" in response2.output_text
+
+    @pytest.mark.parametrize(
+        "project_ua,openai_default_header,expected_ua",
+        [
+            # 1) No user_agent anywhere
+            (
+                None,
+                None,
+                f"AIProjectClient {BASE_OPENAI_UA}",
+            ),
+            # 2) user_agent at project client only
+            (
+                "custom-client-ua",
+                None,
+                f"custom-client-ua-AIProjectClient {BASE_OPENAI_UA}",
+            ),
+            # 3) user_agent at openai client only
+            (
+                None,
+                {"User-Agent": "custom-openai-ua"},
+                "custom-openai-ua",
+            ),
+            # 4) user_agent at both clients only
+            (
+                "custom-client-ua",
+                {"User-Agent": "custom-openai-ua"},
+                "custom-openai-ua",
+            ),
+        ],
+    )
+    def test_user_agent_patching_via_response_create(self, project_ua, openai_default_header, expected_ua):
+        client = _build_client(project_ua, openai_default_header)
+
+        calls = []
+
+        def fake_send(request: httpx.Request, *args: Any, **kwargs: Any):
+            # Capture headers that would be sent over the wire.
+            calls.append(dict(request.headers))
+            return httpx.Response(
+                200,
+                request=request,
+                json={
+                    "id": "resp_123",
+                    "object": "response",
+                    "model": kwargs.get("model", ""),
+                    "status": "ok",
+                    "output": "",
+                },
+            )
+
+        # Monkeypatch the underlying httpx client used by the OpenAI client instance.
+        client._client.send = fake_send  # type: ignore[attr-defined]
+
+        # Act through the actual call surface
+        client.responses.create(model="gpt-4o")
+
+        # Assert
+        assert calls, "Expected a responses.create call to be captured"
+        headers_used = {k.lower(): v for k, v in calls[0].items()}
+
+        assert headers_used["user-agent"] == expected_ua