GitHub Uncensored API Reference

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

API برای هر درخواست نیازمند یک توکن حامل (Bearer Token) است. شما این کلید را به سرعت از طریق داشبورد با استفاده از اعتبارنامه‌های Google یا ایمیل ایجاد می‌کنید. پس از ایجاد، کلید حساب پیش‌پرداخت شما را در برابر مدل میزبانی شده احراز هویت می‌کند.

URL پایه خود را مستقیماً به دروازه API ما متصل کنید. این تضمین می‌کند که تمام درخواست‌ها به سرور مدل uncensored صحیح هدایت می‌شوند.

از هدر استاندارد Authorization با طرح Bearer استفاده کنید. جایگزین را با رشته کلید منحصر به فرد خود جایگزین کنید.

پیکربندی پایه

• URL پایه: https://api.githubuncensoredai.com/v1
• هدر Auth: Authorization: Bearer YOUR_API_KEY
• شناسه مدل: uncensored

Copycurl https://api.githubuncensoredai.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Fix the syntax error in this python loop"}]
  }'

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

ارسال داده‌های متنی به نقطه پایانی تکمیل چت و دریافت متن تولید شده در پاسخ. سیستم یک لیست از پیام‌ها با نقش‌هایی مانند user یا assistant را می‌پذیرد. آن یک تکمیل بر اساس تاریخچه پرامپت برمی‌گرداند.

این اندپوینت، جریان‌های مکالمه استاندارد را مدیریت می‌کند. می‌توانید چندین نوبت ارسال کنید و مدل زمینه را تا حد مجاز حفظ می‌کند. از ورودی‌های تصویر، صدا یا ویدیو پشتیبانی نمی‌کند. فرمت پاسخ، JSON استاندارد است.

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

Copyfrom openai import OpenAI

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

پاسخ‌های استریم

با تنظیم پرچم stream به true، پخش زنده را فعال کنید. API سریالی از رویدادهای سربرگ‌فرستاده‌شده را به جای یک شیء JSON واحد برمی‌گرداند. هر رویداد حاوی قطعه‌ای از متن تولیدشده است.

این رویکرد تأخیر ادراک‌شده را برای پاسخ‌های طولانی کاهش می‌دهد. می‌توانید متن را هنگام تولید برای کاربران نمایش دهید. قطعه نهایی شامل آمار مصرف توکن برای صورتحساب است.

جریان را در کد کلاینت به‌صورت کارآمد مدیریت کنید. اتصال را هنگام پایان جریان یا وقوع خطا ببندید. این روش برای رابط‌های چت بلادرنگ خوب کار می‌کند.

Copyimport OpenAI from "openai";

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

Function Calling & JSON Mode

مدل از خروجی ساختاریافته از طریق فراخوان تابع پشتیبانی می‌کند. ابزارها را در درخواست خود با نام‌ها، توضیحات و طرح‌واره‌های پارامتر تعریف کنید. مدل ابزار مناسب را انتخاب کرده و آرگومان‌ها را تولید می‌کند.

استفاده از حالت JSON برای انطباق دقیق با طرحواره. فرمت پاسخ را روی json_object تنظیم کنید تا خروجی JSON معتد را مجبور کنید. این برای تجزیه داده‌ها یا تولید قطعات کد مفید است.

فراخوانی تابع را با استریم برای تجربیات تعاملی ترکیب کنید. مدل می‌تواند چندین ابزار را به صورت متوالی فراخوانی کند. طرح خروجی را قبل از اجرای توابع در منطق برنامه خود اعتبارسنجی کنید.

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)

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

رفتار تولید را با پارامترهایی مانند temperature و top_p کنترل کنید. این مقادیر را تنظیم کنید تا تعادلی بین خلاقیت و قطعیت ایجاد شود. تنظیمات پیش‌فرض برای بیشتر موارد عمومی کار می‌کنند.

به محدودیت‌های درخواست احترام بگذارید تا از خطاها جلوگیری کنید. شما می‌توانید تا 300 درخواست در دقیقه به ازای هر کلید ارسال کنید. درخواست‌های همزمان به هشت درخواست به ازای هر کلید محدود می‌شود. حداکثر اندازه بدنه درخواست 8 مگابایت است.

پنجره زمینه ۱۰۰,۰۰۰ توکن است. این شامل توکن‌های پرامپت و تکمیل می‌شود. خروجی به ۱۶,۰۰۰ توکن در هر درخواست محدود است. فراتر رفتن از این محدودیت‌ها کد خطا برمی‌گرداند.

مصرف و صورتحساب توکن

صورتحساب پیش‌پرداخت است و بر اساس مصرف واقعی توکن محاسبه می‌شود. توکن‌های ورودی $0.15 به ازای هر میلیون و توکن‌های خروجی $0.50 به ازای هر میلیون هزینه دارند. خطاها و رد شدن‌ها اعتبار مصرف نمی‌کنند.

اعتبار شما منقضی نمی‌شود. شارژ‌ها فقط از طریق رمزارز پردازش می‌شوند. برای واریزهای بزرگ‌تر، اعتبار هدیه دریافت می‌کنید. سیستم استفاده را برای هر کلید API به دقت ردیابی می‌کند.

موجودی خود را از طریق داشبورد پایش کنید. اگر اعتبار کم شود، درخواست‌های شما با یک کد خطای خاص ناموفق خواهند شد. برای ادامه سرویس بدون انتظار برای تأییدیه‌ها، به‌طور فوری وجوه اضافه کنید.