| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Name | Name | Last commit date | ||
|---|---|---|---|---|
parent directory.. | ||||
OpenAI integration for Microsoft Agent Framework.
This package provides:
pip install agent-framework-openaiUse OpenAIChatClient for new work unless you specifically need the Chat Completions API.
The previous deprecated Responses alias has been removed. Use OpenAIChatClient directly.
These variables are used when the client is configured for OpenAI:
| Variable | Purpose |
|---|---|
| OPENAI_API_KEY | OpenAI API key |
| OPENAI_ORG_ID | OpenAI organization ID |
| OPENAI_BASE_URL | Custom OpenAI-compatible base URL |
| OPENAI_MODEL | Generic fallback model |
| OPENAI_CHAT_MODEL | Preferred model for OpenAIChatClient |
| OPENAI_CHAT_COMPLETION_MODEL | Preferred model for OpenAIChatCompletionClient |
| OPENAI_EMBEDDING_MODEL | Preferred model for OpenAIEmbeddingClient |
Model lookup order:
These model variables are only consulted when you do not pass model= directly. In other words, OpenAIChatClient(model="...") ignores OPENAI_CHAT_MODEL, and OpenAIChatCompletionClient(model="...") ignores OPENAI_CHAT_COMPLETION_MODEL.
These variables are used when the client is configured for Azure OpenAI:
| Variable | Purpose |
|---|---|
| AZURE_OPENAI_ENDPOINT | Azure OpenAI resource endpoint |
| AZURE_OPENAI_BASE_URL | Full Azure OpenAI base URL (.../openai/v1) |
| AZURE_OPENAI_API_KEY | Azure OpenAI API key |
| AZURE_OPENAI_API_VERSION | Azure OpenAI API version |
| AZURE_OPENAI_MODEL | Generic fallback deployment |
| AZURE_OPENAI_CHAT_MODEL | Preferred deployment for OpenAIChatClient |
| AZURE_OPENAI_CHAT_COMPLETION_MODEL | Preferred deployment for OpenAIChatCompletionClient |
| AZURE_OPENAI_EMBEDDING_MODEL | Preferred deployment for OpenAIEmbeddingClient |
Deployment lookup order:
For Azure routing, the same rule applies: the client-specific deployment variable is checked first, then the generic AZURE_OPENAI_MODEL fallback. Passing model= overrides both environment variables.
When both OpenAI and Azure environment variables are present, the generic clients prefer OpenAI when OPENAI_API_KEY is configured. To use Azure explicitly, pass azure_endpoint or credential.
from agent_framework.openai import OpenAIChatClient
client = OpenAIChatClient(model="gpt-4.1")from azure.identity.aio import AzureCliCredential
from agent_framework.openai import OpenAIChatClient
client = OpenAIChatClient(
model="my-responses-deployment",
azure_endpoint="https://my-resource.openai.azure.com",
credential=AzureCliCredential(),
)Use OpenAIChatClient when you want the Responses API as your default chat surface.
Use OpenAIChatCompletionClient when you specifically need the Chat Completions API:
from agent_framework.openai import OpenAIChatCompletionClient
client = OpenAIChatCompletionClient(model="gpt-4o-mini")| Back | FazBrowse Home | New Git URL |