OpenAI 相容 API 快速入門

先決條件與環境設定

您需要 API 金鑰和正確的基礎 URL 即可連接您的客戶端。在「獲取 API 金鑰」頁面使用 Google 或電子郵件註冊，即可立即獲得憑證。試用提供 7 天 $0.50 額度，您可以透過加密貨幣充值 USDT 或 USDC。妥善保管您的金鑰，並確認其與您的帳戶設定匹配。

確保您的環境支援標準 HTTP 請求。我們的服務僅運行單一 uncensored 模型，因此您無需管理多個模型端點。在發出任何呼叫前，請將 base URL 設定為 HTTPS://api.openaiapicompatibility.com/v1，以確保所有請求正確路由至我們經過微調的推理伺服器。

安裝官方 OpenAI SDK

使用官方 SDK 以與現有的 OpenAI 工作流程保持兼容。Python 和 Node 庫直接與我們的端點配合使用，因為我們遵循標準 API 架構。使用您首選的包管理器在項目目錄中安裝該包。此方法避免了編寫自定義 HTTP 客戶端代碼的需要。

我們支援 temperature、top_p 和 stop sequences 等標準參數。SDK 會自動處理 JSON 序列化和請求標頭。您可以在客戶端設定中交換 base URL 以指向我們的伺服器。這允許您在不同供應商之間切換，而無需更改應用程式邏輯。

配置基礎 URL 和 API 金鑰

在客戶端配置物件中設定基礎 URL 和 API 金鑰。基礎 URL 為 HTTPS://api.openaiapicompatibility.com/v1。在 Authorization 標頭中以 Bearer token 形式傳遞您的 API 金鑰。此配置可確保您的請求經過身份驗證並路由至正確的服務。

Copycurl https://api.openaiapicompatibility.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list all python packages for data science"}]
  }'

透過呼叫 GET /v1/models 端點來驗證您的連線。這將返回可用模型列表，包括 uncensored 模型的識別碼。在此步驟中，請確認您的網路存取和憑證是否正確，再發送複雜的提示詞。

進行首次聊天完成請求

向 /v1/chat/completions 發送 POST 請求，附上您的提示詞訊息。將模型定義為 uncensored 以存取未過濾的推論引擎。包含您的系統提示詞以設定行為，並新增使用者訊息以生成所需內容。

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.openaiapicompatibility.com/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

回應包含生成文字與 Token 用量統計。您可以調整溫度等參數以控制創造力。該模型不會拒絕合法的成人內容或爭議性話題，因此適合多種使用情境。請檢查回應物件中的 content 欄位以取得輸出。

帶有 SSE 的串流回應

透過在請求中將 stream 參數設為 true 來啟用串流。這會以伺服器發送事件（SSE）的形式發送部分回應。它透過顯示產生中的文字來改善使用者體驗。

Copystream = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Tell the story in second person."}],
    stream=True,
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)

每個區塊包含回應的差異。累積這些差異以重建完整文字。最終區塊包含請求的總令牌使用量。此方法適用於任何標準的 SSE 客戶端或函式庫。它降低了長篇內容生成時的感知延遲。

處理 JSON 模式與函數調用

將 response_format 設定為 json_object 以啟用 JSON 模式。這會強制模型輸出有效的 JSON，而非自由文字。這對於結構化資料擷取或 API 回應很有用。結合函式呼叫可實現工具使用情境。

在 tools 陣列中定義您的工具。指定函數名稱、描述和參數。模型將在回應中傳回函數呼叫詳細資訊。然後您可以執行該函數並將結果傳回給模型。這能透過 uncensored 模型啟用複雜的多步驟工作流程。

Node.js

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.openaiapicompatibility.com/v1", apiKey: process.env.API_KEY });

const resp = await client.chat.completions.create({
  model: "uncensored",
  messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);