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>

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

2.1 KiB

Raw Permalink Blame History

Azure Provider Samples

This folder contains Azure-backed samples for the generic OpenAI clients in agent_framework.openai.

Chat Completions API samples (`OpenAIChatCompletionClient`)

File	Description
`openai_chat_completion_client_basic.py`	Basic Azure chat completions sample using explicit Azure settings and `credential=AzureCliCredential()`.
`openai_chat_completion_client_with_explicit_settings.py`	Azure chat completions sample with explicit settings.
`openai_chat_completion_client_with_function_tools.py`	Azure chat completions sample with function tools.
`openai_chat_completion_client_with_session.py`	Azure chat completions sample with session management.

Responses API samples (`OpenAIChatClient`)

File	Description
`openai_client_basic.py`	Basic Azure responses sample using explicit settings and `credential=AzureCliCredential()`.
`openai_client_with_function_tools.py`	Azure responses sample with function tools.
`openai_client_with_session.py`	Azure responses sample with session management.
`openai_client_with_structured_output.py`	Azure responses sample with structured output.

Environment Variables

Set these before running the Azure provider samples:

AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_DEPLOYMENT_NAME

Optionally, you can also set:

AZURE_OPENAI_API_KEY
AZURE_OPENAI_API_VERSION
AZURE_OPENAI_BASE_URL

These Azure samples are written around explicit Azure inputs such as credential=AzureCliCredential(), so they stay on Azure even if OPENAI_API_KEY is also present.

Optional Dependencies

Credential-based samples require azure-identity:

pip install azure-identity

Run az login before executing the credential-based samples.

2.1 KiB Raw Permalink Blame History