API Dokümantasyon

Temel URL ve Kimlik Doğrulama

API şurada yaşar: https://api.ollamaapidoc.com/v1. Bearer token'ı kullanarak kimlik doğrulaması yaparsınız Authorization header Anahtarınızı, panoda Google veya e-posta ile anında oluşturun. Telefon numarası gerekmez. Anahtar, temel URL'yi ayarlayarak standart OpenAI SDK'ları ile çalışır.

İlk İsteğiniz

Şuraya bir POST isteği gönderin /v1/chat/completions model kimliği ile uncensored. Bu uç nokta metin girdisi ve metin çıktısı yönetir. Akış (streaming), JSON modu ve fonksiyon çağırma (function calling) destekler. Modeller uç noktasını kontrol ederek kredi harcamadan bağlantıyı test edebilirsiniz.

Copycurl https://api.ollamaapidoc.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list all installed models"}]
  }'

Yanıt, standart OpenAI biçimlendirmesini döndürür. Hatalar uygun HTTP kodlarını döndürür. Gövdeyi error bir şeyler ters gittiğinde detaylar. Akış yanıtları Sunucu Tarafından Gönderilen Olayları (SSE) kullanır.

Python SDK Entegrasyonu

Resmi OpenAI kitaplığını yükleyin. İstemciyi temel URL'niz ve API anahtarınızla yapılandırın. chat tamamlamaları uç noktasını çağırın. Kod, standart OpenAI kullanımıyla aynı kalır. Bu, mevcut projeler için kolay geçişi sağlar. Sıcaklık ve top_p gibi parametreleri çağrı içinde doğrudan ayarlayabilirsiniz.

Copyfrom openai import OpenAI

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

Hız sınımları veya geçersiz anahtarlar için istisnaları yönetin. Kütüphane, stream parametresini true olarak ayarlarsanız tokenları akış olarak gönderir. Bu yaklaşım kod tabanınızı temiz ve uyumlu tutar.

Node.js SDK Kurulumu

Şu openai npm paketi. İstemciyi özel base URL ile başlatın. API anahtarınızı iletin. Sözdizimi Python örneğini yansıtır. Bu tutarlılık hata ayıklama süresini azaltır. Sohbet geçmişi dizisinde birden fazla mesaj gönderebilirsiniz.

Copyimport OpenAI from "openai";

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

Yanıtı dikkatlice ayrıştırın. API yapılandırılmış JSON döndürür. Üretim uygulamaları için hata yönetimi kritiktir. Ağ hatalarını ve API'ye özgü hataları ayrı ayrı yakalayın. Bu, yüksek trafik sırasında uygulamanızın yanıt vermeye devam etmesini sağlar.

Streaming ve JSON Modu

Akışı etkinleştirmek için stream parametresini true olarak ayarlayın. API, belirteçleri Sunucu Tarafından Gönderilen Olaylar aracılığıyla gönderir. Kısmi yanıtları gerçek zamanlı olarak alırsınız. Bu, uzun çıktılar için kullanıcı deneyimini iyileştirir. Ayrıca response_format. Yapılandırılmış veri çıkarma için bu faydalıdır.

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)

İşlev çağırma benzer şekilde çalışır. Araçları isteğinizde tanımlayın. Model araç çağrıları döndürür. Bu çağrıları kodunuzda ayrıştırın. Çalıştırın ve sonuçları modele geri besleyin. Bu döngü karmaşık iş akışlarını mümkün kılar.

Limitler, Hatalar ve Bağlam

Bağlam penceresi 100.000 token'dır. Maksimum çıktı istek başına 16.000 token'dır. Hatalar arasında geçersiz anahtarlar için 401 ve yetersiz kredi için 402 bulunur. Hız limitleri dakikada 300 istekle sınırlıdır. Bunları uygulamanızda zarifçe yönetin. API prompt'larınızı eğitim için kullanmaz. Gizlilik korunur. Kredi süresi dolmaz.