mirror of https://github.com/microsoft/agent-framework.git synced 2026-06-16 21:04:09 +08:00

Files

T

Eduard van Valkenburg 6acab3d1d6 Python: [BREAKING] Standardize model selection on model (#4999 )

* Refactor Anthropic model option and provider clients

Rename the Anthropic client model option from model_id to model, add provider-specific Anthropic wrappers for Foundry, Bedrock, and Vertex, and expose them through the Anthropic, Foundry, Amazon, and Google namespaces. Update core option handling, docs, samples, and tests accordingly.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fix Anthropic skills sample typing

Cast the Anthropic beta client to Any in the skills sample so the pre-commit sample pyright check no longer fails on beta skills and files endpoints that are not exposed by the current SDK stubs.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* undo sample mypy

* Retry CI after transient external failures

Retrigger PR validation after an unrelated Copilot review workflow SAML failure and a transient external tau2 git fetch failure in the Windows Python test setup.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Address review feedback on model option merging

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Address Anthropic compatibility review feedback

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* moved all to `model`

* fixes for azure ai search

* Python: standardize remaining sample env var names

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Python: fix foundry-local pyright compatibility

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* updated env vars in cicd

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

2026-04-01 19:00:18 +00:00

3.4 KiB

Raw Permalink Blame History

agent-framework-openai

OpenAI integration for Microsoft Agent Framework.

This package provides:

OpenAIChatClient for the OpenAI Responses API
OpenAIChatCompletionClient for the Chat Completions API
OpenAIEmbeddingClient for embeddings

Installation

pip install agent-framework-openai --pre

Which chat client should I use?

Use OpenAIChatClient for new work unless you specifically need the Chat Completions API.

OpenAIChatClient uses the Responses API and is the preferred general-purpose chat client.
OpenAIChatCompletionClient uses the Chat Completions API and is mainly for compatibility with existing Chat Completions-based integrations.

The previous deprecated Responses alias has been removed. Use OpenAIChatClient directly.

Environment variables

OpenAI

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_RESPONSES_MODEL`	Preferred model for `OpenAIChatClient`
`OPENAI_CHAT_MODEL`	Preferred model for `OpenAIChatCompletionClient`
`OPENAI_EMBEDDING_MODEL`	Preferred model for `OpenAIEmbeddingClient`

Model lookup order:

OpenAIChatClient: OPENAI_RESPONSES_MODEL -> OPENAI_MODEL
OpenAIChatCompletionClient: OPENAI_CHAT_MODEL -> OPENAI_MODEL
OpenAIEmbeddingClient: OPENAI_EMBEDDING_MODEL -> OPENAI_MODEL

Azure OpenAI

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_RESPONSES_MODEL`	Preferred deployment for `OpenAIChatClient`
`AZURE_OPENAI_CHAT_MODEL`	Preferred deployment for `OpenAIChatCompletionClient`
`AZURE_OPENAI_EMBEDDING_MODEL`	Preferred deployment for `OpenAIEmbeddingClient`

Deployment lookup order:

OpenAIChatClient: AZURE_OPENAI_RESPONSES_MODEL -> AZURE_OPENAI_MODEL
OpenAIChatCompletionClient: AZURE_OPENAI_CHAT_MODEL -> AZURE_OPENAI_MODEL
OpenAIEmbeddingClient: AZURE_OPENAI_EMBEDDING_MODEL -> AZURE_OPENAI_MODEL

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.

OpenAI example

from agent_framework.openai import OpenAIChatClient

client = OpenAIChatClient(model="gpt-4.1")

Azure OpenAI example

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(),
)

ChatClient vs ChatCompletionClient

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")

3.4 KiB Raw Permalink Blame History