AzureOpenAI/Foundry: promote x-ms-served-model header into Response.model for the Responses API (parity with OpenAI/Azure Chat Completions)
维护者通常 1 天内回复
@scarab-systems 已经在做这个了。
开始于 2026年7月28日。
评估
调研方向
从 openai/lib/azure.py 中的 BaseAzureClient 及其异步对应实现开始,然后跟踪 Azure Responses 对已解析响应和流式响应的处理。确认非空的 x-ms-served-model 值会替换 Response.model 和每个 event.response.model,包括 responses.create 和 responses.retrieve 的流。完成标准是 Azure Responses 一致地暴露所服务的快照,同时不改变其他端点。
由索引模型根据 Issue 内容生成。
描述
Confirm this is a feature request for the Python library and not the underlying OpenAI API
- This is a feature request for the Python library
Describe the feature or improvement you're looking for
For Azure OpenAI clients (AzureOpenAI / AsyncAzureOpenAI), please promote the value of the x-ms-served-model response header into Response.model (and into event.response.model for streamed response.* events) when calling the Responses API.
This would bring AzureOpenAI in line with OpenAI's own behavior on every other endpoint.
Background
OpenAI's own (non-Azure) endpoints already return the dated snapshot of the model that served the request, regardless of the alias sent in the request. Empirically (today, via openai 1.x):
Sent model (alias) |
Response.model from OpenAI |
|---|---|
gpt-4o-mini |
gpt-4o-mini-2024-07-18 |
gpt-4o |
gpt-4o-2024-08-06 |
gpt-5-nano |
gpt-5-nano-2025-08-07 |
The same is true on Azure Chat Completions — the body already returns the snapshot — and (as a courtesy) Azure surfaces the deployment alias in x-ms-deployment-name:
[Chat Completions sent=gpt-5-nano]
body.model = 'gpt-5-nano-2025-08-07' ✅ snapshot
x-ms-served-model = None
x-ms-deployment-name = 'gpt-5-nano'
But on the Azure Responses API specifically, the body carries the deployment alias and the snapshot is moved into the x-ms-served-model response header (not exposed by the SDK today):
[Responses sent=gpt-5-nano, non-streaming]
body.model = 'gpt-5-nano' ❌ alias, not snapshot
x-ms-served-model = 'gpt-5-nano-2025-08-07'
x-ms-deployment-name = (not sent on Responses)
[Responses sent=gpt-5-nano, streaming]
body.model (per event)= 'gpt-5-nano' ❌
x-ms-served-model = 'gpt-5-nano-2025-08-07'
So Azure Responses is the outlier among all four code paths.
Additional context
Why this matters
Downstream consumers (telemetry, eval, RAG/agent frameworks, etc.) read Response.model to record which model actually served the request — to attribute traces, costs, regressions, and behavior changes to specific dated snapshots. With the current SDK behavior, Azure Responses users see the deployment alias only, which can mask:
- Auto-rollouts when an alias deployment is bumped from one snapshot to a newer one.
- Spillover routing (
x-ms-is-spilled-over: true) where a different snapshot serves the request. - Regional differences in which snapshot backs the same alias.
Proposed change (behavioral)
In openai/lib/azure.py, in BaseAzureClient (and async equivalent), add response post-processing such that:
- For
/responsesendpoint responses, when thex-ms-served-modelresponse header is present and non-empty, replaceResponse.modelwith that value before the SDK returns the parsed object. - For streaming
responses.create(stream=True, ...)andresponses.retrieve(..., stream=True), do the same on every event whoseevent.response.modelis currently set (e.g.response.created,response.in_progress,response.completed, ...) so that the value is consistent across the lifetime of the stream. - A non-empty / stripped guard on the header keeps the SDK robust to empty values.
We deliberately suggest the behavioral fix (overwrite Response.model) rather than a backward-compatible additive Response.served_model field, because:
- It restores parity with what
Response.modelalready means on OpenAI's own endpoints and on Azure Chat Completions: the snapshot of the model that actually served the request. - It avoids forcing every framework / telemetry library to learn an Azure-specific second field; today they read
response.modeland that should "just work". - The Azure-side mapping from alias to snapshot is only ever known on the response, so promoting the header at the SDK boundary is the natural place to do it (callers can still get the alias they sent from their own request options).
Impact / breakage analysis
The only consumers that would observe a behavior change are those who:
- Use
AzureOpenAI, AND - Call the Responses API specifically, AND
- Read
Response.modelexpecting the deployment alias.
For those callers, the deployment alias they sent is already known on their side (it's the model they passed in). Azure also still surfaces it in x-ms-deployment-name for Chat Completions — and could trivially start sending the same header on Responses if needed for parity.
Reference implementation in a third-party framework
We've shipped a local fix in microsoft/agent-framework#5910 that does exactly this at the framework level (because we cannot wait on an SDK release). Doing this in openai-python would let us drop that workaround and benefit every Azure customer of the Responses API uniformly.
- 主要语言
- Python
- 星标
- 31.8k
- 派生
- 7.3k
- 平均合并
- 1 天 3 小时
- 30 天内合并 PR
- 131
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
openai/openai-python 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
openai/openai-python#4022 · 18 条评论 ·
维护者通常 1 天内回复
-
fix(auth): SubjectTokenProviderError drops response and duplicates error message in workload identity providers可能已有人在做 @mohmedmm 于 7 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 86/100
openai/openai-python#4017 · 3 条评论 ·
维护者通常 1 天内回复
-
Querystring drops explicit empty-string scalar values可能已有人在做 @sylvesterkaczmarek 于 30 天前认领。 未关闭sdk-breaking-change v4
难度 2/5 1-3 小时 新手友好度 86/100
openai/openai-python#3837 ·
维护者通常 1 天内回复
-
Define + export `ServiceTiers` string literal可能已有人在做 @SparshGarg999 于 56 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 68/100
openai/openai-python#3556 · 3 条评论 ·
维护者通常 1 天内回复
-
Empty OPENAI_BASE_URL prevents fallback to default API endpoint可能已有人在做 @Sehastrajit-S 于 23 天前认领。 未关闭bug
难度 2/5 1-3 小时 新手友好度 68/100
openai/openai-python#2927 · 6 条评论 ·
维护者通常 1 天内回复
查看 openai/openai-python 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
-
EvaluationSuite.run fails with default args_for_task and mutates supplied kwargs可能已有人在做 @ktz03 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 82/100
huggingface/evaluate#825 ·
维护者通常 1 天内回复
-
dependencies feature github_actions good first issue
难度 2/5 1-3 小时 新手友好度 62/100
wemake-services/wemake-django-template#3149 ·
维护者通常 1 天内回复
-
upstream update
难度 2/5 1-3 小时 新手友好度 65/100
conan-io/conan-center-index#31142 ·
维护者通常 1 天内回复
-
area:core bug
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复