Cleanup

Author: moonbox3

agent-framework/integrations/ag-ui/backend-tool-rendering.md

@@ -299,6 +299,9 @@ Before you begin, ensure you have completed the [Getting Started](getting-starte
 - Azure OpenAI service configured
 - Basic understanding of AG-UI server and client setup
 
+> [!NOTE]
+> These samples use `DefaultAzureCredential` for authentication. Make sure you're authenticated with Azure (e.g., via `az login`). For more information, see the [Azure Identity documentation](/python/api/azure-identity/azure.identity.defaultazurecredential).
+
 ## What is Backend Tool Rendering?
 
 Backend tool rendering means:
@@ -392,6 +395,7 @@ from typing import Annotated, Any
 from agent_framework import ChatAgent, ai_function
 from agent_framework.azure import AzureOpenAIChatClient
 from agent_framework_ag_ui import add_agent_framework_fastapi_endpoint
+from azure.identity import AzureCliCredential
 from fastapi import FastAPI
 from pydantic import Field
 
@@ -424,21 +428,26 @@ def search_restaurants(
     }
 
 
-# Read configuration
+# Read required configuration
 endpoint = os.environ.get("AZURE_OPENAI_ENDPOINT")
 deployment_name = os.environ.get("AZURE_OPENAI_DEPLOYMENT_NAME")
 
-if not endpoint or not deployment_name:
-    raise ValueError("AZURE_OPENAI_ENDPOINT and AZURE_OPENAI_DEPLOYMENT_NAME are required")
+if not endpoint:
+    raise ValueError("AZURE_OPENAI_ENDPOINT environment variable is required")
+if not deployment_name:
+    raise ValueError("AZURE_OPENAI_DEPLOYMENT_NAME environment variable is required")
+
+chat_client = AzureOpenAIChatClient(
+    credential=AzureCliCredential(),
+    endpoint=endpoint,
+    deployment_name=deployment_name,    
+)
 
 # Create agent with tools
 agent = ChatAgent(
     name="TravelAssistant",
     instructions="You are a helpful travel assistant. Use the available tools to help users plan their trips.",
-    chat_client=AzureOpenAIChatClient(
-        endpoint=endpoint,
-        deployment_name=deployment_name,
-    ),
+    chat_client=chat_client,
     tools=[get_weather, search_restaurants],
 )
 

agent-framework/integrations/ag-ui/getting-started.md

@@ -410,32 +410,29 @@ import os
 from agent_framework import ChatAgent
 from agent_framework.azure import AzureOpenAIChatClient
 from agent_framework_ag_ui import add_agent_framework_fastapi_endpoint
+from azure.identity import AzureCliCredential
 from fastapi import FastAPI
 
 # Read required configuration
 endpoint = os.environ.get("AZURE_OPENAI_ENDPOINT")
 deployment_name = os.environ.get("AZURE_OPENAI_DEPLOYMENT_NAME")
-# Note: a token may also be used in place of the api_key using:
-# from azure.identity import AzureCliCredential
-# chat_client = AzureOpenAIChatClient(credential=AzureCliCredential())
-api_key = os.environ.get("AZURE_OPENAI_API_KEY")
 
 if not endpoint:
     raise ValueError("AZURE_OPENAI_ENDPOINT environment variable is required")
 if not deployment_name:
     raise ValueError("AZURE_OPENAI_DEPLOYMENT_NAME environment variable is required")
-if not api_key:
-    raise ValueError("AZURE_OPENAI_API_KEY environment variable is required")
+
+chat_client = AzureOpenAIChatClient(
+    credential=AzureCliCredential(),
+    endpoint=endpoint,
+    deployment_name=deployment_name,    
+)
 
 # Create the AI agent
 agent = ChatAgent(
     name="AGUIAssistant",
     instructions="You are a helpful assistant.",
-    chat_client=AzureOpenAIChatClient(
-        endpoint=endpoint,
-        deployment_name=deployment_name,
-        api_key=api_key,
-    ),
+    chat_client=chat_client,
 )
 
 # Create FastAPI app

agent-framework/integrations/ag-ui/human-in-the-loop.md

@@ -584,6 +584,7 @@ from typing import Annotated
 from agent_framework import ChatAgent, ai_function
 from agent_framework.azure import AzureOpenAIChatClient
 from agent_framework_ag_ui import AgentFrameworkAgent, add_agent_framework_fastapi_endpoint
+from azure.identity import AzureCliCredential
 from fastapi import FastAPI
 from pydantic import Field
 
@@ -618,21 +619,26 @@ def check_balance(
     return f"Account {account} balance: $5,432.10 USD"
 
 
-# Read configuration
+# Read required configuration
 endpoint = os.environ.get("AZURE_OPENAI_ENDPOINT")
 deployment_name = os.environ.get("AZURE_OPENAI_DEPLOYMENT_NAME")
 
-if not endpoint or not deployment_name:
-    raise ValueError("AZURE_OPENAI_ENDPOINT and AZURE_OPENAI_DEPLOYMENT_NAME are required")
+if not endpoint:
+    raise ValueError("AZURE_OPENAI_ENDPOINT environment variable is required")
+if not deployment_name:
+    raise ValueError("AZURE_OPENAI_DEPLOYMENT_NAME environment variable is required")
+
+chat_client = AzureOpenAIChatClient(
+    credential=AzureCliCredential(),
+    endpoint=endpoint,
+    deployment_name=deployment_name,    
+)
 
 # Create agent with tools
 agent = ChatAgent(
     name="BankingAssistant",
     instructions="You are a banking assistant. Help users with their banking needs. Always confirm details before performing transfers.",
-    chat_client=AzureOpenAIChatClient(
-        endpoint=endpoint,
-        deployment_name=deployment_name,
-    ),
+    chat_client=chat_client,
     tools=[transfer_money, cancel_subscription, check_balance],
 )
 

agent-framework/integrations/ag-ui/state-management.md

@@ -412,6 +412,7 @@ from agent_framework_ag_ui import (
     RecipeConfirmationStrategy,
     add_agent_framework_fastapi_endpoint,
 )
+from azure.identity import AzureCliCredential
 from fastapi import FastAPI
 
 # Create the chat agent with tools
@@ -451,7 +452,11 @@ agent = ChatAgent(
     - Add finishing touches: lemon zest, fresh parsley
     - Make instructions more detailed and professional
     """,
-    chat_client=AzureOpenAIChatClient(),
+    chat_client=AzureOpenAIChatClient(
+        credential=AzureCliCredential(),
+        endpoint=endpoint,
+        deployment_name=deployment_name,    
+    ),
     tools=[update_recipe],
 )
 

agent-framework/integrations/ag-ui/testing-with-dojo.md

@@ -70,6 +70,9 @@ AZURE_OPENAI_API_KEY=your_api_key_here
 AZURE_OPENAI_CHAT_DEPLOYMENT_NAME=your_deployment_here
 ```
 
+> [!NOTE]
+> If using `DefaultAzureCredential`, in place for an `api_key` for authentication, make sure you're authenticated with Azure (e.g., via `az login`). For more information, see the [Azure Identity documentation](/python/api/azure-identity/azure.identity.defaultazurecredential).
+
 ## Running the Dojo Application
 
 ### 1. Start the Backend Server