Dokumentasi API Ollama: Rujukan Endpoint

URL Asas dan Pengesahan

URL asas untuk semua permintaan ialah https://api.ollamaapidocumentation.com/v1. Anda mengesahkan menggunakan token bearer yang dihantar dalam Authorization header. Kunci anda dijana pada papan pemuka dan berfungsi serta-merta.

• Gunakan SDK rasmi OpenAI atau mana-mana klien serasi.
• Tetapkan URL asas kepada nilai di atas.
• Masukkan kunci API anda dalam header.

Pengesahihan adalah ketat. Jika kunci tiada atau tidak sah, API mengembalikan ralat 401. Ini memastikan penggunaan anda dikesan dengan tepat untuk pengebilan.

Hujung Sambungan Penyelesaian Sembang: POST /v1/chat/completions

Hantar mesej ke model melalui POST /v1/chat/completions. Hujung ini menerima badan JSON dengan model field set to "uncensored" and a messages array.

Endpoint ini mengendalikan penjanaan teks. Ia tidak menyokong imej, audio, atau video. Anda boleh menstrim respons atau menunggu hasil penuh.

Kesilapan seperti 402 menunjukkan kredit tidak mencukupi. Permintaan dicalarkan berdasarkan penggunaan token sebenar. Penolakan akibat kredit adalah percuma.

Senarai Model: GET /v1/models

Dapatkan model yang tersedia menggunakan GET /v1/models. Ini mengembalikan senarai objek model. ID model yang tersedia hanyalah "uncensored".

Endpoint ini membantu mengesahkan sambungan. Ia mengesahkan URL asas adalah betul. Ia juga menunjukkan nama model dan jenis objek.

Gunakan ini untuk mengesahkan masalah sambungan sebelum menghantar beban kerja berat.

Parameter: Suhu, Top P, dan Seed

Kawal penjanaan dengan temperature, top_p, dan seed. The seed parameter memastikan output deterministik. Gunakan untuk nyahpepijat atau hasil yang konsisten.

Tetapkan temperature antara 0 dan 2. Nilai yang lebih rendah menjadikan respons lebih boleh ramal. Nilai yang lebih tinggi meningkatkan rawak. The top_p parameter menapis token berdasarkan kebarangkalian terkumpul.

Parameter ini berfungsi tepat seperti API OpenAI. Anda boleh menggabungkannya untuk kawalan tepat atas gaya.

Penggunaan Token Respons Streaming

Aktifkan aliran dengan menetapkan stream: true. API mengembalikan Peristiwa Dihantar Pelayan (SSE). Setiap bahagian mengandungi teks separa.

Bungkusan akhir termasuk statistik penggunaan token. Ini membolehkan anda mengira kos dengan tepat. Anda boleh memproses token apabila ia tiba.

Penstriman mengurangkan latensi yang dirasakan. Ia sesuai untuk antara muka sembang. Pelayan menolak data sehingga respons selesai.

Had, Ralat, dan Tetingkap Konteks

Tingkap konteks ialah 100,000 token. Ini termasuk token input dan output. Anda boleh menjana sehingga 16,000 token setiap permintaan. Output maksimum lalai ialah 2,048 token.

Had kadar ialah 300 permintaan setiap minit. Anda boleh mempunyai 8 permintaan serentak. Saiz badan permintaan terhad kepada 8 MB.

Kesilapan termasuk 401 untuk kunci tidak sah dan 429 untuk had kadar. Kesilapan kredit memulangkan 402. Kesilapan ini jelas dan boleh ditindak.

cURL

Copycurl https://api.ollamaapidocumentation.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list files in the current directory"}]
  }'

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

Aliran

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)