mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Giles Odigwe
7c2dae8855
* Fix sample bugs: incorrect API params, wrong client types, and invalid options - typed_options.py: Fix AnthropicClient model->model_id, wrap raw strings in Message objects for get_response(), fix reasoning_effort->reasoning dict, fix budget_tokens minimum (1024), use OpenAIChatClient not FoundryChatClient, remove unused import - client_reasoning.py: Fix deprecated model_id to model param - client_with_hosted_mcp.py: Remove invalid store=True kwarg from Agent.run() - code_defined_skill.py: Fix precision kwarg to use function_invocation_kwargs - Various other samples: Fix deprecated API usage and incorrect params Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address PR review comments - client_with_hosted_mcp.py: Fix remaining store=True kwarg on line 68 to use options dict - client_with_session.py: Change store=True to store=False to match in-memory persistence demo intent - typed_options.py: Remove non-existent import and model key from docstring example Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * new sample fixes --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
7c2dae8855
ยท
2026-03-31 16:58:51 +00:00
History
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.