API Dokümantasyonu

Hızlı Başlangıç: İlk isteğinizi gönderin

İlk mesajınızı uncensored modele hemen gönderin. Metin üretmek için standart chat-completions uç noktasını kullanın. Model, yasal yetişkin kullanımı için içerik reddetmeleri olmadan doğal dil isteklerine yanıt verir. Bu kurulum herhangi bir OpenAI-uyumlu istemci ile çalışır.

Tercih ettiğiniz dil için SDK'yı yükleyerek başlayın. Ardından API anahtarınızı yapılandırın. Aşağıdaki örnek, bağlantıyı test etmek için temel bir curl isteğini gösterir.

Rastgeleliği kontrol etmek için sıcaklık gibi parametreleri ayarlayabilirsiniz. Yanıt, oluşturulan metni doğrudan döndürür. Bu basit akış, karmaşık mantık oluşturmadan önce API'nin çalıştığını doğrulamanıza olanak tanır.

Copycurl https://api.apiaicharacter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the current API rate limit status?"}]
  }'

Temel URL ve Kimlik Doğrulama

Bu API için özel temel URL'yi kullanarak bağlanın. Varsayılan uç noktayı barındırılan sunucu adresimizle değiştirin. Bu, isteklerinizin sınırlandırmasız modele doğrudan ulaşmasını sağlar. Kimlik doğrulama, hesap başına tek bir API anahtarına dayanır.

Anahtarınızı panelden oluşturun. Bearer token olarak Authorization başlığında iletin. Bu yöntem standart OpenAI SDK'ları ile uyumludur. Sağlayıcıları yalnızca temel URL'yi ve anahtarı değiştirerek değiştirebilirsiniz.

Anahtarınızı güvende tutun. Ön ödemeli kredinize tam erişim sağlar. Anahtar, oluşturulduğu anda önceki aktif anahtarı değiştirir.

Uç noktalar: Sohbet Tamamlamaları

Modelle sohbet tamamlama uç noktası üzerinden etkileşim kurun. Bu, mevcut tek metin üretme uç noktasıdır. Mesajları kabul eder ve oluşturulan metni döndürür. Gömme vektörleri, görüntüler veya ses desteklenmez.

Sohbet rotasına bir POST isteği gönderin. Gövdeye sistem ve kullanıcı mesajlarınızı dahil edin. Model bağlamı işler ve bir yanıt oluşturur. Yapılandırılmış çıktı için JSON modunu kullanabilirsiniz.

Fonksiyon çağırma desteklenir. Araçları tanımlayın ve modelin ne zaman kullanması gerektiğine karar vermesine izin verin. Bu esneklik, karmaşık ajan iş akışlarına olanak tanır. Yanıt, oluşturulan içeriği ve token kullanımını içerir.

Copyfrom openai import OpenAI

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

Parametreler: Sıcaklık, Top P ve Durdur

Çıktı stilini standart parametrelerle kontrol edin. Yaratıcılığı değiştirmek için sıcaklığı ayarlayın. Daha düşük değerler yanıtları daha belirleyici hale getirir. Daha yüksek değerler daha fazla çeşitlilik getirir.

Olası olmayan kelimeleri filtrelemek için top P'yi kullanın. Bu, yaratıcılığa izin verirken tutarlılığı korumaya yardımcı olur. Üretimi belirli işaretlerde sonlandırmak için stop dizilerini ayarlayın. Bu, diyalog yapısını kontrol etmek için faydalıdır.

Seed parametresi tekrarlanabilir sonuçlar sağlar. İstemcilerinizi hata ayıklarken kullanın. Bu parametreler, modelin davranışı üzerinde hassas kontrol sağlar. Uygulamanızın ihtiyaçlarına uyacak şekilde ince ayar yapın.

Copyimport OpenAI from "openai";

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

Streaming ve Token Kullanımı

Sunucu Tarafından Gönderilen Etkinlikler (SSE) kullanarak gerçek zamanlı yanıtlar alın. Akış, kullanıcılar için algılanan gecikmeyi azaltır. API, tokenları oluşturuldukları anda gönderir. Bu daha akıcı bir okuma deneyimi yaratır.

Token kullanımı son chunk'ta raporlanır. Bu, maliyetleri doğru takip etmenizi sağlar. Faturalandırma, tüketilen gerçek tokenlara dayanır. Hatalar ve reddedilen istekler ücretlendirilmez.

Veriyi işlemek için bir akış işleyicisi uygulayın. Tokenlar geldikçe kullanıcı arayüzünüzü güncelleyin. Bu yaklaşım sohbet arayüzleri için idealdir. Model tüm istek türleri için akış desteği sunar.

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)

Saniye Başına İstek Limitleri ve Kısıtlamalar

Servis kesintilerinden kaçınmak için limitleri anlayın. Anahtar başına dakikada 300 istek yapabilirsiniz. Eşzamanlı istekler aynı anda sekizle sınırlıdır. İstek gövdesi 8 MB'ı aşmamalıdır.

401 durumu anahtarınızın geçersiz olduğunu gösterir. 402 durumu yetersiz krediyi belirtir. 429 durumu hız sınırına ulaştığınızı işaret eder.

Bağlam penceresi toplamda 100.000 token destekler. Bu hem prompt hem de completion'u içerir. Maksimum çıktı isteği başına 16.000 token'dır. Çıktı uzunluğunu kontrol etmek için max_tokens'i ayarlayın. Hatalar ücretsizdir, bu nedenle yeniden deneme mantığı güvenlidir.