Belge özeti
Zaten OpenAI ile konuşan kodunuz varsa, OpenAI uyumlu API belgesinin kısa versiyonu şudur: base URL'yi değiştirin, anahtarı değiştirin, modeli uncensored olarak ayarlayın. İstek ve yanıt gövdeleri chat completions şekline uyar, bu nedenle SDK'lar değişiklik olmadan ayrıştırır.
| Öğe | Değer |
|---|---|
| Temel URL | https://api.unrestrictedaiapi.com/v1 |
| Kimlik Doğrulama | Authorization: Bearer YOUR_KEY |
| Uç noktalar | POST /v1/chat/completions, GET /v1/models |
| Model kimliği | uncensored |
| Bağlam penceresi | 100.000 token, istem plus tamamlama |
| Maksimum istek gövdesi | 8 MB |
| Çıktı | Sadece metin |
Model, bağımsız bir sağlayıcı tarafından yürütülen ve yasal yetişkin kullanım için içerik reddetmeleri olmadan cevap vermeye ayarlanmış tek bir açık ağırlıklı modeldir. Herhangi bir model satıcısının resmi uç noktası değildir ve satıcılar arasında yönlendirme yapmaz. Bu nedenle tek bir model ID'si vardır ve model listesi kısadır.
Uç noktalar
GET /v1/models
Anahtarınıza mevcut olan modelleri döndürür. Anahtarınızın ve base URL'nizin doğru olduğunu onaylamanın en ucuz yoludur ve birçok UI istemcisi bir açılır menüyü doldurmak için bunu çağırır.
curl https://api.unrestrictedaiapi.com/v1/models \
-H "Authorization: Bearer $KEY"
POST /v1/chat/completions
Tek üretim uç noktasıdır. Bir messages nesne dizisi gönderirsiniz; bu dizide bir role (system, user, assistant veya tool) ve content bulunur, ayrıca model ve herhangi bir örnekleme seçenekleri. Minimal bir çağrı:
curl https://api.unrestrictedaiapi.com/v1/chat/completions \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [
{"role": "system", "content": "Answer in one sentence."},
{"role": "user", "content": "What is a base URL?"}
]
}'
Yanıt, oluşturulan metni choices[0].message.content içinde ve token sayılarını usage içinde taşır. Bu sayılar faturalamanın temelidir.
Teklif edilmez: eski completions uç noktası, embeddings, görsel, ses ve video uç noktaları, ince ayar ve dosya uç noktaları. Bunları çağıran bir istemci bir hata alacaktır, bu nedenle varsayılan olarak bunları kullanan araçlarda bu özellikleri devre dışı bırakın.
İstek parametreleri
Bu parametreler kabul edilir ve modele iletilir:
- Örnekleme için
temperaturevetop_p. - Bir veya daha fazla durma dizisi için
stop. - Diğer her şeyi eşit tuttuğunuzda tekrarlanabilir örnekleme için
seed. - Tekrarlamayı azaltmak için
presence_penaltyvefrequency_penalty. max_tokens, isteğe bağlıdır. Bırakırsanız, tamamlama 100.000 token penceresinin geri kalanını kullanabilir.stream, sunucu tarafından gönderilen olaylar (SSE) içindir.- Fonksiyon çağırma için
toolsvetool_choice. - JSON modu için
response_formatile{"type":"json_object"}.
İki pratik not. İlk olarak, pencere istem ve tamamlamayı birlikte sayar, bu nedenle 90.000 tokenlik bir istem, cevap için yaklaşık 10.000 token bırakır. İkinci olarak, gövde limiti 8 MB'tır, bu da 100.000 tokenlik metnin ihtiyacından çok daha fazladır, bu nedenle büyük kodlanmış yükleri mesajlarda gömerek bu limite ulaşırsınız.
Akış
stream: true ayarlayın ve yanıt sunucu tarafından gönderilen olaylar olarak gelir. Her olay, bir delta içeren bir JSON parçasıdır ve akışın sonunda kullanım raporlanır. SDK'lar çerçeveyi gizler; ham protokolle, akış kapanana kadar data: ile başlayan satırları okursunuz.
from openai import OpenAI
client = OpenAI(base_url="https://api.unrestrictedaiapi.com/v1", api_key="YOUR_KEY")
with client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "List five HTTP status codes."}],
stream=True,
) as stream:
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="")
Kapasite planlamasını etkileyen bir kural şudur: akışlı bir istek, ilk token'ı gönderene kadar değil, akış sona erene kadar eşzamanlılık slotunu tutar. Bir istemci okuma sırasında takılırsa, bu slotu meşgul tutar. Akışı her zaman kapatın veya sonlandırın ve bir istemci zaman aşımı ayarlayın.
Araç çağırma ve JSON modu
Araç çağırma
JSON Schema parametreleri ile bir fonksiyon tanımı listesi olarak tools geçirin. Model birini çağırmaya karar verirse, mesaj tool_calls içerir; bu da stream açıkken akışlanır. Fonksiyonu çalıştırın ve sonucunu role: "tool" ve eşleşen tool_call_id ile bir mesaj olarak gönderin. tool_choice kullanarak belirli bir fonksiyonu zorlayın veya kararı modele bırakın.
{
"model": "uncensored",
"messages": [{"role": "user", "content": "Weather in Oslo?"}],
"tools": [{
"type": "function",
"function": {
"name": "get_weather",
"description": "Current weather for a city",
"parameters": {
"type": "object",
"properties": {"city": {"type": "string"}},
"required": ["city"]
}
}
}]
}
Model argümanlar önerir; hiçbir şey yürütmez. Herhangi bir kullanıcı girdisiyle yapacağınız gibi, eyleme geçmeden önce bunları doğrulayın.
JSON modu
Tek geçerli bir JSON nesnesi istemek için "response_format": {"type": "json_object"} ekleyin. Diğer OpenAI tarzı uygulamalarla birlikte, istemde istediğiniz anahtarları modele de söyleyin, örneğin "title ve tags anahtarlarına sahip bir nesne döndürün". Sonucu yine de bir try bloğunda ayrıştırın ve uzun bir nesnenin kesilmemesi için max_tokens'ı cömert tutun.
Sınırlar, başlıklar ve hatalar
| Anahtar türü | Eşzamanlı istekler | Dakikada istek |
|---|---|---|
| Tam anahtar | 8 | 300 |
| Deneme anahtarı | 2 | 60 |
Her yanıt X-Request-Id (support ile iletişime geçerken alıntılayın), X-Balance-USD (kalan krediniz), X-RateLimit-Limit-Requests ve X-RateLimit-Limit-Concurrency içerir.
Bir limiti geçtiğinizde API HTTP 429 döndürür. Hata kodu durumları ayırır:
rate_limited: bir dakikada çok fazla istek. Yavaşlayın veya yükü dağıtın.concurrency: aynı anda uçuşta çok fazla istek. Kendi tarafınızda sıraya alın.Retry-After: 5başlığıyla 429: geçici aşırı yüklenme. Beş saniye bekleyin ve yeniden deneyin.
import time
import httpx
def post_with_retry(payload, key, tries=4):
# payload example: {"model": "uncensored", "messages": [...]}
for attempt in range(tries):
r = httpx.post(
"https://api.unrestrictedaiapi.com/v1/chat/completions",
headers={"Authorization": "Bearer " + key},
json=payload,
timeout=120,
)
if r.status_code == 429:
wait = int(r.headers.get("Retry-After", 2 ** attempt))
time.sleep(wait)
continue
return r
return r
Başarısız olan veya reddedilen istekler için ücret alınmaz.
Roller, geçmiş ve yanıt nesnesi
API statesizdir. Önceki istekleri hatırlamaz, bu nedenle bir konuşma yalnızca her seferinde gönderdiğiniz messages dizisi olarak vardır. Tipik bir geçmiş, davranışı belirleyen bir system mesajıyla başlar, ardından değişen user ve assistant mesajları gelir. Fonksiyon çağırma devrede olduğunda, tool mesajları bunların arasında görünür, her biri tool_call_id ile cevap verdiği çağrıya bağlanır.
Bunun iki sonucu vardır. Birincisi maliyettir: her dönüş, tüm geçmişi girdi olarak öder, bu nedenle uzun bir sohbet, her soru kısa olsa bile mesaj başına daha pahalı hale gelir. İkincisi kontroldür: geçmişi istediğiniz gibi düzenleyebilir, kısaltabilir veya yeniden yazabilirsiniz. En eski dönüşleri bırakmak, onları bir özetle değiştirmek veya düzeltilmiş bir assistant mesajı enjekte etmek sıradan işlemlerdir ve model size ne gönderirseniz onu gerçek olarak kabul eder.
Geri dönerken üç şeyi okuyun. choices[0].message metni veya araç çağrılarını içerir. choices[0].finish_reason üretimin neden durduğunu belirtir: doğal bir son, token limiti veya bir araç çağrısı. usage istem, tamamlama ve toplam token sayılarını içerir. Finish reason, token limitinin aşıldığını belirtiyorsa metin kesilmiştir; limiti artırmalı veya modeli bir sonraki adımda devam etmesi için yönlendirmelisiniz.
Kısa bir uyumluluk kontrol listesi
Bu uç noktaya bir istemci göndermeden önce, bu kontrolleri uygulayın. Entegrasyon sorunlarının çoğunu birkaç dakikada yakalarlar.
- Anahtarınızla
GET /v1/modelsçağırın veuncensorediçeren bir liste aldığınızı onaylayın. - Seçenekler olmadan düz bir sohbet isteği gönderin ve normal bir yanıt aldığınızı
usagebloğu ile onaylayın. stream: trueile tekrarlayın ve istemcinizin akışın sonunu ve nihai kullanım verilerini işlediğini onaylayın.- Araçlar kullanıyorsanız,
toolmesajını içeren takip isteği dahil olmak üzere bir araç çağrısı dönüşünü uçtan uca gönderin. - Bir deneme anahtarında aynı anda 10 istek gönderin ve kodunuzun ikinci eşzamanlı istek takip eden 429 ile başa çıktığını onaylayın.
- Her çağrı için
X-Request-Id'ı günlüğe kaydedin, böylece herhangi bir tuhaf sonuç daha sonra izlenebilir.
Altı kontrolün tümünü geçmek, istemcinizin gerçek trafik için hazır olduğunu gösterir.
Bunun tam OpenAI platformundan nasıl farklı olduğu
Uyumluluk chat protokolünü ifade eder, tüm platformu değil. Metin sohbeti dışındaki her şey yoktur ve birkaç davranış protokolden ziyade modelden kaynaklanır. Model adı sabittir, cevaplar daha önce kullandığınız herhangi bir modelden tarz olarak farklı olabilir ve aynı seed ile örnekleme, istem ve parametreler aynı kaldığı sürece tekrarlanabilirdir.
Değiştiremeyeceğiniz tek içerik kuralı, reşit olmayanlarla ilgili cinsel içeriklerin engellenmesidir. Bunun dışında model, yasal yetişkin kullanımlarında reddetmelerden kaçacak şekilde ayarlanmıştır ve istemler eğitim için kullanılmaz.
Beş dilde kod için hızlı başlangıç sayfasına bakın, sansürsüz bir modele istem yazma konusunda ipuçları için okuyun ve hesap tarafı için fiyatlandırma oranları listeler: 1M giriş token başına $0.15 ve 1M çıkış token başına $0.50, süresi dolmayan kredi ile. dokümantasyon aynı spec'i kısa formda içerir.
