Hızlı Başlangıç: AI Arkadaş API'sini Entegre Etme

Temel URL ve Kimlik Doğrulama

API'miz OpenAI chat-completions standardını takip eder, bu da mevcut istemciler için entegrasyonu kolaylaştırır. Her istekte API anahtarınızı Authorization başlığında dahil etmelisiniz. Tüm uç noktalar için temel URL https://api.roleplayapi.com/v1 şeklindedir. Resmi SDK'ları kullanırken, bu adresi gösterecek şekilde base_url yapılandırmasını güncelleyin ve anahtarınızı api_key olarak sağlayın. Bu kurulum, isteklerinizin standart mantığınıza herhangi bir değişiklik yapmadan özel sansürsüz uç noktamıza ulaşmasını sağlar.

Tamamlama Gönderme

Bir konuşmaya /v1/chat/completions uç noktasına POST isteği göndererek başlayın. Model tanımlayıcısı uncensored'dir. Bağlamı oluşturmak veya yeni bir diyalog başlatmak için messages dizisine istediğiniz sayıda mesaj iletebilirsiniz. Yanıt, modelin metin çıktısını içerir; bunu akış olarak iletebilir veya JSON nesnesi olarak ayrıştırabilirsiniz. Bu uç nokta, karakter odaklı uygulamalar için gerekli olan metin-giriş, metin-çıktı etkileşimini yönetir.

Copycurl https://api.roleplayapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

Python SDK Entegrasyonu

API ile minimum kod yazarak etkileşim kurmak için resmi openai Python kütüphanesini kullanın. İstemciyi temel URL'niz ve API anahtarınızla yapılandırın. Ardından, uncensored model kimliği ile chat.completions.create çağrısını yapın. Bu yaklaşım mevcut tür ipuçlarını ve hata işleme mekanizmalarını kullanır, böylece HTTP ayrıştırma yerine uygulama mantığınıza odaklanabilirsiniz. Yanıt nesnesi, oluşturulan içeriğe doğrudan erişim sağlar.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.roleplayapi.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 SDK Entegrasyonu

JavaScript ve TypeScript projeleri için OpenAI Node SDK'si, API çağrıları için temiz bir arayüz sağlar. İstemciyi özel temel URL ile gizli anahtarınızı kullanarak başlatın. uncensored modelini kullanarak sohbet tamamlama uç noktasını çağırın. Bu yöntem, eşzamanlı istekleri verimli bir şekilde yönetmeniz gereken web sunucuları veya kenar işlevleri için idealdir. SDK, JSON yükünün serileştirilmesini ve serileştirilmemiş hale getirme işlemini otomatik olarak halleder.

Copyimport OpenAI from "openai";

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

Akışı Etkinleştirme

Sunucu tarafından gönderilen olayları (SSE) etkinleştirerek algılanan gecikmeyi azaltın. İsteğinizde stream parametresini true olarak ayarlayın. API, tek bir tam yanıt yerine bir veri akışı döndürecektir. Bu, kullanıcıların anlık karakter yanıtları beklediği sohbet arayüzleri için özellikle yararlıdır. Her parçayı geldiği şekilde işleyebilir kullanıcı arayüzünü kademeli olarak güncelleyebilirsiniz. Akış, model token dizisinin oluşturulmasını tamamladığında sona erer.

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)

Limitler, Hatalar ve Bağlam

İstekleriniz dakikada anahtar başına 300 isteklik bir hız limitine tabidir. Bu limiti aşarsanız API 429 durum kodunu döndürür. Kimlik doğrulama hataları 401 hatasına, yetersiz ön ödemeli kredi ise 402 hatasına neden olur. Bağlam penceresi, birleşik istem ve tamamlama için 100.000 token'a kadar destekler. Mevcut modelleri kontrol etmeniz gerekiyorsa, /v1/models adresine GET isteği gönderin. İstek gövdenizin 8 MB'ı aşmadığından emin olun.