mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Eduard van Valkenburg
3a49b1d6dd
* [BREAKING] Remove deprecated Python OpenAI/Azure AI surfaces Also clean up follow-on docs, environment guidance, package metadata, and lab test stability. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix deleted semantic-kernel sample links Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address PR review feedback Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * improve foundry language * Fix A2A Foundry sample regression Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1.3 KiB
1.3 KiB
AGENTS.md — agent-framework-openai
OpenAI integration package for Agent Framework. Contains OpenAI Responses API and Chat Completions API clients.
Package Structure
agent_framework_openai/
├── __init__.py # Public API exports
├── _chat_client.py # OpenAIChatClient (Responses API) + RawOpenAIChatClient
├── _chat_completion_client.py # OpenAIChatCompletionClient (Chat Completions API) + RawOpenAIChatCompletionClient
├── _embedding_client.py # OpenAIEmbeddingClient
├── _exceptions.py # OpenAI-specific exceptions
└── _shared.py # OpenAISettings and shared config helpers
Key Classes
| Class | API | Status |
|---|---|---|
OpenAIChatClient |
Responses API | Primary |
OpenAIChatCompletionClient |
Chat Completions API | Primary |
OpenAIEmbeddingClient |
Embeddings API | Primary |
All clients follow the Raw + Full-Featured pattern (e.g., RawOpenAIChatClient + OpenAIChatClient).
The generic OpenAI clients support both OpenAI and Azure OpenAI routing. Precedence is:
explicit Azure inputs (credential, azure_endpoint, api_version) → OpenAI API key
(OPENAI_API_KEY) → Azure environment fallback (AZURE_OPENAI_*).
Dependencies
agent-framework-core— core abstractionsopenai— OpenAI Python SDK