API เอกสาร

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

API อยู่ที่ https://api.ollamaapidoc.com/v1. คุณตรวจสอบสิทธิ์โดยใช้โทเค็น Bearer ใน Authorization header สร้างคีย์ของคุณทันทีผ่าน Google หรืออีเมลบนแดชบอร์ด ไม่ต้องใช้เบอร์โทรศัพท์ คีย์นี้ใช้งานได้กับ SDK มาตรฐานของ OpenAI โดยการตั้งค่า URL พื้นฐาน

คำขอแรกของคุณ

ส่งคำขอ POST ไปยัง /v1/chat/completions ด้วยรหัสโมเดล uncensored. เอนด์พอยต์นี้จัดการอินพุตข้อความและเอาต์พุตข้อความ มันรองรับการสตรีม โหมด JSON และการเรียกใช้ฟังก์ชัน คุณสามารถทดสอบการเชื่อมต่อโดยไม่ต้องใช้เครดิตโดยการตรวจสอบเอนด์พอยต์โมเดลก่อน

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"}]
  }'

การตอบกลับส่งรูปแบบมาตรฐานของ OpenAI ความผิดพลาดส่งรหัส HTTP ที่เหมาะสม ตรวจสอบเนื้อหาสำหรับ error รายละเอียดหากมีข้อผิดพลาด การตอบสนองแบบสตรีมใช้ Server-Sent Events

การผสานรวม SDK Python

ติดตั้งไลบรารี OpenAI ทางการ กำหนดค่าไคลเอนต์ด้วย URL พื้นฐานและคีย์ API เรียกใช้จุดปลาย chat completions โค้ดจะเหมือนกันกับการใช้งาน OpenAI มาตรฐาน สิ่งนี้รับประกันการย้ายที่ง่ายสำหรับโปรเจกต์ที่มีอยู่ คุณสามารถปรับพารามิเตอร์เช่นอุณหภูมิและ top_p ได้โดยตรงในการเรียก

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)

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

การตั้งค่า SDK Node.js

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

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

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

โหมด JSON และการสตรีม

เปิดใช้งานการสตรีมโดยการตั้งค่า stream ตั้งค่าเป็น true API จะส่งโทเค็นผ่าน Server-Sent Events คุณจะได้รับคำตอบบางส่วนแบบเรียลไทม์ ซึ่งช่วยปรับปรุงประสบการณ์ผู้ใช้สำหรับผลลัพธ์ที่ยาวนาน นอกจากนี้คุณยังสามารถบังคับใช้เอาต์พุต JSON โดยใช้ response_format. สิ่งนี้มีประโยชน์สำหรับการดึงข้อมูลที่มีโครงสร้าง

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)

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

ข้อจำกัด, ข้อผิดพลาด และบริบท

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