API Dokümantasyonu & Hızlı Başlangıç

Temel URL ve Kimlik Doğrulama

Bağlanmak için temel URL'mizi ve tek bir API anahtarını kullanın. Uç nokta standart başlıkları kabul eder. Değiştirin YOUR_API_KEY panonuzdaki dize ile.

• Temel URL: https://api.ollamaopenaicompatibleapi.com/v1
• Model Kimliği: uncensored

Kimlik doğrulama bir bearer jetonuna dayanır. Bunu Authorization header. Bu, herhangi bir OpenAI SDK uyumlu istemci ile uyumluluğu sağlar. Anahtarınızı Google veya e-posta ile anında oluşturabilirsiniz. Telefon numarası gerekmez.

Sohbet Tamamlamaları Uç Noktası

Şuraya bir POST isteği gönderin /v1/chat/completions. messages dizinizi ve model adını ekleyin. API, prompt'unuza dayalı olarak metin çıktısı döndürür. Bu, standart parametreleri kullanan herhangi bir sağlayıcıyla çalışır.

Yaratıcılık için sıcaklığı ayarlayın veya hassasiyet için düşük tutun. Durdurma dizilerini de tanımlayabilirsiniz. Sunucu isteği işler ve tamamlamayı döndürür. Bu, çoğu entegrasyon için temel etkileşimdir.

Hatalar ön ödemeli bakiyenizi tüketmez. Yalnızca başarılı tamamlamalar faturalandırılır. Bu, hata ayıklama aşamalarında bütçenizi korur.

Copycurl https://api.ollamaopenaicompatibleapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 10 Linux kernel security patches from 2023"}]
  }'

SSE Üzerinden Akış Yanıtları

Ayarlayarak akışı etkinleştirin stream: true. Sunucu, oluşturuldukları gibi parçalar gönderir. Bu, algılanan gecikmeyi önemli ölçüde azaltır. Kısmi yanıtları gerçek zamanlı olarak alırsınız.

Sunucu Tarafından Gönderilen Olaylar (SSE) akışını ayrıştırın. Son parça kullanım istatistiklerini içerir. Bu, hem giriş hem de çıktı için token sayılarını içerir. Maliyetleri üretim sırasında dinamik olarak izleyebilirsiniz.

Bu yaklaşım sohbet arayüzleri için iyi çalışır. Kullanıcılar metnin kelime kelime belirdiğini görür. Tam yanıtı beklemekten daha hızlı hissettirir. API bağlantı stabilitesini otomatik olarak yönetir.

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)

Fonksiyon Çağırma ve JSON Modu

İstek gövnenize araçlar tanımlayın. Model yapılandırılmış veriler üretebilir. Kullanın response_format ile {"type": "json_object"} katı JSON için. Bu, her seferinde ayrıştırılabilir bir çıktı sağlar.

Araç tanımlamaları ad, açıklama ve parametreler içerir. Model hangi aracı çağıracağına karar verir. İşlevi yürütür ve sonuçları geri beslersiniz. Bu, karmaşık ajan iş akışlarını mümkün kılar.

JSON modu serbest metin üretimini devre dışı bırakır. Modeli şemanıza uymaya zorlar. Veritabanlarına veya API'lere entegre ederken bunu kullanın. Yapılandırılmış alanlardaki halüsinasyonu azaltır.

Copyfrom openai import OpenAI

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

Saniye Başına İstek Limitleri ve İstek Gövdeleri

Anahtar başına dakikada 300 istek alırsınız. Eşzamanlılık, eşzamanlı 8 istekle sınırlıdır. Maksimum istek gövdesi boyutu 8 MB'tır. Bu, çoğu metin ağırlıklı uygulama için uygundur.

Bağlam penceresi toplamda 100.000 token'a izin verir. Bu hem istem hem de tamamlama tokenlarını içerir. İste başına maksimum çıktı 16.000 tokendır. Eğer max_tokens, varsayılan olarak 2.048'e düşer.

HTTP 429 hatalarını zarifçe yönetin. Hız sınırına ulaştığınızı gösterirler. İstemci kodunuzda üstel geri çekilme uygulayın. Bu, dalgalanmalar sırasında sunucuyu aşırı yüklemeyi önler.

Copyimport OpenAI from "openai";

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

Kimlik Doğrulama Hataları ve Limitler

401 durumu, anahtarınızın geçersiz olduğunu gösterir. Yazım hatalarını veya süresi dolmuş oturumları kontrol edin. 402 durumu yetersiz bakiye olduğunu belirtir. Servisi devam ettirmek için kripto ile yükleyin.

Bir 429 durumu hız sınırlamasını işaret eder. Dakikada 300 isteği aştınız. İş akışınızı azaltın veya anahtarınızı yükseltin. API, net hata mesajları döndürür.

Kredi süresi dolmaz. İstediğiniz zaman yükleyebilirsiniz. Minimum yükleme $20'dir. Daha büyük miktarlar için bonus krediler uygulanır. Bu, projenizin sorunsuz çalışmasını sağlar.