文檔導覽
DEVELOPER DOCUMENTATION

API 介面與相容性

區分協定形狀、模型能力與應用程式應自行驗證的部分。

先確認協定,再選用戶端

API 接入需要同時確認目的地、認證方式與請求格式。取得支援確認的 base URL 與模型識別後,再選擇相應用戶端;不要自行補上網域或路徑,也不要把另一服務的設定當作本站預設值。

相容不是所有能力都相同

相近的訊息格式不代表工具呼叫、結構化輸出、圖片或串流事件完全相同。只提交已確認可用的參數,對必要欄位建立驗證,並保留不支援功能時的清楚錯誤與替代流程。

回應處理與錯誤邊界

將示意範例視為理解介面的起點,而非現有服務保證。設定任務期限,區分部分內容與完整結果,依實際回應判斷能否重試。保存去識別化請求紀錄,讓支援能核對問題而不必取得秘密或客戶全文。

服務端接入範例

先在本機安裝相應的官方 SDK(Python:pip install openai;Node.js:npm install openai)。將 OPENAI_API_KEY、OPENAI_BASE_URL 和 OPENAI_MODEL 設為服務方確認的值;不要把實際密鑰貼入官網或前端。下例只展示常見 Chat Completions 模式,不能替代對實際接口的驗收。

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["OPENAI_API_KEY"],
    base_url=os.environ["OPENAI_BASE_URL"],
)

result = client.chat.completions.create(
    model=os.environ["OPENAI_MODEL"],
    messages=[{"role": "user", "content": "Hello, AI."}],
)
print(result.choices[0].message.content)
整合範例,並非在線測試。Base URL、模型及權限請先向我們確認。