mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Eduard van Valkenburg
cc0cfaaac8
* 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>
4.2 KiB
4.2 KiB
OpenAI Provider Samples
This folder contains OpenAI provider samples for the generic clients in
agent_framework.openai.
Chat Completions API samples (OpenAIChatCompletionClient)
| File | Description |
|---|---|
chat_completion_client_basic.py |
Basic non-streaming and streaming chat completion sample with an explicit gpt-5.4-nano model and API key. |
chat_completion_client_with_explicit_settings.py |
Chat completion sample with explicit model and API key settings. |
chat_completion_client_with_function_tools.py |
Function tools with agent-level and run-level patterns. |
chat_completion_client_with_local_mcp.py |
Local MCP integration with the chat completions client. |
chat_completion_client_with_runtime_json_schema.py |
Runtime JSON schema output with the chat completions client. |
chat_completion_client_with_session.py |
Session management with the chat completions client. |
chat_completion_client_with_web_search.py |
Web search with the chat completions client. |
Responses API samples (OpenAIChatClient)
| File | Description |
|---|---|
client_basic.py |
Basic non-streaming and streaming responses sample with an explicit gpt-5.4-nano model and API key. |
client_image_analysis.py |
Analyze images with the responses client. |
client_image_generation.py |
Generate images from text prompts. |
client_reasoning.py |
Reasoning-focused sample for models such as gpt-5. |
client_streaming_image_generation.py |
Streaming image generation sample. |
client_with_agent_as_tool.py |
Agent-as-tool orchestration pattern. |
client_with_code_interpreter.py |
Code interpreter sample. |
client_with_code_interpreter_files.py |
Code interpreter sample with uploaded files. |
client_with_explicit_settings.py |
Responses client with explicit model and API key settings. |
client_with_file_search.py |
Hosted file search sample. |
client_with_function_tools.py |
Function tools with agent-level and run-level patterns. |
client_with_hosted_mcp.py |
Hosted MCP tools and approval workflows. |
client_with_local_mcp.py |
Local MCP integration with the responses client. |
client_with_local_shell.py |
Local shell tool sample. |
client_with_runtime_json_schema.py |
Runtime JSON schema output with the responses client. |
client_with_session.py |
Session management with the responses client. |
client_with_shell.py |
Hosted shell tool sample. |
client_with_structured_output.py |
Structured output with Pydantic models. |
client_with_web_search.py |
Web search with the responses client. |
Environment Variables
Set these before running the OpenAI provider samples:
OPENAI_API_KEYOPENAI_MODEL
Optionally, you can also set:
OPENAI_ORG_IDOPENAI_BASE_URL
If your shell also contains AZURE_OPENAI_* variables, these samples still stay on OpenAI as long as
OPENAI_API_KEY is present. To force Azure routing with the generic clients, pass an explicit Azure
input such as credential, azure_endpoint, or api_version, or use the Azure provider samples.
Optional Dependencies
Some samples need extra packages:
client_image_generation.pyandclient_streaming_image_generation.pyuse Pillow for image display.- MCP samples require the relevant MCP server/tooling you configure locally.