Dokumentasi Titik Akhir Serasi OpenAI

Pengesahan dan URL Asas

Mula dengan menjana kunci API anda melalui papan pemuka menggunakan akaun Google atau e-mel anda. Tampal kunci ini ke setiap header permintaan sebagai Authorization: Bearer YOUR_API_KEY. URL asas ialah https://api.openaicompatibleendpoints.com/v1, memastikan kod klien sedia ada anda berfungsi tanpa pengubahsuaian. Anda menerima satu kunci aktif setiap akaun, yang boleh anda jana semula serta-merta jika dikompromikan. Tiada nombor telefon diperlukan untuk pendaftaran, mengekalkan proses yang pantas dan peribadi.

Permintaan Pertama

Hantar permintaan penyelesaian chat standard untuk mula menjana teks serta-merta. Ini mengesahkan kelayakan dan baki token anda aktif sebelum meluaskan aliran kerja anda. Hujung endpoint menerima payload JSON standard yang serupa dengan format OpenAI, membolehkan anda menguji sambungan dengan overhead minimum.

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

Integrasi SDK Python

Pasang pakej Python rasmi OpenAI dan arahkan ke URL asas kami untuk memanfaatkan corak yang sudah dikenali. Pendekatan ini berfungsi dengan lancar dengan alat seperti LangChain atau LlamaIndex yang memerlukan titik akhir serasi OpenAI. Anda boleh menukar model atau penyedia hanya dengan mengemas kini konfigurasi URL asas tanpa mengubah logik aplikasi anda. Fleksibiliti ini sangat penting untuk agensi yang menguruskan pelbagai landasan inferens.

Copyfrom openai import OpenAI

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

Penggunaan SDK Node

Mulakan klien Node.js dengan URL asas dan kunci API anda untuk memulakan permintaan aliran atau sinkron. Persediaan ini menyerupai antara muka klien OpenAI piawai, menjadikannya mudah untuk diintegrasikan ke dalam aplikasi Express atau Fastify. Anda boleh mengendalikan ralat dengan baik dengan memeriksa kod status yang dipulangkan oleh pelayan, memastikan aplikasi anda kekal kukuh semasa penggunaan bervolume tinggi.

Copyimport OpenAI from "openai";

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

Respons Streaming (SSE)

Aktifkan penstriman dengan menetapkan stream parameter kepada true, yang mengembalikan data secara masa nyata melalui Acara Dikirim Pelayan. Ini mengurangkan latensi yang dirasakan untuk pengguna akhir, terutamanya semasa menjana respons panjang atau rantaian penalaran kompleks. Setiap pecahan mengandungi kandungan separa, membolehkan anda memaparkan teks secara progresif dalam antara muka anda. Pecahan akhir mengandungi statistik penggunaan token lengkap untuk penjejakan pengebilan yang tepat.

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)

Had, Ralat, dan Konteks

Kunci API anda menyokong sehingga 300 permintaan setiap minit dan membenarkan 8 sambungan serentak. Jika anda melebihi had ini, pelayan akan mengembalikan kod status 429; dana tidak mencukupi akan mencetuskan ralat 402, manakala kunci tidak sah akan menghasilkan ralat 401. Model ini mengendalikan tingkap konteks 100,000 token, menggabungkan prompt dan penyelesaian. Ralat dan penolakan tidak menggunakan kredit pra-bayar anda, memastikan anda hanya membayar untuk inferens yang sah.