[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"skill:01M69A0Q19GVNW8RWHTNNK108M":3,"skill-same:01M69A0Q19GVNW8RWHTNNK108M":62},{"skillNo":4,"name":5,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":7,"ownerLogin":8,"ownerAvatarUrl":9,"ownerAccountNo":10,"ownerDisplayName":11,"repositoryNo":12,"starsCount":13,"licenseSpdxId":14,"licenseFileUrl":6,"sourceHtmlUrl":15,"categories":16,"keywords":17,"publishedAt":19,"linkOnly":20,"markdownContent":21,"markdownBody":22,"frontMatter":23,"refName":24,"commitSha":25,"skillDirectory":26,"forksCount":27,"repositoryHtmlUrl":28,"repositoryHomepageUrl":29,"ownerHtmlUrl":30,"ownerBlogUrl":31,"ownerDescription":32,"updatedAt":33,"install":34,"resources":47},"01M69A0Q19GVNW8RWHTNNK108M","azure-openai-to-responses",null,"microsoft\u002Fai-agents-for-beginners","microsoft","https:\u002F\u002Favatars.githubusercontent.com\u002Fu\u002F6154722?v=4","01M698VYDXZ6JW5WH3CRV650R8","Microsoft","01M6998ZK2275KMJE6Y5SEA2X2",79423,"MIT","https:\u002F\u002Fgithub.com\u002Fmicrosoft\u002Fai-agents-for-beginners\u002Fblob\u002Fmain\u002Ftranslations\u002Fzh-HK\u002F.agents\u002Fskills\u002Fazure-openai-to-responses\u002FSKILL.md",[],[18],"azure openai to responses","2026-11-10 10:12:30",false,"---\nname: azure-openai-to-responses\nlicense: MIT\n---\n# 將 Python 應用程式從 Azure OpenAI Chat Completions 遷移至 Responses API\n\n> **權威指南 — 請嚴格遵循**\n>\n> 本技能將使用 Azure OpenAI Chat Completions 的 Python 代碼庫\n> 遷移至統一的 Responses API。請精確遵循這些指示。\n> 不可隨意即興對應參數或發明 API 介面。\n\n---\n\n## 觸發條件\n\n當使用者想要啟用本技能時：\n- 將 Python 應用程式從 Azure OpenAI Chat Completions 遷移至 Responses API\n- 將 Python OpenAI SDK 用法升級為最新的 Azure OpenAI API 格式\n- 為 GPT-5 或更新版需要 Responses API 的模型準備 Python 程式碼\n- 從 `AzureOpenAI` \u002F `AsyncAzureOpenAI` 切換到帶 v1 端點的標準 `OpenAI` \u002F `AsyncOpenAI` 用戶端\n- 修正與 `AzureOpenAI` 構造函數或 `api_version` 相關的過時警告\n\n---\n\n## ⚠️ 模型相容性 — 請先檢查\n\n> **遷移前，請確認你的 Azure OpenAI 部署支援 Responses API。**\n\n### 1. 快速測試部署（最快）\n\n```python\nimport os\nfrom openai import OpenAI\n\nclient = OpenAI(\n    api_key=os.environ[\"AZURE_OPENAI_API_KEY\"],\n    base_url=f\"{os.environ['AZURE_OPENAI_ENDPOINT'].rstrip('\u002F')}\u002Fopenai\u002Fv1\u002F\",\n)\n\ntry:\n    resp = client.responses.create(\n        model=os.environ[\"AZURE_OPENAI_DEPLOYMENT\"],\n        input=\"ping\",\n        max_output_tokens=50,\n        store=False,\n    )\n    print(f\"✅ Deployment supports Responses API: {resp.output_text}\")\nexcept Exception as e:\n    print(f\"❌ Deployment does NOT support Responses API: {e}\")\n```\n\n> \u003Cstrong>注意\u003C\u002Fstrong>：Azure OpenAI 中 `max_output_tokens` 最低為 16。低於 16 的值會回傳 400 錯誤。測試時請使用 50 以上。\n\n如果此請求回傳 404，表示該部署的模型尚未支援 Responses。請參考下方文件或用支援的模型重新部署。\n\n### 2. 檢查區域中的可用模型（推薦）\n\n執行內建模型相容性工具，查看特定區域中有哪些模型支援 Responses API：\n\n```bash\npython migrate.py models --subscription YOUR_SUB_ID --location YOUR_REGION\n```\n\n該查詢即時連接 Azure ARM 並顯示相容性矩陣—哪些模型支援 Responses、結構化輸出、工具等。可用 `--filter gpt-5.1,gpt-5.2` 篩選結果，或 `--json` 用於腳本。\n\n### 3. 完整模型支援參考\n\n- \u003Cstrong>即時查詢\u003C\u002Fstrong>：`python migrate.py models`（見上方 — 區域特定，持續更新）\n- \u003Cstrong>瀏覽可用性\u003C\u002Fstrong>: [模型摘要表及區域可用性](https:\u002F\u002Flearn.microsoft.com\u002Fen-us\u002Fazure\u002Ffoundry\u002Ffoundry-models\u002Fconcepts\u002Fmodels-sold-directly-by-azure?tabs=global-standard-aoai%2Cglobal-standard&pivots=azure-openai#model-summary-table-and-region-availability)\n- \u003Cstrong>快速入門與指南\u003C\u002Fstrong>：**https:\u002F\u002Faka.ms\u002Fopenai\u002Fstart**\n\n### ⚠️ 較舊模型的限制\n\n> \u003Cstrong>警告\u003C\u002Fstrong>：較舊模型（早於 `gpt-4.1` 的版本）可能無法完整支援所有 Responses API 功能。\n>\n> 已知較舊模型的限制：\n> - **`reasoning` 參數**：許多非推理模型不支援此參數。只在原始代碼已有 `reasoning` 時才遷移。\n> - **`seed` 參數**：Responses API 完全不支援，請從所有請求中移除。\n> - **透過 `text.format` 的結構化輸出**：舊模型可能無法可靠強制執行 `strict: true` 的 JSON schema。\n> - \u003Cstrong>工具協調\u003C\u002Fstrong>：GPT-5+ 模型將工具調用整合進內部推理，舊模型在 Responses API 仍可使用工具，但缺乏深入的整合。\n> - \u003Cstrong>溫度限制\u003C\u002Fstrong>：遷移至 `gpt-5` 時，溫度參數必須省略或設為 `1`。舊模型無此限制。\n\n### O 系列推理模型（o1、o3-mini、o3、o4-mini）\n\nO 系列模型有其獨特的參數限制。遷移針對 O 系列模型的應用時：\n\n- **`temperature`**：必須設成 `1`（或省略）。O 系列模型不接受其他數值。\n- **`max_completion_tokens` → `max_output_tokens`**：使用 Azure 專有 `max_completion_tokens` 的應用必須改用 `max_output_tokens`，並設定較高數值（4096 以上），因為推理過程中使用的 tokens 也會占用限制。\n- **`reasoning_effort`**：若應用使用 `reasoning_effort`（低\u002F中\u002F高），請保留；Responses API 對 O 系列模型支援此參數。\n- \u003Cstrong>串流行為\u003C\u002Fstrong>：O 系列模型可能會在推理完成前緩衝輸出，延後發送文字增量事件。串流仍有效，但首次 `response.output_text.delta` 可能比 GPT 模型延遲更久。\n- **`top_p`**：O 系列模型不支援此參數，若出現請移除。\n- \u003Cstrong>工具使用\u003C\u002Fstrong>：O 系列模型通過 Responses API 支援工具功能，與 GPT 模型類似，但工具呼叫協調質量因模型而異。\n\n**行動 — 主動模型建議**：掃描階段檢查應用所用模型（部署名稱、環境變數、配置）。若模型低於 `gpt-4.1`（非 gpt-4.1+），主動告知使用者：\n- 遷移在其目前模型上可行，基本支援文字、聊天、串流和工具。\n- 新型模型（`gpt-5.1`、`gpt-5.2`）在工具協調、結構化輸出強制、推理和跨區域可用性等方面擁有更佳表現。\n- 使用者可視情況考慮升級部署，此非遷移阻礙。\n\n不可基於模型版本阻擋或拒絕遷移。此建議僅供參考。\n\n### GitHub Models 不支援 Responses API\n\n> **GitHub Models (`models.github.ai`, `models.inference.ai.azure.com`) 不支援 Responses API。**\n\n若代碼庫有 GitHub Models 代碼路徑（尋找 `base_url` 指向 `models.github.ai` 或 `models.inference.ai.azure.com`），遷移時\u003Cstrong>應完全移除\u003C\u002Fstrong>。Responses API 需要 Azure OpenAI、OpenAI 或相容的本地端點（例如支援 Responses 的 Ollama）。\n\n掃描期間的行動：\n- 標記任何 GitHub Models 代碼路徑，待移除。\n\n---\n\n## 框架遷移\n\n許多應用在 OpenAI 之上使用高階框架。遷移時，不僅是底層 OpenAI 呼叫，框架本身的 API 也會改變。\n\n### Microsoft Agent Framework (MAF)\n\n**先檢查你的 MAF 版本** — 遷移依賴於你是否使用 MAF 1.0.0+，或先前的 1.0.0 前測試版\u002FRC。\n\n#### MAF 1.0.0+ (agent-framework-openai >= 1.0.0)\n\n`OpenAIChatClient` **已使用 Responses API** — 無需遷移。如代碼使用舊有的 `OpenAIChatCompletionClient`（使用 `chat.completions.create`），請換成 `OpenAIChatClient`。\n\n| 舊版 | 新版 |\n|--------|-------|\n| `from agent_framework.openai import OpenAIChatCompletionClient` | `from agent_framework.openai import OpenAIChatClient` |\n| `OpenAIChatCompletionClient(...)` | `OpenAIChatClient(...)` |\n\n查看版本：`python -c \"import agent_framework_openai; print(agent_framework_openai.__version__)\"`\n\n#### MAF 1.0.0 前版本（beta\u002Frc）\n\n在 1.0.0 前版本中，`OpenAIChatClient` 使用 Chat Completions。請升級至 `agent-framework-openai>=1.0.0`，使 `OpenAIChatClient` 預設使用 Responses API。\n\n其他 API 如 `Agent` 和工具 API 無需更改。\n\n### LangChain (`langchain-openai`)\n\n為 `ChatOpenAI()` 新增 `use_responses_api=True`。同時將回應存取從 `.content` 改為 `.text`。\n\n| 舊版 | 新版 |\n|--------|-------|\n| `ChatOpenAI(model=..., base_url=..., api_key=...)` | `ChatOpenAI(model=..., base_url=..., api_key=..., use_responses_api=True)` |\n| `result['messages'][-1].content` | `result['messages'][-1].text` |\n\n完整前後代碼示例請參閱 [cheat-sheet.md](.\u002Freferences\u002Fcheat-sheet.md)。\n\n---\n\n## 前端遷移指南\n\n> **Responses API 屬於伺服器端問題。** 請先遷移 Python 後端；前端的 HTTP 合約應保持不變，除非你的後端僅做薄轉發——在這種情況下，考慮採用 Responses 請求格式，消除翻譯層。若前端使用客戶端金鑰直接呼叫 OpenAI，請先轉移這部分呼叫到後端。\n\n### `@microsoft\u002Fai-chat-protocol` 已過時\n\n`@microsoft\u002Fai-chat-protocol` npm 套件已停用，應換用 [`ndjson-readablestream`](https:\u002F\u002Fwww.npmjs.com\u002Fpackage\u002Fndjson-readablestream)。若在前端遇到：\n\n1. 替換 CDN 腳本標籤：\n   ```html\n   \u003C!-- Before -->\n   \u003Cscript src=\"https:\u002F\u002Fcdn.jsdelivr.net\u002Fnpm\u002F@microsoft\u002Fai-chat-protocol@...\u002Fdist\u002Fiife\u002Findex.js\">\u003C\u002Fscript>\n   \u003C!-- After -->\n   \u003Cscript src=\"https:\u002F\u002Fcdn.jsdelivr.net\u002Fnpm\u002Fndjson-readablestream@1.0.7\u002Fdist\u002Fndjson-readablestream.umd.js\">\u003C\u002Fscript>\n   ```\n2. 移除 `AIChatProtocolClient` 實例化（`new ChatProtocol.AIChatProtocolClient(\"\u002Fchat\")`）。\n3. 將 `client.getStreamedCompletion(messages)` 改成直接對後端串流端點的 `fetch()` 呼叫。\n4. 將 `for await (const response of result)` 替換為 `for await (const chunk of readNDJSONStream(response.body))`。\n5. 將屬性存取從 `response.delta.content` \u002F `response.error` 改為 `chunk.delta.content` \u002F `chunk.error`。\n\n---\n\n## 目標\n\n- 列出所有在 Azure OpenAI 使用 Chat Completions 或舊版 Completions 的 Python 呼叫點。\n- 提出 Python 代碼庫的遷移計劃及執行順序。\n- 套用安全且最小的修改切換至 Responses API。\n- 更新呼叫者以使用 Responses 輸出架構；不保留向後相容的封裝。\n- 執行測試及碼風檢查；修正遷移導致的瑣碎錯誤。\n- 準備小且可審查的變更集並提供最終摘要和差異（不提交）。\n\n---\n\n## 護欄規則\n\n- 僅修改 git 工作區內的檔案，絕不寫出範圍外。\n- 不保留舊版相容層；代碼直接遷移到新 API 格式。\n- 不留下標記\u002F過渡性註解或備份檔案。\n- 若先前使用串流，則保留串流語意；否則使用非串流模式。\n- 若處於審核模式，執行命令或網路呼叫前需請求批准。\n- 不執行 `git add`\u002F`git commit`\u002F`git push`，只產生工作區修改。\n\n---\n\n## 第 0 步：Azure OpenAI 用戶端遷移（前置條件）\n\n若代碼庫使用 `AzureOpenAI` 或 `AsyncAzureOpenAI` 建構函數，請先遷移至標準 `OpenAI` \u002F `AsyncOpenAI` 建構函數。Azure 專用建構函數自 `openai>=1.108.1` 起已被棄用。\n\n### 為什麼使用 v1 API 路徑？\n\n新的 `\u002Fopenai\u002Fv1` 端點使用標準 `OpenAI()` 用戶端替代 `AzureOpenAI()`，不需 `api_version` 參數，且在 OpenAI 與 Azure OpenAI 上行為完全相同。此用戶端程式碼具未來適應性，無需管理版本。\n\n### 主要變更\n\n| 舊版 | 新版 |\n|--------|-------|\n| `AzureOpenAI` | `OpenAI` |\n| `AsyncAzureOpenAI` | `AsyncOpenAI` |\n| `azure_endpoint` | `base_url` |\n| `azure_ad_token_provider` | `api_key` |\n| `api_version=...` | 完全移除 |\n\n### 清理檢查清單\n\n- 從用戶端建構移除 `api_version` 參數。\n- 從 `.env`、應用設定、Bicep\u002F基礎結構檔移除 `AZURE_OPENAI_VERSION` \u002F `AZURE_OPENAI_API_VERSION` 環境變數。\n- 將 `.env`、應用設定、Bicep\u002F基礎結構及測試夾具中的 `AZURE_OPENAI_CLIENT_ID` 改名為 `AZURE_CLIENT_ID`（Azure Identity SDK 標準慣例）。\n- 確保 `requirements.txt` 或 `pyproject.toml` 中 openai 版本為 `>=1.108.1`。\n\n### 環境變數遷移\n\n| 舊環境變數 | 行動 | 備註 |\n|-------------|--------|-------|\n| `AZURE_OPENAI_VERSION` | \u003Cstrong>移除\u003C\u002Fstrong> | v1 端點不需 `api_version` |\n| `AZURE_OPENAI_API_VERSION` | \u003Cstrong>移除\u003C\u002Fstrong> | 同上 |\n| `AZURE_OPENAI_CLIENT_ID` | \u003Cstrong>改名為\u003C\u002Fstrong> → `AZURE_CLIENT_ID` | 用於 `ManagedIdentityCredential(client_id=...)` 的標準 Azure Identity SDK 慣例 |\n| `AZURE_OPENAI_ENDPOINT` | \u003Cstrong>保留\u003C\u002Fstrong> | 用於 `base_url` 建立 |\n| `AZURE_OPENAI_CHAT_DEPLOYMENT` | \u003Cstrong>保留\u003C\u002Fstrong> | 用於 `responses.create` 的 `model` 參數 |\n| `AZURE_OPENAI_API_KEY` | \u003Cstrong>保留\u003C\u002Fstrong> | 用於金鑰認證的 `api_key` |\n\n用戶端設定代碼範例（同步、非同步、EntraID、API key、多租戶）請見 [cheat-sheet.md](.\u002Freferences\u002Fcheat-sheet.md)。\n\n---\n\n## 第 1 步：偵測舊版呼叫\n\n執行 [detect_legacy.py](..\u002F..\u002F..\u002F..\u002F..\u002F.agents\u002Fskills\u002Fazure-openai-to-responses\u002Fscripts\u002Fdetect_legacy.py) 腳本尋找所有需遷移的呼叫點：\n\n```bash\npython skills\u002Fazure-openai-to-responses\u002Fscripts\u002Fdetect_legacy.py .\n```\n\n或手動執行以下搜尋，每個匹配點均為遷移目標：\n\n```bash\n# 舊有 API 調用（必須重寫）\nrg \"chat\\.completions\\.create\"\nrg \"ChatCompletion\\.create\"\nrg \"Completion\\.create\"\n\n# 已棄用的 Azure 用戶端建構子（必須替換）\nrg \"AzureOpenAI\\(\"\nrg \"AsyncAzureOpenAI\\(\"\n\n# 回應結構存取模式（必須更新）\nrg \"choices\\[0\\]\\.message\\.content\"\nrg \"choices\\[0\\]\\.delta\\.content\"\nrg \"choices\\[0\\]\\.message\\.function_call\"\nrg \"choices\\[0\\]\\.message\\.tool_calls\"\n\n# 舊有巢狀格式的工具定義（必須扁平化）\nrg '\"function\":\\s*{\\s*\"name\"'\nrg \"pydantic_function_tool\"\n\n# 舊格式的工具結果（必須轉換為 function_call_output）\nrg '\"role\":\\s*\"tool\"'\nrg '\"tool_call_id\"'\n\n# 已棄用的參數（必須移除或重新命名）\nrg \"response_format\"\nrg \"max_tokens\\b\"        # 重新命名為 max_output_tokens\nrg \"['\\\"]seed['\\\"]\"      # remove entirely\n\n# 已棄用的環境變數（清理）\nrg \"AZURE_OPENAI_API_VERSION|AZURE_OPENAI_VERSION\"\nrg \"AZURE_OPENAI_CLIENT_ID\"  # 應該是 AZURE_CLIENT_ID\n\n# GitHub 模型端點（必須移除 — 不支援回應 API）\nrg \"models\\.github\\.ai|models\\.inference\\.ai\\.azure\"\n\n# 框架層級的舊有模式（必須更新）\nrg \"OpenAIChatCompletionClient\"  # MAF 1.0.0+：替換為 OpenAIChatClient\nrg \"ChatOpenAI\\(\" | grep -v \"use_responses_api\"  # LangChain：需要 use_responses_api=True\n\n# 測試基礎設施（必須更新）\nrg \"ChatCompletionChunk|AsyncCompletions\\.create\" tests\u002F\nrg \"_azure_ad_token_provider\" tests\u002F\nrg \"prompt_filter_results|content_filter_results\" tests\u002F\nrg \"choices\\[0\\]\" tests\u002F\n\n# 內容篩選錯誤主體存取（必須更新 — 結構已更改）\nrg 'innererror.*content_filter_result|error\\.body\\[\"innererror\"\\]'\nrg \"content_filter_result\\[\" # 舊的單數形式 — 現在在 content_filters 陣列內是 content_filter_results（複數）\n\n# 直接呼叫 Chat Completions 端點的原始 HTTP（必須更新 URL）\nrg \"\u002Fopenai\u002Fdeployments\u002F.*\u002Fchat\u002Fcompletions\"\nrg \"api-version=\"\n```\n\n### 判斷準則（偵測與重寫）\n\n- **Chat Completions 用戶端**：`client.chat.completions.create` → `client.responses.create(...)`。\n\n- **Azure 用戶端建構子**：`AzureOpenAI(...)` → `OpenAI(base_url=..., api_key=...)`。\n- **工具（Tools）**：將函數呼叫工具定義從巢狀格式 (`{\"type\": \"function\", \"function\": {\"name\": ...}}`) 轉換為平坦的 Responses 格式 (`{\"type\": \"function\", \"name\": ...}`)；使用 `tool_choice`；將工具結果以 `{\"type\": \"function_call_output\", \"call_id\": ..., \"output\": ...}` 項目返回（而非 `{\"role\": \"tool\", ...}`）。\n- \u003Cstrong>工具迴圈\u003C\u002Fstrong>：當模型回傳函數呼叫時，將 `response.output` 項目附加到對話紀錄（而非手動建立的 `{\"role\": \"assistant\", \"tool_calls\": [...]}` 字典），接著為每個結果附加 `function_call_output` 項目。\n- \u003Cstrong>少量範例工具呼叫\u003C\u002Fstrong>：若對話包含硬編碼的工具呼叫範例，則將它們轉換為 `{\"type\": \"function_call\", \"id\": \"fc_...\", \"call_id\": \"fc_...\", ...}` + `{\"type\": \"function_call_output\", ...}` 項目。ID 必須以 `fc_` 開頭。\n- **`pydantic_function_tool()`\u003Cstrong>：此輔助函數仍產生舊的巢狀格式且\u003C\u002Fstrong>不相容**於 `responses.create()`。請改用手動工具定義或平坦包裝器。\n- \u003Cstrong>多輪對話\u003C\u002Fstrong>：於應用中維護對話歷史；用 `input` 項目傳遞之前回合。\n- \u003Cstrong>格式化\u003C\u002Fstrong>：將 Chat 的頂層 `response_format` 替換為 Responses 的 `text.format`。標準格式為：`text={\"format\": {\"type\": \"json_schema\", \"name\": \"Output\", \"strict\": True, \"schema\": {...}}}`。\n- \u003Cstrong>內容項目\u003C\u002Fstrong>：將 Chat `content[].type: \"text\"` 替換為 Responses `content[].type: \"input_text\"` 用於使用者\u002F系統回合。\n- \u003Cstrong>圖片內容項目\u003C\u002Fstrong>：將 Chat `content[].type: \"image_url\"` 替換為 Responses `content[].type: \"input_image\"`。`image_url` 欄位從巢狀物件 `{\"url\": \"...\"}` 改為平坦字串。請參考備忘單了解前後範例。\n- \u003Cstrong>推理欄位\u003C\u002Fstrong>：**只有在原始程式碼已有 `reasoning` 時才進行遷移**。\n- \u003Cstrong>內容過濾錯誤處理\u003C\u002Fstrong>：錯誤主體結構改變。Chat Completions 使用 `error.body[\"innererror\"][\"content_filter_result\"]`（單數）；Responses API 使用 `error.body[\"content_filters\"][0][\"content_filter_results\"]`（複數，陣列內）。存取 `innererror` 的程式碼將引發 `KeyError`，請改寫為新路徑。\n- **原生 HTTP 呼叫**：若應用直接呼叫 Azure OpenAI REST API（透過 `requests`、`httpx` 等），使用 `\u002Fopenai\u002Fdeployments\u002F{name}\u002Fchat\u002Fcompletions?api-version=...`，請改寫為 `\u002Fopenai\u002Fv1\u002Fresponses`。請求主體變更：`messages` → `input`、新增 `max_output_tokens` 和 `store: false`，移除 `api-version` 查詢參數。回應主體變更：`choices[0].message.content` → `output[0].content[0].text`（注意：`output_text` 是 SDK 的便利屬性，原生 REST JSON 不存在）。\n\n---\n\n## 步驟 2：套用遷移\n\n### 遷移說明（Chat Completions → Responses）\n\n- \u003Cstrong>為何要遷移\u003C\u002Fstrong>：Responses 是文本、工具和串流的統一 API；Chat Completions 是舊版。使用 GPT-5 時，為取得最佳效能需使用 Responses。\n- **HTTP**：Azure 端點由 `\u002Fopenai\u002Fdeployments\u002F{name}\u002Fchat\u002Fcompletions` 變更為 `\u002Fopenai\u002Fv1\u002Fresponses`。\n- \u003Cstrong>欄位\u003C\u002Fstrong>：`messages` → `input`，`max_tokens` → `max_output_tokens`。`temperature` 不變。\n- \u003Cstrong>格式化\u003C\u002Fstrong>：`response_format` → `text.format`（物件）。\n- \u003Cstrong>內容項目\u003C\u002Fstrong>：將 Chat `content[].type: \"text\"` 替換為 Responses `content[].type: \"input_text\"` 用於系統\u002F使用者回合。\n- \u003Cstrong>圖片內容項目\u003C\u002Fstrong>：將 Chat `content[].type: \"image_url\"` 替換為 Responses `content[].type: \"input_image\"`。將 `image_url` 欄位從 `{\"image_url\": {\"url\": \"...\"}}` 平坦為 `{\"image_url\": \"...\"}`（純字串，可為 HTTPS URL 或 `data:image\u002F...;base64,...` 的資料 URI）。\n\n### 參數對照參考\n\n| Chat Completions | Responses API |\n|-----------------|---------------|\n| `prompt` | `input` |\n| `messages` | `input`（項目陣列） |\n| `max_tokens` | `max_output_tokens` |\n| `response_format` | `text.format`（物件） |\n| `temperature` | `temperature`（不變） |\n| `stop` | `stop`（不變） |\n| `frequency_penalty` | `frequency_penalty`（不變） |\n| `presence_penalty` | `presence_penalty`（不變） |\n| `tools` \u002F 函數呼叫 | `tools`（不變） |\n| `seed` | \u003Cstrong>移除\u003C\u002Fstrong>（不支援） |\n| `store` | `store`（設定為 `false`） |\n| `content[].type: \"text\"` | `content[].type: \"input_text\"` |\n| `content[].type: \"image_url\"` | `content[].type: \"input_image\"` |\n| `\"image_url\": {\"url\": \"...\"}` | `\"image_url\": \"...\"`（平坦字串） |\n\n完整前後範例程式碼請參考 [cheat-sheet.md](.\u002Freferences\u002Fcheat-sheet.md)。\n\n測試基礎建設遷移（mock、快照、斷言）請參考 [test-migration.md](.\u002Freferences\u002Ftest-migration.md)。\n\n錯誤排查與注意事項請參考 [troubleshooting.md](.\u002Freferences\u002Ftroubleshooting.md)。\n\n---\n\n## 資料保留與狀態管理\n\n- 全部 Responses 請求都設定 `store: false`。\n- 不可依賴前訊息 ID 或伺服器儲存的上下文；請保持狀態由客戶端管理並最小化元資料。\n\n---\n\n## 驗收標準\n\n### 程式碼層級門檻（全部必須通過）\n\n- [ ] 在遷移後的檔案中，`rg \"chat\\.completions\\.create|ChatCompletion\\.create|Completion\\.create\"` 無任何匹配。\n- [ ] `rg \"AzureOpenAI\\(|AsyncAzureOpenAI\\(\"` 無任何匹配 — 所有建構子皆使用帶 v1 端點的 `OpenAI`\u002F`AsyncOpenAI`。\n- [ ] `rg \"models\\.github\\.ai|models\\.inference\\.ai\\.azure\"` 無任何匹配 — 移除 GitHub Models 相關程式碼路徑。\n- [ ] `rg \"OpenAIChatCompletionClient\"` 無任何匹配 — MAF 1.0.0+ 程式碼使用 `OpenAIChatClient`（採用 Responses API）。若為 1.0.0 之前版本，請升級至 `agent-framework-openai>=1.0.0`。\n- [ ] 所有 `ChatOpenAI(...)` 調用皆包含 `use_responses_api=True`。\n- [ ] `rg \"choices\\[0\\]\"` 無任何匹配 — 所有回應存取皆使用 `resp.output_text` 或 Responses 輸出結構。\n- [ ] 頂層不再有 `response_format`；所有結構化輸出皆使用 `text={\"format\": {...}}`。\n- [ ] `requirements.txt` 或 `pyproject.toml` 中包含 `openai>=1.108.1` 與 `azure-identity`；並已重新安裝相依套件。\n- [ ] 每次呼叫 `responses.create` 均設置 `store=False`。\n- [ ] 客戶端建構時無 `api_version`；`AZURE_OPENAI_API_VERSION` 已從環境檔與基礎架構移除。\n\n### 測試基礎建設門檻（全部必須通過）\n\n- [ ] `rg \"ChatCompletionChunk|AsyncCompletions\\.create|chat\\.completions\" tests\u002F` 無任何匹配。\n- [ ] `rg \"_azure_ad_token_provider\" tests\u002F` 無任何匹配 — 斷言更新為檢查 `isinstance(client, AsyncOpenAI)` 或 `base_url`。\n- [ ] `rg \"prompt_filter_results|content_filter_results\" tests\u002F` 無任何匹配 — 移除 Azure 專屬過濾 mock。\n- [ ] mock fixture 使用 `kwargs.get(\"input\")` 非 `kwargs.get(\"messages\")`。\n- [ ] 快照 \u002F golden 檔案更新為 Responses 串流結構（無 `choices[0]`、`function_call`、`logprobs` 等）。\n- [ ] `pytest` 執行通過且無失敗。\n\n### 行為驗證門檻（手動或透過測試架構驗證）\n\n- [ ] \u003Cstrong>基本完成\u003C\u002Fstrong>：非串流的 `responses.create` 回傳非空 `output_text`。\n- [ ] \u003Cstrong>串流等價\u003C\u002Fstrong>：原始程式若使用串流，遷移程式需串流並產出帶有非空 delta 的 `response.output_text.delta` 事件。\n- [ ] \u003Cstrong>結構化輸出\u003C\u002Fstrong>：若使用 `text.format` 包含 `json_schema`，`json.loads(resp.output_text)` 成功且符合結構。\n- [ ] \u003Cstrong>工具呼叫迴圈\u003C\u002Fstrong>：若使用工具，模型會呼叫工具，應用執行後，後續請求會回傳最終的 `output_text`（無無限迴圈）。\n- [ ] \u003Cstrong>非同步等價\u003C\u002Fstrong>：若使用 `AsyncAzureOpenAI`，等價的 `AsyncOpenAI` 能以 `await` 呼叫。\n- [ ] \u003Cstrong>錯誤率\u003C\u002Fstrong>：與遷移前基準相比，不增加 400\u002F401\u002F404 的錯誤。\n\n### 交付項目\n\n- 概要包含編輯的檔案、遷移前後的舊版調用數量差異及後續步驟。\n- 變更為工作目錄層級的程式碼編輯（不包含提交）。\n\n---\n\n## SDK 版本需求\n\n| 套件 | 最低版本 |\n|---------|----------------|\n| `openai` | `>=1.108.1` |\n| `azure-identity` | 最新版（用於 EntraID 驗證） |\n\n---\n\n## 參考資料\n\n- [備忘單 — 全部程式碼片段](.\u002Freferences\u002Fcheat-sheet.md)\n- [測試遷移 — mock、快照、斷言](.\u002Freferences\u002Ftest-migration.md)\n- [疑難排解 — 錯誤、風險表、注意事項](.\u002Freferences\u002Ftroubleshooting.md)\n- [detect_legacy.py — 自動掃描器](..\u002F..\u002F..\u002F..\u002F..\u002F.agents\u002Fskills\u002Fazure-openai-to-responses\u002Fscripts\u002Fdetect_legacy.py)\n- [Azure OpenAI 新手套件](https:\u002F\u002Faka.ms\u002Fopenai\u002Fstart)\n- [Azure OpenAI Responses API 文件](https:\u002F\u002Flearn.microsoft.com\u002Fen-us\u002Fazure\u002Fai-foundry\u002Fopenai\u002Fhow-to\u002Fresponses)\n- [Azure OpenAI API 版本生命週期](https:\u002F\u002Flearn.microsoft.com\u002Fen-us\u002Fazure\u002Fai-foundry\u002Fopenai\u002Fapi-version-lifecycle?view=foundry-classic&tabs=python#api-evolution)\n- [OpenAI Responses API 參考](https:\u002F\u002Fplatform.openai.com\u002Fdocs\u002Fapi-reference\u002Fresponses)\n\n---\n\n\u003C!-- CO-OP TRANSLATOR DISCLAIMER START -->\n**免責聲明**：\n本文件由 AI 翻譯服務 [Co-op Translator](https:\u002F\u002Fgithub.com\u002FAzure\u002Fco-op-translator) 翻譯而成。雖然我們致力於確保準確性，但請注意，機器自動翻譯可能包含錯誤或不準確之處。原始文件的母語版本應被視為權威來源。對於重要資訊，建議進行專業人工翻譯。我們不對因使用本翻譯而產生的任何誤解或誤釋承擔責任。\n\u003C!-- CO-OP TRANSLATOR DISCLAIMER END -->","# 將 Python 應用程式從 Azure OpenAI Chat Completions 遷移至 Responses API\n\n> **權威指南 — 請嚴格遵循**\n>\n> 本技能將使用 Azure OpenAI Chat Completions 的 Python 代碼庫\n> 遷移至統一的 Responses API。請精確遵循這些指示。\n> 不可隨意即興對應參數或發明 API 介面。\n\n---\n\n## 觸發條件\n\n當使用者想要啟用本技能時：\n- 將 Python 應用程式從 Azure OpenAI Chat Completions 遷移至 Responses API\n- 將 Python OpenAI SDK 用法升級為最新的 Azure OpenAI API 格式\n- 為 GPT-5 或更新版需要 Responses API 的模型準備 Python 程式碼\n- 從 `AzureOpenAI` \u002F `AsyncAzureOpenAI` 切換到帶 v1 端點的標準 `OpenAI` \u002F `AsyncOpenAI` 用戶端\n- 修正與 `AzureOpenAI` 構造函數或 `api_version` 相關的過時警告\n\n---\n\n## ⚠️ 模型相容性 — 請先檢查\n\n> **遷移前，請確認你的 Azure OpenAI 部署支援 Responses API。**\n\n### 1. 快速測試部署（最快）\n\n```python\nimport os\nfrom openai import OpenAI\n\nclient = OpenAI(\n    api_key=os.environ[\"AZURE_OPENAI_API_KEY\"],\n    base_url=f\"{os.environ['AZURE_OPENAI_ENDPOINT'].rstrip('\u002F')}\u002Fopenai\u002Fv1\u002F\",\n)\n\ntry:\n    resp = client.responses.create(\n        model=os.environ[\"AZURE_OPENAI_DEPLOYMENT\"],\n        input=\"ping\",\n        max_output_tokens=50,\n        store=False,\n    )\n    print(f\"✅ Deployment supports Responses API: {resp.output_text}\")\nexcept Exception as e:\n    print(f\"❌ Deployment does NOT support Responses API: {e}\")\n```\n\n> \u003Cstrong>注意\u003C\u002Fstrong>：Azure OpenAI 中 `max_output_tokens` 最低為 16。低於 16 的值會回傳 400 錯誤。測試時請使用 50 以上。\n\n如果此請求回傳 404，表示該部署的模型尚未支援 Responses。請參考下方文件或用支援的模型重新部署。\n\n### 2. 檢查區域中的可用模型（推薦）\n\n執行內建模型相容性工具，查看特定區域中有哪些模型支援 Responses API：\n\n```bash\npython migrate.py models --subscription YOUR_SUB_ID --location YOUR_REGION\n```\n\n該查詢即時連接 Azure ARM 並顯示相容性矩陣—哪些模型支援 Responses、結構化輸出、工具等。可用 `--filter gpt-5.1,gpt-5.2` 篩選結果，或 `--json` 用於腳本。\n\n### 3. 完整模型支援參考\n\n- \u003Cstrong>即時查詢\u003C\u002Fstrong>：`python migrate.py models`（見上方 — 區域特定，持續更新）\n- \u003Cstrong>瀏覽可用性\u003C\u002Fstrong>: [模型摘要表及區域可用性](https:\u002F\u002Flearn.microsoft.com\u002Fen-us\u002Fazure\u002Ffoundry\u002Ffoundry-models\u002Fconcepts\u002Fmodels-sold-directly-by-azure?tabs=global-standard-aoai%2Cglobal-standard&pivots=azure-openai#model-summary-table-and-region-availability)\n- \u003Cstrong>快速入門與指南\u003C\u002Fstrong>：**https:\u002F\u002Faka.ms\u002Fopenai\u002Fstart**\n\n### ⚠️ 較舊模型的限制\n\n> \u003Cstrong>警告\u003C\u002Fstrong>：較舊模型（早於 `gpt-4.1` 的版本）可能無法完整支援所有 Responses API 功能。\n>\n> 已知較舊模型的限制：\n> - **`reasoning` 參數**：許多非推理模型不支援此參數。只在原始代碼已有 `reasoning` 時才遷移。\n> - **`seed` 參數**：Responses API 完全不支援，請從所有請求中移除。\n> - **透過 `text.format` 的結構化輸出**：舊模型可能無法可靠強制執行 `strict: true` 的 JSON schema。\n> - \u003Cstrong>工具協調\u003C\u002Fstrong>：GPT-5+ 模型將工具調用整合進內部推理，舊模型在 Responses API 仍可使用工具，但缺乏深入的整合。\n> - \u003Cstrong>溫度限制\u003C\u002Fstrong>：遷移至 `gpt-5` 時，溫度參數必須省略或設為 `1`。舊模型無此限制。\n\n### O 系列推理模型（o1、o3-mini、o3、o4-mini）\n\nO 系列模型有其獨特的參數限制。遷移針對 O 系列模型的應用時：\n\n- **`temperature`**：必須設成 `1`（或省略）。O 系列模型不接受其他數值。\n- **`max_completion_tokens` → `max_output_tokens`**：使用 Azure 專有 `max_completion_tokens` 的應用必須改用 `max_output_tokens`，並設定較高數值（4096 以上），因為推理過程中使用的 tokens 也會占用限制。\n- **`reasoning_effort`**：若應用使用 `reasoning_effort`（低\u002F中\u002F高），請保留；Responses API 對 O 系列模型支援此參數。\n- \u003Cstrong>串流行為\u003C\u002Fstrong>：O 系列模型可能會在推理完成前緩衝輸出，延後發送文字增量事件。串流仍有效，但首次 `response.output_text.delta` 可能比 GPT 模型延遲更久。\n- **`top_p`**：O 系列模型不支援此參數，若出現請移除。\n- \u003Cstrong>工具使用\u003C\u002Fstrong>：O 系列模型通過 Responses API 支援工具功能，與 GPT 模型類似，但工具呼叫協調質量因模型而異。\n\n**行動 — 主動模型建議**：掃描階段檢查應用所用模型（部署名稱、環境變數、配置）。若模型低於 `gpt-4.1`（非 gpt-4.1+），主動告知使用者：\n- 遷移在其目前模型上可行，基本支援文字、聊天、串流和工具。\n- 新型模型（`gpt-5.1`、`gpt-5.2`）在工具協調、結構化輸出強制、推理和跨區域可用性等方面擁有更佳表現。\n- 使用者可視情況考慮升級部署，此非遷移阻礙。\n\n不可基於模型版本阻擋或拒絕遷移。此建議僅供參考。\n\n### GitHub Models 不支援 Responses API\n\n> **GitHub Models (`models.github.ai`, `models.inference.ai.azure.com`) 不支援 Responses API。**\n\n若代碼庫有 GitHub Models 代碼路徑（尋找 `base_url` 指向 `models.github.ai` 或 `models.inference.ai.azure.com`），遷移時\u003Cstrong>應完全移除\u003C\u002Fstrong>。Responses API 需要 Azure OpenAI、OpenAI 或相容的本地端點（例如支援 Responses 的 Ollama）。\n\n掃描期間的行動：\n- 標記任何 GitHub Models 代碼路徑，待移除。\n\n---\n\n## 框架遷移\n\n許多應用在 OpenAI 之上使用高階框架。遷移時，不僅是底層 OpenAI 呼叫，框架本身的 API 也會改變。\n\n### Microsoft Agent Framework (MAF)\n\n**先檢查你的 MAF 版本** — 遷移依賴於你是否使用 MAF 1.0.0+，或先前的 1.0.0 前測試版\u002FRC。\n\n#### MAF 1.0.0+ (agent-framework-openai >= 1.0.0)\n\n`OpenAIChatClient` **已使用 Responses API** — 無需遷移。如代碼使用舊有的 `OpenAIChatCompletionClient`（使用 `chat.completions.create`），請換成 `OpenAIChatClient`。\n\n| 舊版 | 新版 |\n|--------|-------|\n| `from agent_framework.openai import OpenAIChatCompletionClient` | `from agent_framework.openai import OpenAIChatClient` |\n| `OpenAIChatCompletionClient(...)` | `OpenAIChatClient(...)` |\n\n查看版本：`python -c \"import agent_framework_openai; print(agent_framework_openai.__version__)\"`\n\n#### MAF 1.0.0 前版本（beta\u002Frc）\n\n在 1.0.0 前版本中，`OpenAIChatClient` 使用 Chat Completions。請升級至 `agent-framework-openai>=1.0.0`，使 `OpenAIChatClient` 預設使用 Responses API。\n\n其他 API 如 `Agent` 和工具 API 無需更改。\n\n### LangChain (`langchain-openai`)\n\n為 `ChatOpenAI()` 新增 `use_responses_api=True`。同時將回應存取從 `.content` 改為 `.text`。\n\n| 舊版 | 新版 |\n|--------|-------|\n| `ChatOpenAI(model=..., base_url=..., api_key=...)` | `ChatOpenAI(model=..., base_url=..., api_key=..., use_responses_api=True)` |\n| `result['messages'][-1].content` | `result['messages'][-1].text` |\n\n完整前後代碼示例請參閱 [cheat-sheet.md](.\u002Freferences\u002Fcheat-sheet.md)。\n\n---\n\n## 前端遷移指南\n\n> **Responses API 屬於伺服器端問題。** 請先遷移 Python 後端；前端的 HTTP 合約應保持不變，除非你的後端僅做薄轉發——在這種情況下，考慮採用 Responses 請求格式，消除翻譯層。若前端使用客戶端金鑰直接呼叫 OpenAI，請先轉移這部分呼叫到後端。\n\n### `@microsoft\u002Fai-chat-protocol` 已過時\n\n`@microsoft\u002Fai-chat-protocol` npm 套件已停用，應換用 [`ndjson-readablestream`](https:\u002F\u002Fwww.npmjs.com\u002Fpackage\u002Fndjson-readablestream)。若在前端遇到：\n\n1. 替換 CDN 腳本標籤：\n   ```html\n   \u003C!-- Before -->\n   \u003Cscript src=\"https:\u002F\u002Fcdn.jsdelivr.net\u002Fnpm\u002F@microsoft\u002Fai-chat-protocol@...\u002Fdist\u002Fiife\u002Findex.js\">\u003C\u002Fscript>\n   \u003C!-- After -->\n   \u003Cscript src=\"https:\u002F\u002Fcdn.jsdelivr.net\u002Fnpm\u002Fndjson-readablestream@1.0.7\u002Fdist\u002Fndjson-readablestream.umd.js\">\u003C\u002Fscript>\n   ```\n2. 移除 `AIChatProtocolClient` 實例化（`new ChatProtocol.AIChatProtocolClient(\"\u002Fchat\")`）。\n3. 將 `client.getStreamedCompletion(messages)` 改成直接對後端串流端點的 `fetch()` 呼叫。\n4. 將 `for await (const response of result)` 替換為 `for await (const chunk of readNDJSONStream(response.body))`。\n5. 將屬性存取從 `response.delta.content` \u002F `response.error` 改為 `chunk.delta.content` \u002F `chunk.error`。\n\n---\n\n## 目標\n\n- 列出所有在 Azure OpenAI 使用 Chat Completions 或舊版 Completions 的 Python 呼叫點。\n- 提出 Python 代碼庫的遷移計劃及執行順序。\n- 套用安全且最小的修改切換至 Responses API。\n- 更新呼叫者以使用 Responses 輸出架構；不保留向後相容的封裝。\n- 執行測試及碼風檢查；修正遷移導致的瑣碎錯誤。\n- 準備小且可審查的變更集並提供最終摘要和差異（不提交）。\n\n---\n\n## 護欄規則\n\n- 僅修改 git 工作區內的檔案，絕不寫出範圍外。\n- 不保留舊版相容層；代碼直接遷移到新 API 格式。\n- 不留下標記\u002F過渡性註解或備份檔案。\n- 若先前使用串流，則保留串流語意；否則使用非串流模式。\n- 若處於審核模式，執行命令或網路呼叫前需請求批准。\n- 不執行 `git add`\u002F`git commit`\u002F`git push`，只產生工作區修改。\n\n---\n\n## 第 0 步：Azure OpenAI 用戶端遷移（前置條件）\n\n若代碼庫使用 `AzureOpenAI` 或 `AsyncAzureOpenAI` 建構函數，請先遷移至標準 `OpenAI` \u002F `AsyncOpenAI` 建構函數。Azure 專用建構函數自 `openai>=1.108.1` 起已被棄用。\n\n### 為什麼使用 v1 API 路徑？\n\n新的 `\u002Fopenai\u002Fv1` 端點使用標準 `OpenAI()` 用戶端替代 `AzureOpenAI()`，不需 `api_version` 參數，且在 OpenAI 與 Azure OpenAI 上行為完全相同。此用戶端程式碼具未來適應性，無需管理版本。\n\n### 主要變更\n\n| 舊版 | 新版 |\n|--------|-------|\n| `AzureOpenAI` | `OpenAI` |\n| `AsyncAzureOpenAI` | `AsyncOpenAI` |\n| `azure_endpoint` | `base_url` |\n| `azure_ad_token_provider` | `api_key` |\n| `api_version=...` | 完全移除 |\n\n### 清理檢查清單\n\n- 從用戶端建構移除 `api_version` 參數。\n- 從 `.env`、應用設定、Bicep\u002F基礎結構檔移除 `AZURE_OPENAI_VERSION` \u002F `AZURE_OPENAI_API_VERSION` 環境變數。\n- 將 `.env`、應用設定、Bicep\u002F基礎結構及測試夾具中的 `AZURE_OPENAI_CLIENT_ID` 改名為 `AZURE_CLIENT_ID`（Azure Identity SDK 標準慣例）。\n- 確保 `requirements.txt` 或 `pyproject.toml` 中 openai 版本為 `>=1.108.1`。\n\n### 環境變數遷移\n\n| 舊環境變數 | 行動 | 備註 |\n|-------------|--------|-------|\n| `AZURE_OPENAI_VERSION` | \u003Cstrong>移除\u003C\u002Fstrong> | v1 端點不需 `api_version` |\n| `AZURE_OPENAI_API_VERSION` | \u003Cstrong>移除\u003C\u002Fstrong> | 同上 |\n| `AZURE_OPENAI_CLIENT_ID` | \u003Cstrong>改名為\u003C\u002Fstrong> → `AZURE_CLIENT_ID` | 用於 `ManagedIdentityCredential(client_id=...)` 的標準 Azure Identity SDK 慣例 |\n| `AZURE_OPENAI_ENDPOINT` | \u003Cstrong>保留\u003C\u002Fstrong> | 用於 `base_url` 建立 |\n| `AZURE_OPENAI_CHAT_DEPLOYMENT` | \u003Cstrong>保留\u003C\u002Fstrong> | 用於 `responses.create` 的 `model` 參數 |\n| `AZURE_OPENAI_API_KEY` | \u003Cstrong>保留\u003C\u002Fstrong> | 用於金鑰認證的 `api_key` |\n\n用戶端設定代碼範例（同步、非同步、EntraID、API key、多租戶）請見 [cheat-sheet.md](.\u002Freferences\u002Fcheat-sheet.md)。\n\n---\n\n## 第 1 步：偵測舊版呼叫\n\n執行 [detect_legacy.py](..\u002F..\u002F..\u002F..\u002F..\u002F.agents\u002Fskills\u002Fazure-openai-to-responses\u002Fscripts\u002Fdetect_legacy.py) 腳本尋找所有需遷移的呼叫點：\n\n```bash\npython skills\u002Fazure-openai-to-responses\u002Fscripts\u002Fdetect_legacy.py .\n```\n\n或手動執行以下搜尋，每個匹配點均為遷移目標：\n\n```bash\n# 舊有 API 調用（必須重寫）\nrg \"chat\\.completions\\.create\"\nrg \"ChatCompletion\\.create\"\nrg \"Completion\\.create\"\n\n# 已棄用的 Azure 用戶端建構子（必須替換）\nrg \"AzureOpenAI\\(\"\nrg \"AsyncAzureOpenAI\\(\"\n\n# 回應結構存取模式（必須更新）\nrg \"choices\\[0\\]\\.message\\.content\"\nrg \"choices\\[0\\]\\.delta\\.content\"\nrg \"choices\\[0\\]\\.message\\.function_call\"\nrg \"choices\\[0\\]\\.message\\.tool_calls\"\n\n# 舊有巢狀格式的工具定義（必須扁平化）\nrg '\"function\":\\s*{\\s*\"name\"'\nrg \"pydantic_function_tool\"\n\n# 舊格式的工具結果（必須轉換為 function_call_output）\nrg '\"role\":\\s*\"tool\"'\nrg '\"tool_call_id\"'\n\n# 已棄用的參數（必須移除或重新命名）\nrg \"response_format\"\nrg \"max_tokens\\b\"        # 重新命名為 max_output_tokens\nrg \"['\\\"]seed['\\\"]\"      # remove entirely\n\n# 已棄用的環境變數（清理）\nrg \"AZURE_OPENAI_API_VERSION|AZURE_OPENAI_VERSION\"\nrg \"AZURE_OPENAI_CLIENT_ID\"  # 應該是 AZURE_CLIENT_ID\n\n# GitHub 模型端點（必須移除 — 不支援回應 API）\nrg \"models\\.github\\.ai|models\\.inference\\.ai\\.azure\"\n\n# 框架層級的舊有模式（必須更新）\nrg \"OpenAIChatCompletionClient\"  # MAF 1.0.0+：替換為 OpenAIChatClient\nrg \"ChatOpenAI\\(\" | grep -v \"use_responses_api\"  # LangChain：需要 use_responses_api=True\n\n# 測試基礎設施（必須更新）\nrg \"ChatCompletionChunk|AsyncCompletions\\.create\" tests\u002F\nrg \"_azure_ad_token_provider\" tests\u002F\nrg \"prompt_filter_results|content_filter_results\" tests\u002F\nrg \"choices\\[0\\]\" tests\u002F\n\n# 內容篩選錯誤主體存取（必須更新 — 結構已更改）\nrg 'innererror.*content_filter_result|error\\.body\\[\"innererror\"\\]'\nrg \"content_filter_result\\[\" # 舊的單數形式 — 現在在 content_filters 陣列內是 content_filter_results（複數）\n\n# 直接呼叫 Chat Completions 端點的原始 HTTP（必須更新 URL）\nrg \"\u002Fopenai\u002Fdeployments\u002F.*\u002Fchat\u002Fcompletions\"\nrg \"api-version=\"\n```\n\n### 判斷準則（偵測與重寫）\n\n- **Chat Completions 用戶端**：`client.chat.completions.create` → `client.responses.create(...)`。\n\n- **Azure 用戶端建構子**：`AzureOpenAI(...)` → `OpenAI(base_url=..., api_key=...)`。\n- **工具（Tools）**：將函數呼叫工具定義從巢狀格式 (`{\"type\": \"function\", \"function\": {\"name\": ...}}`) 轉換為平坦的 Responses 格式 (`{\"type\": \"function\", \"name\": ...}`)；使用 `tool_choice`；將工具結果以 `{\"type\": \"function_call_output\", \"call_id\": ..., \"output\": ...}` 項目返回（而非 `{\"role\": \"tool\", ...}`）。\n- \u003Cstrong>工具迴圈\u003C\u002Fstrong>：當模型回傳函數呼叫時，將 `response.output` 項目附加到對話紀錄（而非手動建立的 `{\"role\": \"assistant\", \"tool_calls\": [...]}` 字典），接著為每個結果附加 `function_call_output` 項目。\n- \u003Cstrong>少量範例工具呼叫\u003C\u002Fstrong>：若對話包含硬編碼的工具呼叫範例，則將它們轉換為 `{\"type\": \"function_call\", \"id\": \"fc_...\", \"call_id\": \"fc_...\", ...}` + `{\"type\": \"function_call_output\", ...}` 項目。ID 必須以 `fc_` 開頭。\n- **`pydantic_function_tool()`\u003Cstrong>：此輔助函數仍產生舊的巢狀格式且\u003C\u002Fstrong>不相容**於 `responses.create()`。請改用手動工具定義或平坦包裝器。\n- \u003Cstrong>多輪對話\u003C\u002Fstrong>：於應用中維護對話歷史；用 `input` 項目傳遞之前回合。\n- \u003Cstrong>格式化\u003C\u002Fstrong>：將 Chat 的頂層 `response_format` 替換為 Responses 的 `text.format`。標準格式為：`text={\"format\": {\"type\": \"json_schema\", \"name\": \"Output\", \"strict\": True, \"schema\": {...}}}`。\n- \u003Cstrong>內容項目\u003C\u002Fstrong>：將 Chat `content[].type: \"text\"` 替換為 Responses `content[].type: \"input_text\"` 用於使用者\u002F系統回合。\n- \u003Cstrong>圖片內容項目\u003C\u002Fstrong>：將 Chat `content[].type: \"image_url\"` 替換為 Responses `content[].type: \"input_image\"`。`image_url` 欄位從巢狀物件 `{\"url\": \"...\"}` 改為平坦字串。請參考備忘單了解前後範例。\n- \u003Cstrong>推理欄位\u003C\u002Fstrong>：**只有在原始程式碼已有 `reasoning` 時才進行遷移**。\n- \u003Cstrong>內容過濾錯誤處理\u003C\u002Fstrong>：錯誤主體結構改變。Chat Completions 使用 `error.body[\"innererror\"][\"content_filter_result\"]`（單數）；Responses API 使用 `error.body[\"content_filters\"][0][\"content_filter_results\"]`（複數，陣列內）。存取 `innererror` 的程式碼將引發 `KeyError`，請改寫為新路徑。\n- **原生 HTTP 呼叫**：若應用直接呼叫 Azure OpenAI REST API（透過 `requests`、`httpx` 等），使用 `\u002Fopenai\u002Fdeployments\u002F{name}\u002Fchat\u002Fcompletions?api-version=...`，請改寫為 `\u002Fopenai\u002Fv1\u002Fresponses`。請求主體變更：`messages` → `input`、新增 `max_output_tokens` 和 `store: false`，移除 `api-version` 查詢參數。回應主體變更：`choices[0].message.content` → `output[0].content[0].text`（注意：`output_text` 是 SDK 的便利屬性，原生 REST JSON 不存在）。\n\n---\n\n## 步驟 2：套用遷移\n\n### 遷移說明（Chat Completions → Responses）\n\n- \u003Cstrong>為何要遷移\u003C\u002Fstrong>：Responses 是文本、工具和串流的統一 API；Chat Completions 是舊版。使用 GPT-5 時，為取得最佳效能需使用 Responses。\n- **HTTP**：Azure 端點由 `\u002Fopenai\u002Fdeployments\u002F{name}\u002Fchat\u002Fcompletions` 變更為 `\u002Fopenai\u002Fv1\u002Fresponses`。\n- \u003Cstrong>欄位\u003C\u002Fstrong>：`messages` → `input`，`max_tokens` → `max_output_tokens`。`temperature` 不變。\n- \u003Cstrong>格式化\u003C\u002Fstrong>：`response_format` → `text.format`（物件）。\n- \u003Cstrong>內容項目\u003C\u002Fstrong>：將 Chat `content[].type: \"text\"` 替換為 Responses `content[].type: \"input_text\"` 用於系統\u002F使用者回合。\n- \u003Cstrong>圖片內容項目\u003C\u002Fstrong>：將 Chat `content[].type: \"image_url\"` 替換為 Responses `content[].type: \"input_image\"`。將 `image_url` 欄位從 `{\"image_url\": {\"url\": \"...\"}}` 平坦為 `{\"image_url\": \"...\"}`（純字串，可為 HTTPS URL 或 `data:image\u002F...;base64,...` 的資料 URI）。\n\n### 參數對照參考\n\n| Chat Completions | Responses API |\n|-----------------|---------------|\n| `prompt` | `input` |\n| `messages` | `input`（項目陣列） |\n| `max_tokens` | `max_output_tokens` |\n| `response_format` | `text.format`（物件） |\n| `temperature` | `temperature`（不變） |\n| `stop` | `stop`（不變） |\n| `frequency_penalty` | `frequency_penalty`（不變） |\n| `presence_penalty` | `presence_penalty`（不變） |\n| `tools` \u002F 函數呼叫 | `tools`（不變） |\n| `seed` | \u003Cstrong>移除\u003C\u002Fstrong>（不支援） |\n| `store` | `store`（設定為 `false`） |\n| `content[].type: \"text\"` | `content[].type: \"input_text\"` |\n| `content[].type: \"image_url\"` | `content[].type: \"input_image\"` |\n| `\"image_url\": {\"url\": \"...\"}` | `\"image_url\": \"...\"`（平坦字串） |\n\n完整前後範例程式碼請參考 [cheat-sheet.md](.\u002Freferences\u002Fcheat-sheet.md)。\n\n測試基礎建設遷移（mock、快照、斷言）請參考 [test-migration.md](.\u002Freferences\u002Ftest-migration.md)。\n\n錯誤排查與注意事項請參考 [troubleshooting.md](.\u002Freferences\u002Ftroubleshooting.md)。\n\n---\n\n## 資料保留與狀態管理\n\n- 全部 Responses 請求都設定 `store: false`。\n- 不可依賴前訊息 ID 或伺服器儲存的上下文；請保持狀態由客戶端管理並最小化元資料。\n\n---\n\n## 驗收標準\n\n### 程式碼層級門檻（全部必須通過）\n\n- [ ] 在遷移後的檔案中，`rg \"chat\\.completions\\.create|ChatCompletion\\.create|Completion\\.create\"` 無任何匹配。\n- [ ] `rg \"AzureOpenAI\\(|AsyncAzureOpenAI\\(\"` 無任何匹配 — 所有建構子皆使用帶 v1 端點的 `OpenAI`\u002F`AsyncOpenAI`。\n- [ ] `rg \"models\\.github\\.ai|models\\.inference\\.ai\\.azure\"` 無任何匹配 — 移除 GitHub Models 相關程式碼路徑。\n- [ ] `rg \"OpenAIChatCompletionClient\"` 無任何匹配 — MAF 1.0.0+ 程式碼使用 `OpenAIChatClient`（採用 Responses API）。若為 1.0.0 之前版本，請升級至 `agent-framework-openai>=1.0.0`。\n- [ ] 所有 `ChatOpenAI(...)` 調用皆包含 `use_responses_api=True`。\n- [ ] `rg \"choices\\[0\\]\"` 無任何匹配 — 所有回應存取皆使用 `resp.output_text` 或 Responses 輸出結構。\n- [ ] 頂層不再有 `response_format`；所有結構化輸出皆使用 `text={\"format\": {...}}`。\n- [ ] `requirements.txt` 或 `pyproject.toml` 中包含 `openai>=1.108.1` 與 `azure-identity`；並已重新安裝相依套件。\n- [ ] 每次呼叫 `responses.create` 均設置 `store=False`。\n- [ ] 客戶端建構時無 `api_version`；`AZURE_OPENAI_API_VERSION` 已從環境檔與基礎架構移除。\n\n### 測試基礎建設門檻（全部必須通過）\n\n- [ ] `rg \"ChatCompletionChunk|AsyncCompletions\\.create|chat\\.completions\" tests\u002F` 無任何匹配。\n- [ ] `rg \"_azure_ad_token_provider\" tests\u002F` 無任何匹配 — 斷言更新為檢查 `isinstance(client, AsyncOpenAI)` 或 `base_url`。\n- [ ] `rg \"prompt_filter_results|content_filter_results\" tests\u002F` 無任何匹配 — 移除 Azure 專屬過濾 mock。\n- [ ] mock fixture 使用 `kwargs.get(\"input\")` 非 `kwargs.get(\"messages\")`。\n- [ ] 快照 \u002F golden 檔案更新為 Responses 串流結構（無 `choices[0]`、`function_call`、`logprobs` 等）。\n- [ ] `pytest` 執行通過且無失敗。\n\n### 行為驗證門檻（手動或透過測試架構驗證）\n\n- [ ] \u003Cstrong>基本完成\u003C\u002Fstrong>：非串流的 `responses.create` 回傳非空 `output_text`。\n- [ ] \u003Cstrong>串流等價\u003C\u002Fstrong>：原始程式若使用串流，遷移程式需串流並產出帶有非空 delta 的 `response.output_text.delta` 事件。\n- [ ] \u003Cstrong>結構化輸出\u003C\u002Fstrong>：若使用 `text.format` 包含 `json_schema`，`json.loads(resp.output_text)` 成功且符合結構。\n- [ ] \u003Cstrong>工具呼叫迴圈\u003C\u002Fstrong>：若使用工具，模型會呼叫工具，應用執行後，後續請求會回傳最終的 `output_text`（無無限迴圈）。\n- [ ] \u003Cstrong>非同步等價\u003C\u002Fstrong>：若使用 `AsyncAzureOpenAI`，等價的 `AsyncOpenAI` 能以 `await` 呼叫。\n- [ ] \u003Cstrong>錯誤率\u003C\u002Fstrong>：與遷移前基準相比，不增加 400\u002F401\u002F404 的錯誤。\n\n### 交付項目\n\n- 概要包含編輯的檔案、遷移前後的舊版調用數量差異及後續步驟。\n- 變更為工作目錄層級的程式碼編輯（不包含提交）。\n\n---\n\n## SDK 版本需求\n\n| 套件 | 最低版本 |\n|---------|----------------|\n| `openai` | `>=1.108.1` |\n| `azure-identity` | 最新版（用於 EntraID 驗證） |\n\n---\n\n## 參考資料\n\n- [備忘單 — 全部程式碼片段](.\u002Freferences\u002Fcheat-sheet.md)\n- [測試遷移 — mock、快照、斷言](.\u002Freferences\u002Ftest-migration.md)\n- [疑難排解 — 錯誤、風險表、注意事項](.\u002Freferences\u002Ftroubleshooting.md)\n- [detect_legacy.py — 自動掃描器](..\u002F..\u002F..\u002F..\u002F..\u002F.agents\u002Fskills\u002Fazure-openai-to-responses\u002Fscripts\u002Fdetect_legacy.py)\n- [Azure OpenAI 新手套件](https:\u002F\u002Faka.ms\u002Fopenai\u002Fstart)\n- [Azure OpenAI Responses API 文件](https:\u002F\u002Flearn.microsoft.com\u002Fen-us\u002Fazure\u002Fai-foundry\u002Fopenai\u002Fhow-to\u002Fresponses)\n- [Azure OpenAI API 版本生命週期](https:\u002F\u002Flearn.microsoft.com\u002Fen-us\u002Fazure\u002Fai-foundry\u002Fopenai\u002Fapi-version-lifecycle?view=foundry-classic&tabs=python#api-evolution)\n- [OpenAI Responses API 參考](https:\u002F\u002Fplatform.openai.com\u002Fdocs\u002Fapi-reference\u002Fresponses)\n\n---\n\n\u003C!-- CO-OP TRANSLATOR DISCLAIMER START -->\n**免責聲明**：\n本文件由 AI 翻譯服務 [Co-op Translator](https:\u002F\u002Fgithub.com\u002FAzure\u002Fco-op-translator) 翻譯而成。雖然我們致力於確保準確性，但請注意，機器自動翻譯可能包含錯誤或不準確之處。原始文件的母語版本應被視為權威來源。對於重要資訊，建議進行專業人工翻譯。我們不對因使用本翻譯而產生的任何誤解或誤釋承擔責任。\n\u003C!-- CO-OP TRANSLATOR DISCLAIMER END -->",{"name":5,"license":14},"main","f09e94ffe170f8af6d3db7c42987bbe4db227723","translations\u002Fzh-HK\u002F.agents\u002Fskills\u002Fazure-openai-to-responses",26019,"https:\u002F\u002Fgithub.com\u002Fmicrosoft\u002Fai-agents-for-beginners","https:\u002F\u002Faka.ms\u002Fai-agents-beginners","https:\u002F\u002Fgithub.com\u002Fmicrosoft","https:\u002F\u002Fopensource.microsoft.com","Open source projects and samples from Microsoft","2026-11-07 12:51:12",{"source":7,"skillName":5,"commands":35,"prompt":45,"zipAvailable":46},[36,39,42],{"tool":37,"command":38},"npx","npx skills add microsoft\u002Fai-agents-for-beginners --skill azure-openai-to-responses",{"tool":40,"command":41},"bunx","bunx skills add microsoft\u002Fai-agents-for-beginners --skill azure-openai-to-responses",{"tool":43,"command":44},"pnpm","pnpm dlx skills add microsoft\u002Fai-agents-for-beginners --skill azure-openai-to-responses","安装技能，技能地址：https:\u002F\u002Fgithub.com\u002Fmicrosoft\u002Fai-agents-for-beginners\u002Fblob\u002Fmain\u002Ftranslations\u002Fzh-HK\u002F.agents\u002Fskills\u002Fazure-openai-to-responses\u002FSKILL.md",true,[48,54,58],{"path":49,"resourceType":50,"resourceTypeDesc":51,"sizeBytes":52,"sourceHtmlUrl":53},"references\u002Fcheat-sheet.md","REFERENCE","参考文档",28182,"https:\u002F\u002Fgithub.com\u002Fmicrosoft\u002Fai-agents-for-beginners\u002Fblob\u002Fmain\u002Ftranslations\u002Fzh-HK\u002F.agents\u002Fskills\u002Fazure-openai-to-responses\u002Freferences\u002Fcheat-sheet.md",{"path":55,"resourceType":50,"resourceTypeDesc":51,"sizeBytes":56,"sourceHtmlUrl":57},"references\u002Ftest-migration.md",7155,"https:\u002F\u002Fgithub.com\u002Fmicrosoft\u002Fai-agents-for-beginners\u002Fblob\u002Fmain\u002Ftranslations\u002Fzh-HK\u002F.agents\u002Fskills\u002Fazure-openai-to-responses\u002Freferences\u002Ftest-migration.md",{"path":59,"resourceType":50,"resourceTypeDesc":51,"sizeBytes":60,"sourceHtmlUrl":61},"references\u002Ftroubleshooting.md",14883,"https:\u002F\u002Fgithub.com\u002Fmicrosoft\u002Fai-agents-for-beginners\u002Fblob\u002Fmain\u002Ftranslations\u002Fzh-HK\u002F.agents\u002Fskills\u002Fazure-openai-to-responses\u002Freferences\u002Ftroubleshooting.md",[63,81,92,100,108,115],{"skillNo":64,"name":65,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":7,"ownerLogin":8,"ownerAvatarUrl":9,"ownerAccountNo":10,"ownerDisplayName":11,"repositoryNo":12,"starsCount":13,"licenseSpdxId":14,"licenseFileUrl":6,"sourceHtmlUrl":66,"categories":67,"keywords":78,"publishedAt":19},"01M69A206TRZ8KK0CW0HYJF5V5","testing-course-samples","https:\u002F\u002Fgithub.com\u002Fmicrosoft\u002Fai-agents-for-beginners\u002Fblob\u002Fmain\u002Ftranslations\u002Fzh-TW\u002F.agents\u002Fskills\u002Ftesting-course-samples\u002FSKILL.md",[68,73],{"categoryNo":69,"categoryName":70,"taxonomyType":71,"taxonomyTypeDesc":72},"01JBSEEDCAT000000000000008","测试与质量","SCENARIO","使用场景",{"categoryNo":74,"categoryName":75,"taxonomyType":76,"taxonomyTypeDesc":77},"01JBSEEDCAT000000000000039","教师与教育","PROFESSION","适用职业",[79,80],"testing","testing course samples",{"skillNo":82,"name":83,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":7,"ownerLogin":8,"ownerAvatarUrl":9,"ownerAccountNo":10,"ownerDisplayName":11,"repositoryNo":12,"starsCount":13,"licenseSpdxId":14,"licenseFileUrl":6,"sourceHtmlUrl":84,"categories":85,"keywords":89,"publishedAt":19},"01M69A1XRB2SFHYRMEH0K08EKZ","microsoft-docs","https:\u002F\u002Fgithub.com\u002Fmicrosoft\u002Fai-agents-for-beginners\u002Fblob\u002Fmain\u002Ftranslations\u002Fzh-TW\u002F.agents\u002Fskills\u002Fmicrosoft-docs\u002FSKILL.md",[86],{"categoryNo":87,"categoryName":88,"taxonomyType":71,"taxonomyTypeDesc":72},"01JBSEEDCAT000000000000023","Skill与智能体开发",[90,8,91],"docs","microsoft docs",{"skillNo":93,"name":94,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":7,"ownerLogin":8,"ownerAvatarUrl":9,"ownerAccountNo":10,"ownerDisplayName":11,"repositoryNo":12,"starsCount":13,"licenseSpdxId":14,"licenseFileUrl":6,"sourceHtmlUrl":95,"categories":96,"keywords":97,"publishedAt":19},"01M69A1VPZFJQ1HNGTZQ5P3WSC","local-ai-agents","https:\u002F\u002Fgithub.com\u002Fmicrosoft\u002Fai-agents-for-beginners\u002Fblob\u002Fmain\u002Ftranslations\u002Fzh-TW\u002F.agents\u002Fskills\u002Flocal-ai-agents\u002FSKILL.md",[],[98,99],"ai agents","local ai agents",{"skillNo":101,"name":102,"nameZh":6,"description":103,"descriptionZh":6,"repositoryFullName":7,"ownerLogin":8,"ownerAvatarUrl":9,"ownerAccountNo":10,"ownerDisplayName":11,"repositoryNo":12,"starsCount":13,"licenseSpdxId":14,"licenseFileUrl":6,"sourceHtmlUrl":104,"categories":105,"keywords":106,"publishedAt":19},"01M69A1S947N7MM6V9JF85S2E7","jupyter-notebook","當使用者要求建立、搭建或編輯 Jupyter 筆記本（`.ipynb`）用於實驗、探索或教學時使用；優先使用隨附範本並執行輔助腳本 `new_notebook.py` 來產生一個乾淨的起始筆記本。","https:\u002F\u002Fgithub.com\u002Fmicrosoft\u002Fai-agents-for-beginners\u002Fblob\u002Fmain\u002Ftranslations\u002Fzh-TW\u002F.agents\u002Fskills\u002Fjupyter-notebook\u002FSKILL.md",[],[107],"jupyter notebook",{"skillNo":109,"name":110,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":7,"ownerLogin":8,"ownerAvatarUrl":9,"ownerAccountNo":10,"ownerDisplayName":11,"repositoryNo":12,"starsCount":13,"licenseSpdxId":14,"licenseFileUrl":6,"sourceHtmlUrl":111,"categories":112,"keywords":113,"publishedAt":19},"01M69A1Q8EXPWKZSQK69V6WF22","deploying-scalable-agents","https:\u002F\u002Fgithub.com\u002Fmicrosoft\u002Fai-agents-for-beginners\u002Fblob\u002Fmain\u002Ftranslations\u002Fzh-TW\u002F.agents\u002Fskills\u002Fdeploying-scalable-agents\u002FSKILL.md",[],[114],"deploying scalable agents",{"skillNo":116,"name":5,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":7,"ownerLogin":8,"ownerAvatarUrl":9,"ownerAccountNo":10,"ownerDisplayName":11,"repositoryNo":12,"starsCount":13,"licenseSpdxId":14,"licenseFileUrl":6,"sourceHtmlUrl":117,"categories":118,"keywords":119,"publishedAt":19},"01M69A1MHZTH3RH9N8VYSYG74X","https:\u002F\u002Fgithub.com\u002Fmicrosoft\u002Fai-agents-for-beginners\u002Fblob\u002Fmain\u002Ftranslations\u002Fzh-TW\u002F.agents\u002Fskills\u002Fazure-openai-to-responses\u002FSKILL.md",[],[18]]