Codex --output-schema 強制輸出結構化 JSON 怎麼用:在自動化腳本里提取標準格式代碼審查報告

在腳本或 CI 裏調用 codex exec 怕返回自由格式 Markdown 難以解析?本文按官方文檔詳解 --output-schema 參數用法、JSON Schema 必填約束、與 --json 事件流的區別,附代碼審查提取模板。

NNathaniel bigo··原創首發·AI 輔助撰寫
10 分鐘讀完
資料核對於 2026-11-18 · 依據官方文檔與公開資料整理 Plus 帳號

結論先說

  1. --output-schema <路徑> 用於強制約束 codex exec 的最終輸出結構。按官方文檔說明,傳入 Schema 文件後,模型在標準輸出(stdout)返回的最終結果會嚴格匹配定義好的字段名與類型。
  2. 它和 --json 參數用途完全不同。--output-schema 把最終答案變成單個業務 JSON 對象;而 --json 是把整個執行期間的會話啟動、工具調用和消息輸出變成逐行 JSONL 事件流。
  3. 編寫 Schema 時每個對象層級都要寫嚴約束。參照 OpenAI 結構化輸出規範,根對象及嵌套對象均需設定 additionalProperties 為 false,並把當前層所有屬性列入 required 數組。
  4. 提取報告時建議搭配 --sandbox read-only。只讀沙箱能防止 Codex 在分析過程中修改業務代碼,保證流水線檢查安全可控。
  5. 自動化審查流水線對帳號額度消耗較集中。國內缺少外幣卡或綁卡受阻的用戶,可在本站自助開通 ChatGPT Plus 或更高額度的 ChatGPT Pro,團隊集中採購可諮詢 ChatGPT Business 團隊定製。

codex --output-schema 四步用法

圖:本站根據 OpenAI Codex 官方文檔:Non-interactive mode 整理的示意圖

本文根據 OpenAI Codex 官方文檔《Non-interactive mode》《Command line options》及 OpenAI API《Structured Outputs》指南整理,資料核對於 2026-11-18。配圖為本站整理的示意圖,不是介面截圖。本站(bigolab.com)不是 OpenAI 官方網站。

適用於誰

  • 在 GitHub Actions、GitLab CI 或本地腳本里調用 codex exec,需要下游程序穩定解析返回字段的開發者;
  • 用提示詞要求只輸出 JSON,卻仍偶發遇到多餘代碼塊圍欄或字段缺漏的人;
  • 分不清 codex exec 裏 --output-schema 與 --json 兩個參數各自用途的用戶。

一、--output-schema 與 --json 參數對比

查閱命令幫助(見 /guides/codex-cli-commands-cheatsheet)時容易混淆這兩個選項,核心差異如下:

對比項--output-schema ./schema.json--json
輸出格式單個符合自定義 Schema 的 JSON 對象多行換行分隔的 JSONL 系統事件流
關注重點業務結論的字段結構(如問題列表、嚴重級別)運行全鏈路軌跡(思考、讀文件、跑命令事件)
下游解析方式直接交給 jq 或腳本 json.load 解析按行流式讀取並過濾末尾完成事件
典型場景自動生成審查單、變更元數據、風險評級卡自研外部監控面板、審計代理每一步動作

若業務腳本只關心最終審查結論,直接使用 --output-schema 最穩妥。底層 Schema 語法規則可參考 /guides/openai-api-structured-outputs。

二、實戰步驟:提取標準格式代碼審查報告

第 1 步:生成 review-schema.json

在項目根目錄用 Python 生成標準 Schema 文件,確保根類型為 object 且所有屬性列入 required:

python
import json

schema = dict(
    type='object',
    additionalProperties=False,
    required=['passed', 'summary', 'issues'],
    properties=dict(
        passed=dict(type='boolean'),
        summary=dict(type='string'),
        issues=dict(
            type='array',
            items=dict(
                type='object',
                additionalProperties=False,
                required=['file', 'line', 'severity', 'reason'],
                properties=dict(
                    file=dict(type='string'),
                    line=dict(type='integer'),
                    severity=dict(type='string', enum=['high', 'medium', 'low']),
                    reason=dict(type='string'),
                ),
            ),
        ),
    ),
)
json.dump(schema, open('review-schema.json', 'w', encoding='utf-8'), indent=2)

第 2 步:結合 git diff 執行審查並做門禁判斷

bash
git diff origin/main...HEAD | codex exec \
  --sandbox read-only \
  --output-schema ./review-schema.json \
  "審查當前分支相對於 main 的變更。存在 high 級別缺陷時將 passed 設為 false,用中文填寫 summary 與 reason。" \
  > review-report.json

jq -e '.passed == true' review-report.json >/dev/null || exit 1

專用審查命令對比也可查看 /guides/codex-code-review。

