No need to make get_openai_client() on the async AIProjectClient an "async" method. It does not make any network calls. (#43991)

dargilco · web-flow · commit 392008a435a3 · 2025-11-13T05:19:21.000-08:00
diff --git a/sdk/ai/azure-ai-projects/CHANGELOG.md b/sdk/ai/azure-ai-projects/CHANGELOG.md
@@ -1,5 +1,17 @@
 # Release History
 
+## 2.0.0b2 (Unreleased)
+
+### Features Added
+
+### Breaking changes
+
+* `get_openai_client()` method on the asynchronous AIProjectClient is no longer an "async" method.
+
+### Bugs Fixed
+
+### Sample updates
+
 ## 2.0.0b1 (2025-11-11)
 
 ### Features added
diff --git a/sdk/ai/azure-ai-projects/_tsp-location.yaml b/sdk/ai/azure-ai-projects/_tsp-location.yaml
@@ -0,0 +1,4 @@
+directory: specification/ai/Azure.AI.Projects
+commit: 78bfd335c31b8764578cfb9840f3b74349c10354
+repo: Azure/azure-rest-api-specs-pr
+additionalDirectories: 
diff --git a/sdk/ai/azure-ai-projects/azure/ai/projects/_version.py b/sdk/ai/azure-ai-projects/azure/ai/projects/_version.py
@@ -6,4 +6,4 @@
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
 
-VERSION = "2.0.0b1"
+VERSION = "2.0.0b2"
diff --git a/sdk/ai/azure-ai-projects/azure/ai/projects/aio/_patch.py b/sdk/ai/azure-ai-projects/azure/ai/projects/aio/_patch.py
@@ -10,7 +10,7 @@
 import os
 import logging
 from typing import List, Any, TYPE_CHECKING
-from azure.core.tracing.decorator_async import distributed_trace_async
+from azure.core.tracing.decorator import distributed_trace
 from azure.core.credentials_async import AsyncTokenCredential
 from ._client import AIProjectClient as AIProjectClientGenerated
 from .._patch import _patch_user_agent
@@ -95,8 +95,8 @@ def __init__(self, endpoint: str, credential: AsyncTokenCredential, **kwargs: An
 
         self.telemetry = TelemetryOperations(self)  # type: ignore
 
-    @distributed_trace_async
-    async def get_openai_client(self, **kwargs: Any) -> "AsyncOpenAI":  # type: ignore[name-defined]  # pylint: disable=too-many-statements
+    @distributed_trace
+    def get_openai_client(self, **kwargs: Any) -> "AsyncOpenAI":  # type: ignore[name-defined]  # pylint: disable=too-many-statements
         """Get an authenticated AsyncOpenAI client from the `openai` package.
 
         Keyword arguments are passed to the AsyncOpenAI client constructor.
diff --git a/sdk/ai/azure-ai-projects/azure/ai/projects/models/_models.py b/sdk/ai/azure-ai-projects/azure/ai/projects/models/_models.py
diff --git a/sdk/ai/azure-ai-projects/samples/agents/sample_agent_basic_async.py b/sdk/ai/azure-ai-projects/samples/agents/sample_agent_basic_async.py
@@ -46,7 +46,7 @@ async def main() -> None:
 
         async with project_client:
 
-            openai_client = await project_client.get_openai_client()
+            openai_client = project_client.get_openai_client()
 
             agent = await project_client.agents.create_version(
                 agent_name="MyAgent",
diff --git a/sdk/ai/azure-ai-projects/samples/agents/sample_agent_retrieve_basic_async.py b/sdk/ai/azure-ai-projects/samples/agents/sample_agent_retrieve_basic_async.py
@@ -47,7 +47,7 @@ async def main():
         )
 
         async with project_client:
-            openai_client = await project_client.get_openai_client()
+            openai_client = project_client.get_openai_client()
 
             # Retrieves latest version of an existing Agent
             agent = await project_client.agents.get(agent_name=agent_name)
diff --git a/sdk/ai/azure-ai-projects/samples/agents/sample_agent_structured_output_async.py b/sdk/ai/azure-ai-projects/samples/agents/sample_agent_structured_output_async.py
@@ -66,7 +66,7 @@ async def main() -> None:
 
         async with project_client:
 
-            openai_client = await project_client.get_openai_client()
+            openai_client = project_client.get_openai_client()
 
             agent = await project_client.agents.create_version(
                 agent_name="MyAgent",
diff --git a/sdk/ai/azure-ai-projects/samples/agents/sample_mcp_tool_async_.py b/sdk/ai/azure-ai-projects/samples/agents/sample_mcp_tool_async_.py
@@ -79,7 +79,7 @@ async def main():
                 )
                 async with project_client:
                     # Create a vector store
-                    openai_client = await project_client.get_openai_client()
+                    openai_client = project_client.get_openai_client()
                     vector_store = await openai_client.vector_stores.create(
                         name="sample_vector_store",
                     )
diff --git a/sdk/ai/azure-ai-projects/samples/agents/sample_workflow_multi_agent_async.py b/sdk/ai/azure-ai-projects/samples/agents/sample_workflow_multi_agent_async.py
@@ -48,7 +48,7 @@ async def main():
         )
 
         async with project_client:
-            openai_client = await project_client.get_openai_client()
+            openai_client = project_client.get_openai_client()
 
             teacher_agent = await project_client.agents.create_version(
                 agent_name="teacher-agent",
diff --git a/sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_code_interpreter.py b/sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_code_interpreter.py
@@ -51,7 +51,7 @@
     file = openai_client.files.create(purpose="assistants", file=open(asset_file_path, "rb"))
     tool = CodeInterpreterTool(container=CodeInterpreterToolAuto(file_ids=[file.id]))
     # [END tool_declaration]
-    
+
     print(f"File uploaded (id: {file.id})")
 
     # Create agent with code interpreter tool
diff --git a/sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_code_interpreter_async.py b/sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_code_interpreter_async.py
@@ -49,7 +49,7 @@ async def main() -> None:
 
         try:
             async with project_client:
-                openai_client = await project_client.get_openai_client()
+                openai_client = project_client.get_openai_client()
 
                 # Upload the CSV file for the code interpreter to use
                 with open(asset_file_path, "rb") as file_data:
diff --git a/sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_computer_use_async.py b/sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_computer_use_async.py
@@ -83,7 +83,7 @@ async def main():
             )
             print(f"Agent created (id: {agent.id}, name: {agent.name}, version: {agent.version})")
 
-            openai_client = await project_client.get_openai_client()
+            openai_client = project_client.get_openai_client()
 
             # Initial request with screenshot - start with Bing search page
             print("Starting computer automation session (initial screenshot: cua_browser_search.png)...")
diff --git a/sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_file_search_in_stream_async.py b/sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_file_search_in_stream_async.py
@@ -50,7 +50,7 @@ async def main() -> None:
 
         async with project_client:
             # Get the OpenAI client for vector store operations
-            openai_client = await project_client.get_openai_client()
+            openai_client = project_client.get_openai_client()
 
             print("Setting up file search with streaming responses...")
 
diff --git a/sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_function_tool.py b/sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_function_tool.py
@@ -52,6 +52,7 @@
 )
 # [END tool_declaration]
 
+
 def get_horoscope(sign: str) -> str:
     """Generate a horoscope for the given astrological sign."""
     return f"{sign}: Next Tuesday you will befriend a baby otter."
diff --git a/sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_function_tool_async.py b/sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_function_tool_async.py
@@ -82,7 +82,7 @@ async def main():
                 ),
             )
 
-            openai_client = await project_client.get_openai_client()
+            openai_client = project_client.get_openai_client()
 
             async with openai_client:
 
diff --git a/sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_image_generation_async.py b/sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_image_generation_async.py
@@ -67,7 +67,7 @@ async def main():
             )
             print(f"Agent created (id: {agent.id}, name: {agent.name}, version: {agent.version})")
 
-            openai_client = await project_client.get_openai_client()
+            openai_client = project_client.get_openai_client()
 
             async with openai_client:
                 response = await openai_client.responses.create(
diff --git a/sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_mcp_async.py b/sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_mcp_async.py
@@ -66,7 +66,7 @@ async def main():
             print(f"Agent created (id: {agent.id}, name: {agent.name}, version: {agent.version})")
 
             # Get the OpenAI async client for responses and conversations
-            openai_client = await project_client.get_openai_client()
+            openai_client = project_client.get_openai_client()
 
             async with openai_client:
                 # Create a conversation thread to maintain context across multiple interactions
diff --git a/sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_mcp_with_project_connection_async.py b/sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_mcp_with_project_connection_async.py
@@ -70,7 +70,7 @@ async def main():
             print(f"Agent created (id: {agent.id}, name: {agent.name}, version: {agent.version})")
 
             # Get the async OpenAI client for responses and conversations
-            openai_client = await project_client.get_openai_client()
+            openai_client = project_client.get_openai_client()
 
             # Create a conversation thread to maintain context across multiple interactions
             conversation = await openai_client.conversations.create()
diff --git a/sdk/ai/azure-ai-projects/samples/evaluations/sample_agent_response_evaluation_with_function_tool.py b/sdk/ai/azure-ai-projects/samples/evaluations/sample_agent_response_evaluation_with_function_tool.py
@@ -67,6 +67,7 @@ def get_horoscope(sign: str) -> str:
     """Generate a horoscope for the given astrological sign."""
     return f"{sign}: Next Tuesday you will befriend a baby otter."
 
+
 project_client = AIProjectClient(
     endpoint=os.environ["AZURE_AI_PROJECT_ENDPOINT"],
     credential=DefaultAzureCredential(),
@@ -126,9 +127,7 @@ def get_horoscope(sign: str) -> str:
             "type": "azure_ai_evaluator",
             "name": "tool_call_accuracy",
             "evaluator_name": "builtin.tool_call_accuracy",
-            "initialization_parameters": {
-                "deployment_name": f"{model_deployment_name}"
-            }
+            "initialization_parameters": {"deployment_name": f"{model_deployment_name}"},
         }
     ]
     eval_object = openai_client.evals.create(
diff --git a/sdk/ai/azure-ai-projects/samples/evaluations/sample_eval_catalog_prompt_based_evaluators.py b/sdk/ai/azure-ai-projects/samples/evaluations/sample_eval_catalog_prompt_based_evaluators.py
@@ -19,14 +19,14 @@
     Set these environment variables with your own values:
     1) AZURE_AI_PROJECT_ENDPOINT - Required. The Azure AI Project endpoint, as found in the overview page of your
        Microsoft Foundry project. It has the form: https://<account_name>.services.ai.azure.com/api/projects/<project_name>.
-       
+
     For Custom Prompt Based Evaluators:
-    
+
         Following are the possible outputs that can be used in the prompt definition:
-        
+
         result could be int, float or boolean based on the metric type defined.
         reason is a brief explanation for the score. (Optional)
-        
+
         - An ordinal metric with a score from 1 to 5 (int)
             ### Output Format (JSON):
             {
@@ -47,7 +47,7 @@
                 "result": "true",
                 "reason": "<brief explanation for the score>"
             }
-            
+
             ### Output Format (JSON):
             {
                 "result": "false",
diff --git a/sdk/ai/azure-ai-projects/samples/files/sample_files_async.py b/sdk/ai/azure-ai-projects/samples/files/sample_files_async.py
@@ -42,7 +42,7 @@ async def main() -> None:
 
         async with AIProjectClient(endpoint=endpoint, credential=credential) as project_client:
 
-            async with await project_client.get_openai_client() as openai_client:
+            async with project_client.get_openai_client() as openai_client:
 
                 # [START files_async_sample]
                 print("Uploading file")
diff --git a/sdk/ai/azure-ai-projects/samples/responses/sample_responses_basic_async.py b/sdk/ai/azure-ai-projects/samples/responses/sample_responses_basic_async.py
@@ -43,7 +43,7 @@ async def main() -> None:
 
         async with project_client:
 
-            openai_client = await project_client.get_openai_client()
+            openai_client = project_client.get_openai_client()
 
             async with openai_client:
 
diff --git a/sdk/ai/azure-ai-projects/tests/agents/telemetry/test_responses_instrumentor_async.py b/sdk/ai/azure-ai-projects/tests/agents/telemetry/test_responses_instrumentor_async.py
diff --git a/sdk/ai/azure-ai-projects/tests/agents/test_agent_responses_crud_async.py b/sdk/ai/azure-ai-projects/tests/agents/test_agent_responses_crud_async.py
diff --git a/sdk/ai/azure-ai-projects/tests/files/test_files_async.py b/sdk/ai/azure-ai-projects/tests/files/test_files_async.py

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ async def main():`
`47`	`47`	`)`
`48`	`48`
`49`	`49`	`async with project_client:`
`50`		`- openai_client = await project_client.get_openai_client()`
	`50`	`+ openai_client = project_client.get_openai_client()`
`51`	`51`
`52`	`52`	`# Retrieves latest version of an existing Agent`
`53`	`53`	`agent = await project_client.agents.get(agent_name=agent_name)`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ async def main():`
`79`	`79`	`)`
`80`	`80`	`async with project_client:`
`81`	`81`	`# Create a vector store`
`82`		`- openai_client = await project_client.get_openai_client()`
	`82`	`+ openai_client = project_client.get_openai_client()`
`83`	`83`	`vector_store = await openai_client.vector_stores.create(`
`84`	`84`	`name="sample_vector_store",`
`85`	`85`	`)`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ async def main():`
`48`	`48`	`)`
`49`	`49`
`50`	`50`	`async with project_client:`
`51`		`- openai_client = await project_client.get_openai_client()`
	`51`	`+ openai_client = project_client.get_openai_client()`
`52`	`52`
`53`	`53`	`teacher_agent = await project_client.agents.create_version(`
`54`	`54`	`agent_name="teacher-agent",`