Dokumentasi API

Mula Cepat: Permintaan pertama dengan Python atau JS

Hantar arahan pertama anda dan dapatkan output teks mentah serta-merta. API menerima beban penyelesaian sem piawai, jadi anda boleh menukar URL asas dan kunci anda untuk mula menjana kandungan tanpa sensor tanpa menulis semula logik anda. Gunakan arahan cURL berikut untuk mengesahkan sambungan dan ketersediaan model sebelum mengintegrasikannya ke dalam pangkalan kod anda.

Permintaan awal ini mengesahkan bahawa hujung sambungan boleh dicapai dan bahawa token pengesahan identiti anda sah. Anda kemudian boleh meneruskan membina logik aplikasi anda menggunakan pembungkus SDK yang disediakan.

Copycurl https://api.chatunrestricted.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the three main endpoints for user authentication"}]
  }'

Pengesahan & URL Asas

Sahkan dengan menghantar kunci API anda dalam header HTTP. Semua permintaan mesti menyasarkan URL asas https://api.chatunrestricted.com/v1 untuk memastikan keserasian dengan SDK OpenAI. Anda boleh menjana kunci anda serta-merta melalui papan pemuka menggunakan kelayakan Google atau e-mel, tanpa memerlukan nombor telefon.

Kunci API mengenal pasti akaun anda dan menjejak penggunaan token terhadap baki pra-dibayar anda. Simpan kunci ini dengan selamat, kerana ia memberikan akses terus kepada kredit anda. Hanya satu kunci aktif dibenarkan per akaun; menjana kunci baru akan menyahaktifkan kunci sebelumnya secara automatik.

POST /v1/chat/completions

Hasilkan teks dengan menghantar permintaan POST ke akhir penyelesaian sembang. ID model ialah uncensored, yang menjalankan model berat terbuka yang disesuaikan untuk menjawab tanpa penolakan kandungan untuk penggunaan dewasa yang sah. Anda boleh mengawal panjang output, keacakan, dan keadaan pemberhentian melalui parameter standard.

Penamat ini menyokong respons aliran (streaming), panggilan fungsi, dan mod JSON. Ia tidak menyokong enkodean (embeddings), imej, atau penalaan halus (fine-tuning). Gunakan SDK Python untuk mengendalikan permintaan secara tidak segerak bagi prestasi yang lebih baik dalam aplikasi web.

Copyfrom openai import OpenAI

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

GET /v1/models

Dapatkan senarai model yang tersedia untuk mengesahkan struktur API. Respons termasuk uncensored ID model, yang mesti anda nyatakan dalam permintaan penyelesaian anda. Hujung sambungan ini membantu anda mengesahkan bahawa perkhidmatan dalam talian dan bahawa ID model tidak berubah.

Gunakan penamat ini untuk mengesan masalah sambungan sebelum menghantar permintaan penjanaan mahal. Ia mengembalikan metadata model serasi OpenAI standard, termasuk ID model dan jenis objek.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.chatunrestricted.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: Suhu, Top P, Seed

Kawal rawak dan determinisme output anda menggunakan parameter pensampelan piawai. Tetapkan temperature antara 0 dan 2 untuk menyesuaikan kreativiti, dan gunakan top_p untuk membatasi pensampelan nukleus. The seed parameter membolehkan anda menghasilkan output khusus yang sama untuk nyahpepijat atau senario roleplay yang konsisten.

Parameter ini secara langsung mempengaruhi bagaimana model menjana teks. Suhu yang lebih tinggi menghasilkan respons yang lebih pelbagai, manakala suhu yang lebih rendah menjadikan output lebih fokus dan boleh diramal. Gunakan stop jujukan untuk menghentikan penjanaan pada penanda tertentu.

Penstriman, Alat, dan Mod JSON

Alirkan respon secara masa nyata menggunakan Acara yang Dihantar Pelayan (SSE) untuk latensi lebih rendah. Dayakan mod JSON dengan menetapkan response_format ke json_object untuk pengeluaran data terstruktur. Panggilan alat disokong untuk pelaksanaan fungsi, membolehkan model memanggil API luar.

Penstriman sangat penting untuk membina antara muka sembang yang memaparkan token sejajar dengan penghasilanannya. Potongan akhir penstriman mengandungi jumlah penggunaan token untuk permintaan tersebut, membolehkan penjejak bil yang tepat. Gunakan contoh berikut untuk melaksanakan penstriman dalam aplikasi anda.

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 Kadar dan Pengebilan

Pantau had kadar anda untuk mengelakkan gangguan perkhidmatan semasa penggunaan bervolume tinggi. API melaksanakan had 300 permintaan setiap minit dan had kekonkurenan 8 permintaan serentak per kunci. Saiz badan permintaan maksimum ialah 8 MB.

Pembayaran adalah pra-dibayar dan berdasarkan penggunaan token sebenar. Kesilapan dan penolakan tidak menggunakan kredit. Jika anda menghadapi ralat 401, kunci API anda tidak sah. Ralat 402 menunjukkan kredit tidak mencukupi, manakala ralat 429 bermaksud anda telah melebihi had kadar. Tetingkap konteks menyokong 100,000 token untuk gabungan prompt dan pelengkap.