db620d33df
CodeQL / Analyze (csharp) (push) Waiting to run
CodeQL / Analyze (python) (push) Waiting to run
dotnet-build-and-test / dotnet-test-functions (push) Has been cancelled
dotnet-build-and-test / paths-filter (push) Has been cancelled
dotnet-build-and-test / dotnet-build (Debug, windows-latest, net9.0) (push) Has been cancelled
dotnet-build-and-test / dotnet-build (Release, ubuntu-latest, net10.0) (push) Has been cancelled
dotnet-build-and-test / dotnet-build (Release, ubuntu-latest, net8.0) (push) Has been cancelled
dotnet-build-and-test / dotnet-build (Release, windows-latest, net472) (push) Has been cancelled
dotnet-build-and-test / dotnet-test (Release, integration, true, ubuntu-latest, net10.0) (push) Has been cancelled
dotnet-build-and-test / dotnet-test (Release, integration, true, windows-latest, net472) (push) Has been cancelled
dotnet-build-and-test / dotnet-foundry-hosted-it (push) Has been cancelled
dotnet-build-and-test / dotnet-build-and-test-check (push) Has been cancelled
dotnet-build-and-test / Integration Test Report (push) Has been cancelled
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