مستندات API برای مدل‌های بدون سانسور

هدرهای احراز هویت

کلید API خود را در هدر Authorization برای هر درخواست ارسال کنید. از فرمت Bearer YOUR_API_KEY و آن را در Authorization فیلد. کلید شما بلافاصله پس از ثبت‌نام از طریق گوگل یا ایمیل ایجاد می‌شود. برای ثبت‌نام نیازی به شماره تلفن نیست. کلید خود را در متغیرهای محیطی به صورت امن نگهداری کنید تا از استفاده غیرمجاز در برابر موجودی اعتبار پیش‌پرداخت خود جلوگیری کنید. هدر تضمین می‌کند که سرورهای ما حساب شما را برای صورتحساب دقیق توکن شناسایی کنند.

POST /v1/chat/completions

اولین درخواست خود را برای تولید پاسخ‌های متنی انجام دهید. از POST /v1/chat/completions اندپوینت با model تنظیم شده روی uncensored. این انتهای‌بند، آرایه‌های پیام شامل نقش‌های user و assistant را می‌پذیرد. می‌توانید پاسخ‌ها را استریم کنید یا متن کامل را بر اساس پیکربندی کلاینت دریافت کنید. مدل ورودی شما را پردازش کرده و متن بدون رد شدن محتوا برای استفاده بزرگسالان قانونی برمی‌گرداند. برای محدودیت‌های همزمانی به صفحه نرخ محدودیت مراجعه کنید.

GET /v1/models

اطلاعات مدل‌های موجود را با استفاده از نقطه پایانی GET بازیابی کنید. این کار متادیتا درباره مدل بدون سانسور و قابلیت‌های آن را برمی‌گرداند. می‌توانید شناسه مدل را قبل از ارسال درخواست‌های تکمیل‌کننده (completion) بررسی کنید. پاسخ سازگاری API با ساختارهای استاندارد OpenAI را تأیید می‌کند. از این مورد برای عیب‌یابی پیکربندی‌های کلاینت به سرعت استفاده کنید. این کار به اطمینان از اینکه SDK شما به نسخه صحیح سرویس اشاره می‌کند کمک می‌کند. این نقطه پایانی اعتبار توکنی از حساب شما مصرف نمی‌کند.

پاسخ‌های استریم‌شده و مصرف توکن

با تنظیم stream پارامتر را true تنظیم کنید. رویدادهای ارسال‌شده توسط سرور (SSE) را همان‌طور که توکن‌ها تولید می‌شوند دریافت می‌کنید. قطعه نهایی شامل کل مصرف توکن برای درخواست است. این امکان نمایش بلادرنگ پاسخ‌ها را در برنامه شما فراهم می‌کند. شمارش توکن‌ها به شما کمک می‌کند تا موجودی پیش‌پرداخت خود را به‌دقت پایش کنید. خطاهای حین پخش زنده با بستن طبیعی جریان مدیریت می‌شوند. در صورت نیاز می‌توانید جریان را بدون جریمه قطع کنید.

فراخوانی تابع و حالت JSON

از tools پارامتر برای قابلیت‌های فراخوانی تابع. مقدار response_format به json_object برای خروجی JSON دقیق. مدل از تولید داده‌های ساختاریافته برای برنامه‌های شما پشتیبانی می‌کند. می‌توانید ابزارهای سفارشی را در بدنه درخواست تعریف کنید. API ساختار را قبل از ارسال به مدل اعتبارسنجی می‌کند. این تضمین‌کننده تجزیه (parsing) یکسان در کد downstream شماست. حالت JSON برای جریان‌های کاری خودکار که فرمت‌های خاصی را نیاز دارند ایده‌آل است.

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

انتظار خطاهای 429 در صورت عبور از ۳۰۰ درخواست در دقیقه را داشته باشید. محدودیت اجازه ۸ درخواست همزمان به ازای هر کلید را می‌دهد. اندازه بدنه درخواست باید کمتر از ۸ مگابایت باشد. اگر خطای 401 دریافت کردید، اعتبار کلید API خود را بررسی کنید. خطای 402 نشان‌دهنده اعتبار پیش‌پرداخت ناکافی است. خطاها توکن‌هایی از موجودی شما مصرف نمی‌کنند. پنجره زمینه از ۱۰۰,۰۰۰ توکن برای prompt و completion ترکیبی پشتیبانی می‌کند. حداکثر خروجی ۱۶,۰۰۰ توکن است مگر اینکه خلاف آن ذکر شود. این خطاها را به صورت ایمن در کد کلاینت خود مدیریت کنید.

cURL

Copycurl https://api.unrestrictedgptchat.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "what is the capital of france"}]
  }'

پایتون

Copyfrom openai import OpenAI

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

Copyimport OpenAI from "openai";

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

جریان‌سازی

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)