OpenAI
此頁面由機器翻譯。查看原文英文文章

我如何將我的 API 用戶端加入 Community Libraries 頁面?

確保你的函式庫已準備好加入我們 Community Libraries 頁面的條件與步驟

更新日期:18 days ago

OpenAI 維護一個Community Libraries頁面,我們會在該頁列出開發人員可用來存取 OpenAI API 的 API 用戶端。

如果你建立了想加入此頁面的開源函式庫——謝謝你!我們很高興看到開發人員為其他開發人員建立額外的 API 工具。我們亦希望確保我們引導開發人員採用優質的解決方案,讓他們能長遠取得成功,因此在我們的網站列出函式庫之前,我們有幾項必須符合的準則。

請先確認你符合下列準則,然後填寫我們的Community Libraries 申請表

  1. 標準開源授權
    若要列出,我們要求社群函式庫使用如 MIT 等寬鬆開源授權。這樣一來,若擁有者停止維護或新增功能,我們的客戶在必要時便可更容易分支複製函式庫。

  2. 透過環境變數載入 API 金鑰
    README 中的程式碼範例必須鼓勵使用環境變數載入 OpenAI API 金鑰,而不是將其硬編碼在原始碼中。

  3. 正確、高品質且準確反映 API 的程式碼
    程式碼應易於閱讀/理解,並且一般應遵循我們的OpenAPI 規格——新函式庫不應包含在此規格中標示為 deprecated: true 的端點。

  4. 註明這是非官方函式庫
    請在 README 靠近開首的位置註明,這是「非官方」或「由社群維護」的函式庫。

  5. 承諾維護函式庫
    這主要表示要處理問題,以及審閱和合併拉取請求。你亦可以考慮像我們的Github Issue & PR templates那樣,設定官方 node 函式庫中的範本。

這篇文章對你有幫助嗎?