Panduan Memulai API Kompatibel OpenAI

Prasyarat dan Penyiapan Lingkungan

Anda memerlukan kunci API dan URL dasar yang benar untuk menghubungkan klien Anda. Daftar dengan Google atau email di halaman Get API key untuk menerima kredensial Anda segera. Percobaan memberikan Anda $0.50 selama tujuh hari, dan Anda dapat mengisi ulang dengan USDT atau USDC melalui kripto. Simpan kunci Anda dengan aman dan verifikasi bahwa kunci tersebut cocok dengan pengaturan akun Anda.

Pastikan lingkungan Anda mendukung permintaan HTTP standar. Layanan kami berjalan pada satu model uncensored, sehingga Anda tidak perlu mengelola beberapa endpoint model. Tetapkan URL dasar ke HTTPS://api.openaiapicompatibility.com/v1 sebelum melakukan panggilan apa pun. Ini memastikan semua permintaan dialihkan dengan benar ke server inferensi yang telah disesuaikan kami.

Menginstal SDK OpenAI Resmi

Gunakan SDK resmi untuk menjaga kompatibilitas dengan alur kerja OpenAI yang ada. Pustaka Python dan Node berfungsi langsung dengan endpoint kami karena kami mengikuti skema API standar. Instal paket di direktori proyek Anda menggunakan manajer paket pilihan Anda. Pendekatan ini menghindari kebutuhan akan kode klien HTTP kustom.

Kami mendukung parameter standar seperti temperature, top_p, dan urutan henti. SDK menangani serialisasi JSON dan header permintaan secara otomatis. Anda dapat mengganti URL dasar dalam konfigurasi klien untuk menunjuk ke server kami. Ini memungkinkan Anda beralih antara penyedia tanpa mengubah logika aplikasi Anda.

Mengkonfigurasi URL Dasar dan Kunci API

Atur URL dasar dan kunci API dalam objek konfigurasi klien Anda. URL dasar adalah HTTPS://api.openaiapicompatibility.com/v1. Berikan kunci API Anda di header Authorization sebagai token Bearer. Konfigurasi ini memastikan permintaan Anda diautentikasi dan dialihkan ke layanan yang benar.

Copycurl https://api.openaiapicompatibility.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list all python packages for data science"}]
  }'

Verifikasi koneksi Anda dengan memanggil endpoint GET /v1/models. Ini akan mengembalikan daftar model yang tersedia, termasuk pengidentifikasi model uncensored. Gunakan langkah ini untuk mengonfirmasi bahwa akses jaringan dan kredensial Anda benar sebelum mengirim prompt kompleks.

Melakukan Chat Completion Pertama Anda

Kirim permintaan POST ke /v1/chat/completions dengan pesan prompt Anda. Tetapkan model sebagai uncensored untuk mengakses mesin inferensi tanpa filter. Sertakan prompt sistem Anda untuk mengatur perilaku, dan tambahkan pesan pengguna untuk konten yang ingin Anda hasilkan.

Copyfrom openai import OpenAI

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

Respons berisi teks yang dihasilkan dan statistik penggunaan token. Anda dapat menyesuaikan parameter seperti suhu untuk mengendalikan kreativitas. Model tidak menolak topik dewasa yang sah atau kontroversial, menjadikannya cocok untuk berbagai kasus penggunaan. Periksa objek respons untuk bidang konten guna mengakses output.

Respons Streaming dengan SSE

Aktifkan streaming dengan mengatur parameter stream menjadi true dalam permintaan Anda. Ini mengirimkan respons parsial sebagai Server-Sent Events (SSE). Ini meningkatkan pengalaman pengguna dengan menampilkan teks saat teks tersebut dihasilkan.

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)

Setiap chunk berisi delta dari respons. Akumulasi delta ini untuk merekonstruksi teks lengkap. Chunk terakhir mencakup penggunaan token total untuk permintaan tersebut. Metode ini berfungsi dengan klien atau pustaka SSE standar apa pun. Ini mengurangi latensi yang dirasakan untuk generasi konten panjang.

Menangani Mode JSON dan Pemanggilan Fungsi

Gunakan mode JSON dengan mengatur response_format menjadi json_object. Ini memaksa model untuk menghasilkan JSON valid alih-alih teks bebas. Ini berguna untuk ekstraksi data terstruktur atau respons API. Gabungkan ini dengan pemanggilan fungsi untuk skenario penggunaan alat.

Tentukan alat Anda dalam array tools. Tentukan nama fungsi, deskripsi, dan parameter. Model akan mengembalikan detail panggilan fungsi dalam respons. Anda kemudian dapat mengeksekusi fungsi dan mengirim hasil kembali ke model. Ini memungkinkan alur kerja multi-langkah yang kompleks dengan model uncensored.

Node.js

Copyimport OpenAI from "openai";

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