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

ข้อกำหนดเบื้องต้น: SDK และ URL พื้นฐาน

เริ่มต้นด้วยการติดตั้งไลบรารีที่คุณต้องการและชี้ไปยังจุดปลายของเรา base_url คือ https://api.apicompatible.com/v1. เอกสารประกอบ API ที่เข้ากันได้กับ OpenAI นี้ยืนยันว่าไลบรารีมาตรฐานใช้งานได้ทันที คุณไม่จำเป็นต้องใช้ตัวเปลี่ยนเส้นทางหรือเกทเวย์ที่ซับซ้อน เปลี่ยน URL และคีย์ แล้วรันโค้ดที่มีอยู่ของคุณ

การตรวจสอบสิทธิ์: รูปแบบหัวเรื่องและคีย์

ส่งคีย์ของคุณใน Authorization header. ใช้รูปแบบ Bearer your_api_key. API ของเราใช้โครงสร้างคีย์ API ที่เข้ากันได้กับ OpenAI มาตรฐาน คีย์จะถูกสร้างทันทีผ่านการเข้าสู่ระบบด้วย Google หรืออีเมล เก็บคีย์ของคุณให้ปลอดภัย เนื่องจากคีย์นี้จะให้สิทธิ์ในการเข้าถึงเครดิตที่เติมเงินล่วงหน้าของคุณ

จุดจบ API Chat Completions

ส่งคำขอไปยัง /v1/chat/completions. ระบุโมเดลเป็น uncensored. API ส่งผลลัพธ์ข้อความโดยตรง ใช้คำสั่ง curl ต่อไปนี้เพื่อตรวจสอบการเชื่อมต่อ:

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

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

การตอบกลับแบบสตรีมมิ่งด้วย SSE

เปิดใช้งานการสตรีมโดยตั้งค่า stream: true. การตอบกลับจะมาถึงผ่าน Server-Sent Events (SSE) รายละเอียดการใช้โทเค็นจะปรากฏในชิ้นสุดท้าย เอกสาร API ที่เข้ากันได้กับ OpenAI นี้รองรับโปรโตคอลสตรีมมาตรฐาน ใช้สำหรับประสบการณ์ผู้ใช้แบบเรียลไทม์:

Copyfrom openai import OpenAI

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

การสตรีมช่วยลดความล่าช้าได้อย่างมาก ทำงานได้อย่างราบรื่นกับไลบรารีฝั่งไคลเอนต์มาตรฐาน

พารามิเตอร์: อุณหภูมิ, Top-P และ Tools

ควบคุมการสร้างด้วยพารามิเตอร์มาตรฐาน ตั้งค่า temperature สำหรับความสุ่มหรือ top_p สำหรับการสุ่มแบบ nucleus เปิดใช้งาน tools สำหรับการเรียกใช้ฟังก์ชัน โหมด JSON มีให้ผ่าน response_formatThe uncensored โมเดลเคารพข้อจำกัดเหล่านี้ได้อย่างมีประสิทธิภาพ:

Copyimport OpenAI from "openai";

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

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

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

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

การสตรีม

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)