API Dokümantasyonu

İlk isteğinizi hızlandırın

İstemcinizi temel URL'mize yönlendirerek ve oluşturulmuş bir API anahtarıyla kimlik doğrulaması yaparak hemen metin üretmeye başlayın. Arayüz standart kuralları izler, bu nedenle yeni bir protokol öğrenmeden mevcut SDK'ları kullanabilirsiniz. İstemleriniz şuna gönderilecektir uncensored model ve yasal yetişkin kullanım için tipik içerik filtreleri uygulanmayan metin yanıtları alın.

Temel URL'yi ve anahtarı yapılandırın

İsteklerinizi özel uç noktamıza yönlendirmek için ortam değişkenlerinizi ayarlayın. Yer tutucu anahtar yerine kayıt sırasında oluşturulan anahtarı kullanın. Bu, tüm sonraki çağrıların doğru uncensored model örneğini kullandığını sağlar.

• Temel URL: https://api.nsfwlocalllm.com/v1
• Auth Header: Authorization: Bearer YOUR_API_KEY

Anahtarınızın çalıştığını modeller endpoint'ini kontrol ederek doğrulayabilirsiniz. Geçerli bir anahtar, mevcut model ID'sini hemen döndürür.

Bir sohbet tamamlama isteği gönderin

Metin oluşturmak için standart bir chat completion yükü gönderin. Sistem girdinizi işler ve modelin yanıtını döndürür. Kullanın uncensored filtresiz örneğe eriştiğinizden emin olmak için model kimliği.

Yanıt, oluşturulan metni ve token kullanım istatistiklerini içerir. Bu verileri doğrudan uygulama mantığınıza ayrıştırabilirsiniz.

Copycurl https://api.nsfwlocalllm.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Send me the server uptime stats"}]
  }'

Başarı veya hata durumlarını işlemek için standart HTTP durum kodlarını kontrol edin.

Gerçek zamanlı çıktı için akışı etkinleştirin

Kullanıcılarınız için algılanan gecikmeyi azaltmak için akış yanıtları yapın. Akışı etkinleştirmek için ayarlayın stream: true istemci gövnenizde. API, kısmi tokenlar içeren bir dizi Sunucu Tarafı Olayları (SSE) döndürür.

Bu tokenları istemci tarafında birleştirerek tam mesajı yeniden oluşturun. Bu yaklaşım, anlık geri bildirimin önemli olduğu sohbet arayüzleri için idealdir. Son SSE olayı, istek için toplam token kullanımını içerir.

Copyfrom openai import OpenAI

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

Sorunsuz bir kullanıcı deneyimi sağlamak için bağlantı hatalarını zarif bir şekilde yönetin.

Yapılandırılmış veri için JSON modu kullanın

Programatik kullanım için modelin geçerli JSON çıktısı vermesini sağlayın. Parametreyi ayarlayın response_format için {"type": "json_object"} istekinizde. Bu, ayrıştırma hatalarını azaltır ve tutarlı veri yapıları sağlar.

Yapılandırılmış promptlar oluşturmak, varlıkları çıkarmak veya dinamik içerik oluşturmak için bunu kullanın. Model, sistem talimatlarınızda sağlanan format kısıtlamalarına uyum sağlar. Bu, diğer hizmetlerle güvenilir entegrasyon için kritiktir.

Copyimport OpenAI from "openai";

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

Kenar durumları yakalamak için çıktı JSON'unu tarafınızda doğrulayın.

İşlev çağrısını uygulayın

Modelin yeteneklerini genişletmek için araçları tanımlayın. Bir tools en az bir kullanıcı mesajı içeren dizi. API metin girdisi bekler ve metin çıktısı döndürür. Bu sadelik, karmaşık yük yapılarıyla uğraşmadan hızlı prototipleme imkanı sağlar.

Bu, LLM'in veri çekme veya eylem gerçekleştirme zamanını belirlediği karmaşık iş akışlarını mümkün kılar. Yanıtta fonksiyon argümanlarını alırsınız ve bunları tarafınızda yürütürsünüz. Daha fazla muhakeme için sonuçları modele geri iletin.

Ayarla tool_choice için auto esnek karar verme için. Bu özellik, harici veri erişimi gerektiren gelişmiş rol yapma senaryolarını destekler.

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)