คู่มือ API Quickstart

ติดตั้ง SDK

เริ่มต้นด้วยการเพิ่มไลบรารีไคลเอนต์ทางการลงในดีเพนเดนซีของโปรเจกต์ เพื่อให้แน่ใจว่าเข้ากันได้กับเอนด์พอยต์มาตรฐานของเราและทำให้การจัดการคำของ่ายขึ้น

ใช้ package manager ที่คุณชอบเพื่อติดตั้งเวอร์ชันล่าสุด ไลบรารีจะจัดการการตรวจสอบสิทธิ์และการทำ serialization อัตโนมัติ

ขั้นตอนนี้จำเป็นก่อนที่คุณจะส่งคำขอใดๆ ไปยังเซิร์ฟเวอร์

กำหนดค่า URL พื้นฐานและคีย์

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

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

• Base URL: https://api.aizonderfilter.com/v1
• Auth Header: Authorization: Bearer YOUR_API_KEY

ตรวจสอบว่าคีย์ของคุณทำงานได้โดยตรวจสอบเอนด์พอยต์โมเดล

ทำการร้องขอครั้งแรกของคุณ

ส่งคำขอ chat completion มาตรฐานเพื่อรับข้อความตอบกลับดิบที่ไม่มีการกรอง โมเดลของเราไม่ใช้การปฏิเสธความปลอดภัยมาตรฐานสำหรับเนื้อหาที่ถูกต้องตามกฎหมาย

ใช้ uncensored ID ของโมเดลสำหรับการสร้างคำตอบทั้งหมด

ตัวอย่างต่อไปนี้แสดงการเรียกสร้างข้อความพื้นฐาน

Copycurl https://api.aizonderfilter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate python code to parse json"}]
  }'

ตรวจสอบ response สำหรับข้อความที่สร้างและสถิติการใช้งาน token

เปิดใช้งานการตอบกลับแบบสตรีม

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

ตั้งค่าพารามิเตอร์ stream เป็น true ใน payload การร้องขอของคุณ

เซิร์ฟเวอร์ส่ง Server-Sent Events (SSE) ที่มีผลลัพธ์บางส่วน

Copyfrom openai import OpenAI

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

รวมชิ้นส่วนข้อความเพื่อสร้างข้อความเต็ม โทเค็นการใช้งานจะปรากฏในชิ้นส่วนสุดท้าย

ใช้โหมด JSON และเครื่องมือ

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

กำหนดเครื่องมือในคำขอเพื่อให้โมเดลสามารถเรียกใช้ฟังก์ชันภายนอก ระบุ tool_choice: "auto" สำหรับการเลือกอัตโนมัติ

Copyimport OpenAI from "openai";

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

แยก tool calls จากการตอบกลับเพื่อตรรกะแบบกำหนดเองของคุณ วิธีนี้ทำงานได้อย่างน่าเชื่อถือกับโมเดล uncensored ของเรา

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

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

หน้าต่างบริบทรองรับ 100,000 tokens รวม ผลลัพธ์สูงสุดต่อคำขอคือ 16,000 tokens

จัดการข้อผิดพลาด HTTP ที่พบบ่อยอย่างเหมาะสม:

• 401 Unauthorized: คีย์ API ของคุณไม่ถูกต้องหรือหายไป
• 402 Payment Required: เครดิตพรีเพดของคุณหมดแล้ว เติมเงินด้วยคริปโตเพื่อดำเนินการต่อ
• 429 Too Many Requests: คุณเกินขีดจำกัดอัตรา รอครู่หนึ่งก่อนลองใหม่

ข้อผิดพลาดไม่ใช้ยอดเครดิตของคุณ

การสตรีม

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)