Dokumentasi API Kimicode

URL Asas dan Pengesahan

Sambungkan ke API menggunakan URL asas yang disediakan dan kunci token pra-dibayar. Anda mengesahkan diri dengan menghantar kunci API anda dalam header permintaan, memastikan hanya akaun anda mengakses kredit anda. Daftar melalui Google atau e-mel untuk menerima kunci anda serta-merta tanpa pengesahan telefon.

Copycurl https://api.kimicodeapi.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 rate limit for free tier users?"}]
  }'

Permintaan anda menyasarkan hujung titik serasi OpenAI yang piawai. Reka bentuk ini membolehkan anda menukar perkhidmatan kami tanpa menulis semula kod klien sedia ada anda, dengan syarat anda mengemas kini URL asas dan kelayakan.

Hujung Sambungan Penyelesaian Sembang

Hantar mesej ke model menggunakan POST /v1/chat/completions endpoint. Anda mesti menentukan ID model sebagai uncensored untuk mengakses model bahasa besar yang dioptimumkan yang berjalan di pelayan kami. Sistem menerima peranan mesej piawai seperti pengguna atau pembantu untuk perbualan berbilang giliran.

Copyfrom openai import OpenAI

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

Endpoint ini mengendalikan input teks dan mengembalikan teks yang dijana. Ia tidak menyokong pengekodan semula (embeddings), imej, atau audio. Fokus pada struktur prompt anda untuk mendapatkan hasil terbaik dari model tanpa sensor.

Respons Streaming (SSE)

Aktifkan penghantaran token masa nyata dengan menetapkan parameter stream kepada true dalam permintaan anda. API mengembalikan potongan Acara Dikirim Pelayan (SSE), membolehkan aplikasi anda memaparkan teks semasa ia dijana. Potongan akhir mengandungi statistik penggunaan token lengkap untuk pengebilan.

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)

Penstriman mengurangkan latensi yang dirasakan untuk pengguna akhir. Anda boleh memproses setiap token apabila ia tiba, yang sesuai untuk antara muka sembang. Ingat bahawa penstriman tidak mengubah tingkah laku model asas atau harga token.

Panggilan Fungsi dan Alat

Takrifkan alat dalam permintaan anda untuk membolehkan model memulangkan panggilan fungsi terstruktur. API menyokong parameter tool_choice, membolehkan anda memaksa model menggunakan alat tertentu atau memutuskan secara autonomi. Ciri ini berfungsi dengan format alat OpenAI piawai, menjadikan integrasi mudah.

Copyimport OpenAI from "openai";

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

Gunakan panggilan fungsi untuk mengekstrak data atau mencetuskan tindakan dalam aplikasi anda. Model menafsir takrifan alat dan mengembalikan objek JSON yang mengandungi hujah yang diperlukan. Keupayaan ini melanjutkan API melebihi penjanaan teks mudah.

Mod JSON dan Parameter

Memaksakan output JSON ketat dengan menetapkan response_format ke {"type": "json_object"}. Ini memastikan model mengembalikan JSON, yang sangat penting untuk penguraian programatik. Anda juga boleh melaraskan parameter seperti suhu, top_p, dan jujukan henti untuk mengawal kreativiti dan panjang output.

Model ini menyokong tetingkap konteks 100,000 token. Ini membolehkan anda menghantar jumlah konteks yang besar dalam satu permintaan. Output maksimum ialah 16,000 token setiap permintaan, atau 2,048 jika anda tidak menentukan max_tokens.

Had, Ralat, dan Konteks

Pantau had permintaan anda untuk mengelakkan gangguan perkhidmatan. API ini membenarkan 300 permintaan setiap minit setiap kunci dan sehingga 8 permintaan serentak. Badan permintaan anda mesti kekal di bawah 8 MB. Jika anda melebihi had ini, anda akan menerima ralat had kadar 429.

Kegagalan pengesahan mengembalikan ralat 401 jika kunci tidak sah. Ralat 402 menunjukkan kredit pra-dibayar tidak mencukupi. Ralat semasa penjanaan tidak menggunakan token anda. Jendela konteks termasuk token prompt dan penyelesaian. Kredit yang tidak luput tidak akan luput, memastikan baki pra-dibayar anda kekal tersedia untuk projek masa hadapan.