คู่มือเริ่มต้นใช้งาน API Opensfw

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

เริ่มต้นด้วยการสร้างคีย์ของคุณบนแดชบอร์ด ใช้ https://api.opensfw.com/v1 URL พื้นฐานและกำหนดคีย์ API ของคุณใน Authorization header. การตั้งค่านี้ใช้งานได้กับไคลเอนต์ SDK มาตรฐานของ OpenAI ใดๆ

การขอ chat completion ครั้งแรกของคุณ

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

Copycurl https://api.opensfw.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the current release version of the model?"}]
  }'

การใช้งานโทเค็นและการตอบกลับแบบสตรีม

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

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.opensfw.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 สิ่งนี้ทำงานร่วมกับพารามิเตอร์การเรียกใช้ฟังก์ชันมาตรฐานได้อย่างราบรื่น

Copyimport OpenAI from "openai";

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

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

ตรวจสอบหา 401 if your key is invalid, 402 สำหรับเครดิตไม่เพียงพอ และ 429 สำหรับการจำกัดอัตรา คุณได้รับ 300 คำขอต่อนาทีและ 3 คำขอพร้อมกันต่อคีย์ ข้อผิดพลาดไม่ใช้โทเค็น

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)

ทำความเข้าใจหน้าต่างบริบทและขีดจำกัด

โมเดลแบบไม่เซ็นเซอร์รองรับหน้าต่างบริบทขนาด 100,000 token ขนาดผลลัพธ์สูงสุดคือ 16,000 token ต่อการเรียก รักษาขนาด body ของ request ไว้ต่ำกว่า 8 MB เพื่อให้มั่นใจในประสิทธิภาพที่เสถียรสำหรับข้อมูลขนาดใหญ่