API Dokumentasi

URL Asas dan Pengesahan

API tinggal di https://api.ollamaapidoc.com/v1. Anda mengesahkan menggunakan token Bearer dalam Authorization header. Jana kunci anda serta-merta melalui Google atau e-mel di papan pemuka. Tiada nombor telefon diperlukan. Kunci berfungsi dengan SDK OpenAI piawai dengan menetapkan URL asas.

Permintaan Pertama anda

Hantar permintaan POST ke /v1/chat/completions dengan ID model uncensored. Hujung sambungan ini mengendalikan input teks dan output teks. Ia menyokong aliran, mod JSON, dan pemanggilan fungsi. Anda boleh menguji sambungan tanpa menggunakan kredit dengan memeriksa hujung sambungan model dahulu.

Copycurl https://api.ollamaapidoc.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list all installed models"}]
  }'

Respons mengembalikan format OpenAI piawai. Ralat mengembalikan kod HTTP yang sesuai. Semak badan untuk error butiran jika sesuatu gagal. Respons penstriman menggunakan Acara Dihantar Pelayan.

Integrasi SDK Python

Pasang perpustakaan rasmi OpenAI. Konfigurasikan klien dengan URL asas dan kunci API anda. Panggil titik akhir penyelesaian sembang. Kod kekal sama seperti penggunaan OpenAI piawai. Ini memastikan migrasi mudah untuk projek sedia ada. Anda boleh melaraskan parameter seperti suhu dan top_p secara langsung dalam panggilan.

Copyfrom openai import OpenAI

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

Tangani pengecualian untuk had kadar atau kunci tidak sah. Perpustakaan mengalirkan token jika anda menetapkan aliran kepada benar. Pendekatan ini mengekalkan kod asas anda yang bersih dan serasi.

Persediaan SDK Node.js

Gunakan openai pakej npm. Mulakan klien dengan URL asas khusus. Luluskan kunci API anda. Sintaks meniru contoh Python. Konsistensi ini mengurangkan masa nyahpepijat. Anda boleh menghantar beberapa mesej dalam tatasusunan sejarah perbualan.

Copyimport OpenAI from "openai";

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

Uraikan respons dengan teliti. API mengembalikan JSON terstruktur. Pengendalian ralat adalah penting untuk aplikasi pengeluaran. Tangkap ralat rangkaian dan ralat khusus API secara berasingan. Ini memastikan aplikasi anda kekal responsif semasa trafik tinggi.

Streaming dan Mod JSON

Aktifkan penstriman dengan menetapkan stream parameter kepada true. API menghantar token melalui Acara Dikirim Pelayan. Anda menerima respons separa secara masa nyata. Ini meningkatkan pengalaman pengguna untuk output yang panjang. Anda juga boleh memaksakan output JSON menggunakan response_format. Ini berguna untuk pengekstrakan data terstruktur.

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)

Pemanggilan fungsi berfungsi serupa. Takrifkan alat dalam permintaan anda. Model mengembalikan panggilan alat. Uraikan panggilan ini dalam kod anda. Jalankan dan maklum balas keputusan kepada model. Gelung ini membolehkan aliran kerja kompleks.

Had, Ralat, dan Konteks

Jendela konteks ialah 100,000 token. Output maksimum ialah 16,000 token setiap permintaan. Ralat termasuk 401 untuk kunci tidak sah dan 402 untuk kredit tidak mencukupi. Had kadar maksimum 300 permintaan setiap minit. Tangani ini dengan baik dalam aplikasi anda. API tidak pernah menggunakan prompt anda untuk latihan. Privasi dikekalkan. Kredit tidak luput.