Files
Eduard van Valkenburg 5e056b672e Python: [BREAKING] Python: Provider-leading client design & OpenAI package extraction (#4818)
* Python: Provider-leading client design & OpenAI package extraction

Major refactoring of the Python Agent Framework client architecture:

- Extract OpenAI clients into new `agent-framework-openai` package
- Core package no longer depends on openai, azure-identity, azure-ai-projects
- Rename clients for discoverability: OpenAIResponsesClient → OpenAIChatClient,
  OpenAIChatClient → OpenAIChatCompletionClient
- Unify `model_id`/`deployment_name`/`model_deployment_name` → `model` param
- New FoundryChatClient for Azure AI Foundry Responses API
- New FoundryAgent/FoundryAgentClient for connecting to pre-configured Foundry agents
- Remove OpenAIBase/OpenAIConfigMixin from non-deprecated client MRO
- Deprecate AzureOpenAI* clients, AzureAIClient, OpenAIAssistantsClient
- Reorganize samples: azure_openai+azure_ai+azure_ai_agent → azure/
- ADR-0020: Provider-Leading Client Design

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix: missing Agent imports in samples, .model_id → .model in foundry_local sample

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix: CI failures — mypy errors, coverage targets, sample imports

- azure-ai mypy: add type ignores for TypedDict total=, model arg, forward ref
- Coverage: replace core.azure/openai targets with openai package target
- project_provider: add type annotation for opts dict

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix: populate openai .pyi stub, fix broken README links, coverage targets

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fixes

* updated observabilitty

* reset azure init.pyi

* fix errors

* updated adr number

* fix foundry local

* fixed not renamed docstrings and comments, and added deprecated markers to old classes

* fix tests and pyprojects

* fix test vars

* updated function tests

* update durable

* updated test setup for functions

* Fix Foundry auth in workflow samples

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Stabilize Python integration workflows

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Update hosting samples for Foundry

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Trigger full CI rerun

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Trigger CI rerun again

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* trigger rerun

* trigger rerun

* fix for litellm

* undo durabletask changes

* Move Foundry APIs into foundry namespace

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fix Foundry pyproject formatting

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Split provider samples by Foundry surface

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Restore hosting sample requirements

Also fix the Foundry Local sample link after the provider sample move.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* updated tests

* udpated foundry integration tests

* removed dist from azurefunctions tests

* Use separate Foundry clients for concurrent agents

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix client setup in azfunc and durable

* disabled two tests

* updated setup for some function and durable tests

* improved azure openai setup with new clients

* ignore deprecated

* fixes

* skip 11

* remove openai assistants int tests

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
5e056b672e · 2026-03-25 09:56:29 +00:00
History
..

Hosted Agent Samples

These samples demonstrate how to build and host AI agents in Python using the Azure AI AgentServer SDK together with Microsoft Agent Framework. Each sample runs locally as a hosted agent and includes Dockerfile and agent.yaml assets for deployment to Microsoft Foundry.

Samples

Sample Description
agent_with_hosted_mcp Hosted MCP tool that connects to Microsoft Learn via https://learn.microsoft.com/api/mcp
agent_with_text_search_rag Retrieval-augmented generation using a custom BaseContextProvider with Contoso Outdoors sample data
agents_in_workflow Concurrent workflow that combines researcher, marketer, and legal specialist agents
agent_with_local_tools Local Python tool execution for Seattle hotel search
writer_reviewer_agents_in_workflow Writer/Reviewer workflow using AzureOpenAIResponsesClient

Common Prerequisites

Before running any sample, ensure you have:

  1. Python 3.10 or later
  2. Azure CLI installed
  3. An Azure OpenAI resource or a Microsoft Foundry project with a chat model deployment

Authenticate with Azure CLI

All samples rely on Azure credentials. For local development, the simplest approach is Azure CLI authentication:

az login
az account show

Running a Sample

Each sample folder contains its own requirements.txt. Run commands from the specific sample directory you want to try.

The sample dependencies include preview packages, so allow prerelease installs:

cd <sample-directory>
uv venv .venv
uv pip install --prerelease=allow -r requirements.txt
uv run main.py

Alternative: venv

Windows PowerShell:

cd <sample-directory>
python -m venv .venv
.\.venv\Scripts\Activate.ps1
pip install -r requirements.txt
python main.py

macOS/Linux:

cd <sample-directory>
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
python main.py

Each sample starts a hosted agent locally on http://localhost:8088/.

Environment Variable Setup

You can either export variables in your shell or create a local .env file in the sample directory.

Example .env for Azure OpenAI samples:

AZURE_OPENAI_ENDPOINT=https://<your-openai-resource>.openai.azure.com/
AZURE_OPENAI_CHAT_DEPLOYMENT_NAME=gpt-4.1

Example .env for Foundry project samples:

PROJECT_ENDPOINT=https://<your-resource>.services.ai.azure.com/api/projects/<your-project>
MODEL_DEPLOYMENT_NAME=gpt-4.1

Interacting with the Agent

After starting a sample, send requests to the Responses endpoint.

PowerShell:

$body = @{
		input = "Your question here"
		stream = $false
} | ConvertTo-Json

Invoke-RestMethod -Uri "http://localhost:8088/responses" -Method Post -Body $body -ContentType "application/json"

curl:

curl -sS -H "Content-Type: application/json" -X POST http://localhost:8088/responses \
	-d '{"input":"Your question here","stream":false}'

Example prompts by sample:

Sample Example input
agent_with_hosted_mcp What does Microsoft Learn say about managed identities in Azure?
agent_with_text_search_rag What is Contoso Outdoors' return policy for refunds?
agents_in_workflow Create a launch strategy for a budget-friendly electric SUV.
agent_with_local_tools Find me Seattle hotels from 2025-03-15 to 2025-03-18 under $200 per night.
writer_reviewer_agents_in_workflow Write a slogan for a new affordable electric SUV.

Deploying to Microsoft Foundry

Each sample includes a Dockerfile and agent.yaml for deployment. For deployment steps, follow the hosted agents guidance in Microsoft Foundry:

Troubleshooting

Missing Azure credentials

If startup fails with authentication errors, run az login and verify the selected subscription with az account show.

Preview package install issues

These samples depend on preview packages such as azure-ai-agentserver-agentframework. Use uv pip install --prerelease=allow -r requirements.txt or pip install -r requirements.txt.

ARM64 container images fail after deployment

If you build images locally on ARM64 hardware such as Apple Silicon, build for linux/amd64:

docker build --platform=linux/amd64 -t image .