Dokumentasi API Serasi OpenAI

Mula Cepat: Sambungkan dengan SDK OpenAI

Mula dengan mengesahkan dengan kunci anda dan arahkan klien ke URL asas kami. Setup ini berfungsi dengan SDK rasmi OpenAI untuk Python dan Node.js, memastikan anda boleh menjalankan kod klien yang sama terhadap perkhidmatan kami. Anda memerlukan kunci API yang sah dari papan pemuka dan konfigurasi hujung yang betul.

Copycurl https://api.openaiapicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Return the current UTC timestamp in ISO 8601 format"}]
  }'

Copyfrom openai import OpenAI

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

Copyimport OpenAI from "openai";

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

Hujung Sambungan Penyelesaian Sembang

Hantar teks ke hujung sambungan sem tunggal kami untuk output teks langsung. Kami menggunakan POST /v1/chat/completions untuk memproses permintaan anda dan mengembalikan teks yang dijana. Ini adalah interaksi teras untuk kebanyakan aplikasi LLM, tanpa memerlukan pengalihan kompleks atau panggilan perkhidmatan tambahan.

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)

Penghantaran berstrim dengan SSE

Terima token secara masa nyata menggunakan Acara Dihantar Pelayan untuk latensi yang lebih rendah. Aktifkan penstriman dengan menetapkan parameter penstrim kepada true dalam permintaan anda. Pecahan terakhir termasuk data penggunaan token, membolehkan anda menjejak kos dengan tepat apabila model menjana teks. Pendekatan ini mengekalkan UI anda responsif walaupun untuk output panjang.

Panggilan Fungsi & Mod JSON

Integrasikan alat dan pastikan output terstruktur untuk interaksi berprogram yang boleh dipercayai. Gunakan parameter alat untuk menentukan skema fungsi dan tetapkan response_format kepada json_object untuk pematuhan JSON yang ketat. Model tanpa sensor kami mengendalikan arahan kompleks dan kes sempadan tanpa menolak permintaan fungsi yang sah.

Had Kadar & Parameter

Pantau penggunaan anda terhadap had per-kunci yang ketat untuk mengelakkan gangguan perkhidmatan. Anda dibenarkan 300 permintaan setiap minit dan lapan permintaan serentak setiap kunci, dengan had badan 8 MB. Ralat seperti 401 (kunci tidak sah), 402 (tiada kredit), dan 429 (had kadar) menunjukkan keadaan akaun khusus.

Tetingkap Konteks & Kekangan

Maksimumkan pengendalian konteks dengan tetingkap 100,000 token untuk input dan output digabungkan. Tetapkan max_tokens untuk mengawal panjang penjanaan, dengan nilai lalai 2,048 jika tidak dinyatakan. Model kami berjalan pada pelayan milik sendiri, bukan sebagai proksi untuk vendor lain, memastikan prestasi yang konsisten untuk kes penggunaan khusus anda.