เอกสาร API: คู่มือเริ่มต้นอย่างรวดเร็ว

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

API ของ Heretic AI เข้ากันได้กับ OpenAI อย่างสมบูรณ์ คุณสามารถโต้ตอบกับมันได้โดยชี้ไคลเอนต์ของคุณไปยัง URL พื้นฐานของเรา: https://api.hereticai.cc/v1. การตรวจสอบสิทธิ์อาศัย API key เดียวต่อบัญชี ซึ่งสร้างทันทีเมื่อสมัครสมาชิกผ่าน Google หรืออีเมล ส่งคีย์นี้ใน Authorization header เป็น Bearer token ตัวระบุโมเดลคือ uncensored. โมเดลเดียวนี้จัดการคำขอทั้งหมดของคุณโดยไม่มีความซับซ้อนในการเปลี่ยนเส้นทาง ข้อผิดพลาดเช่น 401 บ่งชี้ว่าคีย์ไม่ถูกต้อง ในขณะที่ 402 หมายความว่าคุณต้องการเครดิตคริปโตที่เติมเงินล่วงหน้าเพิ่มเติม

Copycurl https://api.hereticai.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "generate twenty test cases"}]
  }'

จุดจบ API Chat Completions

ส่งคำขอข้อความโดยใช้ POST /v1/chat/completions endpoint. endpoint. API คาดหวังอาร์เรย์ข้อความมาตรฐานซึ่งประกอบด้วยประวัติการสนทนาหรือ prompt ของคุณ จะส่งข้อความที่สร้างแล้วใน choices array. นี่คือ API เครื่องมือล้วนๆ: ข้อความเข้า ข้อความออก คุณจ่ายเฉพาะสำหรับโทเค็นที่บริโภค เครดิตที่เติมล่วงหน้าไม่หมดอายุ และการปฏิเสธหรือข้อผิดพลาดไม่ได้ใช้โทเค็น วิธีการนี้ขจัดล็อกการสมัครสมาชิกและระดับฟรีที่ไม่คาดคิด

Copyfrom openai import OpenAI

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

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

เปิดใช้งานการสตรีมโทเค็นแบบเรียลไทม์โดยการตั้งค่า stream: true ในการร้องขอของคุณ API ส่งคืนเหตุการณ์ที่ส่งโดยเซิร์ฟเวอร์ (SSE) สำหรับแต่ละโทเค็นที่สร้าง ซึ่งทำให้คุณสามารถแสดงผลลัพธ์แบบก้าวหน้า ซึ่งสำคัญสำหรับแอปพลิเคชันที่ไวต่อความล่าช้า สถิติการใช้งานโทเค็นจะปรากฏในชิ้นสุดท้ายของสตรีม คุณลักษณะนี้ทำงานได้อย่างราบรื่นกับ SDK มาตรฐานของ OpenAI ที่จัดการ SSE โดยอัตโนมัติ ซึ่งให้การตอบกลับทันทีโดยไม่ต้องรอการเสร็จสิ้นเต็มรูปแบบ

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)

Function Calling และเครื่องมือ

API รองรับ function calling พร้อม tools และ tool_choice พารามิเตอร์ กำหนดสคีมาเครื่องมือของคุณในคำขอ แล้วโมเดลจะส่งกลับการเรียกฟังก์ชันที่มีโครงสร้างเมื่อเหมาะสม สิ่งนี้เปิดใช้งานเวิร์กโฟลว์ที่ซับซ้อนซึ่ง LLM ตัดสินใจว่าจะดำเนินการใดต่อไป คุณสามารถบังคับใช้การใช้งานเครื่องมือเฉพาะหรือปล่อยให้โมเดลเลือกได้อย่างอิสระ ความสามารถนี้จำเป็นสำหรับการสร้างแอปพลิเคชันแบบเอเจนต์ที่โต้ตอบกับระบบภายนอกหรือฐานข้อมูล

โหมด JSON

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

Parameters and Limits

ควบคุมการสร้างด้วยพารามิเตอร์มาตรฐานเช่น temperature, top_p, และ seed. หน้าต่างบริบทมีขนาด 100,000 tokens สำหรับ prompt รวมกับ completion ขนาดผลลัพธ์สูงสุดคือ 16,000 tokens ต่อการร้องขอ หรือ 2,048 หาก max_tokens ยังไม่กำหนด ขีดจำกัดอัตราส่วนคือ 300 คำขอต่อนาทีและ 8 คำขอพร้อมกันต่อคีย์ ร่างคำขอต้องไม่เกิน 8 MB ขีดจำกัดเหล่านี้รับประกันการใช้งานปริมาณสูงที่เสถียรสำหรับนักพัฒนา

Node.js

Copyimport OpenAI from "openai";

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