你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
本文将帮助你了解 Azure OpenAI API 的支持生命周期。
注释
可以随时将新的 API 响应对象添加到 API 响应中。 建议仅分析所需的响应对象。
API 演变
以前,Azure OpenAI 每月都会收到新的 API 版本更新。 为了利用新功能,每次新的 API 发布时都需要不断更新代码和环境变量。 Azure OpenAI 还需要使用专用于 Azure 的客户端的额外步骤,这些客户端在 OpenAI 和 Azure OpenAI 之间进行代码迁移时会增加工作量。
从 2025 年 8 月开始,现在可以选择加入下一代 v1 Azure OpenAI API,该 API 添加了对以下方面的支持:
- 持续访问最新功能,无需每月指定新的
api-version。 - API 发布周期更快,更频繁地推出新功能。
- 在使用密钥身份验证时,OpenAI 客户端支持通过最少的代码更改在 OpenAI 和 Azure OpenAI 之间切换。
- OpenAI 客户端支持基于令牌的身份验证和自动令牌刷新,而无需依赖于单独的 Azure OpenAI 客户端。
- 使用支持 v1 聊天完成语法的其他提供商(例如 DeepSeek 和 Grok)的模型来进行聊天完成调用。
通过传递功能特定的预览标头来控制对仍处于预览状态的新 API 调用的访问,从而允许你选择加入所需的功能,而无需交换 API 版本。 或者,某些功能将通过 API 路径指示预览状态,并且不需要其他标头。
示例:
-
/openai/v1/evals处于预览状态,需要传递"aoai-evals":"preview"标头。 -
/openai/v1/fine_tuning/alpha/graders/处于预览状态,由于 API 路径中存在alpha,不需要自定义标头。
对于初始 v1 正式版 (GA) API 发布,我们仅支持部分推理和创作 API 功能。 所有 GA 功能都支持在生产环境中使用。 我们将很快添加对更多功能的支持。
代码更改
v1 API
API 密钥:
import os
from openai import OpenAI
client = OpenAI(
api_key=os.getenv("AZURE_OPENAI_API_KEY"),
base_url="https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/"
)
response = client.responses.create(
model="gpt-4.1-nano", # Replace with your model deployment name
input="This is a test.",
)
print(response.model_dump_json(indent=2))
- 使用
OpenAI()客户端而不是AzureOpenAI()。 -
base_url传递至 Azure OpenAI 终结点,并将/openai/v1追加到终结点地址。 -
api-version不再是 v1 GA API 的必需参数。
为 和 OPENAI_BASE_URL 设置环境变量的 API 密钥OPENAI_API_KEY:
client = OpenAI()
Microsoft Entra ID:
重要
之前通过使用 AzureOpenAI() 客户端来处理自动令牌刷新。 v1 API 通过向 OpenAI() 客户端添加自动令牌刷新支持来移除此依赖项。
from openai import OpenAI
from azure.identity import DefaultAzureCredential, get_bearer_token_provider
token_provider = get_bearer_token_provider(
DefaultAzureCredential(), "https://cognitiveservices.azure.com/.default"
)
client = OpenAI(
base_url = "https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/",
api_key = token_provider
)
response = client.responses.create(
model="gpt-4.1-nano",
input= "This is a test"
)
print(response.model_dump_json(indent=2))
-
base_url传递至 Azure OpenAI 终结点,并将/openai/v1追加到终结点地址。 -
api_key参数设置为token_provider,启用身份验证令牌的自动检索和刷新,而不是使用静态 API 密钥。
模型支持
但是,对于 Azure OpenAI 模型,我们建议使用 响应 API,v1 API 还允许你通过支持 OpenAI v1 聊天完成语法的其他提供程序(例如 DeepSeek 和 Grok)的模型进行聊天完成调用。
base_url 将接受这两种格式 https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/ 和 https://YOUR-RESOURCE-NAME.services.ai.azure.com/openai/v1/ 格式。
from openai import OpenAI
from azure.identity import DefaultAzureCredential, get_bearer_token_provider
token_provider = get_bearer_token_provider(
DefaultAzureCredential(), "https://cognitiveservices.azure.com/.default"
)
client = OpenAI(
base_url = "https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/",
api_key=token_provider,
)
completion = client.chat.completions.create(
model="grok-3-mini", # Replace with your model deployment name.
messages=[
{"role": "system", "content": "You are a helpful assistant."},
{"role": "user", "content": "Tell me about the attention is all you need paper"}
]
)
#print(completion.choices[0].message)
print(completion.model_dump_json(indent=2))
v1 API 支持
状态
支持在生产环境中使用正式版功能。
| API 路径 | 状态 |
|---|---|
/openai/v1/chat/completions |
正式版 |
/openai/v1/embeddings |
正式版 |
/openai/v1/evals |
Preview |
/openai/v1/files |
正式版 |
/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints/{fine_tuning_checkpoint_id}/copy |
Preview |
/openai/v1/fine_tuning/alpha/graders/ |
Preview |
/openai/v1/fine_tuning/ |
正式版 |
/openai/v1/models |
正式版 |
/openai/v1/responses |
正式版 |
/openai/v1/vector_stores |
正式版 |
预览标头
| API 路径 | Header |
|---|---|
/openai/v1/evals |
"aoai-evals":"preview" |
/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints/{fine_tuning_checkpoint_id}/copy |
"aoai-copy-ft-checkpoints" : "preview" |
v1 预览版和 2025-04-01-preview 之间的更改
- v1 预览版 API
- 视频生成支持
-
新的响应 API 功能:
- 远程模型上下文协议 (MCP) 服务器工具集成
- 对异步后台任务的支持
- 加密推理项
- 图像生成
2025-04-01-preview 和 2025-03-01-preview 之间的更改
2025-03-01-preview 和 2025-02-01-preview 之间的更改
2025-02-01-preview 和 2025-01-01-preview 之间的更改
- 存储补全(蒸馏)API 支持。
2025-01-01-preview 和 2024-12-01-preview 之间的更改
-
已为
prediction支持添加 参数。 -
gpt-4o-audio-preview模型支持。
2024-12-01-preview 和 2024-10-01-preview 之间的变更
2024-09-01-preview 和 2024-08-01-preview 之间的变更
-
添加了
max_completion_tokens以支持o1-preview和o1-mini模型。max_tokens不适用于 o1 系列 模型。 -
已添加
parallel_tool_calls。 -
添加了
completion_tokens_details和reasoning_tokens。 -
添加了
stream_options和include_usage。
2024-07-01-preview 和 2024-08-01-preview API 规范之间的变更
- 结构化输出支持。
- 添加了大型文件上传 API。
- 关于数据更改:
- Mongo DB 集成。
-
已删除
role_information参数。 -
已将
rerank_score添加到引文对象。 - 已删除 AML 数据源。
- AI 搜索矢量化集成改进。
2024-5-01-preview 和 2024-07-01-preview API 规范之间的更改
- 添加了 Batch API 支持
- 矢量存储分块策略参数
-
文件搜索工具应输出的
max_num_results。
2024-04-01-preview 和 2024-05-01-preview API 规范之间的变更
- 助手 v2 支持 - 文件搜索工具和矢量存储
- 微调检查点、种子、事件
- 关于数据更新
- DALL-E 2 现在支持模型部署,可用于最新的预览 API。
- 内容筛选更新
2024-03-01-preview 和 2024-04-01-preview API 规范之间的更改
-
中断性变更:删除了增强功能参数。 这将影响
gpt-4版本:vision-preview模型。 - 添加了 timestamp_granularities 参数。
-
添加了
audioWord对象。 - 其他 TTS
response_formats: wav & pcm。
最新 GA API 版本
目前,Azure OpenAI API 版本 2024-10-21 是最新的 GA API 版本。 此 API 版本替代了以前的 2024-06-01 GA API 版本。
已知问题
-
2025-04-01-previewAzure OpenAI 规范使用 OpenAPI 3.1,这是一个已知问题,Azure API 管理当前不支持此问题