شروع سریع API و یکپارچه‌سازی

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

پروژه Herict یک اندپوینت میزبانی‌شده واحد برای تولید متن ارائه می‌دهد. از https://api.hereticproject.com/v1 به‌عنوان آدرس پایه (base URL). احراز هویت بر پایه یک توکن bearer است که از طریق Authorization هدر. کلید خود را با ورود به داشبورد با گوگل یا ایمیل ایجاد کنید. سیستم یک کلید فعال برای هر حساب کاربری صادر می‌کند؛ ایجاد کلید جدید، کلید قبلی را بلافاصله نامعتبر می‌سازد.

شما فقط بابت توکن‌های مصرف‌شده پرداخت می‌کنید. خطاها و رد شدن‌ها اعتبار پیش‌پرداخت شما را کسر نمی‌کنند. حساب جدید $0.50 اعتبار آزمایشی دارد که هفت روز اعتبار دارد. با USDT (TRC20) یا USDC (Base) با مبالغ بین $20 و $500 شارژ می‌کنید.

Endpoint /v1/chat/completions

پیام‌ها را به نقطه پایانی تکمیل چت استاندارد ارسال کنید. شناسه مدل uncensored. یک لیست از اشیاء پیام با نقش‌هایی مانند system, user, یا assistantمدل موضوعات بزرگسالان قانونی، داستانی یا بحث‌برانگیز را رد نمی‌کند. این یک مدل وزن‌باز است که برای پاسخ‌های مستقیم تنظیم شده است.

درخواست‌ها یک آبجکت JSON شامل متن تولید شده برمی‌گردانند. پنجره زمینه برای پرامپت و تکمیل به صورت ترکیبی از 100,000 توکن پشتیبانی می‌کند. خروجی در هر درخواست به 16,000 توکن محدود است مگر اینکه مقدار کمتری مشخص کنید max_tokens مقدار.

Copycurl https://api.hereticproject.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list dependencies for node project"}]
  }'

یکپارچه‌سازی SDK Python

از کتابخانه رسمی پایتون OpenAI با آدرس پایه سفارشی استفاده کنید. آدرس api_key به رشته API خود اضافه کنید. پیکربندی base_url به سرور پروژه Heretic اشاره کنید. این به شما اجازه می‌دهد از روش‌های آشنا مانند chat.completions.create() بدون تغییر قابل توجه در ساختار کد موجود شما.

کتابخانه را از طریق pip نصب کنید. اعتبارنامه‌های خود را مستقیماً به مقداردهی اولیه کلاینت ارسال کنید. کتابخانه serialisation را به‌طور خودکار مدیریت می‌کند. این روش برای هر دو جریان کاری synchronous و asynchronous کار می‌کند. اطمینان حاصل کنید که خطاهای احتمالی شبکه را به‌خوبی مدیریت کنید.

Copyfrom openai import OpenAI

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

یکپارچه‌سازی Node SDK

SDK Node.js دقیقاً مشابه نسخه Python کار می‌کند. کلاینت را با کلید API و URL پایه صحیح مقداردهی اولیه کنید. می‌توانید درخواست‌های completion را با همان امضای متدها ارسال کنید. این موضوع یکپارچگی را در بخش‌های مختلف استک شما تضمین می‌کند.

پاسخ‌ها را به‌صورت ناهمگام پردازش کنید. اگر از روش جریان داده استفاده کنید، SDK داده‌ها را جریان‌دهی می‌کند. در غیر این صورت، پاسخ JSON کامل را برمی‌گرداند. این انعطاف‌پذیری از پردازش دسته‌ای و رابط‌های بلادرنگ پشتیبانی می‌کند. کلید API خود را در متغیرهای محیطی به‌طور ایمن نگهداری کنید.

Copyimport OpenAI from "openai";

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

پاسخ‌های استریم (SSE)

استریمینگ را با تنظیم stream: true در درخواست شما. سرور رویدادهای ارسالی سرور (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)

محدودیت‌ها، خطاها و زمینه

به محدودیت‌های نرخ احترام بگذارید تا از وقفه خدمات جلوگیری شود. شما مجاز به 300 درخواست در دقیقه به ازای هر کلید هستید. همزمانی به 8 درخواست همزمان محدود می‌شود. بدنه درخواست نمی‌تواند از 8 مگابایت بیشتر باشد. عبور از این محدودیت‌ها کد وضعیت 429 را برمی‌گرداند. پیش از تلاش مجدد، کمی صبر کنید.

شکست‌های احراز هویت خطای 401 را برمی‌گردانند. این اتفاق می‌افتد اگر کلید نامعتبر یا منقضی شده باشد. خطای 402 نشان‌دهنده اعتبار پیش‌پرداخت ناکافی است. اشتباهات بازپرداخت از طریق صفحه پشتیبانی مدیریت می‌شوند. اعتبار هرگز منقضی نمی‌شود. مدل محتوای مرتبط با اطفال را رد می‌کند. تمام محتوای قانونی دیگر پذیرفته می‌شود.