เอกสาร API Ollama: คู่มือเริ่มต้นอย่างรวดเร็ว

URL ฐานและการตรวจสอบสิทธิ์

URL ฐานคือ HTTPS://api.ollamaapidocs.com/v1 ส่งคีย์ของคุณใน header Authorization มาตรฐาน

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

จุดจบ API Chat Completions

ส่งคำขอ POST ไปยัง /v1/chat/completions โดยตั้งค่า model เป็น uncensored

Copyfrom openai import OpenAI

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

การรองรับการสตรีมและเครื่องมือ

เปิดใช้งานการสตรีมโดยตั้งค่า stream เป็น true API จะส่งมอบโทเค็นผ่าน Server-Sent Events และรองรับการเรียกใช้ฟังก์ชัน

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)

โหมด JSON และพารามิเตอร์

ใช้ response_format json_object สำหรับผลลัพธ์ JSON ที่เข้มงวด คุณยังสามารถปรับอุณหภูมิ top_p และลำดับหยุดได้

Copyimport OpenAI from "openai";

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

อัตราจำกัดและข้อจำกัด

ข้อจำกัดคือ 300 คำขอต่อนาทีต่อคีย์ แต่ละคำรองรับหน้าต่างบริกรขนาด 100,000 โทเค็น

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

ข้อผิดพลาดและ Context Window

จัดการสถานะ 401 สำหรับคีย์ที่ไม่ถูกต้อง, 402 สำหรับไม่มีเครดิต และ 429 สำหรับข้อจำกัดอัตราการใช้งาน โมเดลรองรับหน้าต่างบริบทขนาด 100,000 tokens

Copyfrom openai import OpenAI

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