Python: Implemented FoundryChatClient (#193)

* Initial version of FoundryChatClient

* Updates to the tool call streaming wrapper

* Small fixes

* Small updates and addressed PR feedback

* Handle automatic client creation

* Small improvement

* Added credential parameter

* Small improvements

* Made FoundryChatClient disposable

* Small fixes

* Added unit tests

* Refactored samples

* Small improvements

* Small fix

* Addressed PR feedback

* Small fixes

* Small updates

* Small fix

* Addressed PR feedback

python/samples/getting_started/agents/chat_client_agent.py

@@ -6,6 +6,7 @@ from typing import Annotated
 
 from agent_framework import ChatClientAgent
 from agent_framework.openai import OpenAIChatClient
+from dotenv import load_dotenv
 from pydantic import Field
 
 
@@ -17,11 +18,12 @@ def get_weather(
     return f"The weather in {location} is {conditions[randint(0, 3)]} with a high of {randint(10, 30)}°C."
 
 
-async def main():
+async def main() -> None:
     instructions = "You are a helpful assistant, you can help the user with weather information."
     agent = ChatClientAgent(OpenAIChatClient(), instructions=instructions, tools=get_weather)
     print(str(await agent.run("What's the weather in Amsterdam?")))
 
 
 if __name__ == "__main__":
+    load_dotenv()
     asyncio.run(main())

python/samples/getting_started/agents/foundry/README.md

@@ -0,0 +1,44 @@
+# Foundry Chat Client Examples
+
+This folder contains examples demonstrating different ways to use the `FoundryChatClient` from the `agent_framework.foundry` package.
+
+## Examples
+
+### 1. `foundry_basic.py`
+The simplest way to use FoundryChatClient. It automatically handles all configuration using environment variables.
+
+### 2. `foundry_with_explicit_settings.py`
+Shows how to explicitly configure the FoundryChatClient with custom settings, including project endpoint, model deployment, credentials, and agent name.
+
+### 3. `foundry_with_existing_client.py`
+Demonstrates how to use an existing `AIProjectClient` instance with FoundryChatClient, giving you more control over the underlying Azure AI client.
+
+### 4. `foundry_with_existing_agent.py`
+Shows how to work with a pre-existing agent by providing the agent ID to FoundryChatClient. This example also demonstrates proper cleanup of manually created agents.
+
+## Environment Variables
+
+Make sure to set the following environment variables before running the examples:
+
+- `FOUNDRY_PROJECT_ENDPOINT`: Your Azure AI Foundry project endpoint
+- `FOUNDRY_MODEL_DEPLOYMENT_NAME`: The name of your model deployment
+
+## Running the Examples
+
+Each example can be run independently:
+
+```bash
+# Run the basic example
+python samples/getting_started/agents/foundry/foundry_basic.py
+
+# Run the explicit settings example
+python samples/getting_started/agents/foundry/foundry_with_explicit_settings.py
+
+# Run the existing client example
+python samples/getting_started/agents/foundry/foundry_with_existing_client.py
+
+# Run the existing agent example
+python samples/getting_started/agents/foundry/foundry_with_existing_agent.py
+```
+
+All examples use the same weather tool function that returns mock weather data.

python/samples/getting_started/agents/foundry/foundry_basic.py

@@ -0,0 +1,37 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+import asyncio
+from random import randint
+from typing import Annotated
+
+from agent_framework import ChatClientAgent
+from agent_framework.foundry import FoundryChatClient
+from dotenv import load_dotenv
+from pydantic import Field
+
+
+def get_weather(
+    location: Annotated[str, Field(description="The location to get the weather for.")],
+) -> str:
+    """Get the weather for a given location."""
+    conditions = ["sunny", "cloudy", "rainy", "stormy"]
+    return f"The weather in {location} is {conditions[randint(0, 3)]} with a high of {randint(10, 30)}°C."
+
+
+async def main() -> None:
+    print("=== Basic Foundry Chat Client Example ===")
+
+    # Since no Agent ID is provided, the agent will be automatically created
+    # and deleted after getting a response
+    async with ChatClientAgent(
+        chat_client=FoundryChatClient(),
+        instructions="You are a helpful weather agent.",
+        tools=get_weather,
+    ) as agent:
+        result = await agent.run("What's the weather like in Seattle?")
+        print(f"Result: {result}\n")
+
+
+if __name__ == "__main__":
+    load_dotenv()
+    asyncio.run(main())

python/samples/getting_started/agents/foundry/foundry_with_existing_agent.py

@@ -0,0 +1,50 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+import asyncio
+import os
+from random import randint
+from typing import Annotated
+
+from agent_framework import ChatClientAgent
+from agent_framework.foundry import FoundryChatClient
+from azure.ai.projects.aio import AIProjectClient
+from azure.identity.aio import AzureCliCredential
+from dotenv import load_dotenv
+from pydantic import Field
+
+
+def get_weather(
+    location: Annotated[str, Field(description="The location to get the weather for.")],
+) -> str:
+    """Get the weather for a given location."""
+    conditions = ["sunny", "cloudy", "rainy", "stormy"]
+    return f"The weather in {location} is {conditions[randint(0, 3)]} with a high of {randint(10, 30)}°C."
+
+
+async def main() -> None:
+    print("=== Foundry Chat Client with Existing Agent ===")
+
+    # Create the client
+    client = AIProjectClient(endpoint=os.environ["FOUNDRY_PROJECT_ENDPOINT"], credential=AzureCliCredential())
+
+    # Create an agent that will persist
+    created_agent = await client.agents.create_agent(
+        model=os.environ["FOUNDRY_MODEL_DEPLOYMENT_NAME"], name="WeatherAgent"
+    )
+
+    try:
+        async with ChatClientAgent(
+            chat_client=FoundryChatClient(client=client, agent_id=created_agent.id),
+            instructions="You are a helpful weather agent.",
+            tools=get_weather,
+        ) as agent:
+            result = await agent.run("What's the weather like in Tokyo?")
+            print(f"Result: {result}\n")
+    finally:
+        # Clean up the agent manually
+        await client.agents.delete_agent(created_agent.id)
+
+
+if __name__ == "__main__":
+    load_dotenv()
+    asyncio.run(main())

python/samples/getting_started/agents/foundry/foundry_with_existing_client.py

@@ -0,0 +1,47 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+import asyncio
+import os
+from random import randint
+from typing import Annotated
+
+from agent_framework import ChatClientAgent
+from agent_framework.foundry import FoundryChatClient
+from azure.ai.projects.aio import AIProjectClient
+from azure.identity.aio import AzureCliCredential
+from dotenv import load_dotenv
+from pydantic import Field
+
+
+def get_weather(
+    location: Annotated[str, Field(description="The location to get the weather for.")],
+) -> str:
+    """Get the weather for a given location."""
+    conditions = ["sunny", "cloudy", "rainy", "stormy"]
+    return f"The weather in {location} is {conditions[randint(0, 3)]} with a high of {randint(10, 30)}°C."
+
+
+async def main() -> None:
+    print("=== Foundry Chat Client with Existing AIProjectClient ===")
+
+    # Create the client
+    client = AIProjectClient(endpoint=os.environ["FOUNDRY_PROJECT_ENDPOINT"], credential=AzureCliCredential())
+
+    # Since no Agent ID is provided, the agent will be automatically created
+    # and deleted after getting a response
+    async with ChatClientAgent(
+        chat_client=FoundryChatClient(
+            client=client,
+            model_deployment_name=os.environ["FOUNDRY_MODEL_DEPLOYMENT_NAME"],
+            agent_name="WeatherAgent",
+        ),
+        instructions="You are a helpful weather agent.",
+        tools=get_weather,
+    ) as agent:
+        result = await agent.run("What's the weather like in London?")
+        print(f"Result: {result}\n")
+
+
+if __name__ == "__main__":
+    load_dotenv()
+    asyncio.run(main())

python/samples/getting_started/agents/foundry/foundry_with_explicit_settings.py

@@ -0,0 +1,44 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+import asyncio
+import os
+from random import randint
+from typing import Annotated
+
+from agent_framework import ChatClientAgent
+from agent_framework.foundry import FoundryChatClient
+from azure.identity.aio import AzureCliCredential
+from dotenv import load_dotenv
+from pydantic import Field
+
+
+def get_weather(
+    location: Annotated[str, Field(description="The location to get the weather for.")],
+) -> str:
+    """Get the weather for a given location."""
+    conditions = ["sunny", "cloudy", "rainy", "stormy"]
+    return f"The weather in {location} is {conditions[randint(0, 3)]} with a high of {randint(10, 30)}°C."
+
+
+async def main() -> None:
+    print("=== Foundry Chat Client with Explicit Settings ===")
+
+    # Since no Agent ID is provided, the agent will be automatically created
+    # and deleted after getting a response
+    async with ChatClientAgent(
+        chat_client=FoundryChatClient(
+            project_endpoint=os.environ["FOUNDRY_PROJECT_ENDPOINT"],
+            model_deployment_name=os.environ["FOUNDRY_MODEL_DEPLOYMENT_NAME"],
+            credential=AzureCliCredential(),
+            agent_name="WeatherAgent",
+        ),
+        instructions="You are a helpful weather agent.",
+        tools=get_weather,
+    ) as agent:
+        result = await agent.run("What's the weather like in New York?")
+        print(f"Result: {result}\n")
+
+
+if __name__ == "__main__":
+    load_dotenv()
+    asyncio.run(main())