Ollama API Documentation: การอ้างอิง Endpoint

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

URL พื้นฐานสำหรับคำขอทั้งหมดคือ https://api.ollamaapidocumentation.com/v1. คุณตรวจสอบสิทธิ์โดยใช้โทเค็น bearer ที่ส่งใน Authorization header. คีย์ของคุณถูกสร้างบนแดชบอร์ดและใช้งานได้ทันที

• ใช้ SDK ทางการของ OpenAI หรือไคลเอนต์ที่เข้ากันได้
• ตั้งค่า URL ฐานเป็นค่าด้านบน
• ใส่คีย์ API ของคุณในหัวเรื่อง

การตรวจสอบสิทธิ์นั้นเข้มงวด หากคีย์หายไปหรือไม่ถูกต้อง API จะส่งข้อผิดพลาด 401 สิ่งนี้ช่วยให้การติดตามการใช้งานของคุณสำหรับการเรียกเก็บเงินแม่นยำ

จุดจบ API Chat Completions: POST /v1/chat/completions

ส่งข้อความไปยังโมเดลผ่าน POST /v1/chat/completions. จุดปลายทางยอมรับ body JSON ที่มี model field set to "uncensored" and a messages อาร์เรย์

เอนด์พอยต์นี้จัดการการสร้างข้อความ ไม่รองรับรูปภาพ เสียง หรือวิดีโอ คุณสามารถสตรีมคำตอบหรือรอรับผลลัพธ์แบบเต็ม

ข้อผิดพลาดเช่น 402 บ่งชี้ถึงเครดิตไม่เพียงพอ คำขอจะถูกเรียกเก็บตามการใช้งานโทเค็นจริง การปฏิเสธเนื่องจากเครดิตเป็นฟรี

การรายการโมเดล: GET /v1/models

ดึงโมเดลที่มีอยู่โดยใช้ GET /v1/modelsสิ่งนี้ส่งคืนรายการวัตถุโมเดล รหัสโมเดลที่มีให้คือ "uncensored" เท่านั้น

เอนด์พอยต์นี้ช่วยตรวจสอบการเชื่อมต่อ ยืนยันว่า URL พื้นฐานถูกต้อง และแสดงชื่อโมเดลพร้อมประเภทออบเจกต์

ใช้สิ่งนี้เพื่อแก้ไขปัญหาการเชื่อมต่อก่อนส่งข้อมูลปริมาณหนัก

พารามิเตอร์: Temperature, Top P และ Seed

ควบคุมการสร้างด้วย temperature, top_p, และ seedThe seed parameter ensures deterministic outputs. Use it for debugging or consistent results.

ตั้งค่า temperature ระหว่าง 0 ถึง 2 ค่าที่ต่ำกว่าทำให้การตอบสนองคาดเดาได้มากขึ้น ค่าที่สูงขึ้นเพิ่มความสุ่ม top_p พารามิเตอร์นี้กรองโทเค็นโดยความน่าจะเป็นสะสม

พารามิเตอร์เหล่านี้ทำงานเหมือนกับ API ของ OpenAI คุณสามารถรวมพวกมันเพื่อควบคุมสไตล์ได้อย่างแม่นยำ

การตอบกลับแบบสตรีมมิ่งและการใช้งานโทเค็น

เปิดใช้งานการสตรีมโดยตั้งค่า stream: true. API ส่งกลับ Server-Sent Events (SSE) แต่ละส่วนมีข้อความบางส่วน

ชิ้นข้อมูลสุดท้ายรวมถึงสถิติการใช้งานโทเค็น ซึ่งช่วยให้คุณคำนวณต้นทุนได้อย่างแม่นยำ คุณสามารถประมวลผลโทเค็นเมื่อได้รับข้อมูล

การสตรีมช่วยลดความล่าช้า เหมาะอย่างยิ่งสำหรับอินเทอร์เฟซแชท เซิร์ฟเวอร์จะส่งข้อมูลจนกว่าคำตอบจะเสร็จสมบูรณ์

ข้อจำกัด, ข้อผิดพลาด และหน้าต่างบริบท

หน้าต่างบริบทมีขนาด 100,000 tokens ซึ่งรวมทั้ง input และ output คุณสามารถสร้างผลลัพธ์ได้สูงสุด 16,000 tokens ต่อการร้องขอ ค่า max output เริ่มต้นคือ 2,048 tokens

อัตราจำกัดการเรียกใช้คือ 300 ครั้งต่อนาที คุณสามารถเรียกใช้พร้อมกันได้ 8 ครั้ง ขนาดบอดี้ของการเรียกใช้จำกัดไว้ที่ 8 MB

ข้อผิดพลาดรวมถึง 401 สำหรับคีย์ไม่ถูกต้องและ 429 สำหรับอัตราจำกัด ข้อผิดพลาดเกี่ยวกับเครดิตจะคืนค่า 402 ข้อผิดพลาดเหล่านี้ชัดเจนและสามารถดำเนินการได้

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);

การสตรีม

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)