訂閱與帳號準備提示:在本地和腳本里批量跑結構化代碼審查會持續佔用模型推理配額。遇到額度見底時,可在本站自助升級 ChatGPT Pro 充值 或選用 ChatGPT Pro 5x 空白號檔;日常輕量審查開通 ChatGPT Plus 會員 即可滿足需求。

三、常見 Schema 報錯與排錯決策

--output-schema 與 --json 選型及排錯

圖:本站根據 OpenAI Structured Outputs 官方指南 整理的示意圖

遇到命令報錯或解析失敗時(更多錯誤見 /guides/codex-common-errors-summary),按三點核查:

  1. 報 invalid_json_schema 400 錯誤:通常是嵌套對象漏寫了 additionalProperties: false,或 properties 裏的字段未全部放進 required。需要可空字段時,把類型設為 ['string', 'null'] 並保留在 required 中。
  2. 根節點寫成了 array:結構化輸出頂層必須是 object,返回列表時包一層 issues 屬性即可。
  3. 輸出文件混入進度日誌:檢查是否在 codex exec 右側誤加了 2>&1。保持預設分離才能讓 stdout 只輸出純 JSON。
  4. 字段描述(description)寫得含糊導致取值偏離預期:雖然 Schema 能鎖死字段名和數據類型,但對於評分口徑、嚴重等級劃分標準等語義邊界,建議在每個屬性的 description 字段中用一兩句中文寫清判定依據(例如明確寫出「僅當可導致線上崩潰、數據越權或資金計算錯誤時標為 high,代碼風格建議一律標為 low」),能顯著減少誤報攔截。
  5. 超長差異導致響應緩慢或超時:當合並請求包含自動生成的鎖文件(如 package-lock.json、pnpm-lock.yaml)或編譯產物時,直接將全量 git diff 塞進管道會拖慢審查速度;上游命令可用路徑排除語法(如 git diff origin/main...HEAD -- . ':(exclude)lock')提前過濾無關文件。

常見問題

問:--output-schema 支持所有 JSON Schema 校驗語法嗎?

答:它遵循 OpenAI Structured Outputs 支持子集,基礎類型、enum 枚舉、嵌套對象與數組均支持;若包含不受支持的關鍵字,接口會返回 400 並指出具體字段。

問:能不能用命令行參數直接指定輸出文件路徑?

答:可以。除標準輸出重定向外,官方命令參考中 codex exec 也支持輸出文件選項,具體參數名可運行 codex exec --help 核對當前 CLI 版本。

問:國內沒有境外信用卡,或團隊需要開增值稅發票報銷,怎麼開通訂閱?

答:可前往本站 AI 會員充值總覽 選用 ChatGPT Plus 或 ChatGPT Pro,支持支付寶、微信支付及 AlipayHK 結算,提供卡密自助兌換(無需交出密碼)與團隊定製,支持開具增值稅發票。實時價格以頁面顯示為準;售後遵循掉訂閱按剩餘天數折退、封號不在質保範圍的規則。

相關教學

參考資料

  • OpenAI Codex 官方文檔:Non-interactive mode — https://learn.chatgpt.com/docs/non-interactive-mode
  • OpenAI Codex 官方文檔:Command line options — https://learn.chatgpt.com/docs/developer-commands
  • OpenAI API 官方文檔:Structured Outputs — https://platform.openai.com/docs/guides/structured-outputs

