เอกสาร API & เริ่มต้นอย่างรวดเร็ว

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

ใช้ base URL ของเราและ API key เดียวเพื่อเชื่อมต่อ Endpoint ยอมรับ header มาตรฐาน แทนที่ YOUR_API_KEY ด้วยสตริงจากแดชบอร์ดของคุณ

• Base URL: https://api.ollamaopenaicompatibleapi.com/v1
• ID โมเดล: uncensored

การตรวจสอบสิทธิ์อาศัยโทเค็น bearer ส่งมันใน Authorization header. สิ่งนี้ทำให้เข้ากันได้กับไคลเอนต์ที่เข้ากันได้กับ SDK มาตรฐานของ OpenAI ใดๆ คุณสามารถสร้างคีย์ใหม่ได้ทันทีผ่าน Google หรืออีเมล ไม่ต้องใช้หมายเลขโทรศัพท์

จุดจบ API Chat Completions

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

ตั้งค่า temperature เพื่อความคิดสร้างสรรค์ หรือคงค่าไว้ต่ำเพื่อความแม่นยำ คุณยังสามารถกำหนด stop sequences ได้ เซิร์ฟเวอร์จะประมวลผลคำขอและส่งผลลัพธ์กลับ นี่คือการทำงานหลักสำหรับการผสานรวมส่วนใหญ่

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

Copycurl https://api.ollamaopenaicompatibleapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 10 Linux kernel security patches from 2023"}]
  }'

การตอบกลับแบบสตรีมมิ่งผ่าน SSE

เปิดใช้งานการสตรีมโดยตั้งค่า stream: true. เซิร์ฟเวอร์ส่งชิ้นส่วนข้อมูลเมื่อสร้างขึ้นมา ซึ่งช่วยลดความล่าช้าที่ผู้ใช้รู้สึกอย่างมีนัยสำคัญ คุณได้รับคำตอบบางส่วนแบบเรียลไทม์

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

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

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)

Function Calling และโหมด JSON

กำหนดเครื่องมือใน body ของคำขอ โมเดลสามารถแสดงผลข้อมูลที่มีโครงสร้างได้ ใช้ response_format กับ {"type": "json_object"} สำหรับ JSON แบบเข้มงวด สิ่งนี้รับประกันผลลัพธ์ที่แยกวิเคราะห์ได้ทุกครั้ง

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

โหมด JSON ปิดการสร้างข้อความแบบฟรีเท็กซ์ บังคับให้โมเดลปฏิบัติตามสคีมาของคุณ ใช้สิ่งนี้เมื่อผสานรวมกับฐานข้อมูลหรือ API ลดการเกิดฮัลลิเนชันในฟิลด์ที่มีโครงสร้าง

Copyfrom openai import OpenAI

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

อัตราจำกัดและส่วนหัวคำขอ

คุณได้รับสิทธิ์ 300 คำขอต่อนาทีต่อคีย์ ความพร้อมใช้งานจำกัดที่ 8 คำขอพร้อมกัน ขนาดร่างกายคำขอสูงสุดคือ 8 MB ซึ่งเหมาะกับแอปพลิเคชันที่เน้นข้อความส่วนใหญ่

หน้าต่างบริกรวม 100,000 tokens ซึ่งรวมถึง prompt และ completion ผลลัพธ์สูงสุดต่อคำขอคือ 16,000 tokens หากคุณละเลย max_tokens, ค่าเริ่มต้นคือ 2,048

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

Copyimport OpenAI from "openai";

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

Authentication Errors and Limits

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

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

เครดิตไม่หมดอายุ คุณสามารถเติมเงิน anytime ยอดเติมขั้นต่ำคือ $20 เครดิตโบนัสใช้กับจำนวนเงินที่มากขึ้นนี้ทำให้โครงการของคุณทำงานได้อย่างราบรื่น