Dokumentasi API

Pengesahan dan URL Asas

API memerlukan satu kunci API untuk pengesahan. Anda menerima kunci ini serta-merta selepas mendaftar masuk dengan Google atau alamat e-mel. Luluskan dalam Authorization pencap sebagai token Bearer. URL asas adalah https://api.topuncensored.com/v1. URL ini berfungsi dengan mana-mana SDK atau perpustakaan klien serasi OpenAI.

• Gunakan header: Authorization: Bearer YOUR_API_KEY
• Tetapkan URL asas klien anda ke hujung titik yang disediakan.

Konfigurasi ini memastikan anda boleh menukar perpustakaan tanpa mengubah logik teras anda.

Copycurl https://api.topuncensored.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate a list of ten distinct UI layout patterns."}]
  }'

Hujung Sambungan Penyelesaian Sembang

Hantar prompt teks ke /v1/chat/completions endpoint. ID model ialah uncensored. Hujung sambungan ini mengendalikan format perbualan piawai dengan mesej. Ia mengembalikan respons teks secara langsung. Tiada lapisan atau pembungkus tambahan. Anda mengawal tetingkap konteks 100,000 token. Permintaan bawah 8 MB berfungsi dengan boleh dipercayai. Gunakan ini untuk penjanaan teks langsung.

Struktur permintaan anda dengan prompt sistem dan mesej pengguna. Model memberi respons tanpa menapis kandungan dewasa yang sah. Kesilapan seperti kunci yang hilang memulangkan 401. Habis kredit? Anda mendapat ralat 402. Ini adalah isyarat yang jelas.

Respons Streaming

Aktifkan aliran dengan menetapkan stream: true. Anda menerima potongan teks semasa ia dijana. Ini mengurangkan latensi yang dirasakan untuk output yang panjang. Potongan terakhir termasuk data penggunaan token. Gunakan ini untuk paparan masa nyata atau pemprosesan berperingkat. Ia cekap untuk aplikasi berisipadat tinggi.

Uraikan setiap pecahan untuk membina respons akhir anda. Kaedah ini mengendalikan output besar dengan baik. API menyokong Server-Sent Events piawai. Ini adalah pendekatan yang disyorkan untuk aplikasi interaktif.

Copyfrom openai import OpenAI

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

Pemanggilan Alat dan Mod JSON

Gunakan panggilan fungsi untuk interaksi berstruktur. Takrifkan alat dalam permintaan anda. Model mengembalikan hujah berstruktur. Tetapkan response_format ke {"type": "json_object"} untuk output JSON ketat. Ini memastikan format data yang boleh diramal. Gabungkan ciri-ciri ini untuk integrasi yang kukuh. Anda mendapat kawalan tepat terhadap struktur output.

Pemanggilan alat berfungsi dengan skema OpenAI piawai. Mod JSON memaksa JSON yang sah. Gunakan ini untuk integrasi API atau pengekstrakan data. Fleksibiliti ini menyokong aliran kerja kompleks.

Copyimport OpenAI from "openai";

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

Parameter dan Had

Laraskan temperature, top_p, dan stop urutan. Tetapkan max_tokens to 16,000. Default is 2,048 if omitted. Control repetition with presence_penalty dan frequency_penalty. Gunakan seed untuk output deterministik. Parameter ini menala kualiti penjanaan. Anda mempunyai kawalan penuh ke atas gaya output.

Had laju adalah 300 permintaan setiap minit. Permintaan serentak dihadkan kepada 8. Had ini memastikan prestasi yang stabil. Pantau penggunaan anda melalui papan pemuka. Laraskan parameter untuk mengoptimumkan mengikut kes penggunaan khusus anda.

Ralau dan Jendela Konteks

Tangani ralat dengan anggun. 401 bermaksud kunci tidak sah. 402 menunjukkan kredit tidak mencukupi. 429 menandakan had kadar. Jendela konteks ialah 100,000 token secara keseluruhan. Output maksimum ialah 16,000 token. Uruskan token anda dengan bijak. Ralat tidak menggunakan kredit. Ini menjimatkan wang semasa nyahpepijat. Gunakan pecahan terakhir untuk statistik penggunaan.

Jejaki penggunaan token anda. Elakkan melanggar had kadar. Cuba semula dengan penangguhan eksponen. Ini memastikan operasi yang boleh dipercayai. API direka untuk ketahanan. Tangani ralat sebagai sebahagian daripada aliran biasa.

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)