KiApi Dokümantasyonu: 5 dakikada entegrasyon

Başlangıç: Temel URL ve Kimlik Doğrulama

KiApi, OpenAI API'si ile tamamen uyumludur. base_url değerini değiştirerek mevcut SDK ve istemci ekosistemini kullanabilirsiniz. Tüm istekler için temel URL https://api.kiapis.com/v1 şeklindedir. Kimlik doğrulama yalnızca kayıt sonrası kontrol panelinizde alacağınız bir API anahtarı ile yapılır. Bu anahtar, Authorization: Bearer <IHR_API_SCHLÜSSEL> HTTP başlığında gönderilmelidir. İstediğiniz zaman yeni bir anahtar oluşturabilirsiniz; bu durumda eski anahtar geçersiz olur.

Diğer hizmetlerin aksine, gömme (embedding) veya ince ayar için karmaşık uç noktalar sunmuyoruz. Odak noktamız saf metin üretimidir. KiApi, sansürsüz yanıtlar için optimize edilmiş bir modele doğrudan bağlantınızdır. İlk isteğinizi göndermeden önce ortamınızı doğru yapılandırdığınızdan emin olun.

POST /v1/chat/completions: Metin Üretimi

API'nin kalbi POST /v1/chat/completions uç noktasıdır. Burada bir mesaj listesi (Sistem, Kullanıcı, Asistan) gönderir ve metinsel bir yanıt alırsınız. Model kimliği parametresi uncensored olarak ayarlanmalıdır. Yanıt senkrondur ve oluşturulan metin parçasını ile token kullanım metadatalarını hemen içerir.

İstek yapısı standart formatı takip eder. Bağlamı net bir şekilde yapılandırmak için roller tanımlayabilirsiniz. Sistem girdiyi işler ve modelin öğrendiği davranışlara dayanarak bir yanıt oluşturur. Bu, sohbet botlarından metin analizine kadar neredeyse tüm metin uygulamaları için birincil yöntemdir.

Kopierencurl https://api.kiapis.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."}]
  }'

Yanıt, oluşturulan içerikleri içeren bir JSON nesnesi içerir. Uygulamanızda kullanmak için content alanını yanıtından çıkardığınızdan emin olun. Standart yanıtta istek başına maliyet gibi ek metadatalar döndürülmez; bunları kontrol panelinde bulabilirsiniz.

Sunucu Gönderilen Etkinlikler (SSE) ile Akış

Anlık çıktıya ihtiyaç duyan uygulamalar için KiApi, Sunucu Gönderilen Etkinlikler (SSE) üzerinden akış desteği sağlar. Bunu etkinleştirmek için istek gövdesinde "stream": true ayarlayın. Tam bir yanıtı beklemek yerine, oluşturulan metni kademeli olarak içeren JSON yamaları akışı alırsınız.

Bu, anlık geri bildirim kullanıcı deneyimini iyileştirdiği için sohbet arayüzleri için özellikle faydalıdır. KiApi bir akış API'si olarak gecikmeyi azaltmanıza ve gerçek zamanlı bir konuşma hissi yaratmanıza olanak tanır. İstemci, akış sonu bildirilene kadar akışı ayrıştırmalı ve parçaları birleştirmelidir.

Kopierenstream = 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)

Akış sırasında token kullanım istatistikleri genellikle akışın sonunda, son olayda döndürülür. Bu, gerçek üretim uzunluğuna dayalı hassas faturalandırmaya olanak tanır. Kaynakları doğru şekilde serbest bırakmak için istemci kodunuzun akış sonunu işlediğinden emin olun.

Araç Çağırma ve Fonksiyon Çağrıları

Model, Araç Çağırma (Function Calling) olarak bilinen özelliği destekler. Bu, LLM'in uygulamanızdaki belirli işlevleri veya eylemleri temsil eden yapılandırılmış JSON verileri döndürmesini sağlar. Kullanılabilir araçları istek gövdesinde tanımlarsınız ve model, kullanıcı girdisine dayanarak bir aracın ne zaman çağrılacağına karar verir.

Araç tanımlarının yapısı OpenAI standardını takip eder. Birden fazla araç belirtebilir ve model en uygun olanı seçer. Yanıt, arka uç mantığınızda çalıştırabileceğiniz bir araç çağrıları listesi içerir. Bu, KiApi'in yeteneklerini saf metin üretiminden çok ötesine taşır.

Kopierenfrom openai import OpenAI

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

Araç Çağırma'yı kullanarak karmaşık iş akışlarını otomatikleştirin. Model, araç için parametreleri doğrudan JSON formatında sağlar. Yanıt için harici ayrıştırıcılar kullanmanıza gerek yoktur çünkü yapı doğrudan modelden gelir. Bu, mevcut sistemlere entegrasyonu önemli ölçüde daha kolay ve güvenilir hale getirir.

GET /v1/models: Mevcut Modeller

GET /v1/models uç noktası, API üzerinden erişilebilen mevcut modelleri listeler. Bu, hangi modellerin mevcut olduğunu dinamik olarak kontrol etmek veya model kimliğini onaylamak için faydalıdır. Genellikle uncensored modelini içeren bir liste alırsınız.

Yanıt, modelle ilgili metadatalar (kimlik, sahibi, oluşturulma tarihi) içerir. Bazı diğer API'lerin aksine, standart yanıt doğrudan maksimum bağlam uzunluğunu veya spesifik fiyatları içermez. Bu bilgiler kılavuzdan veya kontrol panelinden alınmalıdır. Ancak bu uç nokta, istemci otomatik yapılandırması için vazgeçilmezdir.

Kopierenimport OpenAI from "openai";

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

Uygulamanızı gelecekteki değişikliklere uyarlamak için bu uç noktayı kullanın. Yeni modeller eklendiğinde, bu listede otomatik olarak görünecektir. Mevcut uncensored modeli tek mevcut modeldir ve sansürsüz içerikler için optimize edilmiş büyük bir dil modeli olarak tanımlanır.

Hız Limitleri ve Hata Kodları

Hizmetin istikrarını sağlamak için belirli limitler geçerlidir. API anahtarı başına dakikada 300 istek izniniz vardır. Maksimum istek gövdesi 8 MB'tır. Bu limitleri aşarsanız HTTP 429 Too Many Requests durum kodunu alırsınız. Yeniden denemeleri üstel geri çekilme ile uygulayacak şekilde uygulamanızı planlayın.

Diğer yaygın hata kodları arasında API anahtarı geçersizse 401 Unauthorized ve bakiyeniz tükendiğinde 402 Payment Required bulunur. KiApi ön ödemeli bir model kullandığından, bakiyesi olmayan istekler hemen reddedilir. Hesap bakiyelerinizi düzenli olarak kontrol ettiğinizden emin olun.

Bağlam penceresi, girdi ve çıktı toplamı için 100.000 token'dır. Bu limiti aşarsanız bir hata mesajı döndürülür. KiApi, net kuralları ve şeffaf limitleri seven geliştiriciler için güvenilir bir çözümdür.