مستندات API: راهنمای شروع سریع

URL پایه و احراز هویت

API Heretic AI کاملاً سازگار با OpenAI است. شما با اشاره کلاینت خود به URL پایه ما با آن تعامل دارید: https://api.hereticai.cc/v1. احراز هویت به یک کلید API منحصر‌به‌فرد برای هر حساب کاربری متکی است که بلافاصله پس از ثبت‌نام از طریق Google یا ایمیل تولید می‌شود. این کلید را در Authorization هدر به عنوان یک توکن Bearer. شناسه مدل به سادگی 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"}]
  }'

نقطه پایانی تکمیل چت

درخواست‌های متنی را با استفاده از POST /v1/chat/completions نقطه پایانی. API یک آرایه پیام استاندارد شامل تاریخچه مکالمه یا پرامپت شما را انتظار دارد. متن تولید شده را در choices آرایه. این یک 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)

فراخوانی تابع و ابزارها

این API فراخوانی تابع با tools و tool_choice پارامترها. اسکیمای ابزارهای خود را در درخواست تعریف کنید و مدل در صورت لزوم فراخوان‌های تابع ساختاریافته را برمی‌گرداند. این امکان‌پذیر می‌کند که جریان‌های کاری پیچیده‌ای ایجاد کنید که در آن LLM تصمیم می‌گیرد که اقدام بعدی چیست. می‌توانید استفاده از ابزارهای خاص را تحمیل کنید یا به مدل اجازه دهید آزادانه انتخاب کند. این قابلیت برای ساخت برنامه‌های عامل‌محور که با سیستم‌ها یا پایگاه‌های داده خارجی تعامل دارند ضروری است.

حالت JSON

تضمین خروجی قطعی با تنظیم response_format به {"type": "json_object"}. مدل پاسخ خود را به JSON معتبر محدود می‌کند، که برای تجزیه برنامه‌نویسی حیاتی است. این نیاز به اصلاحات regex پس‌پردازش را کاهش می‌دهد. تضمین می‌کند که خروجی مستقیماً توسط کد شما قابل مصرف است. این به ویژه برای وظایف استخراج داده ساختاریافته یا تولید پیکربندی مفید است.

پارامترها و محدودیت‌ها

تولید را با پارامترهای استاندارد مانند کنترل کنید temperature, top_p، و seed. پنجره زمینه ۱۰۰,۰۰۰ توکن برای ورودی به همراه خروجی است. حداکثر خروجی ۱۶,۰۰۰ توکن در هر درخواست است، یا ۲,۰۴۸ اگر max_tokens تنظیم نشده است. محدودیت‌های نرخ 300 درخواست در دقیقه و 8 درخواست همزمان در هر کلید است. بدنه درخواست باید زیر 8 مگابایت باشد. این محدودیت‌ها برای استفاده پایدار با حجم بالا توسط توسعه‌دهندگان تضمین می‌شود.

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);