เอกสาร API

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

API จำเป็นต้องใช้คีย์ API เพียงตัวเดียวสำหรับการตรวจสอบสิทธิ์ คุณจะได้รับคีย์นี้ทันทีหลังจากสมัครสมาชิกด้วย Google หรือที่อยู่อีเมล ส่งคีย์นี้ใน Authorization header เป็น Bearer token base URL คือ https://api.topuncensored.com/v1. URL นี้ทำงานกับ SDK หรือไลบรารีไคลเอนต์ที่เข้ากันได้กับ OpenAI ใดๆ

• ใช้ header: Authorization: Bearer YOUR_API_KEY
• ตั้งค่า URL ฐานของไคลเอนต์ของคุณไปยังจุดปลายที่ให้ไว้

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

Copycurl https://api.topuncensored.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate a list of ten distinct UI layout patterns."}]
  }'

จุดจบ API Chat Completions

ส่ง prompt ข้อความไปยัง /v1/chat/completions endpoint. endpoint. ID ของโมเดลคือ uncensored. เอนด์พอยต์นี้รองรับรูปแบบการเขียนข้อความแชทด้วยข้อความ มันส่งคืนข้อความตอบกลับโดยตรง ไม่มีเลเยอร์หรือ wrapper เพิ่มเติม คุณควบคุมหน้าต่างบริบทขนาด 100,000 tokens ได้ คำขอขนาดต่ำกว่า 8 MB ทำงานได้อย่างเชื่อถือได้ ใช้สิ่งนี้สำหรับการสร้างข้อความโดยตรง

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

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

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

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

Copyfrom openai import OpenAI

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

Tool Calling และโหมด JSON

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

Tool Calling ทำงานกับสคีมามาตรฐานของ OpenAI โหมด JSON บังคับใช้ JSON ที่ถูกต้อง ใช้สิ่งเหล่านี้สำหรับการผสานรวม API หรือการสกัดข้อมูล ความยืดหยุ่นนี้รองรับเวิร์กโฟลว์ที่ซับซ้อน

Copyimport OpenAI from "openai";

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

Parameters and Limits

ปรับ temperature, top_p, และ stop ลำดับ. ตั้ง max_tokens to 16,000. Default is 2,048 if omitted. Control repetition with presence_penalty และ frequency_penalty. ใช้ seed สำหรับผลลัพธ์ที่มีความแน่นอน พารามิเตอร์เหล่านี้ปรับแต่งคุณภาพการสร้าง คุณควบคุมสไตล์ผลลัพธ์ได้อย่างเต็มที่

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

ข้อผิดพลาดและ Context Window

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

ติดตามการใช้งาน tokens ของคุณ หลีกเลี่ยงการชนกับขีดจำกัดอัตรา ลองใหม่ด้วยการถดถอยแบบเอกซ์โพเนนเชียล สิ่งนี้รับประกันการทำงานที่เชื่อถือได้ 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)