Character api 整合快速入門

安裝 SDK

開始安裝您語言的官方用戶端程式庫。這可確保與我們提供的 OpenAI 相容端點相容。程式庫會為您處理序列化和重試邏輯。

對於 Python，使用 pip。對於 Node.js，使用 npm。此步驟僅需幾秒鐘，即可為後續的程式碼範例設定環境。

設定您的基礎 URL

將您的 SDK 客戶端指向我們的端點以存取無審查模型。基礎 URL 為 HTTPS://api.apicharacter.com/v1。這將取代配置中的預設 OpenAI URL。

若未進行此變更，請求將失敗或連接到錯誤的服務。您只需在初始化客戶端實例時設定一次即可。

設置您的 API 密鑰

將您的金鑰注入環境變數或客戶端設定。每次請求都需要驗證，以追蹤您預付信用額度的使用情況。您的金鑰可存取無審查的 LLM 端點。

妥善保管此值。它是您帳戶的唯一憑證，無需電話號碼或其他額外驗證即可進行基本存取。

進行您的首次請求

發送簡單的聊天完成請求以驗證連線能力。模型 ID 為 "uncensored"。這可確認您的驗證憑證和基礎 URL 正確無誤，以便您後續開發應用程式。

查看下方標準 cURL 請求的範例。

Copycurl https://api.apicharacter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "set my name to Alex"}]
  }'

處理串流回應

啟用串流以降低聊天介面的延遲。在請求中將 stream 參數設為 true。SDK 將在產生 token 時產生輸出。

這對於響應式使用者體驗至關重要。您可以透過伺服器發送事件（Server-Sent Events）處理到達的部分數據塊。

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)

限制、錯誤與上下文

了解您的約束條件以避免服務中斷。您擁有 100,000 個 token 的上下文視窗。除非另有指定，否則最大輸出為 16,000 個 token。

速率限制為每分鐘 300 次請求。401 錯誤表示金鑰無效，402 表示餘額為零，429 表示已觸發速率限制。在擴展生產環境時請留意這些限制。

Python

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.apicharacter.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)

Node.js

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.apicharacter.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);