เอกสาร API ที่เข้ากันได้กับ OpenAI

เริ่มต้น: เชื่อมต่อด้วย SDK OpenAI

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

Copycurl https://api.openaiapicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Return the current UTC timestamp in ISO 8601 format"}]
  }'

Copyfrom openai import OpenAI

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

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.openaiapicompatible.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 Chat Completions

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

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)

การสตรีมด้วย SSE

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

การเรียกใช้ฟังก์ชัน & โหมด JSON

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

อัตราจำกัด & พารามิเตอร์

ติดตามการใช้งานของคุณเทียบกับขีดจำกัดต่อคีย์ที่เข้มงวดเพื่อหลีกเลี่ยงการหยุดชะงักของบริการ คุณได้รับอนุญาต 300 คำขอต่อนาทีและแปดคำขอพร้อมกันต่อคีย์ พร้อมขีดจำกัด body ขนาด 8 MB ข้อผิดพลาดเช่น 401 (คีย์ไม่ถูกต้อง), 402 (ไม่มีเครดิต), และ 429 (ขีดจำกัดอัตรา) บ่งชี้สถานะบัญชีเฉพาะ

หน้าต่างบริบท & ข้อจำกัด

เพิ่มประสิทธิภาพการจัดการบริบทด้วยหน้าต่าง 100,000 โทเค็นสำหรับการป้อนข้อมูลและการเอาต์พุตรวมกัน ตั้งค่า max_tokens เพื่อควบคุมความยาวของการสร้าง โดยจะกลับเป็นค่าเริ่มต้นที่ 2,048 หากไม่ได้ระบุ โมเดลของเราทำงานบนเซิร์ฟเวอร์ที่เป็นกรรมสิทธิ์ ไม่ใช่เป็นพร็อกซีสำหรับผู้ขายรายอื่น ทำให้มั่นใจในประสิทธิภาพที่สอดคล้องกันสำหรับกรณีการใช้งานเฉพาะของคุณ