Dokumentasi API & Permulaan Pantas

URL Asas dan Pengesahan

Gunakan URL asas kami dan satu kunci API untuk menyambung. Endpoint menerima header piawai. Gantikan YOUR_API_KEY dengan rentetan dari papan pemuka anda.

• URL Asas: https://api.ollamaopenaicompatibleapi.com/v1
• ID Model: uncensored

Pengesahihan bergantung pada token bearer. Hantar ia dalam Authorization header. This ensures compatibility with any OpenAI SDK compatible client. You can generate a new key instantly via Google or email. No phone number is required.

Hujung Sambungan Penyelesaian Sembang

Hantar permintaan POST ke /v1/chat/completions. Sertakan array mesej anda dan nama model. API mengembalikan output teks berdasarkan prompt anda. Ini berfungsi dengan mana-mana penyedia yang menggunakan parameter piawai.

Tetapkan suhu untuk kreativiti atau kekalkan pada nilai rendah untuk ketepatan. Anda juga boleh menentukan jeda hentian. Pelayan memproses permintaan dan mengembalikan penyelesaian. Ini adalah interaksi teras untuk kebanyakan integrasi.

Perhatikan bahawa ralat tidak menggunakan kredit pra-dibayar anda. Hanya penyelesaian berjaya yang dibil. Ini melindungi bajet anda semasa fasa nyahpepijat.

Copycurl https://api.ollamaopenaicompatibleapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 10 Linux kernel security patches from 2023"}]
  }'

Respons Streaming Melalui SSE

Aktifkan aliran dengan menetapkan stream: true. Pelayan menghantar keping apabila ia dijana. Ini mengurangkan latensi yang dirasakan dengan ketara. Anda menerima respons separa secara masa nyata.

Uraikan aliran Acara Dihantar Pelayan. Chunk akhir mengandungi statistik penggunaan. Ini termasuk kiraan token untuk input dan output. Anda boleh menjejaki kos secara dinamik semasa penjanaan.

Pendekatan ini berfungsi dengan baik untuk antara muka sembang. Pengguna melihat teks muncul perkataan demi perkataan. Ia terasa lebih responsif daripada menunggu respons penuh. API mengendalikan kestabilan sambungan secara automatik.

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 dan Mod JSON

Takrifkan alat dalam badan permintaan anda. Model boleh memulangkan data terstruktur. Gunakan response_format dengan {"type": "json_object"} untuk JSON yang ketat. Ini memastikan output yang boleh dianalisis setiap kali.

Definisi alat termasuk nama, penerangan, dan parameter. Model memutuskan alat mana untuk dipanggil. Anda melaksanakan fungsi dan memaklumkan semula hasilnya. Ini membolehkan aliran kerja ejen yang kompleks.

mod JSON menonaktifkan penjanaan teks bebas. Ia memaksa model mematuhi skema anda. Gunakan ini apabila berintegrasi dengan pangkalan data atau API. Ia mengurangkan halusinasi dalam medan terstruktur.

Copyfrom openai import OpenAI

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

Had had laju dan badan permintaan

Anda mendapat 300 permintaan setiap minit setiap kunci. Kekonkurenan dihadkan kepada 8 permintaan serentak. Saiz badan permintaan maksimum ialah 8 MB. Ini sesuai untuk kebanyakan aplikasi yang berat teks.

Tetingkap konteks membolehkan 100,000 token jumlah. Ini termasuk prompt dan penyelesaian. Output maksimum per permintaan ialah 16,000 token. Jika anda membiarkan max_tokens, ia secara lalai kepada 2,048.

Tangani ralat HTTP 429 dengan baik. Ia menunjukkan anda mencapai had kadar. Laksanakan backoff eksponen dalam kod klien anda. Ini mencegah membanjiri pelayan semasa lonjakan.

Copyimport OpenAI from "openai";

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

Ralat Pengesahan dan Had

Status 401 bermaksud kunci anda tidak sah. Semak kesilapan taip atau sesi yang telah luput. Status 402 menunjukkan kredit tidak mencukupi. Tambah nilai melalui kripto untuk meneruskan perkhidmatan.

Status 429 menandakan had kadar. Anda melebihi 300 permintaan setiap minit. Kurangkan kadar aliran atau naik taraf kunci anda. API mengembalikan mesej ralat yang jelas.

Kredit tidak luput. Anda boleh menambah baki bila-bila masa. Tambah baki minimum ialah $20. Kredit bonus terpakai untuk jumlah yang lebih besar. Ini memastikan projek anda berjalan dengan lancar.