mirror of https://github.com/microsoft/agent-framework.git synced 2026-06-16 21:04:09 +08:00

Files

T

Eduard van Valkenburg cc0cfaaac8 [BREAKING] Python: fix OpenAI Azure routing and provider samples (#4925 )

* Python: fix OpenAI Azure routing and provider samples

Prefer OpenAI when OPENAI_API_KEY is present unless Azure is explicitly requested. Clarify constructor docs, keep deprecated Azure wrappers compatible with stricter settings validation, and refresh the provider samples and tests to use the current client patterns.

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

* fix bandit

* Python: align OpenAI embedding Azure routing

Extend the shared OpenAI-vs-Azure routing and credential behavior to the embedding client, add Azure embedding regression coverage, and refresh the embedding samples to use the generic client path.

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

* Python: fix embedding client pyright check

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

* Python: thin OpenAI embedding wrapper

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

* Python: document embedding overload routing

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

* Python: fix callable OpenAI key routing

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

* Python: fix Azure credential routing tests

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

* Python: address OpenAI review feedback

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

* Python: narrow Azure routing markers

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

* Python: refine OpenAI model fallback order

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

* Python: narrow Azure deployment docs

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

* Python: remove embedding routing wording

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

* Python: run embedding Azure integration tests

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

* changed variable name

* Python: expand OpenAI package README

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

* clarified readme

* Python: fix Azure OpenAI integration setup

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

* Python: correct Azure integration env mapping

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

* updated code to fix int tests

* test updates

* test fix

* fix test setup

* updates to tests and setup

* remove openai assistants int tests

* improvements in int tests

* fix env var

* fix env vars

* fix azure responses test

* trigger actions

---------

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

cc0cfaaac8 · 2026-03-27 13:33:39 +00:00

History

built_in_chat_clients.py

Python: [BREAKING] Python: Provider-leading client design & OpenAI package extraction (#4818 )

2026-03-25 09:56:29 +00:00

chat_response_cancellation.py

Python: [BREAKING] Python: Provider-leading client design & OpenAI package extraction (#4818 )

2026-03-25 09:56:29 +00:00

custom_chat_client.py

Python: [BREAKING] Python: Provider-leading client design & OpenAI package extraction (#4818 )

2026-03-25 09:56:29 +00:00

README.md

[BREAKING] Python: fix OpenAI Azure routing and provider samples (#4925 )

2026-03-27 13:33:39 +00:00

README.md

Chat Client Examples

This folder contains examples for direct chat client usage patterns.

Examples

File	Description
`built_in_chat_clients.py`	Consolidated sample for built-in chat clients. Uses `get_client()` to create the selected client and pass it to `main()`.
`chat_response_cancellation.py`	Demonstrates how to cancel chat responses during streaming, showing proper cancellation handling and cleanup.
`custom_chat_client.py`	Demonstrates how to create custom chat clients by extending the `BaseChatClient` class. Shows a `EchoingChatClient` implementation and how to integrate it with `Agent` using the `as_agent()` method.

Selecting a built-in client

built_in_chat_clients.py starts with:

asyncio.run(main("openai_chat"))

Change the argument to pick a client:

openai_chat
openai_responses
openai_assistants
anthropic
ollama
bedrock
azure_openai_chat
azure_openai_responses
azure_openai_responses_foundry
azure_openai_assistants
azure_ai_agent

Example:

uv run samples/02-agents/chat_client/built_in_chat_clients.py

Environment Variables

Depending on the selected client, set the appropriate environment variables:

For Azure clients:

AZURE_OPENAI_ENDPOINT: Your Azure OpenAI endpoint
AZURE_OPENAI_CHAT_DEPLOYMENT_NAME: The name of your Azure OpenAI chat deployment
AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAME: The name of your Azure OpenAI responses deployment

For Azure OpenAI Foundry responses client (azure_openai_responses_foundry):

AZURE_AI_PROJECT_ENDPOINT: Your Azure AI project endpoint
AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAME: The name of your Azure OpenAI responses deployment

For Azure AI agent client (azure_ai_agent):

AZURE_AI_PROJECT_ENDPOINT: Your Azure AI project endpoint
AZURE_AI_MODEL_DEPLOYMENT_NAME: The name of your model deployment (used by azure_ai_agent)

For OpenAI clients:

OPENAI_API_KEY: Your OpenAI API key
OPENAI_CHAT_MODEL: The OpenAI model for openai_chat and openai_assistants
OPENAI_RESPONSES_MODEL: The OpenAI model for openai_responses

For Anthropic client (anthropic):

ANTHROPIC_API_KEY: Your Anthropic API key
ANTHROPIC_CHAT_MODEL_ID: The Anthropic model ID (for example, claude-sonnet-4-5)

For Ollama client (ollama):

OLLAMA_HOST: Ollama server URL (defaults to http://localhost:11434 if unset)
OLLAMA_MODEL_ID: Ollama model name (for example, mistral, qwen2.5:8b)

For Bedrock client (bedrock):

BEDROCK_CHAT_MODEL_ID: Bedrock model ID (for example, anthropic.claude-3-5-sonnet-20240620-v1:0)
BEDROCK_REGION: AWS region (defaults to us-east-1 if unset)
AWS credentials via standard environment variables (for example, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY)