Dokumentasi API Serasi OpenAI

Prasyarat: SDK dan URL Asas

Mula dengan memasang pustaka pilihan anda dan arahkan ke hujung sambungan kami. The base_url ialah https://api.apicompatible.com/v1. Dokumentasi API serasi OpenAI ini mengesahkan bahawa perpustakaan piawai berfungsi serta-merta. Anda tidak memerlukan router atau set-up gerbang yang kompleks. Tukar URL dan kunci, kemudian jalankan kod sedia ada anda.

Pengesahan: Header dan Format Kunci

Hantar kunci anda dalam Authorization header. Gunakan format Bearer your_api_key. API kami menggunakan struktur kunci API serasi openai yang standard. Kunci dijana serta-merta melalui log masuk Google atau e-mel. Simpan kunci anda dengan selamat, kerana ia memberikan akses kepada kredit pra-dibayar anda.

Hujung Sambungan Penyelesaian Sembang

Hantar permintaan ke /v1/chat/completions. Nyatakan model sebagai uncensored. API ini memulangkan respons teks secara langsung. Gunakan arahan curl berikut untuk mengesahkan sambungan:

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

Pendekatan serasi SDK OpenAI ini memastikan anda mendapatkan penjanaan teks tanpa had. Model ini mengendalikan arahan kompleks tanpa penolakan tidak perlu untuk kandungan yang sah.

Respons Streaming dengan SSE

Aktifkan aliran dengan menetapkan stream: true. Respons tiba melalui Server-Sent Events (SSE). Butiran penggunaan token muncul dalam segmen akhir. Dokumentasi API serasi OpenAI ini menyokong protokol penstriman piawai. Gunakan ini untuk pengalaman pengguna masa nyata:

Copyfrom openai import OpenAI

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

Penstriman mengurangkan latensi yang dirasakan dengan ketara. Ia berfungsi dengan lancar dengan pustaka sisi klien standard.

Parameter: Suhu, Top-P, dan Alat

Kawal penjanaan dengan parameter standard. Tetapkan temperature untuk rawak atau top_p untuk pensampelan nukleus. Dayakan tools untuk pemanggilan fungsi. Mod JSON tersedia melalui response_format. The uncensored model mematuhi kekangan ini dengan berkesan:

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.apicompatible.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 ini membolehkan kawalan halus atas gaya output. Anda boleh memaksa struktur JSON yang ketat untuk kes penggunaan pengaturcaraan.

Had: Had Kadar dan Saiz Badan

Setiap kunci membolehkan 300 permintaan setiap minit. Permintaan serentak terhad kepada 8 per kunci. Saiz badan permintaan maksimum ialah 8 MB. Tetingkap konteks menyokong 100,000 token secara keseluruhan. Tangani ralat 401 dengan memeriksa kunci anda. Selesaikan ralat 402 dengan menambah kredit. Uruskan ralat 429 dengan melaksanakan logik penangguhan.

Aliran

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)