OpenAI Uyumlu API Dokümantasyonu

Önkoşullar: SDK ve Temel URL

Tercih ettiğiniz kütüphaneyi yükleyin ve uç noktamıza işaret edin. base_url dir https://api.apicompatible.com/v1. Bu OpenAI uyumlu API belgeleri, standart kütüphanelerin hemen çalıştığını doğrular. Bir yönlendiriciye veya karmaşık bir ağ geçidi kurulumuna gerek yoktur. URL'yi ve anahtarı değiştirin, ardından mevcut kodunuzu çalıştırın.

Kimlik Doğrulama: Başlık ve Anahtar Formatı

Anahtarınızı şuraya gönderin Authorization header. Şu formatı kullanın Bearer your_api_key. API'miz standart openai uyumlu API anahtar yapısını kullanır. Anahtarlar Google veya e-posta girişi aracılığıyla anında oluşturulur. Anahtarınızı güvende tutun, çünkü ön ödemeli kredinize erişim sağlar.

Sohbet Tamamlamaları Uç Noktası

İstekleri gönderin /v1/chat/completionsModeli şu olarak belirt uncensored. API, metin yanıtlarını doğrudan döndürür. Bağlantı doğrulamasını test etmek için aşağıdaki curl komutunu kullanın:

Copycurl https://api.apicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List available models"}]
  }'

Bu OpenAI SDK uyumlu yaklaşım, size kısıtlamasız metin üretimi sağlar. Model, yasal içerikler için gereksiz reddetmeler olmadan karmaşık istekleri işler.

SSE ile Akış Yanıtları

Ayarlayarak akışı etkinleştirin stream: true. Yanıtlar Sunucu Tarafından Olaylar (SSE) üzerinden gelir. Token kullanım detayları son parçada görünür. Bu OpenAI uyumlu API belgeleri standart akış protokollerini destekler. Gerçek zamanlı kullanıcı deneyimleri için bunu kullanın:

Copyfrom openai import OpenAI

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

Akış, algılanan gecikmeyi önemli ölçüde azaltır. Standart istemci tarafı kütüphaneleriyle sorunsuz çalışır.

Parametreler: Sıcaklık, Top-P ve Araçlar

Standart parametreleri kullanarak üretimi kontrol edin. Ayarlayın temperature rastgelelik veya top_p nükleus ökleme için. Etkinleştirin tools işlev çağrısı için. JSON modu şunu kullanarak mevcuttur response_format. The uncensored model bu kısıtlamaları etkili bir şekilde dikkate alır:

Copyimport OpenAI from "openai";

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

Bu parametreler, programatik kullanım durumları için sıkı JSON yapılarını zorlayarak çıktı stilinde ince ayar yapmanıza olanak tanır.

Limitler: Hız Limitleri ve Gövde Boyutu

Her anahtar dakikada 300 istek yapmanıza olanak tanır. Eşzamanlı istekler anahtar başına 8 ile sınırlıdır. Maksimum istek gövdesi boyutu 8 MB'dır. Bağlam penceresi toplamda 100,000 token destekler. 401 hatalarını anahtarınızı kontrol ederek yönetin. 402 hatalarını kredi yükleyerek çözün. 429 hatalarını geri çekilme mantığı uygulayarak yönetin.

Akış

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)