Dokumentasi API: Titik Akhir Serasi OpenAI

Pengesahan & URL Asas

Akses API dengan menetapkan kunci unik anda dan URL asas dalam pembolehubah persekitaran anda. Endpoint terletak di https://api.apikeykimi.com/v1. Anda mesti termasuk header Authorization: Bearer YOUR_API_KEY dengan setiap permintaan. Kunci ini dijana serta-merta semasa pendaftaran melalui Google atau e-mel. Ia adalah satu-satunya kelayakan yang diperlukan untuk pengesahan. Tiada skop atau kebenaran yang perlu dikonfigurasi.

Copycurl https://api.apikeykimi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "convert this json object to python dictionary syntax"}]
  }'

Hujung Sambungan Penyelesaian Sembang

Hantar mesej ke model menggunakan standard /v1/chat/completions endpoint. Tentukan ID model sebagai uncensored dalam badan permintaan. API memulangkan teks yang dijana berdasarkan sejarah prompt anda. Anda boleh menyesuaikan parameter seperti suhu dan top_p untuk mengawal kreativiti. Model menyokong panggilan fungsi dan mod JSON untuk output berstruktur.

Copyfrom openai import OpenAI

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

Aktifkan penghantaran token masa nyata dengan menetapkan stream: true dalam permintaan anda. pelayan mengembalikan penstriman Acara Dihantar Pelayan. Setiap pecahan mengandungi teks separa sehingga respons lengkap. Ini sesuai untuk antara muka sembang dan paparan pengekodan langsung. Butiran penggunaan token muncul dalam pecahan akhir penstriman.

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)

Panggilan Fungsi & Mod JSON

Takrifkan alat atau paksa output JSON menggunakan response_format parameter. Tetapkan json_object untuk memastikan respons JSON yang sah. Anda juga boleh menghantar definisi alat untuk panggilan fungsi. Model mematuhi kekangan ini dengan ketat. Ini membolehkan integrasi yang boleh dipercayai dengan perkhidmatan luaran. Gunakan tool_choice untuk mengawal bagaimana alat dipanggil.

Had Token & Kekangan

Tingkap konteks menyokong sehingga 100,000 token untuk gabungan input dan output. Output maksimum setiap permintaan ialah 16,000 token. Jika anda tidak menetapkan max_tokens, had ini lalai kepada 2,048 token. Permintaan adalah terhad kepada 8 MB dalam saiz badan. Anda terhad kepada 300 permintaan setiap minit. Hanya 8 permintaan boleh berjalan serentak setiap kunci.

Pengendalian Ralat & Had Penggunaan

Kendalikan ralat dengan menyemak kod status HTTP. 401 menunjukkan kunci API tidak sah atau luput. Ralat 402 bermaksud kredit pra-dibayar anda telah habis. Respons 429 menandakan anda telah melebihi had kadar 300 permintaan setiap minit. Ralat dan penolakan tidak menggunakan token. Semak baki anda di papan pemuka untuk mengelakkan gangguan.

Node.js

Copyimport OpenAI from "openai";

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