Dokumentasi API

Pengenalan: Permintaan pertama anda

Hantar mesej pertama anda ke model tanpa sensor serta-merta. Gunakan endpoint penyelesaian sem piawai untuk menjana teks. Model memberikan respons kepada arahan bahasa semula jadi tanpa penolakan kandungan untuk penggunaan dewasa yang sah. Persediaan ini berfungsi dengan mana-mana klien serasi OpenAI.

Mula dengan memasang SDK untuk bahasa pilihan anda. Kemudian konfigurasikan kunci API anda. Contoh berikut menunjukkan permintaan curl asas untuk menguji sambungan.

Anda boleh menyesuaikan parameter seperti suhu untuk mengawal keacakan. Respons mengembalikan teks yang dijana secara langsung. Aliran mudah ini membolehkan anda mengesahkan API berfungsi sebelum membina logik yang kompleks.

Copycurl https://api.apiaicharacter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the current API rate limit status?"}]
  }'

URL Asas dan Pengesahan

Sambung menggunakan URL asas khusus untuk API ini. Gantikan hujung lalai dengan alamat pelayan hos kami. Ini memastikan permintaan anda mencapai model tanpa sensor secara langsung. Pengesahan bergantung pada satu kunci API per akaun.

Jana kunci anda melalui papan pemuka. Luluskan dalam header Authorization sebagai token Bearer. Kaedah ini serasi dengan SDK OpenAI standard. Anda boleh menukar penyedia dengan menukar hanya URL asas dan kunci.

Kekalkan kunci anda selamat. Ia memberikan akses penuh kepada kredit pra-dibayar anda. Kunci menggantikan mana-mana kunci aktif sebelumnya serta-merta selepas penjanaan.

Titik akhir: Penyelesaian Sembang

Berinteraksi dengan model melalui penamat penyelesaian chat. Ini adalah satu-satunya penamat penjanaan teks yang tersedia. Ia menerima mesej dan mengembalikan teks yang dijana. Tiada pengekodan, imej, atau audio disokong.

Hantar permintaan POST ke laluan sembang. Sertakan mesej sistem dan pengguna anda dalam badan. Model memproses konteks dan menjana respons. Anda boleh menggunakan mod JSON untuk output berstruktur.

Pemanggilan fungsi juga disokong. Tentukan alat dan biarkan model memutuskan bila untuk menggunakannya. Fleksibiliti ini membolehkan aliran kerja agen yang kompleks. Respons termasuk kandungan yang dijana dan penggunaan token.

Copyfrom openai import OpenAI

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

Parameter: Suhu, Top P, dan Henti

Kawal gaya output menggunakan parameter piawai. Laraskan suhu untuk mengubah kreativiti. Nilai yang lebih rendah menjadikan respons lebih deterministik. Nilai yang lebih tinggi memperkenalkan lebih banyak variasi.

Gunakan top P untuk menapis perkataan yang tidak mungkin. Ini membantu mengekalkan koheren sambil membolehkan kreativiti. Tetapkan jeda henti untuk mengakhiri penjanaan pada penanda tertentu. Ini berguna untuk mengawal struktur dialog.

Parameter benih membolehkan hasil yang boleh direproduksi. Gunakan ia semasa nyahpepijat prompt anda. Parameter ini memberikan anda kawalan tepat ke atas tingkah laku model. Laraskan mereka untuk memenuhi keperluan aplikasi anda.

Copyimport OpenAI from "openai";

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

Streaming dan Penggunaan Token

Terima respons secara masa nyata menggunakan server-sent events. Penstriman mengurangkan latensi yang dirasakan untuk pengguna. API menghantar token semasa ia dijana. Ini mewujudkan pengalaman membaca yang lebih lancar.

Penggunaan token dilaporkan dalam segmen akhir. Ini membolehkan anda menjejak kos dengan tepat. Bil berdasarkan token sebenar yang digunakan. Ralat dan penolakan tidak menjejaki caj.

Laksanakan pengendali aliran untuk memproses data. Kemas kini UI anda sejurus token tiba. Pendekatan ini sangat sesuai untuk antara muka sembang. Model menyokong aliran untuk semua jenis permintaan.

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 had laju dan kekangan

Memahami had untuk mengelakkan gangguan perkhidmatan. Anda boleh membuat 300 permintaan setiap minit per kunci. Permintaan konkuren dihadkan kepada lapan serentak. Badan permintaan tidak boleh melebihi 8 MB.

Tangani ralat dengan anggun. Status 401 bermaksud kunci anda tidak sah. Status 402 menunjukkan kredit tidak mencukupi. Status 429 menandakan anda telah mencapai had kadar.

Tingkap konteks menyokong jumlah 100,000 token. Ini termasuk prompt dan penyelesaian. Output maksimum ialah 16,000 token setiap permintaan. Tetapkan max_tokens untuk mengawal panjang output. Ralat adalah percuma, jadi logik cubaan semula adalah selamat.