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

Files

T

Giles Odigwe 6b47cdbf52 Python: Fix broken samples for GitHub Copilot, declarative, and Responses API (#4915 )

* Python: Fix broken samples for GitHub Copilot, declarative, and Responses API

- Add missing on_permission_request handler to github_copilot_basic and
  github_copilot_with_session samples (required by copilot SDK)
- Increase timeout for remote MCP query in github_copilot_with_mcp sample
- Soften session isolation claim in github_copilot_with_session sample
- Fix inline_yaml sample: pass project_endpoint via client_kwargs instead
  of relying on YAML connection block (AzureAIClient expects
  project_endpoint, not endpoint)
- Handle raw JSON schemas in Responses client _convert_response_format
  so declarative outputSchema works with the Responses API

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

* Improve raw JSON schema detection heuristic and add tests

- Broaden raw schema detection to handle anyOf, oneOf, allOf, $ref, $defs
  keywords and JSON Schema primitive types, not just 'properties'
- Apply same raw schema handling to azure-ai _shared.py for consistency
- Add unit tests for both openai and azure-ai response_format conversion

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

---------

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

6b47cdbf52 · 2026-03-27 16:27:19 +00:00

History

agent_framework_openai

Python: Fix broken samples for GitHub Copilot, declarative, and Responses API (#4915 )

2026-03-27 16:27:19 +00:00

tests

Python: Fix broken samples for GitHub Copilot, declarative, and Responses API (#4915 )

2026-03-27 16:27:19 +00:00

AGENTS.md

[BREAKING] Python: fix OpenAI Azure routing and provider samples (#4925 )

2026-03-27 13:33:39 +00:00

LICENSE

Python: [BREAKING] Python: Provider-leading client design & OpenAI package extraction (#4818 )

2026-03-25 09:56:29 +00:00

pyproject.toml

Python: [BREAKING] Python: Provider-leading client design & OpenAI package extraction (#4818 )

2026-03-25 09:56:29 +00:00

README.md

[BREAKING] Python: fix OpenAI Azure routing and provider samples (#4925 )

2026-03-27 13:33:39 +00:00

README.md

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 deprecated OpenAIResponsesClient alias points to OpenAIChatClient.

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_DEPLOYMENT_NAME`	Generic fallback deployment
`AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAME`	Preferred deployment for `OpenAIChatClient`
`AZURE_OPENAI_CHAT_DEPLOYMENT_NAME`	Preferred deployment for `OpenAIChatCompletionClient`
`AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME`	Preferred deployment for `OpenAIEmbeddingClient`

Deployment lookup order:

OpenAIChatClient: AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAME -> AZURE_OPENAI_DEPLOYMENT_NAME
OpenAIChatCompletionClient: AZURE_OPENAI_CHAT_DEPLOYMENT_NAME -> AZURE_OPENAI_DEPLOYMENT_NAME
OpenAIEmbeddingClient: AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME -> AZURE_OPENAI_DEPLOYMENT_NAME

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