Nathaniel 的更多內容

  1. 01

    獨立開發者用 ChatGPT + Codex 跑通產品全流程:市場驗證、PRD、原型到代碼上線覆盤清單

    單人做獨立產品最容易陷入「閉門寫兩個月代碼上線零用戶」或「AI 寫到一半目錄越改越崩」。本文整理「ChatGPT 負責市場驗證、PRD 與覆盤 + Codex 負責工程實現與測試」的五階段雙軌流程,附起手提示詞與 7 項上線覆盤清單。

    ChatGPTCodex0
  2. 02

    用 ChatGPT 批量生成規範文件命名規則、整理混亂目錄樹與合併零散發票抬頭清單腳本

    面對滿桌面的「新建文件夾」「最終版2」和上百張零散電子發票,手工改名抄台帳耗時又容易漏重。本文分享先脫敏取樣、再用 ChatGPT 生成帶預演和回滾日誌的本地 Python 腳本,離線安全完成目錄整理與發票抬頭合併去重的實戰流程。

    ChatGPT0
  3. 03

    用 ChatGPT 做海外電郵營銷(EDM)受眾分層文案、A/B 主題行測試與防進垃圾箱自檢

    做海外獨立站或出海 SaaS 電郵營銷(EDM),最怕千人一面群發被直接送進垃圾箱。本文結合 Gmail/Yahoo 批量發件人規範,梳理用 ChatGPT 設計受眾分層文案、批量生成 A/B 主題行矩陣並開展發前垃圾詞與合規自檢的實戰提示詞。

    ChatGPT0
  4. 04

    用 ChatGPT 寫 Notion Formula 2.0 公式、Obsidian Dataview 查詢與 Airtable 自動化腳本

    給 Notion 數據庫寫多條件 Formula 2.0 公式、給 Obsidian 寫 Dataview 動態看板,或在 Airtable 裏寫自動化腳本,經常因為一個小括號或類型不匹配報錯半天。本文整理三大工具的通用上下文喂料規範與三套直接可複製的生成提示詞。

    ChatGPT其他 AI 工具0
  5. 05

    用 ChatGPT 處理複雜 JSON / YAML / XML 字段映射、格式轉換與校驗規則編寫實戰

    對接第三方 API、遷移 Kubernetes 配置或解析政企 XML 報文時,手工對照幾百行嵌套字段既慢又容易漏掉空值與類型邊界。本文整理用 ChatGPT 完成字段映射表梳理、生成確定性轉換腳本以及編寫 JSON Schema / Pydantic / XSD 校驗規則的實戰流。

    ChatGPT其他 AI 工具0
  6. 06

    用 ChatGPT 準備本科/碩士畢業論文答辯:提煉答辯 PPT 結構、模擬導師犀利追問與 3 分鐘自述稿

    畢業論文寫完後,要在 3–5 分鐘內講清研究價值並頂住答辯評委的連環追問並不輕鬆。本文整理在嚴格遵守高校學術規範的前提下,用 ChatGPT 提煉答辯 PPT 結構、打磨 3 分鐘口語自述稿並開展模擬導師犀利追問的排練流程與提示詞。

    ChatGPT0

同產品的其他教學

  1. 01

    用 ChatGPT 整理家庭裝修預算明細、隱蔽工程驗收清單與主材優缺點對比表實戰

    第一次裝修面對幾十頁施工報價單、密密麻麻的水電防水隱蔽項目與五花八門的主材參數,極易踩坑增項。本文梳理用 ChatGPT 審查裝修報價漏項、生成帶公式的預算明細表、定製工地隱蔽工程驗收單與主材對比表的實戰提示詞。

    ChatGPT0
  2. 02

    用 ChatGPT 做費曼學習法讀書共讀:反向追問檢驗自己是否真讀懂專業書籍與整理書單筆記

    讀完一本專業硬書常感覺「合上書就忘」,直接讓 AI 概括全書又容易產生懂了的錯覺。本文介紹用 ChatGPT 結合 Study Mode 與費曼學習法做反向追問共讀,通過通俗複述、挑刺盲區到沉澱書單卡片的完整流程與提示詞。

    ChatGPT0
  3. 03

    用 ChatGPT 做外貿產品多語種目錄、展會邀約與客戶跟進節奏表(附脫敏與本地化提示詞)

    做外貿展會與海外推廣時,手工翻譯十幾款產品目錄費時且容易留下一堆中式英文,展後客戶跟進也常缺節奏。本文梳理用 ChatGPT 先脫敏建術語庫、再批量產出多語種目錄、展前邀約函與展後 21 天跟進節奏表的實戰流程與提示詞。

    ChatGPT0
  4. 04

    用 ChatGPT 寫高質素技術專欄文章、開源項目 Release Notes 與版本更新日誌實戰

    讓 AI 直接憑空寫技術文章容易滿篇空洞套話,直接甩 Git 記錄寫更新日誌又常常漏掉破壞性變更。本文整理用 ChatGPT 結合真實代碼片段、壓測數據與 PR 摘要,高效產出深度技術專欄、GitHub Release Notes 與 CHANGELOG 的實戰工作流。

    ChatGPT0
  5. 05

    用 ChatGPT 做產品用戶訪談紀要編碼、提煉高頻痛點需求池與 RICE 優先級打分實戰

    手頭攢了十幾份用戶訪談逐字稿,手工貼便利貼歸納痛點耗時又容易帶入主觀偏見。本文分享用 ChatGPT 完成脫敏檢查、逐份開放式編碼、跨樣本聚類高頻痛點並搭建 RICE 優先級打分表的 5 步實戰流,附可直接複製的三段核心提示詞。

    ChatGPT0
  6. 06

    ChatGPT 網頁版上載超過 10 個文件或回形針附件按鈕變灰怎麼辦:打包合併與配額限制排查

    在 ChatGPT 網頁版批量分析文檔時,常遇到一次選超 10 個文件被攔截或輸入框回形針按鈕變灰。本文依據 OpenAI 文件上載與存儲說明,梳理 6 類常見報錯的分流排查法,提供 ZIP 打包、本地合併與 Projects 複用方案及可直接複製的解包提示詞。

    ChatGPT0

0 條評論

登入 後參與評論

還沒有評論,來搶沙發~